org.apache.directory.api.ldap.schema.manager.impl

Class DefaultSchemaManager

java.lang.Object

org.apache.directory.api.ldap.schema.manager.impl.DefaultSchemaManager

All Implemented Interfaces:

org.apache.directory.api.ldap.model.schema.SchemaManager

public class DefaultSchemaManager
extends Object
implements org.apache.directory.api.ldap.model.schema.SchemaManager

The SchemaManager class : it handles all the schema operations (addition, removal, modification).

Author:

Apache Directory Project

Field Summary

Fields

Modifier and Type	Field and Description
private org.apache.directory.api.ldap.model.schema.SchemaErrorHandler	errorHandler Class that handles all the error that may occur during schema processing.
private EntityFactory	factory the factory that generates respective SchemaObjects from LDIF entries
private boolean	isRelaxed A flag indicating that the SchemaManager is relaxed or not
private static org.slf4j.Logger	LOG static class logger
private org.apache.directory.api.ldap.model.name.Dn	namingContext The NamingContext this SchemaManager is associated with
private org.apache.directory.api.ldap.model.schema.registries.Registries	registries The global registries for this namingContext
private Map<String,Set<String>>	schemaDependencies A Map containing all the schema being dependent from a schema
private Map<String,org.apache.directory.api.ldap.model.schema.registries.Schema>	schemaMap A map of all available schema names to schema objects.

Fields inherited from interface org.apache.directory.api.ldap.model.schema.SchemaManager

RELAXED, STRICT

Constructor Summary

Constructors

Constructor and Description
DefaultSchemaManager() Creates a new instance of DefaultSchemaManager with LDIF based SchemaLoader, Strict schema validation
DefaultSchemaManager(boolean relaxed, Collection<org.apache.directory.api.ldap.model.schema.registries.Schema> schemas) Creates a new instance of DefaultSchemaManager with the default schema schemaLoader
DefaultSchemaManager(Collection<org.apache.directory.api.ldap.model.schema.registries.Schema> schemas) Creates a new instance of DefaultSchemaManager with the default schema schemaLoader Strict schema validation
DefaultSchemaManager(org.apache.directory.api.ldap.model.schema.registries.SchemaLoader schemaLoader) Creates a new instance of DefaultSchemaManager with the given schemaLoader Schema validation strictness (i.e. relaxed/strict) controlled by the given schemaLoader

Method Summary

Modifier and Type	Method and Description
boolean	add(org.apache.directory.api.ldap.model.schema.SchemaObject schemaObject)
private void	addAttributeTypes(org.apache.directory.api.ldap.model.schema.registries.Schema schema, org.apache.directory.api.ldap.model.schema.registries.Registries registries) Add all the Schema's AttributeTypes
private void	addComparators(org.apache.directory.api.ldap.model.schema.registries.Schema schema, org.apache.directory.api.ldap.model.schema.registries.Registries registries) Add all the Schema's comparators
private void	addMatchingRules(org.apache.directory.api.ldap.model.schema.registries.Schema schema, org.apache.directory.api.ldap.model.schema.registries.Registries registries) Add all the Schema's MatchingRules
private void	addNormalizers(org.apache.directory.api.ldap.model.schema.registries.Schema schema, org.apache.directory.api.ldap.model.schema.registries.Registries registries) Add all the Schema's Normalizers
private void	addObjectClasses(org.apache.directory.api.ldap.model.schema.registries.Schema schema, org.apache.directory.api.ldap.model.schema.registries.Registries registries) Add all the Schema's ObjectClasses
protected org.apache.directory.api.ldap.model.schema.SchemaObject	addSchemaObject(org.apache.directory.api.ldap.model.schema.registries.Registries registries, org.apache.directory.api.ldap.model.schema.SchemaObject schemaObject, org.apache.directory.api.ldap.model.schema.registries.Schema schema) Add the schemaObject into the registries.
protected void	addSchemaObjects(org.apache.directory.api.ldap.model.schema.registries.Schema schema, org.apache.directory.api.ldap.model.schema.registries.Registries registries)
private void	addSyntaxCheckers(org.apache.directory.api.ldap.model.schema.registries.Schema schema, org.apache.directory.api.ldap.model.schema.registries.Registries registries) Register all the Schema's SyntaxCheckers
private void	addSyntaxes(org.apache.directory.api.ldap.model.schema.registries.Schema schema, org.apache.directory.api.ldap.model.schema.registries.Registries registries) Add all the Schema's Syntaxes
private boolean	checkOidExist(org.apache.directory.api.ldap.model.schema.SchemaObject schemaObject) Check that the given OID exists in the globalOidRegistry.
private org.apache.directory.api.ldap.model.schema.registries.Registries	cloneRegistries() Clone the registries before doing any modification on it.
private org.apache.directory.api.ldap.model.schema.SchemaObject	copy(org.apache.directory.api.ldap.model.schema.SchemaObject schemaObject)
boolean	delete(org.apache.directory.api.ldap.model.schema.SchemaObject schemaObject)
private void	deleteSchemaObjects(org.apache.directory.api.ldap.model.schema.registries.Schema schema, org.apache.directory.api.ldap.model.schema.registries.Registries registries) Delete all the schemaObjects for a given schema from the registries
boolean	disable(org.apache.directory.api.ldap.model.schema.registries.Schema... schemas)
boolean	disable(String... schemaNames)
boolean	disabledRelaxed(org.apache.directory.api.ldap.model.schema.registries.Schema... schemas)
boolean	disabledRelaxed(String... schemas)
boolean	enable(org.apache.directory.api.ldap.model.schema.registries.Schema... schemas)
boolean	enable(String... schemaNames)
boolean	enableRelaxed(org.apache.directory.api.ldap.model.schema.registries.Schema... schemas)
boolean	enableRelaxed(String... schemas)
List<org.apache.directory.api.ldap.model.schema.registries.Schema>	getAllSchemas()
org.apache.directory.api.ldap.model.schema.AttributeType	getAttributeType(String oid)
org.apache.directory.api.ldap.model.schema.registries.AttributeTypeRegistry	getAttributeTypeRegistry()
org.apache.directory.api.ldap.model.schema.registries.ComparatorRegistry	getComparatorRegistry()
List<org.apache.directory.api.ldap.model.schema.registries.Schema>	getDisabled()
org.apache.directory.api.ldap.model.schema.registries.DitContentRuleRegistry	getDITContentRuleRegistry()
org.apache.directory.api.ldap.model.schema.registries.DitStructureRuleRegistry	getDITStructureRuleRegistry()
List<org.apache.directory.api.ldap.model.schema.registries.Schema>	getEnabled()
org.apache.directory.api.ldap.model.schema.SchemaErrorHandler	getErrorHandler()
List<Throwable>	getErrors()
org.apache.directory.api.ldap.model.schema.registries.OidRegistry	getGlobalOidRegistry()
org.apache.directory.api.ldap.model.schema.registries.LdapSyntaxRegistry	getLdapSyntaxRegistry()
org.apache.directory.api.ldap.model.schema.registries.Schema	getLoadedSchema(String schemaName)
org.apache.directory.api.ldap.model.schema.registries.MatchingRuleRegistry	getMatchingRuleRegistry()
org.apache.directory.api.ldap.model.schema.registries.MatchingRuleUseRegistry	getMatchingRuleUseRegistry()
org.apache.directory.api.ldap.model.schema.registries.NameFormRegistry	getNameFormRegistry()
org.apache.directory.api.ldap.model.name.Dn	getNamingContext()
Map<String,org.apache.directory.api.ldap.model.schema.normalizers.OidNormalizer>	getNormalizerMapping()
org.apache.directory.api.ldap.model.schema.registries.NormalizerRegistry	getNormalizerRegistry()
org.apache.directory.api.ldap.model.schema.registries.ObjectClassRegistry	getObjectClassRegistry()
org.apache.directory.api.ldap.model.schema.registries.Registries	getRegistries()
private String	getSchemaName(org.apache.directory.api.ldap.model.schema.SchemaObject schemaObject) Retrieve the schema name for a specific SchemaObject, or return "other" if none is found.
private org.apache.directory.api.ldap.model.schema.SchemaObject	getSchemaObject(org.apache.directory.api.ldap.model.schema.SchemaObject schemaObject) Get the inner SchemaObject if it's not a C/N/SC
org.apache.directory.api.ldap.model.schema.registries.SyntaxCheckerRegistry	getSyntaxCheckerRegistry()
void	initialize() Initializes the SchemaService
boolean	isDisabled(org.apache.directory.api.ldap.model.schema.registries.Schema schema)
boolean	isDisabled(String schemaName)
boolean	isDisabledAccepted() Currently not implemented.
boolean	isEnabled(org.apache.directory.api.ldap.model.schema.registries.Schema schema)
boolean	isEnabled(String schemaName)
boolean	isRelaxed() Tells if the SchemaManager is permissive or if it must be checked against inconsistencies.
boolean	isSchemaLoaded(String schemaName)
boolean	isStrict() Tells if the SchemaManager is strict.
private static org.apache.directory.api.ldap.model.schema.registries.SchemaLoader	jarLdifSchemaLoader()
Set<String>	listDependentSchemaNames(String schemaName)
private boolean	load(org.apache.directory.api.ldap.model.schema.registries.Registries registries, org.apache.directory.api.ldap.model.schema.registries.Schema schema) Load the schema in the registries.
boolean	load(org.apache.directory.api.ldap.model.schema.registries.Schema... schemas)
boolean	load(String... schemaNames)
boolean	loadAllEnabled()
boolean	loadAllEnabledRelaxed()
private void	loadDepsFirst(org.apache.directory.api.ldap.model.schema.registries.Registries registries, org.apache.directory.api.ldap.model.schema.registries.Schema schema) Recursive method which loads schema's with their dependent schemas first and tracks what schemas it has seen so the recursion does not go out of control with dependency cycle detection.
private void	loadDepsFirstRelaxed(org.apache.directory.api.ldap.model.schema.registries.Schema schema) Recursive method which loads schema's with their dependent schemas first and tracks what schemas it has seen so the recursion does not go out of control with dependency cycle detection.
boolean	loadDisabled(org.apache.directory.api.ldap.model.schema.registries.Schema... schemas)
boolean	loadDisabled(String... schemaNames)
boolean	loadRelaxed(org.apache.directory.api.ldap.model.schema.registries.Schema... schemas)
boolean	loadRelaxed(String... schemaNames)
boolean	loadWithDeps(org.apache.directory.api.ldap.model.schema.registries.Schema... schemas)
boolean	loadWithDeps(String... schemas)
boolean	loadWithDepsRelaxed(org.apache.directory.api.ldap.model.schema.registries.Schema... schemas)
boolean	loadWithDepsRelaxed(String... schemas)
org.apache.directory.api.ldap.model.schema.AttributeType	lookupAttributeTypeRegistry(String oid)
org.apache.directory.api.ldap.model.schema.LdapComparator<?>	lookupComparatorRegistry(String oid)
org.apache.directory.api.ldap.model.schema.LdapSyntax	lookupLdapSyntaxRegistry(String oid)
org.apache.directory.api.ldap.model.schema.MatchingRule	lookupMatchingRuleRegistry(String oid)
org.apache.directory.api.ldap.model.schema.Normalizer	lookupNormalizerRegistry(String oid)
org.apache.directory.api.ldap.model.schema.ObjectClass	lookupObjectClassRegistry(String oid)
org.apache.directory.api.ldap.model.schema.SyntaxChecker	lookupSyntaxCheckerRegistry(String oid)
void	setErrorHandler(org.apache.directory.api.ldap.model.schema.SchemaErrorHandler errorHandler)
void	setRegistries(org.apache.directory.api.ldap.model.schema.registries.Registries registries)
void	setRelaxed() Change the SchemaManager to a relaxed mode, where invalid SchemaObjects can be registered.
void	setStrict() Change the SchemaManager to a strict mode, where invalid SchemaObjects cannot be registered.
private String	stripOptions(String oid) Get rid of AT's options (everything after the ';'
private org.apache.directory.api.ldap.model.schema.registries.Schema[]	toArray(String... schemas) Transform a String[] array of schema to a Schema[]
private boolean	unload(org.apache.directory.api.ldap.model.schema.registries.Registries registries, org.apache.directory.api.ldap.model.schema.registries.Schema schema) Unload the schema from the registries.
boolean	unload(org.apache.directory.api.ldap.model.schema.registries.Schema... schemas)
boolean	unload(String... schemaNames)
org.apache.directory.api.ldap.model.schema.SchemaObject	unregisterAttributeType(String attributeTypeOid)
org.apache.directory.api.ldap.model.schema.SchemaObject	unregisterComparator(String comparatorOid)
org.apache.directory.api.ldap.model.schema.SchemaObject	unregisterDitControlRule(String ditControlRuleOid)
org.apache.directory.api.ldap.model.schema.SchemaObject	unregisterDitStructureRule(String ditStructureRuleOid)
org.apache.directory.api.ldap.model.schema.SchemaObject	unregisterLdapSyntax(String ldapSyntaxOid)
org.apache.directory.api.ldap.model.schema.SchemaObject	unregisterMatchingRule(String matchingRuleOid)
org.apache.directory.api.ldap.model.schema.SchemaObject	unregisterMatchingRuleUse(String matchingRuleUseOid)
org.apache.directory.api.ldap.model.schema.SchemaObject	unregisterNameForm(String nameFormOid)
org.apache.directory.api.ldap.model.schema.SchemaObject	unregisterNormalizer(String normalizerOid)
org.apache.directory.api.ldap.model.schema.SchemaObject	unregisterObjectClass(String objectClassOid)
org.apache.directory.api.ldap.model.schema.SchemaObject	unregisterSyntaxChecker(String syntaxCheckerOid)
boolean	verify(org.apache.directory.api.ldap.model.schema.registries.Schema... schemas)
boolean	verify(String... schemas)

Methods inherited from class java.lang.Object

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

Field Detail

LOG

private static final org.slf4j.Logger LOG

static class logger

namingContext

private org.apache.directory.api.ldap.model.name.Dn namingContext

The NamingContext this SchemaManager is associated with

registries

private volatile org.apache.directory.api.ldap.model.schema.registries.Registries registries

The global registries for this namingContext

factory

private final EntityFactory factory

the factory that generates respective SchemaObjects from LDIF entries

schemaDependencies

private Map<String,Set<String>> schemaDependencies

A Map containing all the schema being dependent from a schema

schemaMap

private Map<String,org.apache.directory.api.ldap.model.schema.registries.Schema> schemaMap

A map of all available schema names to schema objects. This map is populated when this class is created with all the schemas present in the LDIF based schema repository.

isRelaxed

private boolean isRelaxed

A flag indicating that the SchemaManager is relaxed or not

errorHandler

private org.apache.directory.api.ldap.model.schema.SchemaErrorHandler errorHandler

Class that handles all the error that may occur during schema processing.

Constructor Detail

DefaultSchemaManager

public DefaultSchemaManager()

Creates a new instance of DefaultSchemaManager with LDIF based SchemaLoader, Strict schema validation

DefaultSchemaManager

public DefaultSchemaManager(Collection<org.apache.directory.api.ldap.model.schema.registries.Schema> schemas)

Creates a new instance of DefaultSchemaManager with the default schema schemaLoader Strict schema validation

Parameters:

schemas - The list of schema to load

DefaultSchemaManager

public DefaultSchemaManager(org.apache.directory.api.ldap.model.schema.registries.SchemaLoader schemaLoader)

Creates a new instance of DefaultSchemaManager with the given schemaLoader Schema validation strictness (i.e. relaxed/strict) controlled by the given schemaLoader

Parameters:

schemaLoader - The schemaLoader containing the schemas to load

DefaultSchemaManager

public DefaultSchemaManager(boolean relaxed,
                            Collection<org.apache.directory.api.ldap.model.schema.registries.Schema> schemas)

Creates a new instance of DefaultSchemaManager with the default schema schemaLoader

Parameters:

relaxed - If the schema manager should be relaxed or not

schemas - The list of schema to load

Method Detail

jarLdifSchemaLoader

private static org.apache.directory.api.ldap.model.schema.registries.SchemaLoader jarLdifSchemaLoader()

cloneRegistries

private org.apache.directory.api.ldap.model.schema.registries.Registries cloneRegistries()
                                                                                  throws org.apache.directory.api.ldap.model.exception.LdapException

Clone the registries before doing any modification on it. Relax it too so that we can update it.

Returns:

The cloned Registries

Throws:

org.apache.directory.api.ldap.model.exception.LdapException - If the Registries cannot be cloned

toArray

private org.apache.directory.api.ldap.model.schema.registries.Schema[] toArray(String... schemas)
                                                                        throws org.apache.directory.api.ldap.model.exception.LdapException

Transform a String[] array of schema to a Schema[]

Parameters:

schemas - The Schema names to process

Returns:

an array of Schema instance

Throws:

org.apache.directory.api.ldap.model.exception.LdapException - If one of the Schema cannot be found

addSchemaObjects

protected void addSchemaObjects(org.apache.directory.api.ldap.model.schema.registries.Schema schema,
                                org.apache.directory.api.ldap.model.schema.registries.Registries registries)
                         throws org.apache.directory.api.ldap.model.exception.LdapException

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

deleteSchemaObjects

private void deleteSchemaObjects(org.apache.directory.api.ldap.model.schema.registries.Schema schema,
                                 org.apache.directory.api.ldap.model.schema.registries.Registries registries)
                          throws org.apache.directory.api.ldap.model.exception.LdapException

Delete all the schemaObjects for a given schema from the registries

Parameters:

schema - The schema from which we want teh SchemaObjects to be deleted

registries - The Registries to process

Throws:

org.apache.directory.api.ldap.model.exception.LdapException - If the SchemaObjects cannot be deleted

disable

public boolean disable(org.apache.directory.api.ldap.model.schema.registries.Schema... schemas)
                throws org.apache.directory.api.ldap.model.exception.LdapException

Specified by:

disable in interface org.apache.directory.api.ldap.model.schema.SchemaManager

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

disable

public boolean disable(String... schemaNames)
                throws org.apache.directory.api.ldap.model.exception.LdapException

Specified by:

disable in interface org.apache.directory.api.ldap.model.schema.SchemaManager

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

disabledRelaxed

public boolean disabledRelaxed(org.apache.directory.api.ldap.model.schema.registries.Schema... schemas)

Specified by:

disabledRelaxed in interface org.apache.directory.api.ldap.model.schema.SchemaManager

disabledRelaxed

public boolean disabledRelaxed(String... schemas)

Specified by:

disabledRelaxed in interface org.apache.directory.api.ldap.model.schema.SchemaManager

getDisabled

public List<org.apache.directory.api.ldap.model.schema.registries.Schema> getDisabled()

Specified by:

getDisabled in interface org.apache.directory.api.ldap.model.schema.SchemaManager

enable

public boolean enable(org.apache.directory.api.ldap.model.schema.registries.Schema... schemas)
               throws org.apache.directory.api.ldap.model.exception.LdapException

Specified by:

enable in interface org.apache.directory.api.ldap.model.schema.SchemaManager

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

enable

public boolean enable(String... schemaNames)
               throws org.apache.directory.api.ldap.model.exception.LdapException

Specified by:

enable in interface org.apache.directory.api.ldap.model.schema.SchemaManager

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

enableRelaxed

public boolean enableRelaxed(org.apache.directory.api.ldap.model.schema.registries.Schema... schemas)

Specified by:

enableRelaxed in interface org.apache.directory.api.ldap.model.schema.SchemaManager

enableRelaxed

public boolean enableRelaxed(String... schemas)

Specified by:

enableRelaxed in interface org.apache.directory.api.ldap.model.schema.SchemaManager

getEnabled

public List<org.apache.directory.api.ldap.model.schema.registries.Schema> getEnabled()

Specified by:

getEnabled in interface org.apache.directory.api.ldap.model.schema.SchemaManager

getAllSchemas

public List<org.apache.directory.api.ldap.model.schema.registries.Schema> getAllSchemas()

Specified by:

getAllSchemas in interface org.apache.directory.api.ldap.model.schema.SchemaManager

getErrors

public List<Throwable> getErrors()

Specified by:

getErrors in interface org.apache.directory.api.ldap.model.schema.SchemaManager

getRegistries

public org.apache.directory.api.ldap.model.schema.registries.Registries getRegistries()

Specified by:

getRegistries in interface org.apache.directory.api.ldap.model.schema.SchemaManager

isDisabledAccepted

public boolean isDisabledAccepted()

Currently not implemented.

Returns:

Always FALSE

load

public boolean load(org.apache.directory.api.ldap.model.schema.registries.Schema... schemas)
             throws org.apache.directory.api.ldap.model.exception.LdapException

Specified by:

load in interface org.apache.directory.api.ldap.model.schema.SchemaManager

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

load

public boolean load(String... schemaNames)
             throws org.apache.directory.api.ldap.model.exception.LdapException

Specified by:

load in interface org.apache.directory.api.ldap.model.schema.SchemaManager

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

load

private boolean load(org.apache.directory.api.ldap.model.schema.registries.Registries registries,
                     org.apache.directory.api.ldap.model.schema.registries.Schema schema)
              throws org.apache.directory.api.ldap.model.exception.LdapException

Load the schema in the registries. We will load everything accordingly to the two flags : - isRelaxed - disabledAccepted

Parameters:

registries - The Registries to process

schema - The schema to load in the Registries

Returns:

true if the schema has been loaded

Throws:

org.apache.directory.api.ldap.model.exception.LdapException - If the schema cannot be loaded

unload

private boolean unload(org.apache.directory.api.ldap.model.schema.registries.Registries registries,
                       org.apache.directory.api.ldap.model.schema.registries.Schema schema)
                throws org.apache.directory.api.ldap.model.exception.LdapException

Unload the schema from the registries. We will unload everything accordingly to the two flags : - isRelaxed - disabledAccepted

Parameters:

registries - The Registries to process

schema - The schema to unload from the Registries

Returns:

true if the schema has been unloaded

Throws:

org.apache.directory.api.ldap.model.exception.LdapException - If the schema cannot be unloaded

addAttributeTypes

private void addAttributeTypes(org.apache.directory.api.ldap.model.schema.registries.Schema schema,
                               org.apache.directory.api.ldap.model.schema.registries.Registries registries)
                        throws org.apache.directory.api.ldap.model.exception.LdapException,
                               IOException

Add all the Schema's AttributeTypes

Parameters:

schema - The schema in which the AttributeTypes will be added

registries - The Registries to process

Throws:

org.apache.directory.api.ldap.model.exception.LdapException - If the AttributeTypes cannot be added

IOException - If the AttributeTypes cannot be loaded

addComparators

private void addComparators(org.apache.directory.api.ldap.model.schema.registries.Schema schema,
                            org.apache.directory.api.ldap.model.schema.registries.Registries registries)
                     throws org.apache.directory.api.ldap.model.exception.LdapException,
                            IOException

Add all the Schema's comparators

Parameters:

schema - The schema in which the Comparators will be added

registries - The Registries to process

Throws:

org.apache.directory.api.ldap.model.exception.LdapException - If the Comparators cannot be added

IOException - If the Comparators cannot be loaded

addMatchingRules

private void addMatchingRules(org.apache.directory.api.ldap.model.schema.registries.Schema schema,
                              org.apache.directory.api.ldap.model.schema.registries.Registries registries)
                       throws org.apache.directory.api.ldap.model.exception.LdapException,
                              IOException

Add all the Schema's MatchingRules

Parameters:

schema - The schema in which the MatchingRules will be added

registries - The Registries to process

Throws:

org.apache.directory.api.ldap.model.exception.LdapException - If the MatchingRules cannot be added

IOException - If the MatchingRules cannot be loaded

addNormalizers

private void addNormalizers(org.apache.directory.api.ldap.model.schema.registries.Schema schema,
                            org.apache.directory.api.ldap.model.schema.registries.Registries registries)
                     throws org.apache.directory.api.ldap.model.exception.LdapException,
                            IOException

Add all the Schema's Normalizers

Parameters:

schema - The schema in which the Normalizers will be added

registries - The Registries to process

Throws:

org.apache.directory.api.ldap.model.exception.LdapException - If the Normalizers cannot be added

IOException - If the Normalizers cannot be loaded

addObjectClasses

private void addObjectClasses(org.apache.directory.api.ldap.model.schema.registries.Schema schema,
                              org.apache.directory.api.ldap.model.schema.registries.Registries registries)
                       throws org.apache.directory.api.ldap.model.exception.LdapException,
                              IOException

Add all the Schema's ObjectClasses

Parameters:

schema - The schema in which the ObjectClasses will be added

registries - The Registries to process

Throws:

org.apache.directory.api.ldap.model.exception.LdapException - If the ObjectClasses cannot be added

IOException - If the ObjectClasses cannot be loaded

addSyntaxes

private void addSyntaxes(org.apache.directory.api.ldap.model.schema.registries.Schema schema,
                         org.apache.directory.api.ldap.model.schema.registries.Registries registries)
                  throws org.apache.directory.api.ldap.model.exception.LdapException,
                         IOException

Add all the Schema's Syntaxes

Parameters:

schema - The schema in which the Syntaxes will be added

registries - The Registries to process

Throws:

org.apache.directory.api.ldap.model.exception.LdapException - If the Syntaxes cannot be added

IOException - If the Syntaxes cannot be loaded

addSyntaxCheckers

private void addSyntaxCheckers(org.apache.directory.api.ldap.model.schema.registries.Schema schema,
                               org.apache.directory.api.ldap.model.schema.registries.Registries registries)
                        throws org.apache.directory.api.ldap.model.exception.LdapException,
                               IOException

Register all the Schema's SyntaxCheckers

Parameters:

schema - The schema in which the SyntaxChecker will be added

registries - The Registries to process

Throws:

org.apache.directory.api.ldap.model.exception.LdapException - If the SyntaxChecker cannot be added

IOException - If the SyntaxChecker cannot be loaded

addSchemaObject

protected org.apache.directory.api.ldap.model.schema.SchemaObject addSchemaObject(org.apache.directory.api.ldap.model.schema.registries.Registries registries,
                                                                                  org.apache.directory.api.ldap.model.schema.SchemaObject schemaObject,
                                                                                  org.apache.directory.api.ldap.model.schema.registries.Schema schema)
                                                                           throws org.apache.directory.api.ldap.model.exception.LdapException

Add the schemaObject into the registries.

Parameters:

registries - The Registries

schemaObject - The SchemaObject containing the SchemaObject description

schema - The associated schema

Returns:

the created schemaObject instance

Throws:

org.apache.directory.api.ldap.model.exception.LdapException - If the registering failed

loadAllEnabled

public boolean loadAllEnabled()
                       throws org.apache.directory.api.ldap.model.exception.LdapException

Specified by:

loadAllEnabled in interface org.apache.directory.api.ldap.model.schema.SchemaManager

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

loadAllEnabledRelaxed

public boolean loadAllEnabledRelaxed()
                              throws org.apache.directory.api.ldap.model.exception.LdapException

Specified by:

loadAllEnabledRelaxed in interface org.apache.directory.api.ldap.model.schema.SchemaManager

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

loadDisabled

public boolean loadDisabled(org.apache.directory.api.ldap.model.schema.registries.Schema... schemas)
                     throws org.apache.directory.api.ldap.model.exception.LdapException

Specified by:

loadDisabled in interface org.apache.directory.api.ldap.model.schema.SchemaManager

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

loadDisabled

public boolean loadDisabled(String... schemaNames)
                     throws org.apache.directory.api.ldap.model.exception.LdapException

Specified by:

loadDisabled in interface org.apache.directory.api.ldap.model.schema.SchemaManager

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

loadRelaxed

public boolean loadRelaxed(org.apache.directory.api.ldap.model.schema.registries.Schema... schemas)
                    throws org.apache.directory.api.ldap.model.exception.LdapException

Specified by:

loadRelaxed in interface org.apache.directory.api.ldap.model.schema.SchemaManager

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

loadRelaxed

public boolean loadRelaxed(String... schemaNames)
                    throws org.apache.directory.api.ldap.model.exception.LdapException

Specified by:

loadRelaxed in interface org.apache.directory.api.ldap.model.schema.SchemaManager

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

loadWithDeps

public boolean loadWithDeps(org.apache.directory.api.ldap.model.schema.registries.Schema... schemas)
                     throws org.apache.directory.api.ldap.model.exception.LdapException

Specified by:

loadWithDeps in interface org.apache.directory.api.ldap.model.schema.SchemaManager

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

loadWithDeps

public boolean loadWithDeps(String... schemas)
                     throws org.apache.directory.api.ldap.model.exception.LdapException

Specified by:

loadWithDeps in interface org.apache.directory.api.ldap.model.schema.SchemaManager

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

loadDepsFirst

private void loadDepsFirst(org.apache.directory.api.ldap.model.schema.registries.Registries registries,
                           org.apache.directory.api.ldap.model.schema.registries.Schema schema)
                    throws org.apache.directory.api.ldap.model.exception.LdapException

Recursive method which loads schema's with their dependent schemas first and tracks what schemas it has seen so the recursion does not go out of control with dependency cycle detection.

Parameters:

registries - The Registries in which the schemas will be loaded

schema - the current schema we are attempting to load

Throws:

org.apache.directory.api.ldap.model.exception.LdapException - if there is a cycle detected and/or another failure results while loading, producing and or registering schema objects

loadWithDepsRelaxed

public boolean loadWithDepsRelaxed(org.apache.directory.api.ldap.model.schema.registries.Schema... schemas)
                            throws org.apache.directory.api.ldap.model.exception.LdapException

Specified by:

loadWithDepsRelaxed in interface org.apache.directory.api.ldap.model.schema.SchemaManager

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

loadWithDepsRelaxed

public boolean loadWithDepsRelaxed(String... schemas)
                            throws org.apache.directory.api.ldap.model.exception.LdapException

Specified by:

loadWithDepsRelaxed in interface org.apache.directory.api.ldap.model.schema.SchemaManager

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

loadDepsFirstRelaxed

private void loadDepsFirstRelaxed(org.apache.directory.api.ldap.model.schema.registries.Schema schema)
                           throws org.apache.directory.api.ldap.model.exception.LdapException

Recursive method which loads schema's with their dependent schemas first and tracks what schemas it has seen so the recursion does not go out of control with dependency cycle detection.

Parameters:

schema - the current schema we are attempting to load

Throws:

org.apache.directory.api.ldap.model.exception.LdapException - if there is a cycle detected and/or another failure results while loading, producing and or registering schema objects

setRegistries

public void setRegistries(org.apache.directory.api.ldap.model.schema.registries.Registries registries)

Specified by:

setRegistries in interface org.apache.directory.api.ldap.model.schema.SchemaManager

unload

public boolean unload(org.apache.directory.api.ldap.model.schema.registries.Schema... schemas)
               throws org.apache.directory.api.ldap.model.exception.LdapException

Specified by:

unload in interface org.apache.directory.api.ldap.model.schema.SchemaManager

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

unload

public boolean unload(String... schemaNames)
               throws org.apache.directory.api.ldap.model.exception.LdapException

Specified by:

unload in interface org.apache.directory.api.ldap.model.schema.SchemaManager

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

verify

public boolean verify(org.apache.directory.api.ldap.model.schema.registries.Schema... schemas)
               throws org.apache.directory.api.ldap.model.exception.LdapException

Specified by:

verify in interface org.apache.directory.api.ldap.model.schema.SchemaManager

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

verify

public boolean verify(String... schemas)
               throws org.apache.directory.api.ldap.model.exception.LdapException

Specified by:

verify in interface org.apache.directory.api.ldap.model.schema.SchemaManager

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

getNamingContext

public org.apache.directory.api.ldap.model.name.Dn getNamingContext()

Specified by:

getNamingContext in interface org.apache.directory.api.ldap.model.schema.SchemaManager

Returns:

the namingContext

initialize

public void initialize()
                throws org.apache.directory.api.ldap.model.exception.LdapException

Initializes the SchemaService

Specified by:

initialize in interface org.apache.directory.api.ldap.model.schema.SchemaManager

Throws:

org.apache.directory.api.ldap.model.exception.LdapException - If the initialization fails

getAttributeTypeRegistry

public org.apache.directory.api.ldap.model.schema.registries.AttributeTypeRegistry getAttributeTypeRegistry()

Specified by:

getAttributeTypeRegistry in interface org.apache.directory.api.ldap.model.schema.SchemaManager

getComparatorRegistry

public org.apache.directory.api.ldap.model.schema.registries.ComparatorRegistry getComparatorRegistry()

Specified by:

getComparatorRegistry in interface org.apache.directory.api.ldap.model.schema.SchemaManager

getDITContentRuleRegistry

public org.apache.directory.api.ldap.model.schema.registries.DitContentRuleRegistry getDITContentRuleRegistry()

Specified by:

getDITContentRuleRegistry in interface org.apache.directory.api.ldap.model.schema.SchemaManager

getDITStructureRuleRegistry

public org.apache.directory.api.ldap.model.schema.registries.DitStructureRuleRegistry getDITStructureRuleRegistry()

Specified by:

getDITStructureRuleRegistry in interface org.apache.directory.api.ldap.model.schema.SchemaManager

getMatchingRuleRegistry

public org.apache.directory.api.ldap.model.schema.registries.MatchingRuleRegistry getMatchingRuleRegistry()

Specified by:

getMatchingRuleRegistry in interface org.apache.directory.api.ldap.model.schema.SchemaManager

getMatchingRuleUseRegistry

public org.apache.directory.api.ldap.model.schema.registries.MatchingRuleUseRegistry getMatchingRuleUseRegistry()

Specified by:

getMatchingRuleUseRegistry in interface org.apache.directory.api.ldap.model.schema.SchemaManager

getNameFormRegistry

public org.apache.directory.api.ldap.model.schema.registries.NameFormRegistry getNameFormRegistry()

Specified by:

getNameFormRegistry in interface org.apache.directory.api.ldap.model.schema.SchemaManager

getNormalizerRegistry

public org.apache.directory.api.ldap.model.schema.registries.NormalizerRegistry getNormalizerRegistry()

Specified by:

getNormalizerRegistry in interface org.apache.directory.api.ldap.model.schema.SchemaManager

getObjectClassRegistry

public org.apache.directory.api.ldap.model.schema.registries.ObjectClassRegistry getObjectClassRegistry()

Specified by:

getObjectClassRegistry in interface org.apache.directory.api.ldap.model.schema.SchemaManager

getLdapSyntaxRegistry

public org.apache.directory.api.ldap.model.schema.registries.LdapSyntaxRegistry getLdapSyntaxRegistry()

Specified by:

getLdapSyntaxRegistry in interface org.apache.directory.api.ldap.model.schema.SchemaManager

getSyntaxCheckerRegistry

public org.apache.directory.api.ldap.model.schema.registries.SyntaxCheckerRegistry getSyntaxCheckerRegistry()

Specified by:

getSyntaxCheckerRegistry in interface org.apache.directory.api.ldap.model.schema.SchemaManager

stripOptions

private String stripOptions(String oid)

Get rid of AT's options (everything after the ';'

Parameters:

oid - The AT's OID

Returns:

The AT without its options

lookupAttributeTypeRegistry

public org.apache.directory.api.ldap.model.schema.AttributeType lookupAttributeTypeRegistry(String oid)
                                                                                     throws org.apache.directory.api.ldap.model.exception.LdapException

Specified by:

lookupAttributeTypeRegistry in interface org.apache.directory.api.ldap.model.schema.SchemaManager

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

getAttributeType

public org.apache.directory.api.ldap.model.schema.AttributeType getAttributeType(String oid)

Specified by:

getAttributeType in interface org.apache.directory.api.ldap.model.schema.SchemaManager

lookupComparatorRegistry

public org.apache.directory.api.ldap.model.schema.LdapComparator<?> lookupComparatorRegistry(String oid)
                                                                                      throws org.apache.directory.api.ldap.model.exception.LdapException

Specified by:

lookupComparatorRegistry in interface org.apache.directory.api.ldap.model.schema.SchemaManager

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

lookupMatchingRuleRegistry

public org.apache.directory.api.ldap.model.schema.MatchingRule lookupMatchingRuleRegistry(String oid)
                                                                                   throws org.apache.directory.api.ldap.model.exception.LdapException

Specified by:

lookupMatchingRuleRegistry in interface org.apache.directory.api.ldap.model.schema.SchemaManager

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

lookupNormalizerRegistry

public org.apache.directory.api.ldap.model.schema.Normalizer lookupNormalizerRegistry(String oid)
                                                                               throws org.apache.directory.api.ldap.model.exception.LdapException

Specified by:

lookupNormalizerRegistry in interface org.apache.directory.api.ldap.model.schema.SchemaManager

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

lookupObjectClassRegistry

public org.apache.directory.api.ldap.model.schema.ObjectClass lookupObjectClassRegistry(String oid)
                                                                                 throws org.apache.directory.api.ldap.model.exception.LdapException

Specified by:

lookupObjectClassRegistry in interface org.apache.directory.api.ldap.model.schema.SchemaManager

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

lookupLdapSyntaxRegistry

public org.apache.directory.api.ldap.model.schema.LdapSyntax lookupLdapSyntaxRegistry(String oid)
                                                                               throws org.apache.directory.api.ldap.model.exception.LdapException

Specified by:

lookupLdapSyntaxRegistry in interface org.apache.directory.api.ldap.model.schema.SchemaManager

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

lookupSyntaxCheckerRegistry

public org.apache.directory.api.ldap.model.schema.SyntaxChecker lookupSyntaxCheckerRegistry(String oid)
                                                                                     throws org.apache.directory.api.ldap.model.exception.LdapException

Specified by:

lookupSyntaxCheckerRegistry in interface org.apache.directory.api.ldap.model.schema.SchemaManager

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

checkOidExist

private boolean checkOidExist(org.apache.directory.api.ldap.model.schema.SchemaObject schemaObject)

Check that the given OID exists in the globalOidRegistry.

Parameters:

schemaObject - The SchemaObject to check

Returns:

true if the OID exists

getSchemaObject

private org.apache.directory.api.ldap.model.schema.SchemaObject getSchemaObject(org.apache.directory.api.ldap.model.schema.SchemaObject schemaObject)
                                                                         throws org.apache.directory.api.ldap.model.exception.LdapException

Get the inner SchemaObject if it's not a C/N/SC

Parameters:

schemaObject - The SchemaObject to retreive

Returns:

The found SchemaObject

Throws:

org.apache.directory.api.ldap.model.exception.LdapException - If the SchemaObject can't be found

getSchemaName

private String getSchemaName(org.apache.directory.api.ldap.model.schema.SchemaObject schemaObject)

Retrieve the schema name for a specific SchemaObject, or return "other" if none is found.

Parameters:

schemaObject - The schemaObject to read

Returns:

The schema name

copy

private org.apache.directory.api.ldap.model.schema.SchemaObject copy(org.apache.directory.api.ldap.model.schema.SchemaObject schemaObject)

add

public boolean add(org.apache.directory.api.ldap.model.schema.SchemaObject schemaObject)
            throws org.apache.directory.api.ldap.model.exception.LdapException

Specified by:

add in interface org.apache.directory.api.ldap.model.schema.SchemaManager

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

delete

public boolean delete(org.apache.directory.api.ldap.model.schema.SchemaObject schemaObject)
               throws org.apache.directory.api.ldap.model.exception.LdapException

Specified by:

delete in interface org.apache.directory.api.ldap.model.schema.SchemaManager

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

getNormalizerMapping

public Map<String,org.apache.directory.api.ldap.model.schema.normalizers.OidNormalizer> getNormalizerMapping()

Specified by:

getNormalizerMapping in interface org.apache.directory.api.ldap.model.schema.SchemaManager

getGlobalOidRegistry

public org.apache.directory.api.ldap.model.schema.registries.OidRegistry getGlobalOidRegistry()

Specified by:

getGlobalOidRegistry in interface org.apache.directory.api.ldap.model.schema.SchemaManager

getLoadedSchema

public org.apache.directory.api.ldap.model.schema.registries.Schema getLoadedSchema(String schemaName)

Specified by:

getLoadedSchema in interface org.apache.directory.api.ldap.model.schema.SchemaManager

isSchemaLoaded

public boolean isSchemaLoaded(String schemaName)

Specified by:

isSchemaLoaded in interface org.apache.directory.api.ldap.model.schema.SchemaManager

unregisterAttributeType

public org.apache.directory.api.ldap.model.schema.SchemaObject unregisterAttributeType(String attributeTypeOid)
                                                                                throws org.apache.directory.api.ldap.model.exception.LdapException

Specified by:

unregisterAttributeType in interface org.apache.directory.api.ldap.model.schema.SchemaManager

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

unregisterComparator

public org.apache.directory.api.ldap.model.schema.SchemaObject unregisterComparator(String comparatorOid)
                                                                             throws org.apache.directory.api.ldap.model.exception.LdapException

Specified by:

unregisterComparator in interface org.apache.directory.api.ldap.model.schema.SchemaManager

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

unregisterDitControlRule

public org.apache.directory.api.ldap.model.schema.SchemaObject unregisterDitControlRule(String ditControlRuleOid)
                                                                                 throws org.apache.directory.api.ldap.model.exception.LdapException

Specified by:

unregisterDitControlRule in interface org.apache.directory.api.ldap.model.schema.SchemaManager

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

unregisterDitStructureRule

public org.apache.directory.api.ldap.model.schema.SchemaObject unregisterDitStructureRule(String ditStructureRuleOid)
                                                                                   throws org.apache.directory.api.ldap.model.exception.LdapException

Specified by:

unregisterDitStructureRule in interface org.apache.directory.api.ldap.model.schema.SchemaManager

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

unregisterLdapSyntax

public org.apache.directory.api.ldap.model.schema.SchemaObject unregisterLdapSyntax(String ldapSyntaxOid)
                                                                             throws org.apache.directory.api.ldap.model.exception.LdapException

Specified by:

unregisterLdapSyntax in interface org.apache.directory.api.ldap.model.schema.SchemaManager

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

unregisterMatchingRule

public org.apache.directory.api.ldap.model.schema.SchemaObject unregisterMatchingRule(String matchingRuleOid)
                                                                               throws org.apache.directory.api.ldap.model.exception.LdapException

Specified by:

unregisterMatchingRule in interface org.apache.directory.api.ldap.model.schema.SchemaManager

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

unregisterMatchingRuleUse

public org.apache.directory.api.ldap.model.schema.SchemaObject unregisterMatchingRuleUse(String matchingRuleUseOid)
                                                                                  throws org.apache.directory.api.ldap.model.exception.LdapException

Specified by:

unregisterMatchingRuleUse in interface org.apache.directory.api.ldap.model.schema.SchemaManager

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

unregisterNameForm

public org.apache.directory.api.ldap.model.schema.SchemaObject unregisterNameForm(String nameFormOid)
                                                                           throws org.apache.directory.api.ldap.model.exception.LdapException

Specified by:

unregisterNameForm in interface org.apache.directory.api.ldap.model.schema.SchemaManager

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

unregisterNormalizer

public org.apache.directory.api.ldap.model.schema.SchemaObject unregisterNormalizer(String normalizerOid)
                                                                             throws org.apache.directory.api.ldap.model.exception.LdapException

Specified by:

unregisterNormalizer in interface org.apache.directory.api.ldap.model.schema.SchemaManager

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

unregisterObjectClass

public org.apache.directory.api.ldap.model.schema.SchemaObject unregisterObjectClass(String objectClassOid)
                                                                              throws org.apache.directory.api.ldap.model.exception.LdapException

Specified by:

unregisterObjectClass in interface org.apache.directory.api.ldap.model.schema.SchemaManager

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

unregisterSyntaxChecker

public org.apache.directory.api.ldap.model.schema.SchemaObject unregisterSyntaxChecker(String syntaxCheckerOid)
                                                                                throws org.apache.directory.api.ldap.model.exception.LdapException

Specified by:

unregisterSyntaxChecker in interface org.apache.directory.api.ldap.model.schema.SchemaManager

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

isRelaxed

public boolean isRelaxed()

Tells if the SchemaManager is permissive or if it must be checked against inconsistencies.

Specified by:

isRelaxed in interface org.apache.directory.api.ldap.model.schema.SchemaManager

Returns:

True if SchemaObjects can be added even if they break the consistency

isStrict

public boolean isStrict()

Tells if the SchemaManager is strict.

Specified by:

isStrict in interface org.apache.directory.api.ldap.model.schema.SchemaManager

Returns:

True if SchemaObjects cannot be added if they break the consistency

listDependentSchemaNames

public Set<String> listDependentSchemaNames(String schemaName)

Specified by:

listDependentSchemaNames in interface org.apache.directory.api.ldap.model.schema.SchemaManager

setRelaxed

public void setRelaxed()

Change the SchemaManager to a relaxed mode, where invalid SchemaObjects can be registered.

Specified by:

setRelaxed in interface org.apache.directory.api.ldap.model.schema.SchemaManager

setStrict

public void setStrict()

Change the SchemaManager to a strict mode, where invalid SchemaObjects cannot be registered.

Specified by:

setStrict in interface org.apache.directory.api.ldap.model.schema.SchemaManager

getErrorHandler

public org.apache.directory.api.ldap.model.schema.SchemaErrorHandler getErrorHandler()

setErrorHandler

public void setErrorHandler(org.apache.directory.api.ldap.model.schema.SchemaErrorHandler errorHandler)

isDisabled

public boolean isDisabled(String schemaName)

Specified by:

isDisabled in interface org.apache.directory.api.ldap.model.schema.SchemaManager

isDisabled

public boolean isDisabled(org.apache.directory.api.ldap.model.schema.registries.Schema schema)

Specified by:

isDisabled in interface org.apache.directory.api.ldap.model.schema.SchemaManager

isEnabled

public boolean isEnabled(String schemaName)

Specified by:

isEnabled in interface org.apache.directory.api.ldap.model.schema.SchemaManager

isEnabled

public boolean isEnabled(org.apache.directory.api.ldap.model.schema.registries.Schema schema)

Specified by:

isEnabled in interface org.apache.directory.api.ldap.model.schema.SchemaManager