org.apache.directory.shared.ldap.schema.manager.impl
Class DefaultSchemaManager

java.lang.Object
  org.apache.directory.shared.ldap.schema.manager.impl.DefaultSchemaManager

All Implemented Interfaces:

SchemaManager

public class DefaultSchemaManager
extends java.lang.Object
implements SchemaManager

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

Version:

$Rev$, $Date$

Author:

Apache Directory Project

Field Summary

protected EntityFactory	factory the factory that generates respective SchemaObjects from LDIF entries
static boolean	RELAXED
static boolean	STRICT Two flags for RELAXED and STRUCT

Constructor Summary

DefaultSchemaManager(SchemaLoader loader)
Creates a new instance of DefaultSchemaManager with the default schema schemaLoader

DefaultSchemaManager(SchemaLoader loader, DN namingContext)
Creates a new instance of DefaultSchemaManager, for a specific naming context

Method Summary

boolean	add(SchemaObject schemaObject)
boolean	delete(SchemaObject schemaObject)
boolean	disable(Schema... schemas)
boolean	disable(java.lang.String... schemaNames)
boolean	disabledRelaxed(Schema... schemas)
boolean	disabledRelaxed(java.lang.String... schemas)
boolean	enable(Schema... schemas)
boolean	enable(java.lang.String... schemaNames)
boolean	enableRelaxed(Schema... schemas)
boolean	enableRelaxed(java.lang.String... schemas)
AttributeTypeRegistry	getAttributeTypeRegistry()
ComparatorRegistry	getComparatorRegistry()
java.util.List<Schema>	getDisabled()
DITContentRuleRegistry	getDITContentRuleRegistry()
DITStructureRuleRegistry	getDITStructureRuleRegistry()
java.util.List<Schema>	getEnabled()
java.util.List<java.lang.Throwable>	getErrors()
OidRegistry	getGlobalOidRegistry()
LdapSyntaxRegistry	getLdapSyntaxRegistry()
Schema	getLoadedSchema(java.lang.String schemaName)
SchemaLoader	getLoader()
MatchingRuleRegistry	getMatchingRuleRegistry()
MatchingRuleUseRegistry	getMatchingRuleUseRegistry()
NameFormRegistry	getNameFormRegistry()
DN	getNamingContext()
java.util.Map<java.lang.String,OidNormalizer>	getNormalizerMapping()
NormalizerRegistry	getNormalizerRegistry()
ObjectClassRegistry	getObjectClassRegistry()
Registries	getRegistries()
SyntaxCheckerRegistry	getSyntaxCheckerRegistry()
void	initialize() Initializes the SchemaService
boolean	isDisabled(Schema schema)
boolean	isDisabled(java.lang.String schemaName)
boolean	isDisabledAccepted()
boolean	isEnabled(Schema schema)
boolean	isEnabled(java.lang.String schemaName)
boolean	isRelaxed() Tells if the SchemaManager is permissive or if it must be checked against inconsistencies.
boolean	isSchemaLoaded(java.lang.String schemaName)
boolean	isStrict() Tells if the SchemaManager is strict.
java.util.Set<java.lang.String>	listDependentSchemaNames(java.lang.String schemaName)
boolean	load(Schema... schemas)
boolean	load(java.lang.String... schemaNames)
boolean	loadAllEnabled()
boolean	loadAllEnabledRelaxed()
boolean	loadDisabled(Schema... schemas)
boolean	loadDisabled(java.lang.String... schemaNames)
boolean	loadRelaxed(Schema... schemas)
boolean	loadRelaxed(java.lang.String... schemaNames)
boolean	loadWithDeps(Schema... schemas)
boolean	loadWithDeps(java.lang.String... schemas)
boolean	loadWithDepsRelaxed(Schema... schemas)
boolean	loadWithDepsRelaxed(java.lang.String... schemas)
AttributeType	lookupAttributeTypeRegistry(java.lang.String oid)
LdapComparator<?>	lookupComparatorRegistry(java.lang.String oid)
LdapSyntax	lookupLdapSyntaxRegistry(java.lang.String oid)
MatchingRule	lookupMatchingRuleRegistry(java.lang.String oid)
Normalizer	lookupNormalizerRegistry(java.lang.String oid)
ObjectClass	lookupObjectClassRegistry(java.lang.String oid)
SyntaxChecker	lookupSyntaxCheckerRegistry(java.lang.String oid)
void	setRegistries(Registries registries)
void	setRelaxed() Change the SchemaManager to a relaxed mode, where invalid SchemaObjects can be registered.
void	setSchemaLoader(SchemaLoader schemaLoader)
void	setStrict() Change the SchemaManager to a strict mode, where invalid SchemaObjects cannot be registered.
boolean	unload(Schema... schemas)
boolean	unload(java.lang.String... schemaNames)
SchemaObject	unregisterAttributeType(java.lang.String attributeTypeOid)
SchemaObject	unregisterComparator(java.lang.String comparatorOid)
SchemaObject	unregisterDitControlRule(java.lang.String ditControlRuleOid)
SchemaObject	unregisterDitStructureRule(java.lang.String ditStructureRuleOid)
SchemaObject	unregisterLdapSyntax(java.lang.String ldapSyntaxOid)
SchemaObject	unregisterMatchingRule(java.lang.String matchingRuleOid)
SchemaObject	unregisterMatchingRuleUse(java.lang.String matchingRuleUseOid)
SchemaObject	unregisterNameForm(java.lang.String nameFormOid)
SchemaObject	unregisterNormalizer(java.lang.String normalizerOid)
SchemaObject	unregisterObjectClass(java.lang.String objectClassOid)
SchemaObject	unregisterSyntaxChecker(java.lang.String syntaxCheckerOid)
boolean	verify(Schema... schemas)
boolean	verify(java.lang.String... schemas)

Methods inherited from class java.lang.Object

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

Field Detail

factory

protected final EntityFactory factory

the factory that generates respective SchemaObjects from LDIF entries

STRICT

public static final boolean STRICT

Two flags for RELAXED and STRUCT

See Also:

Constant Field Values

RELAXED

public static final boolean RELAXED

See Also:

Constant Field Values

Constructor Detail

DefaultSchemaManager

public DefaultSchemaManager(SchemaLoader loader)
                     throws java.lang.Exception

Creates a new instance of DefaultSchemaManager with the default schema schemaLoader

Parameters:

loader - The schema loader to use

Throws:

java.lang.Exception

DefaultSchemaManager

public DefaultSchemaManager(SchemaLoader loader,
                            DN namingContext)
                     throws java.lang.Exception

Creates a new instance of DefaultSchemaManager, for a specific naming context

Parameters:

loader - The schema loader to use

namingContext - The associated NamingContext

Throws:

java.lang.Exception

Method Detail

disable

public boolean disable(Schema... schemas)
                throws java.lang.Exception

Specified by:

disable in interface SchemaManager

Throws:

java.lang.Exception

disable

public boolean disable(java.lang.String... schemaNames)
                throws java.lang.Exception

Specified by:

disable in interface SchemaManager

Throws:

java.lang.Exception

disabledRelaxed

public boolean disabledRelaxed(Schema... schemas)

Specified by:

disabledRelaxed in interface SchemaManager

disabledRelaxed

public boolean disabledRelaxed(java.lang.String... schemas)

Specified by:

disabledRelaxed in interface SchemaManager

getDisabled

public java.util.List<Schema> getDisabled()

Specified by:

getDisabled in interface SchemaManager

enable

public boolean enable(Schema... schemas)
               throws java.lang.Exception

Specified by:

enable in interface SchemaManager

Throws:

java.lang.Exception

enable

public boolean enable(java.lang.String... schemaNames)
               throws java.lang.Exception

Specified by:

enable in interface SchemaManager

Throws:

java.lang.Exception

enableRelaxed

public boolean enableRelaxed(Schema... schemas)

Specified by:

enableRelaxed in interface SchemaManager

enableRelaxed

public boolean enableRelaxed(java.lang.String... schemas)

Specified by:

enableRelaxed in interface SchemaManager

getEnabled

public java.util.List<Schema> getEnabled()

Specified by:

getEnabled in interface SchemaManager

getErrors

public java.util.List<java.lang.Throwable> getErrors()

Specified by:

getErrors in interface SchemaManager

getRegistries

public Registries getRegistries()

Specified by:

getRegistries in interface SchemaManager

isDisabledAccepted

public boolean isDisabledAccepted()

load

public boolean load(Schema... schemas)
             throws java.lang.Exception

Specified by:

load in interface SchemaManager

Throws:

java.lang.Exception

load

public boolean load(java.lang.String... schemaNames)
             throws java.lang.Exception

Specified by:

load in interface SchemaManager

Throws:

java.lang.Exception

loadAllEnabled

public boolean loadAllEnabled()
                       throws java.lang.Exception

Specified by:

loadAllEnabled in interface SchemaManager

Throws:

java.lang.Exception

loadAllEnabledRelaxed

public boolean loadAllEnabledRelaxed()
                              throws java.lang.Exception

Specified by:

loadAllEnabledRelaxed in interface SchemaManager

Throws:

java.lang.Exception

loadDisabled

public boolean loadDisabled(Schema... schemas)
                     throws java.lang.Exception

Specified by:

loadDisabled in interface SchemaManager

Throws:

java.lang.Exception

loadDisabled

public boolean loadDisabled(java.lang.String... schemaNames)
                     throws java.lang.Exception

Specified by:

loadDisabled in interface SchemaManager

Throws:

java.lang.Exception

loadRelaxed

public boolean loadRelaxed(Schema... schemas)
                    throws java.lang.Exception

Specified by:

loadRelaxed in interface SchemaManager

Throws:

java.lang.Exception

loadRelaxed

public boolean loadRelaxed(java.lang.String... schemaNames)
                    throws java.lang.Exception

Specified by:

loadRelaxed in interface SchemaManager

Throws:

java.lang.Exception

loadWithDeps

public boolean loadWithDeps(Schema... schemas)
                     throws java.lang.Exception

Specified by:

loadWithDeps in interface SchemaManager

Throws:

java.lang.Exception

loadWithDeps

public boolean loadWithDeps(java.lang.String... schemas)
                     throws java.lang.Exception

Specified by:

loadWithDeps in interface SchemaManager

Throws:

java.lang.Exception

loadWithDepsRelaxed

public boolean loadWithDepsRelaxed(Schema... schemas)
                            throws java.lang.Exception

Specified by:

loadWithDepsRelaxed in interface SchemaManager

Throws:

java.lang.Exception

loadWithDepsRelaxed

public boolean loadWithDepsRelaxed(java.lang.String... schemas)
                            throws java.lang.Exception

Specified by:

loadWithDepsRelaxed in interface SchemaManager

Throws:

java.lang.Exception

setRegistries

public void setRegistries(Registries registries)

Specified by:

setRegistries in interface SchemaManager

unload

public boolean unload(Schema... schemas)
               throws java.lang.Exception

Specified by:

unload in interface SchemaManager

Throws:

java.lang.Exception

unload

public boolean unload(java.lang.String... schemaNames)
               throws java.lang.Exception

Specified by:

unload in interface SchemaManager

Throws:

java.lang.Exception

verify

public boolean verify(Schema... schemas)
               throws java.lang.Exception

Specified by:

verify in interface SchemaManager

Throws:

java.lang.Exception

verify

public boolean verify(java.lang.String... schemas)
               throws java.lang.Exception

Specified by:

verify in interface SchemaManager

Throws:

java.lang.Exception

setSchemaLoader

public void setSchemaLoader(SchemaLoader schemaLoader)

Specified by:

setSchemaLoader in interface SchemaManager

getNamingContext

public DN getNamingContext()

Specified by:

getNamingContext in interface SchemaManager

Returns:

the namingContext

initialize

public void initialize()
                throws java.lang.Exception

Initializes the SchemaService

Specified by:

initialize in interface SchemaManager

Throws:

java.lang.Exception - If the initialization fails

getLoader

public SchemaLoader getLoader()

Specified by:

getLoader in interface SchemaManager

getAttributeTypeRegistry

public AttributeTypeRegistry getAttributeTypeRegistry()

Specified by:

getAttributeTypeRegistry in interface SchemaManager

getComparatorRegistry

public ComparatorRegistry getComparatorRegistry()

Specified by:

getComparatorRegistry in interface SchemaManager

getDITContentRuleRegistry

public DITContentRuleRegistry getDITContentRuleRegistry()

Specified by:

getDITContentRuleRegistry in interface SchemaManager

getDITStructureRuleRegistry

public DITStructureRuleRegistry getDITStructureRuleRegistry()

Specified by:

getDITStructureRuleRegistry in interface SchemaManager

getMatchingRuleRegistry

public MatchingRuleRegistry getMatchingRuleRegistry()

Specified by:

getMatchingRuleRegistry in interface SchemaManager

getMatchingRuleUseRegistry

public MatchingRuleUseRegistry getMatchingRuleUseRegistry()

Specified by:

getMatchingRuleUseRegistry in interface SchemaManager

getNameFormRegistry

public NameFormRegistry getNameFormRegistry()

Specified by:

getNameFormRegistry in interface SchemaManager

getNormalizerRegistry

public NormalizerRegistry getNormalizerRegistry()

Specified by:

getNormalizerRegistry in interface SchemaManager

getObjectClassRegistry

public ObjectClassRegistry getObjectClassRegistry()

Specified by:

getObjectClassRegistry in interface SchemaManager

getLdapSyntaxRegistry

public LdapSyntaxRegistry getLdapSyntaxRegistry()

Specified by:

getLdapSyntaxRegistry in interface SchemaManager

getSyntaxCheckerRegistry

public SyntaxCheckerRegistry getSyntaxCheckerRegistry()

Specified by:

getSyntaxCheckerRegistry in interface SchemaManager

lookupAttributeTypeRegistry

public AttributeType lookupAttributeTypeRegistry(java.lang.String oid)
                                          throws LdapException

Specified by:

lookupAttributeTypeRegistry in interface SchemaManager

Throws:

LdapException

lookupComparatorRegistry

public LdapComparator<?> lookupComparatorRegistry(java.lang.String oid)
                                           throws LdapException

Specified by:

lookupComparatorRegistry in interface SchemaManager

Throws:

LdapException

lookupMatchingRuleRegistry

public MatchingRule lookupMatchingRuleRegistry(java.lang.String oid)
                                        throws LdapException

Specified by:

lookupMatchingRuleRegistry in interface SchemaManager

Throws:

LdapException

lookupNormalizerRegistry

public Normalizer lookupNormalizerRegistry(java.lang.String oid)
                                    throws LdapException

Specified by:

lookupNormalizerRegistry in interface SchemaManager

Throws:

LdapException

lookupObjectClassRegistry

public ObjectClass lookupObjectClassRegistry(java.lang.String oid)
                                      throws LdapException

Specified by:

lookupObjectClassRegistry in interface SchemaManager

Throws:

LdapException

lookupLdapSyntaxRegistry

public LdapSyntax lookupLdapSyntaxRegistry(java.lang.String oid)
                                    throws LdapException

Specified by:

lookupLdapSyntaxRegistry in interface SchemaManager

Throws:

LdapException

lookupSyntaxCheckerRegistry

public SyntaxChecker lookupSyntaxCheckerRegistry(java.lang.String oid)
                                          throws LdapException

Specified by:

lookupSyntaxCheckerRegistry in interface SchemaManager

Throws:

LdapException

add

public boolean add(SchemaObject schemaObject)
            throws java.lang.Exception

Specified by:

add in interface SchemaManager

Throws:

java.lang.Exception

delete

public boolean delete(SchemaObject schemaObject)
               throws java.lang.Exception

Specified by:

delete in interface SchemaManager

Throws:

java.lang.Exception

getNormalizerMapping

public java.util.Map<java.lang.String,OidNormalizer> getNormalizerMapping()

Specified by:

getNormalizerMapping in interface SchemaManager

getGlobalOidRegistry

public OidRegistry getGlobalOidRegistry()

Specified by:

getGlobalOidRegistry in interface SchemaManager

getLoadedSchema

public Schema getLoadedSchema(java.lang.String schemaName)

Specified by:

getLoadedSchema in interface SchemaManager

isSchemaLoaded

public boolean isSchemaLoaded(java.lang.String schemaName)

Specified by:

isSchemaLoaded in interface SchemaManager

unregisterAttributeType

public SchemaObject unregisterAttributeType(java.lang.String attributeTypeOid)
                                     throws LdapException

Specified by:

unregisterAttributeType in interface SchemaManager

Throws:

LdapException

unregisterComparator

public SchemaObject unregisterComparator(java.lang.String comparatorOid)
                                  throws LdapException

Specified by:

unregisterComparator in interface SchemaManager

Throws:

LdapException

unregisterDitControlRule

public SchemaObject unregisterDitControlRule(java.lang.String ditControlRuleOid)
                                      throws LdapException

Specified by:

unregisterDitControlRule in interface SchemaManager

Throws:

LdapException

unregisterDitStructureRule

public SchemaObject unregisterDitStructureRule(java.lang.String ditStructureRuleOid)
                                        throws LdapException

Specified by:

unregisterDitStructureRule in interface SchemaManager

Throws:

LdapException

unregisterLdapSyntax

public SchemaObject unregisterLdapSyntax(java.lang.String ldapSyntaxOid)
                                  throws LdapException

Specified by:

unregisterLdapSyntax in interface SchemaManager

Throws:

LdapException

unregisterMatchingRule

public SchemaObject unregisterMatchingRule(java.lang.String matchingRuleOid)
                                    throws LdapException

Specified by:

unregisterMatchingRule in interface SchemaManager

Throws:

LdapException

unregisterMatchingRuleUse

public SchemaObject unregisterMatchingRuleUse(java.lang.String matchingRuleUseOid)
                                       throws LdapException

Specified by:

unregisterMatchingRuleUse in interface SchemaManager

Throws:

LdapException

unregisterNameForm

public SchemaObject unregisterNameForm(java.lang.String nameFormOid)
                                throws LdapException

Specified by:

unregisterNameForm in interface SchemaManager

Throws:

LdapException

unregisterNormalizer

public SchemaObject unregisterNormalizer(java.lang.String normalizerOid)
                                  throws LdapException

Specified by:

unregisterNormalizer in interface SchemaManager

Throws:

LdapException

unregisterObjectClass

public SchemaObject unregisterObjectClass(java.lang.String objectClassOid)
                                   throws LdapException

Specified by:

unregisterObjectClass in interface SchemaManager

Throws:

LdapException

unregisterSyntaxChecker

public SchemaObject unregisterSyntaxChecker(java.lang.String syntaxCheckerOid)
                                     throws LdapException

Specified by:

unregisterSyntaxChecker in interface SchemaManager

Throws:

LdapException

isRelaxed

public boolean isRelaxed()

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

Returns:

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

isStrict

public boolean isStrict()

Tells if the SchemaManager is strict.

Returns:

True if SchemaObjects cannot be added if they break the consistency

listDependentSchemaNames

public java.util.Set<java.lang.String> listDependentSchemaNames(java.lang.String schemaName)

Specified by:

listDependentSchemaNames in interface SchemaManager

setRelaxed

public void setRelaxed()

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

setStrict

public void setStrict()

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

isDisabled

public boolean isDisabled(java.lang.String schemaName)

Specified by:

isDisabled in interface SchemaManager

isDisabled

public boolean isDisabled(Schema schema)

Specified by:

isDisabled in interface SchemaManager

isEnabled

public boolean isEnabled(java.lang.String schemaName)

Specified by:

isEnabled in interface SchemaManager

isEnabled

public boolean isEnabled(Schema schema)

Specified by:

isEnabled in interface SchemaManager