Package org.apache.directory.server.schema.bootstrap

See:
Description

Class Summary

ApachednsAttributeTypeProducer	A producer of schema attributeType definations for the apachedns schema.
ApachednsComparatorProducer	A producer of Comparator objects for the apachedns schema.
ApachednsDitContentRuleProducer	A producer of DitContentRule objects for the apachedns schema.
ApachednsDitStructureRuleProducer	A producer of DitStructureRule objects for the apachedns schema.
ApachednsMatchingRuleProducer	A producer of MatchingRule objects for the apachedns schema.
ApachednsMatchingRuleUseProducer	A producer of MatchingRuleUse objects for the apachedns schema.
ApachednsNameFormProducer	A producer of NameForm objects for the apachedns schema.
ApachednsNormalizerProducer	A producer of Normalizer objects for the apachedns schema.
ApachednsObjectClassProducer	A producer of schema objectClass definations for the apachedns schema.
ApachednsSchema	Top level apachedns schema class.
ApachednsSyntaxCheckerProducer	A producer of SyntaxChecker objects for the apachedns schema.
ApachednsSyntaxProducer	A producer of Syntax objects for the apachedns schema.
AutofsAttributeTypeProducer	A producer of schema attributeType definations for the autofs schema.
AutofsComparatorProducer	A producer of Comparator objects for the autofs schema.
AutofsDitContentRuleProducer	A producer of DitContentRule objects for the autofs schema.
AutofsDitStructureRuleProducer	A producer of DitStructureRule objects for the autofs schema.
AutofsMatchingRuleProducer	A producer of MatchingRule objects for the autofs schema.
AutofsMatchingRuleUseProducer	A producer of MatchingRuleUse objects for the autofs schema.
AutofsNameFormProducer	A producer of NameForm objects for the autofs schema.
AutofsNormalizerProducer	A producer of Normalizer objects for the autofs schema.
AutofsObjectClassProducer	A producer of schema objectClass definations for the autofs schema.
AutofsSchema	Top level autofs schema class.
AutofsSyntaxCheckerProducer	A producer of SyntaxChecker objects for the autofs schema.
AutofsSyntaxProducer	A producer of Syntax objects for the autofs schema.
CollectiveAttributeTypeProducer	A producer of schema attributeType definations for the collective schema.
CollectiveComparatorProducer	A producer of Comparator objects for the collective schema.
CollectiveDitContentRuleProducer	A producer of DitContentRule objects for the collective schema.
CollectiveDitStructureRuleProducer	A producer of DitStructureRule objects for the collective schema.
CollectiveMatchingRuleProducer	A producer of MatchingRule objects for the collective schema.
CollectiveMatchingRuleUseProducer	A producer of MatchingRuleUse objects for the collective schema.
CollectiveNameFormProducer	A producer of NameForm objects for the collective schema.
CollectiveNormalizerProducer	A producer of Normalizer objects for the collective schema.
CollectiveObjectClassProducer	A producer of schema objectClass definations for the collective schema.
CollectiveSchema	Top level collective schema class.
CollectiveSyntaxCheckerProducer	A producer of SyntaxChecker objects for the collective schema.
CollectiveSyntaxProducer	A producer of Syntax objects for the collective schema.
CorbaAttributeTypeProducer	A producer of schema attributeType definations for the corba schema.
CorbaComparatorProducer	A producer of Comparator objects for the corba schema.
CorbaDitContentRuleProducer	A producer of DitContentRule objects for the corba schema.
CorbaDitStructureRuleProducer	A producer of DitStructureRule objects for the corba schema.
CorbaMatchingRuleProducer	A producer of MatchingRule objects for the corba schema.
CorbaMatchingRuleUseProducer	A producer of MatchingRuleUse objects for the corba schema.
CorbaNameFormProducer	A producer of NameForm objects for the corba schema.
CorbaNormalizerProducer	A producer of Normalizer objects for the corba schema.
CorbaObjectClassProducer	A producer of schema objectClass definations for the corba schema.
CorbaSchema	Top level corba schema class.
CorbaSyntaxCheckerProducer	A producer of SyntaxChecker objects for the corba schema.
CorbaSyntaxProducer	A producer of Syntax objects for the corba schema.
CosineAttributeTypeProducer	A producer of schema attributeType definations for the cosine schema.
CosineComparatorProducer	A producer of Comparator objects for the cosine schema.
CosineDitContentRuleProducer	A producer of DitContentRule objects for the cosine schema.
CosineDitStructureRuleProducer	A producer of DitStructureRule objects for the cosine schema.
CosineMatchingRuleProducer	A producer of MatchingRule objects for the cosine schema.
CosineMatchingRuleUseProducer	A producer of MatchingRuleUse objects for the cosine schema.
CosineNameFormProducer	A producer of NameForm objects for the cosine schema.
CosineNormalizerProducer	A producer of Normalizer objects for the cosine schema.
CosineObjectClassProducer	A producer of schema objectClass definations for the cosine schema.
CosineSchema	Top level cosine schema class.
CosineSyntaxCheckerProducer	A producer of SyntaxChecker objects for the cosine schema.
CosineSyntaxProducer	A producer of Syntax objects for the cosine schema.
DhcpAttributeTypeProducer	A producer of schema attributeType definations for the dhcp schema.
DhcpComparatorProducer	A producer of Comparator objects for the dhcp schema.
DhcpDitContentRuleProducer	A producer of DitContentRule objects for the dhcp schema.
DhcpDitStructureRuleProducer	A producer of DitStructureRule objects for the dhcp schema.
DhcpMatchingRuleProducer	A producer of MatchingRule objects for the dhcp schema.
DhcpMatchingRuleUseProducer	A producer of MatchingRuleUse objects for the dhcp schema.
DhcpNameFormProducer	A producer of NameForm objects for the dhcp schema.
DhcpNormalizerProducer	A producer of Normalizer objects for the dhcp schema.
DhcpObjectClassProducer	A producer of schema objectClass definations for the dhcp schema.
DhcpSchema	Top level dhcp schema class.
DhcpSyntaxCheckerProducer	A producer of SyntaxChecker objects for the dhcp schema.
DhcpSyntaxProducer	A producer of Syntax objects for the dhcp schema.
InetorgpersonAttributeTypeProducer	A producer of schema attributeType definations for the inetorgperson schema.
InetorgpersonComparatorProducer	A producer of Comparator objects for the inetorgperson schema.
InetorgpersonDitContentRuleProducer	A producer of DitContentRule objects for the inetorgperson schema.
InetorgpersonDitStructureRuleProducer	A producer of DitStructureRule objects for the inetorgperson schema.
InetorgpersonMatchingRuleProducer	A producer of MatchingRule objects for the inetorgperson schema.
InetorgpersonMatchingRuleUseProducer	A producer of MatchingRuleUse objects for the inetorgperson schema.
InetorgpersonNameFormProducer	A producer of NameForm objects for the inetorgperson schema.
InetorgpersonNormalizerProducer	A producer of Normalizer objects for the inetorgperson schema.
InetorgpersonObjectClassProducer	A producer of schema objectClass definations for the inetorgperson schema.
InetorgpersonSchema	Top level inetorgperson schema class.
InetorgpersonSyntaxCheckerProducer	A producer of SyntaxChecker objects for the inetorgperson schema.
InetorgpersonSyntaxProducer	A producer of Syntax objects for the inetorgperson schema.
JavaAttributeTypeProducer	A producer of schema attributeType definations for the java schema.
JavaComparatorProducer	A producer of Comparator objects for the java schema.
JavaDitContentRuleProducer	A producer of DitContentRule objects for the java schema.
JavaDitStructureRuleProducer	A producer of DitStructureRule objects for the java schema.
JavaMatchingRuleProducer	A producer of MatchingRule objects for the java schema.
JavaMatchingRuleUseProducer	A producer of MatchingRuleUse objects for the java schema.
JavaNameFormProducer	A producer of NameForm objects for the java schema.
JavaNormalizerProducer	A producer of Normalizer objects for the java schema.
JavaObjectClassProducer	A producer of schema objectClass definations for the java schema.
JavaSchema	Top level java schema class.
JavaSyntaxCheckerProducer	A producer of SyntaxChecker objects for the java schema.
JavaSyntaxProducer	A producer of Syntax objects for the java schema.
Krb5kdcAttributeTypeProducer	A producer of schema attributeType definations for the krb5kdc schema.
Krb5kdcComparatorProducer	A producer of Comparator objects for the krb5kdc schema.
Krb5kdcDitContentRuleProducer	A producer of DitContentRule objects for the krb5kdc schema.
Krb5kdcDitStructureRuleProducer	A producer of DitStructureRule objects for the krb5kdc schema.
Krb5kdcMatchingRuleProducer	A producer of MatchingRule objects for the krb5kdc schema.
Krb5kdcMatchingRuleUseProducer	A producer of MatchingRuleUse objects for the krb5kdc schema.
Krb5kdcNameFormProducer	A producer of NameForm objects for the krb5kdc schema.
Krb5kdcNormalizerProducer	A producer of Normalizer objects for the krb5kdc schema.
Krb5kdcObjectClassProducer	A producer of schema objectClass definations for the krb5kdc schema.
Krb5kdcSchema	Top level krb5kdc schema class.
Krb5kdcSyntaxCheckerProducer	A producer of SyntaxChecker objects for the krb5kdc schema.
Krb5kdcSyntaxProducer	A producer of Syntax objects for the krb5kdc schema.
MozillaAttributeTypeProducer	A producer of schema attributeType definations for the mozilla schema.
MozillaComparatorProducer	A producer of Comparator objects for the mozilla schema.
MozillaDitContentRuleProducer	A producer of DitContentRule objects for the mozilla schema.
MozillaDitStructureRuleProducer	A producer of DitStructureRule objects for the mozilla schema.
MozillaMatchingRuleProducer	A producer of MatchingRule objects for the mozilla schema.
MozillaMatchingRuleUseProducer	A producer of MatchingRuleUse objects for the mozilla schema.
MozillaNameFormProducer	A producer of NameForm objects for the mozilla schema.
MozillaNormalizerProducer	A producer of Normalizer objects for the mozilla schema.
MozillaObjectClassProducer	A producer of schema objectClass definations for the mozilla schema.
MozillaSchema	Top level mozilla schema class.
MozillaSyntaxCheckerProducer	A producer of SyntaxChecker objects for the mozilla schema.
MozillaSyntaxProducer	A producer of Syntax objects for the mozilla schema.
NisAttributeTypeProducer	A producer of schema attributeType definations for the nis schema.
NisComparatorProducer	A producer of Comparator objects for the nis schema.
NisComparatorProducer.DeepTrimCachingNormalizingComparator
NisDitContentRuleProducer	A producer of DitContentRule objects for the nis schema.
NisDitStructureRuleProducer	A producer of DitStructureRule objects for the nis schema.
NisMatchingRuleProducer	A producer of MatchingRule objects for the nis schema.
NisMatchingRuleUseProducer	A producer of MatchingRuleUse objects for the nis schema.
NisNameFormProducer	A producer of NameForm objects for the nis schema.
NisNormalizerProducer	A producer of Normalizer objects for the nis schema.
NisNormalizerProducer.CachingDeepTrimNormalizer
NisObjectClassProducer	A producer of schema objectClass definations for the nis schema.
NisSchema	Top level nis schema class.
NisSyntaxCheckerProducer	A producer of SyntaxChecker objects for the nis schema.
NisSyntaxProducer	A producer of Syntax objects for the nis schema.
SambaAttributeTypeProducer	A producer of schema attributeType definations for the samba schema.
SambaComparatorProducer	A producer of Comparator objects for the samba schema.
SambaDitContentRuleProducer	A producer of DitContentRule objects for the samba schema.
SambaDitStructureRuleProducer	A producer of DitStructureRule objects for the samba schema.
SambaMatchingRuleProducer	A producer of MatchingRule objects for the samba schema.
SambaMatchingRuleUseProducer	A producer of MatchingRuleUse objects for the samba schema.
SambaNameFormProducer	A producer of NameForm objects for the samba schema.
SambaNormalizerProducer	A producer of Normalizer objects for the samba schema.
SambaObjectClassProducer	A producer of schema objectClass definations for the samba schema.
SambaSchema	Top level samba schema class.
SambaSyntaxCheckerProducer	A producer of SyntaxChecker objects for the samba schema.
SambaSyntaxProducer	A producer of Syntax objects for the samba schema.

Package org.apache.directory.server.schema.bootstrap Description

 

 Contains interfaces and classes used for bootstrap schema object loading and
 configuration.
 
 

 Briefly, before delving into the reasons behind our choices, we would like to
 summarize what is here.  First off each schema entity of significance whether
 defined by the protocol or not is introduced into the system using a bootstrap
 configuration set class.  This is a class that implements a specific interface
 for creating all the needed schema objects to establish a baseline within the
 system.  All such schema objects generated will be owned by the directory
 administrator.  Furthermore these objects are temporary and can be overridden
 in the solid state using altered versions that are authoritative definitions
 within the system backend.
 
 

 Just what does all this mean?  Hard coded schema objects in Java classes
 which implement a configuration set interface can be loaded into the system
 and used while bootstrapping it.  If this is the first time bootstrapping,
 meaning these objects are NOT found within the system backend, they will
 be persisted into the system backend at the very end of the bootstrap stage so
 they can be resolved in the solid state.  Changes to these objects via LDAP
 within the system backend by the admin persist across bootstrap sessions.  They
 persist because the bootstrap object is never stored in the system backend
 if a record for that object already exists.
 
 

 Why are we storing a configuration directly in Java code?  First off the
 likelihood of altering schema object fields to bootstrap the system is highly
 unlikely.  Secondly most of these objects are published static entities and
 changing them would have serious repercussions.  Hence its highly unlikely
 that these objects will change and there is no need to get complex to try
 to have an external representation for these schema objects.  The
 representation of these objects as entries and attributes within the directory
 is enough of an external representation.  Schema manipulation tools already
 exist for making changes so why have another additional
 mechanism/representation as well.
 
 
 
Notes:
 

 

 Baseline schema configuration sets are loaded first.
 
 

 Within a logical schema (e.g. krb5-kdc) the ConfigurationSets of that
 schema will be loaded in an order consistent with datatype dependencies.
 For example a ConfigurationSet (CS) for SyntaxCheckers will be loaded
 before the one for Syntaxes within the same schema.  This is because
 Syntaxes depend upon SyntaxCheckers and the proper SyntaxChecker must be
 resolvable via the SyntaxChecker registry.
 
 

 A CS shall contain schema objects associated with a specific owner, and a
 specific logical schema.  The set of CS schema objects may depend on
 Schema objects within other logic schemas, hence other CS objects.  These
 dependencies on other logical schemas are exposed by the CS interface.
 
 

 Other user defined CS classes can be loaded by the system as well.  The
 system can search on the classpath for classes implementing the CS
 interface.  It would then need to analyze dependencies to determine which
 schema object sets to process/load first.  This is the most rudimentary
 of mechanisms for users to introduce new schema objects into the system.
 The other means is during the solid state through LDAP itself.  Changes
 can be made along with new schema object introductions via schemaSubentry
 changes in the usual LDAP manager where schema objects are attributes in
 a massive entry.  Another means is through the alteration of easier to
 manage entries for schema objects through the system namespace.  Changes
 to either schemaSubEntry attributes or system namespace schema entries both
 mirror one another.  A change to one propagates to the other: the same
 entity is being manipulated through two different views.  One is a heck of
 a lot more manageable.
 
 

 We can add a resolver interface so a resolver can be registered after
 bootstrapping with a registry.  In the case of a registry miss we ask the
 resolver for the object.  If it cannot find it then well we're out of luck.
 Once the resolver is set for solid state operation, registry misses make
 the resolver go to disk on the system backend for authoritative copies.
 
 

 The resolver concept mentioned above can itself be another registry.  It's
 just a secondary disk registry used when the first misses disk.  So hence
 other registries should be able to be registerable with others to allow for
 registry delegation like the way classloaders delegate.  This way there is
 no need to replace bootstrap registries.  Once they have enough info to
 enable disk access, they can tap secondary schema information on disk to
 override the bootstrap objects first of all.  Secondly in the solid state
 schema objects can be brought into memory from disk.
 
 
 
 

Version:

$Rev$, $Date$

Author:

Apache Directory Project