org.opends.server.types

Class Schema

java.lang.Object

org.opends.server.types.Schema

@PublicAPI(stability=UNCOMMITTED,
           mayInstantiate=false,
           mayExtend=false,
           mayInvoke=true)
public final class Schema
extends Object

This class defines a data structure that holds information about the components of the Directory Server schema. It includes the following kinds of elements:

• Attribute type definitions
• Objectclass definitions
• Attribute syntax definitions
• Matching rule definitions
• Matching rule use definitions
• DIT content rule definitions
• DIT structure rule definitions
• Name form definitions

It always uses non-strict Schema under the hood.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Schema.SchemaUpdater Interface to update a schema provided a schema builder.

Constructor Summary

Constructors

Constructor and Description
Schema(org.forgerock.opendj.ldap.schema.Schema schemaNG) Creates a new schema structure with all elements initialized but empty.

Method Summary

Methods

Modifier and Type	Method and Description
void	addExtraAttribute(String name, Attribute attr) Add a new extra Attribute for this schema.
static String	addSchemaFileToElementDefinitionIfAbsent(String definition, String schemaFile) Adds the provided schema file to the provided schema element definition.
static void	compareConcatenatedSchema(Set<String> oldElements, Set<String> newElements, org.forgerock.opendj.ldap.schema.AttributeType elementType, List<Modification> mods) Compares the provided sets of schema element definitions and writes any differences found into the given list of modifications.
void	deregisterAttributeType(org.forgerock.opendj.ldap.schema.AttributeType attributeType) Deregisters the provided attribute type definition with this schema.
void	deregisterDITContentRule(DITContentRule ditContentRule) Deregisters the provided DIT content rule definition with this schema.
void	deregisterDITStructureRule(DITStructureRule ditStructureRule) Deregisters the provided DIT structure rule definition with this schema.
void	deregisterLdapSyntaxDescription(LDAPSyntaxDescription syntaxDesc) Deregisters the provided ldap syntax description with this schema.
void	deregisterMatchingRule(org.forgerock.opendj.ldap.schema.MatchingRule matchingRule) Deregisters the provided matching rule definition with this schema.
void	deregisterMatchingRuleUse(MatchingRuleUse matchingRuleUse) Deregisters the provided matching rule use definition with this schema.
void	deregisterNameForm(NameForm nameForm) Deregisters the provided name form definition with this schema.
void	deregisterObjectClass(ObjectClass objectClass) Deregisters the provided objectclass definition with this schema.
void	deregisterSyntax(org.forgerock.opendj.ldap.schema.Syntax syntax) Deregisters the provided attribute syntax definition with this schema.
void	destroy() Destroys the structures maintained by the schema so that they are no longer usable.
Schema	duplicate() Creates a new Schema object that is a duplicate of this one.
void	exclusiveLock() Takes an exclusive lock on the schema.
void	exclusiveUnlock() Releases an exclusive lock on the schema.
static void	genConcatenatedSchema(Set<String> attributeTypes, Set<String> objectClasses, Set<String> nameForms, Set<String> ditContentRules, Set<String> ditStructureRules, Set<String> matchingRuleUses, Set<String> ldapSyntaxes) Reads the files contained in the schema directory and generates a concatenated view of their contents in the provided sets.
org.forgerock.opendj.ldap.schema.AttributeType	getAttributeType(String nameOrOid) Retrieves the attribute type definition with the specified name or OID.
org.forgerock.opendj.ldap.schema.AttributeType	getAttributeType(String nameOrOid, org.forgerock.opendj.ldap.schema.Syntax syntax) Retrieves the attribute type definition with the specified name or OID.
Collection<org.forgerock.opendj.ldap.schema.AttributeType>	getAttributeTypes() Retrieves the attribute type definitions for this schema.
org.forgerock.opendj.ldap.schema.Syntax	getDefaultSyntax() Retrieves the default attribute syntax that should be used for attributes that are not defined in the server schema.
DITContentRule	getDITContentRule(ObjectClass objectClass) Retrieves the DIT content rule definition for the specified objectclass.
ConcurrentHashMap<ObjectClass,DITContentRule>	getDITContentRules() Retrieves the DIT content rule definitions for this schema, as a mapping between the objectclass for the rule and the DIT content rule itself.
DITStructureRule	getDITStructureRule(int ruleID) Retrieves the DIT structure rule definition with the provided rule ID.
DITStructureRule	getDITStructureRule(NameForm nameForm) Retrieves the DIT structure rule definition for the provided name form.
ConcurrentHashMap<Integer,DITStructureRule>	getDITStructureRulesByID() Retrieves the DIT structure rule definitions for this schema, as a mapping between the rule ID for the rule and the DIT structure rule itself.
ConcurrentHashMap<NameForm,DITStructureRule>	getDITStructureRulesByNameForm() Retrieves the DIT structure rule definitions for this schema, as a mapping between the name form for the rule and the DIT structure rule itself.
Map<String,Attribute>	getExtraAttributes() Get the extraAttributes stored in this schema.
LDAPSyntaxDescription	getLdapSyntaxDescription(String lowerName) Retrieves the ldap syntax definition with the OID.
ConcurrentHashMap<String,LDAPSyntaxDescription>	getLdapSyntaxDescriptions() Retrieves the ldap syntax definitions for this schema, as a mapping between the OID for the syntax and the ldap syntax definition itself.
org.forgerock.opendj.ldap.schema.MatchingRule	getMatchingRule(String nameOrOid) Retrieves the matching rule definition with the specified name or OID.
Collection<org.forgerock.opendj.ldap.schema.MatchingRule>	getMatchingRules() Retrieves all matching rule definitions for this schema.
MatchingRuleUse	getMatchingRuleUse(org.forgerock.opendj.ldap.schema.MatchingRule matchingRule) Retrieves the matching rule use definition for the specified matching rule.
ConcurrentHashMap<org.forgerock.opendj.ldap.schema.MatchingRule,MatchingRuleUse>	getMatchingRuleUses() Retrieves the matching rule use definitions for this schema, as a mapping between the matching rule for the matching rule use definition and the matching rule use itself.
List<NameForm>	getNameForm(ObjectClass objectClass) Retrieves the name forms definition for the specified objectclass.
NameForm	getNameForm(String lowerName) Retrieves the name form definition with the provided name or OID.
ConcurrentHashMap<String,NameForm>	getNameFormsByNameOrOID() Retrieves the name form definitions for this schema, as a mapping between the names/OID for the name form and the name form itself.
ConcurrentHashMap<ObjectClass,List<NameForm>>	getNameFormsByObjectClass() Retrieves the name form definitions for this schema, as a mapping between the objectclass for the name forms and the name forms themselves.
ObjectClass	getObjectClass(String lowerName) Retrieves the objectclass definition with the specified name or OID.
ConcurrentHashMap<String,ObjectClass>	getObjectClasses() Retrieves the objectclass definitions for this schema, as a mapping between the lowercase names and OIDs for the objectclass and the objectclass itself.
long	getOldestModificationTime() Retrieves the modification timestamp for the file in the schema configuration directory with the oldest last modified time.
org.forgerock.opendj.ldap.schema.Schema	getSchemaNG() Returns the SDK schema.
List<org.forgerock.opendj.ldap.schema.AttributeType>	getSubTypes(org.forgerock.opendj.ldap.schema.AttributeType attributeType) Retrieves the set of subtypes registered for the given attribute type.
org.forgerock.opendj.ldap.schema.Syntax	getSyntax(String oid) Retrieves the attribute syntax definition with the OID.
Collection<org.forgerock.opendj.ldap.schema.Syntax>	getSyntaxes() Retrieves the attribute syntax definitions for this schema.
long	getYoungestModificationTime() Retrieves the modification timestamp for the file in the schema configuration directory with the youngest last modified time.
boolean	hasAttributeType(String nameOrOid) Indicates whether this schema definition includes an attribute type with the provided name or OID.
boolean	hasMatchingRule(String nameOrOid) Indicates whether this schema definition includes a matching rule with the provided name or OID.
boolean	hasNameForm(String lowerName) Indicates whether this schema definition includes a name form with the specified name or OID.
boolean	hasObjectClass(String lowerName) Indicates whether this schema definition includes an objectclass with the provided name or OID.
boolean	hasSyntax(String oid) Indicates whether this schema definition includes an attribute syntax with the provided OID.
org.forgerock.opendj.ldap.schema.AttributeType	parseAttributeType(String definition) Parses an attribute type from its provided definition.
static String	parseOID(String definition, org.forgerock.opendj.ldap.ResultCode parsingErrorResultCode, LocalizableMessageDescriptor.Arg0 parsingErrorMsg) Returns the OID from the provided attribute type definition, assuming the definition is valid.
static void	readConcatenatedSchema(String concatSchemaFile, Set<String> attributeTypes, Set<String> objectClasses, Set<String> nameForms, Set<String> ditContentRules, Set<String> ditStructureRules, Set<String> matchingRuleUses, Set<String> ldapSyntaxes) Reads data from the specified concatenated schema file into the provided sets.
void	rebuildDependentElements(SchemaFileElement element) Recursively rebuilds all schema elements that are dependent upon the provided element.
void	registerAttributeType(org.forgerock.opendj.ldap.schema.AttributeType attributeType, boolean overwriteExisting) Registers the provided attribute type definition with this schema.
void	registerAttributeType(org.forgerock.opendj.ldap.schema.AttributeType attributeType, String schemaFile, boolean overwriteExisting) Registers the provided attribute type definition with this schema.
void	registerAttributeType(String definition, String schemaFile, boolean overwrite) Registers an attribute type from its provided definition.
void	registerAttributeTypes(List<String> definitions, String schemaFile, boolean overwrite) Registers a list of attribute types from their provided definitions.
void	registerDITContentRule(DITContentRule ditContentRule, boolean overwriteExisting) Registers the provided DIT content rule definition with this schema.
void	registerDITStructureRule(DITStructureRule ditStructureRule, boolean overwriteExisting) Registers the provided DIT structure rule definition with this schema.
void	registerLdapSyntaxDescription(String definition, boolean overwriteExisting) Registers the provided ldap syntax description with this schema.
void	registerMatchingRule(org.forgerock.opendj.ldap.schema.MatchingRule matchingRule, boolean overwriteExisting) Registers the provided matching rule definition with this schema.
void	registerMatchingRuleUse(MatchingRuleUse matchingRuleUse, boolean overwriteExisting) Registers the provided matching rule use definition with this schema.
void	registerNameForm(NameForm nameForm, boolean overwriteExisting) Registers the provided name form definition with this schema.
void	registerObjectClass(ObjectClass objectClass, boolean overwriteExisting) Registers the provided objectclass definition with this schema.
void	registerSyntax(org.forgerock.opendj.ldap.schema.Syntax syntax, boolean overwriteExisting) Registers the provided attribute syntax definition with this schema.
void	setOldestModificationTime(long oldestModificationTime) Sets the modification timestamp for the oldest file in the schema configuration directory.
void	setYoungestModificationTime(long youngestModificationTime) Sets the modification timestamp for the youngest file in the schema configuration directory.
void	updateSchema(Schema.SchemaUpdater updater) Update the schema using the provided schema updater.
<T> void	updateSchemaOption(org.forgerock.util.Option<T> option, T newValue) Updates the schema option if the new value differs from the old value.
static void	writeConcatenatedSchema() Writes a single file containing all schema element definitions, which can be used on startup to determine whether the schema files were edited with the server offline.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Schema

public Schema(org.forgerock.opendj.ldap.schema.Schema schemaNG)
       throws DirectoryException

Creates a new schema structure with all elements initialized but empty.

Parameters:

schemaNG - The SDK schema

Throws:

DirectoryException - if the schema has warnings

Method Detail

getSchemaNG

public org.forgerock.opendj.ldap.schema.Schema getSchemaNG()

Returns the SDK schema.

Returns:

the SDK schema

getAttributeTypes

public Collection<org.forgerock.opendj.ldap.schema.AttributeType> getAttributeTypes()

Retrieves the attribute type definitions for this schema.

Returns:

The attribute type definitions for this schema.

hasAttributeType

public boolean hasAttributeType(String nameOrOid)

Indicates whether this schema definition includes an attribute type with the provided name or OID.

Parameters:

nameOrOid - The name or OID for which to make the determination, ignoring case considerations

Returns:

true if this schema contains an attribute type with the provided name or OID, or false if not.

getAttributeType

public org.forgerock.opendj.ldap.schema.AttributeType getAttributeType(String nameOrOid)

Retrieves the attribute type definition with the specified name or OID.

Parameters:

nameOrOid - The name or OID of the attribute type to retrieve, ignoring case considerations

Returns:

The requested attribute type

getAttributeType

public org.forgerock.opendj.ldap.schema.AttributeType getAttributeType(String nameOrOid,
                                                              org.forgerock.opendj.ldap.schema.Syntax syntax)

Retrieves the attribute type definition with the specified name or OID.

Parameters:

nameOrOid - The name or OID of the attribute type to retrieve, ignoring case considerations

syntax - The syntax to use when creating the temporary "place-holder" attribute type.

Returns:

The requested attribute type

parseAttributeType

public org.forgerock.opendj.ldap.schema.AttributeType parseAttributeType(String definition)
                                                                  throws DirectoryException

Parses an attribute type from its provided definition.

Parameters:

definition - The definition of the attribute type

Returns:

the attribute type

Throws:

DirectoryException - If an error occurs

registerAttributeTypes

public void registerAttributeTypes(List<String> definitions,
                          String schemaFile,
                          boolean overwrite)
                            throws DirectoryException

Registers a list of attribute types from their provided definitions.

This method allows to do only one schema change for multiple definitions, thus avoiding the cost (and the issue of stale schema references) of rebuilding a new schema for each definition.

Parameters:

definitions - The definitions of the attribute types

schemaFile - The schema file where these definitions belong, can be null

overwrite - Indicates whether to overwrite the attribute type if it already exists based on OID or name

Throws:

DirectoryException - If an error occurs

registerAttributeType

public void registerAttributeType(String definition,
                         String schemaFile,
                         boolean overwrite)
                           throws DirectoryException

Registers an attribute type from its provided definition.

Parameters:

definition - The definition of the attribute type

schemaFile - The schema file where this definition belongs, maybe null

overwrite - Indicates whether to overwrite the attribute type if it already exists based on OID or name

Throws:

DirectoryException - If an error occurs

registerAttributeType

public void registerAttributeType(org.forgerock.opendj.ldap.schema.AttributeType attributeType,
                         boolean overwriteExisting)
                           throws DirectoryException

Registers the provided attribute type definition with this schema.

Parameters:

attributeType - The attribute type to register with this schema.

overwriteExisting - Indicates whether to overwrite an existing mapping if there are any conflicts (i.e., another attribute type with the same OID or name).

Throws:

DirectoryException - If a conflict is encountered and the overwriteExisting flag is set to false

registerAttributeType

public void registerAttributeType(org.forgerock.opendj.ldap.schema.AttributeType attributeType,
                         String schemaFile,
                         boolean overwriteExisting)
                           throws DirectoryException

Registers the provided attribute type definition with this schema.

Parameters:

attributeType - The attribute type to register with this schema.

schemaFile - The schema file where this definition belongs, maybe null

overwriteExisting - Indicates whether to overwrite an existing mapping if there are any conflicts (i.e., another attribute type with the same OID or name).

Throws:

DirectoryException - If a conflict is encountered and the overwriteExisting flag is set to false

parseOID

public static String parseOID(String definition,
              org.forgerock.opendj.ldap.ResultCode parsingErrorResultCode,
              LocalizableMessageDescriptor.Arg0 parsingErrorMsg)
                       throws DirectoryException

Returns the OID from the provided attribute type definition, assuming the definition is valid.

This method does not perform any check.

Parameters:

definition - The definition, assumed to be valid

parsingErrorResultCode - the result code to use if a problem occurs while parsing the definition

parsingErrorMsg - the message to use if a problem occurs while parsing the definition

Returns:

the OID, which is never null

Throws:

DirectoryException - If a problem occurs while parsing the definition

deregisterAttributeType

public void deregisterAttributeType(org.forgerock.opendj.ldap.schema.AttributeType attributeType)
                             throws DirectoryException

Deregisters the provided attribute type definition with this schema.

Parameters:

attributeType - The attribute type to deregister with this schema.

Throws:

DirectoryException - If the attribute type is referenced by another schema element.

getSubTypes

public List<org.forgerock.opendj.ldap.schema.AttributeType> getSubTypes(org.forgerock.opendj.ldap.schema.AttributeType attributeType)

Retrieves the set of subtypes registered for the given attribute type.

Parameters:

attributeType - The attribute type for which to retrieve the set of registered subtypes.

Returns:

The set of subtypes registered for the given attribute type, or an empty set if there are no subtypes registered for the attribute type.

getObjectClasses

public ConcurrentHashMap<String,ObjectClass> getObjectClasses()

Retrieves the objectclass definitions for this schema, as a mapping between the lowercase names and OIDs for the objectclass and the objectclass itself. Each objectclass may be associated with multiple keys (once for the OID and again for each name). The contents of the returned mapping must not be altered.

Returns:

The objectclass definitions for this schema.

hasObjectClass

public boolean hasObjectClass(String lowerName)

Indicates whether this schema definition includes an objectclass with the provided name or OID.

Parameters:

lowerName - The name or OID for which to make the determination, formatted in all lowercase characters.

Returns:

true if this schema contains an objectclass with the provided name or OID, or false if not.

getObjectClass

public ObjectClass getObjectClass(String lowerName)

Retrieves the objectclass definition with the specified name or OID.

Parameters:

lowerName - The name or OID of the objectclass to retrieve, formatted in all lowercase characters.

Returns:

The requested objectclass, or null if no class is registered with the provided name or OID.

registerObjectClass

public void registerObjectClass(ObjectClass objectClass,
                       boolean overwriteExisting)
                         throws DirectoryException

Registers the provided objectclass definition with this schema.

Parameters:

objectClass - The objectclass to register with this schema.

overwriteExisting - Indicates whether to overwrite an existing mapping if there are any conflicts (i.e., another objectclass with the same OID or name).

Throws:

DirectoryException - If a conflict is encountered and the overwriteExisting flag is set to false.

deregisterObjectClass

public void deregisterObjectClass(ObjectClass objectClass)

Deregisters the provided objectclass definition with this schema.

Parameters:

objectClass - The objectclass to deregister with this schema.

getSyntaxes

public Collection<org.forgerock.opendj.ldap.schema.Syntax> getSyntaxes()

Retrieves the attribute syntax definitions for this schema.

Returns:

The attribute syntax definitions for this schema.

hasSyntax

public boolean hasSyntax(String oid)

Indicates whether this schema definition includes an attribute syntax with the provided OID.

Parameters:

oid - The OID for which to make the determination

Returns:

true if this schema contains an attribute syntax with the provided OID, or false if not.

getSyntax

public org.forgerock.opendj.ldap.schema.Syntax getSyntax(String oid)

Retrieves the attribute syntax definition with the OID.

Parameters:

oid - The OID of the attribute syntax to retrieve.

Returns:

The requested attribute syntax, or null if no syntax is registered with the provided OID.

getDefaultSyntax

public org.forgerock.opendj.ldap.schema.Syntax getDefaultSyntax()

Retrieves the default attribute syntax that should be used for attributes that are not defined in the server schema.

Returns:

The default attribute syntax that should be used for attributes that are not defined in the server schema.

registerSyntax

public void registerSyntax(org.forgerock.opendj.ldap.schema.Syntax syntax,
                  boolean overwriteExisting)
                    throws DirectoryException

Registers the provided attribute syntax definition with this schema.

Parameters:

syntax - The attribute syntax to register with this schema.

overwriteExisting - Indicates whether to overwrite an existing mapping if there are any conflicts (i.e., another attribute syntax with the same OID).

Throws:

DirectoryException - If a conflict is encountered and the overwriteExisting flag is set to false

deregisterSyntax

public void deregisterSyntax(org.forgerock.opendj.ldap.schema.Syntax syntax)
                      throws DirectoryException

Deregisters the provided attribute syntax definition with this schema.

Parameters:

syntax - The attribute syntax to deregister with this schema.

Throws:

DirectoryException - If the LDAP syntax is referenced by another schema element.

getLdapSyntaxDescriptions

public ConcurrentHashMap<String,LDAPSyntaxDescription> getLdapSyntaxDescriptions()

Retrieves the ldap syntax definitions for this schema, as a mapping between the OID for the syntax and the ldap syntax definition itself. Each ldap syntax should only be present once, since its only key is its OID. The contents of the returned mapping must not be altered.

Returns:

The ldap syntax definitions for this schema.

getLdapSyntaxDescription

public LDAPSyntaxDescription getLdapSyntaxDescription(String lowerName)

Retrieves the ldap syntax definition with the OID.

Parameters:

lowerName - The OID of the ldap syntax to retrieve, formatted in all lowercase characters.

Returns:

The requested ldap syntax, or null if no syntax is registered with the provided OID.

registerLdapSyntaxDescription

public void registerLdapSyntaxDescription(String definition,
                                 boolean overwriteExisting)
                                   throws DirectoryException

Registers the provided ldap syntax description with this schema.

Parameters:

definition - The ldap syntax definition to register with this schema.

overwriteExisting - Indicates whether to overwrite an existing mapping if there are any conflicts (i.e., another ldap syntax with the same OID).

Throws:

DirectoryException - If a conflict is encountered and overwriteExisting flag is set to false

deregisterLdapSyntaxDescription

public void deregisterLdapSyntaxDescription(LDAPSyntaxDescription syntaxDesc)
                                     throws DirectoryException

Deregisters the provided ldap syntax description with this schema.

Parameters:

syntaxDesc - The ldap syntax to deregister with this schema.

Throws:

DirectoryException - If the LDAP syntax is referenced by another schema element.

getMatchingRules

public Collection<org.forgerock.opendj.ldap.schema.MatchingRule> getMatchingRules()

Retrieves all matching rule definitions for this schema.

Returns:

The matching rule definitions for this schema

hasMatchingRule

public boolean hasMatchingRule(String nameOrOid)

Indicates whether this schema definition includes a matching rule with the provided name or OID.

Parameters:

nameOrOid - The name or OID for which to make the determination, ignoring case considerations

Returns:

true if this schema contains a matching rule with the provided name or OID, or false if not.

getMatchingRule

public org.forgerock.opendj.ldap.schema.MatchingRule getMatchingRule(String nameOrOid)

Retrieves the matching rule definition with the specified name or OID.

Parameters:

nameOrOid - The name or OID of the matching rule to retrieve, ignoring case considerations

Returns:

The requested matching rule, or null if no rule is registered with the provided name or OID.

registerMatchingRule

public void registerMatchingRule(org.forgerock.opendj.ldap.schema.MatchingRule matchingRule,
                        boolean overwriteExisting)
                          throws DirectoryException

Registers the provided matching rule definition with this schema.

Parameters:

matchingRule - The matching rule to register with this schema.

overwriteExisting - Indicates whether to overwrite an existing mapping if there are any conflicts (i.e., another matching rule with the same OID or name).

Throws:

DirectoryException - If a conflict is encountered and the overwriteExisting flag is set to false

deregisterMatchingRule

public void deregisterMatchingRule(org.forgerock.opendj.ldap.schema.MatchingRule matchingRule)
                            throws DirectoryException

Deregisters the provided matching rule definition with this schema.

Parameters:

matchingRule - The matching rule to deregister with this schema.

Throws:

DirectoryException - If the matching rule is referenced by another schema element.

getMatchingRuleUses

public ConcurrentHashMap<org.forgerock.opendj.ldap.schema.MatchingRule,MatchingRuleUse> getMatchingRuleUses()

Retrieves the matching rule use definitions for this schema, as a mapping between the matching rule for the matching rule use definition and the matching rule use itself. Each matching rule use should only be present once, since its only key is its matching rule. The contents of the returned mapping must not be altered.

Returns:

The matching rule use definitions for this schema.

getMatchingRuleUse

public MatchingRuleUse getMatchingRuleUse(org.forgerock.opendj.ldap.schema.MatchingRule matchingRule)

Retrieves the matching rule use definition for the specified matching rule.

Parameters:

matchingRule - The matching rule for which to retrieve the matching rule use definition.

Returns:

The matching rule use definition, or null if none exists for the specified matching rule.

registerMatchingRuleUse

public void registerMatchingRuleUse(MatchingRuleUse matchingRuleUse,
                           boolean overwriteExisting)
                             throws DirectoryException

Registers the provided matching rule use definition with this schema.

Parameters:

matchingRuleUse - The matching rule use definition to register.

overwriteExisting - Indicates whether to overwrite an existing mapping if there are any conflicts (i.e., another matching rule use with the same matching rule).

Throws:

DirectoryException - If a conflict is encountered and the overwriteExisting flag is set to false

deregisterMatchingRuleUse

public void deregisterMatchingRuleUse(MatchingRuleUse matchingRuleUse)

Deregisters the provided matching rule use definition with this schema.

Parameters:

matchingRuleUse - The matching rule use to deregister with this schema.

getDITContentRules

public ConcurrentHashMap<ObjectClass,DITContentRule> getDITContentRules()

Retrieves the DIT content rule definitions for this schema, as a mapping between the objectclass for the rule and the DIT content rule itself. Each DIT content rule should only be present once, since its only key is its objectclass. The contents of the returned mapping must not be altered.

Returns:

The DIT content rule definitions for this schema.

getDITContentRule

public DITContentRule getDITContentRule(ObjectClass objectClass)

Retrieves the DIT content rule definition for the specified objectclass.

Parameters:

objectClass - The objectclass for the DIT content rule to retrieve.

Returns:

The requested DIT content rule, or null if no DIT content rule is registered with the provided objectclass.

registerDITContentRule

public void registerDITContentRule(DITContentRule ditContentRule,
                          boolean overwriteExisting)
                            throws DirectoryException

Registers the provided DIT content rule definition with this schema.

Parameters:

ditContentRule - The DIT content rule to register.

overwriteExisting - Indicates whether to overwrite an existing mapping if there are any conflicts (i.e., another DIT content rule with the same objectclass).

Throws:

DirectoryException - If a conflict is encountered and the overwriteExisting flag is set to false

deregisterDITContentRule

public void deregisterDITContentRule(DITContentRule ditContentRule)

Deregisters the provided DIT content rule definition with this schema.

Parameters:

ditContentRule - The DIT content rule to deregister with this schema.

getDITStructureRulesByID

public ConcurrentHashMap<Integer,DITStructureRule> getDITStructureRulesByID()

Retrieves the DIT structure rule definitions for this schema, as a mapping between the rule ID for the rule and the DIT structure rule itself. Each DIT structure rule should only be present once, since its only key is its rule ID. The contents of the returned mapping must not be altered.

Returns:

The DIT structure rule definitions for this schema.

getDITStructureRulesByNameForm

public ConcurrentHashMap<NameForm,DITStructureRule> getDITStructureRulesByNameForm()

Retrieves the DIT structure rule definitions for this schema, as a mapping between the name form for the rule and the DIT structure rule itself. Each DIT structure rule should only be present once, since its only key is its name form. The contents of the returned mapping must not be altered.

Returns:

The DIT structure rule definitions for this schema.

getDITStructureRule

public DITStructureRule getDITStructureRule(int ruleID)

Retrieves the DIT structure rule definition with the provided rule ID.

Parameters:

ruleID - The rule ID for the DIT structure rule to retrieve.

Returns:

The requested DIT structure rule, or null if no DIT structure rule is registered with the provided rule ID.

getDITStructureRule

public DITStructureRule getDITStructureRule(NameForm nameForm)

Retrieves the DIT structure rule definition for the provided name form.

Parameters:

nameForm - The name form for the DIT structure rule to retrieve.

Returns:

The requested DIT structure rule, or null if no DIT structure rule is registered with the provided name form.

registerDITStructureRule

public void registerDITStructureRule(DITStructureRule ditStructureRule,
                            boolean overwriteExisting)
                              throws DirectoryException

Registers the provided DIT structure rule definition with this schema.

Parameters:

ditStructureRule - The DIT structure rule to register.

overwriteExisting - Indicates whether to overwrite an existing mapping if there are any conflicts (i.e., another DIT structure rule with the same name form).

Throws:

DirectoryException - If a conflict is encountered and the overwriteExisting flag is set to false

deregisterDITStructureRule

public void deregisterDITStructureRule(DITStructureRule ditStructureRule)

Deregisters the provided DIT structure rule definition with this schema.

Parameters:

ditStructureRule - The DIT structure rule to deregister with this schema.

getNameFormsByObjectClass

public ConcurrentHashMap<ObjectClass,List<NameForm>> getNameFormsByObjectClass()

Retrieves the name form definitions for this schema, as a mapping between the objectclass for the name forms and the name forms themselves.

Returns:

The name form definitions for this schema.

getNameFormsByNameOrOID

public ConcurrentHashMap<String,NameForm> getNameFormsByNameOrOID()

Retrieves the name form definitions for this schema, as a mapping between the names/OID for the name form and the name form itself. Each name form may be present multiple times with different names and its OID. The contents of the returned mapping must not be altered.

Returns:

The name form definitions for this schema.

hasNameForm

public boolean hasNameForm(String lowerName)

Indicates whether this schema definition includes a name form with the specified name or OID.

Parameters:

lowerName - The name or OID for which to make the determination, formatted in all lowercase characters.

Returns:

true if this schema contains a name form with the provided name or OID, or false if not.

getNameForm

public List<NameForm> getNameForm(ObjectClass objectClass)

Retrieves the name forms definition for the specified objectclass.

Parameters:

objectClass - The objectclass for the name form to retrieve.

Returns:

The requested name forms, or null if no name forms are registered with the provided objectClass.

getNameForm

public NameForm getNameForm(String lowerName)

Retrieves the name form definition with the provided name or OID.

Parameters:

lowerName - The name or OID of the name form to retrieve, formatted in all lowercase characters.

Returns:

The requested name form, or null if no name form is registered with the provided name or OID.

registerNameForm

public void registerNameForm(NameForm nameForm,
                    boolean overwriteExisting)
                      throws DirectoryException

Registers the provided name form definition with this schema.

Parameters:

nameForm - The name form definition to register.

overwriteExisting - Indicates whether to overwrite an existing mapping if there are any conflicts (i.e., another name form with the same objectclass).

Throws:

DirectoryException - If a conflict is encountered and the overwriteExisting flag is set to false

deregisterNameForm

public void deregisterNameForm(NameForm nameForm)

Deregisters the provided name form definition with this schema.

Parameters:

nameForm - The name form definition to deregister.

getOldestModificationTime

public long getOldestModificationTime()

Retrieves the modification timestamp for the file in the schema configuration directory with the oldest last modified time.

Returns:

The modification timestamp for the file in the schema configuration directory with the oldest last modified time.

setOldestModificationTime

public void setOldestModificationTime(long oldestModificationTime)

Sets the modification timestamp for the oldest file in the schema configuration directory.

Parameters:

oldestModificationTime - The modification timestamp for the oldest file in the schema configuration directory.

getYoungestModificationTime

public long getYoungestModificationTime()

Retrieves the modification timestamp for the file in the schema configuration directory with the youngest last modified time.

Returns:

The modification timestamp for the file in the schema configuration directory with the youngest last modified time.

setYoungestModificationTime

public void setYoungestModificationTime(long youngestModificationTime)

Sets the modification timestamp for the youngest file in the schema configuration directory.

Parameters:

youngestModificationTime - The modification timestamp for the youngest file in the schema configuration directory.

rebuildDependentElements

public void rebuildDependentElements(SchemaFileElement element)
                              throws DirectoryException

Recursively rebuilds all schema elements that are dependent upon the provided element. This must be invoked whenever an existing schema element is modified in order to ensure that any elements that depend on it should also be recreated to reflect the change.

The following conditions create dependencies between schema elements:

• If an attribute type references a superior attribute type, then it is dependent upon that superior attribute type.
• If an objectclass requires or allows an attribute type, then it is dependent upon that attribute type.
• If a name form requires or allows an attribute type in the RDN, then it is dependent upon that attribute type.
• If a DIT content rule requires, allows, or forbids the use of an attribute type, then it is dependent upon that attribute type.
• If a matching rule use references an attribute type, then it is dependent upon that attribute type.
• If an objectclass references a superior objectclass, then it is dependent upon that superior objectclass.
• If a name form references a structural objectclass, then it is dependent upon that objectclass.
• If a DIT content rule references a structural or auxiliary objectclass, then it is dependent upon that objectclass.
• If a DIT structure rule references a name form, then it is dependent upon that name form.
• If a DIT structure rule references a superior DIT structure rule, then it is dependent upon that superior DIT structure rule.

Parameters:

element - The element for which to recursively rebuild all dependent elements.

Throws:

DirectoryException - If a problem occurs while rebuilding any of the schema elements.

duplicate

public Schema duplicate()

Creates a new Schema object that is a duplicate of this one. It elements may be added and removed from the duplicate without impacting this version.

Returns:

A new Schema object that is a duplicate of this one.

getExtraAttributes

public Map<String,Attribute> getExtraAttributes()

Get the extraAttributes stored in this schema.

Returns:

The extraAttributes stored in this schema.

addExtraAttribute

public void addExtraAttribute(String name,
                     Attribute attr)

Add a new extra Attribute for this schema.

Parameters:

name - The identifier of the extra Attribute.

attr - The extra attribute that must be added to this Schema.

writeConcatenatedSchema

public static void writeConcatenatedSchema()

Writes a single file containing all schema element definitions, which can be used on startup to determine whether the schema files were edited with the server offline.

genConcatenatedSchema

public static void genConcatenatedSchema(Set<String> attributeTypes,
                         Set<String> objectClasses,
                         Set<String> nameForms,
                         Set<String> ditContentRules,
                         Set<String> ditStructureRules,
                         Set<String> matchingRuleUses,
                         Set<String> ldapSyntaxes)
                                  throws IOException

Reads the files contained in the schema directory and generates a concatenated view of their contents in the provided sets.

Parameters:

attributeTypes - The set into which to place the attribute types read from the schema files.

objectClasses - The set into which to place the object classes read from the schema files.

nameForms - The set into which to place the name forms read from the schema files.

ditContentRules - The set into which to place the DIT content rules read from the schema files.

ditStructureRules - The set into which to place the DIT structure rules read from the schema files.

matchingRuleUses - The set into which to place the matching rule uses read from the schema files.

ldapSyntaxes - The set into which to place the ldap syntaxes read from the schema files.

Throws:

IOException - If a problem occurs while reading the schema file elements.

readConcatenatedSchema

public static void readConcatenatedSchema(String concatSchemaFile,
                          Set<String> attributeTypes,
                          Set<String> objectClasses,
                          Set<String> nameForms,
                          Set<String> ditContentRules,
                          Set<String> ditStructureRules,
                          Set<String> matchingRuleUses,
                          Set<String> ldapSyntaxes)
                                   throws IOException

Reads data from the specified concatenated schema file into the provided sets.

Parameters:

concatSchemaFile - The path to the concatenated schema file to be read.

attributeTypes - The set into which to place the attribute types read from the concatenated schema file.

objectClasses - The set into which to place the object classes read from the concatenated schema file.

nameForms - The set into which to place the name forms read from the concatenated schema file.

ditContentRules - The set into which to place the DIT content rules read from the concatenated schema file.

ditStructureRules - The set into which to place the DIT structure rules read from the concatenated schema file.

matchingRuleUses - The set into which to place the matching rule uses read from the concatenated schema file.

ldapSyntaxes - The set into which to place the ldap syntaxes read from the concatenated schema file.

Throws:

IOException - If a problem occurs while reading the schema file elements.

compareConcatenatedSchema

public static void compareConcatenatedSchema(Set<String> oldElements,
                             Set<String> newElements,
                             org.forgerock.opendj.ldap.schema.AttributeType elementType,
                             List<Modification> mods)

Compares the provided sets of schema element definitions and writes any differences found into the given list of modifications.

Parameters:

oldElements - The set of elements of the specified type read from the previous concatenated schema files.

newElements - The set of elements of the specified type read from the server's current schema.

elementType - The attribute type associated with the schema element being compared.

mods - The list of modifications into which any identified differences should be written.

destroy

@PublicAPI(stability=PRIVATE,
           mayInstantiate=false,
           mayExtend=false,
           mayInvoke=true)
public void destroy()

Destroys the structures maintained by the schema so that they are no longer usable. This should only be called at the end of the server shutdown process, and it can help detect inappropriate cached references.

updateSchema

public void updateSchema(Schema.SchemaUpdater updater)
                  throws DirectoryException

Update the schema using the provided schema updater.

An implicit lock is performed, so it is in general not necessary to call the {code lock()} and {code unlock() methods. However, these method should be used if/when the SchemaBuilder passed as an argument to the updater is not used to return the schema (see for example usage in CoreSchemaProvider class). This case should remain exceptional.

Parameters:

updater - the updater that returns a new schema

Throws:

DirectoryException - if there is any problem updating the schema

updateSchemaOption

public <T> void updateSchemaOption(org.forgerock.util.Option<T> option,
                          T newValue)
                        throws DirectoryException

Updates the schema option if the new value differs from the old value.

Type Parameters:

T - the schema option's type

Parameters:

option - the schema option to update

newValue - the new value for the schema option

Throws:

DirectoryException - if there is any problem updating the schema

exclusiveLock

public void exclusiveLock()

Takes an exclusive lock on the schema.

exclusiveUnlock

public void exclusiveUnlock()

Releases an exclusive lock on the schema.

addSchemaFileToElementDefinitionIfAbsent

public static String addSchemaFileToElementDefinitionIfAbsent(String definition,
                                              String schemaFile)

Adds the provided schema file to the provided schema element definition.

Parameters:

definition - The schema element definition

schemaFile - The name of the schema file to include in the definition

Returns:

The definition string of the element including the X-SCHEMA-FILE extension.