|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface SchemaManager
A class used to manage access to the Schemas and Registries. It's associated with a SchemaLoader, in charge of loading the schemas from the disk.
Method Summary | |
---|---|
boolean |
add(SchemaObject schemaObject)
Registers a new SchemaObject. |
boolean |
delete(SchemaObject schemaObject)
Unregisters a new SchemaObject. |
boolean |
disable(Schema... schemas)
Disables a set of Schemas, and returns true if all the schema have been disabled, with all the dependent schemas, and if the registries is still consistent. |
boolean |
disable(java.lang.String... schemas)
Disables a set of Schemas, and returns true if all the schema have been disabled, with all the dependent schemas, and if the registries is still consistent. |
boolean |
disabledRelaxed(Schema... schemas)
Disables a set of Schemas, and returns true if all the schema have been disabled, with all the dependent schemas. |
boolean |
disabledRelaxed(java.lang.String... schemas)
Disables a set of Schemas, and returns true if all the schema have been disabled, with all the dependent schemas. |
boolean |
enable(Schema... schemas)
Enables a set of Schemas, and returns true if all the schema have been enabled, with all the dependent schemas, and if the registries is still consistent. |
boolean |
enable(java.lang.String... schemas)
Enables a set of Schemas, and returns true if all the schema have been enabled, with all the dependent schemas, and if the registries is still consistent. |
boolean |
enableRelaxed(Schema... schemas)
Enables a set of Schemas, and returns true if all the schema have been enabled, with all the dependent schemas. |
boolean |
enableRelaxed(java.lang.String... schemas)
Enables a set of Schemas, and returns true if all the schema have been enabled, with all the dependent schemas. |
AttributeTypeRegistry |
getAttributeTypeRegistry()
Get an immutable reference on the AttributeType registry |
ComparatorRegistry |
getComparatorRegistry()
Get an immutable reference on the Comparator registry |
java.util.List<Schema> |
getDisabled()
|
DITContentRuleRegistry |
getDITContentRuleRegistry()
Get an immutable reference on the DITContentRule registry |
DITStructureRuleRegistry |
getDITStructureRuleRegistry()
Get an immutable reference on the DITStructureRule registry |
java.util.List<Schema> |
getEnabled()
|
java.util.List<java.lang.Throwable> |
getErrors()
|
OidRegistry |
getGlobalOidRegistry()
Returns a reference to the global OidRegistry |
LdapSyntaxRegistry |
getLdapSyntaxRegistry()
Get an immutable reference on the LdapSyntax registry |
Schema |
getLoadedSchema(java.lang.String schemaName)
Gets a schema that has been loaded into these Registries. |
SchemaLoader |
getLoader()
|
MatchingRuleRegistry |
getMatchingRuleRegistry()
Get an immutable reference on the MatchingRule registry |
MatchingRuleUseRegistry |
getMatchingRuleUseRegistry()
Get an immutable reference on the MatchingRuleUse registry |
NameFormRegistry |
getNameFormRegistry()
Get an immutable reference on the NameForm registry |
DN |
getNamingContext()
|
java.util.Map<java.lang.String,OidNormalizer> |
getNormalizerMapping()
Get an immutable reference on the Normalizer mapping |
NormalizerRegistry |
getNormalizerRegistry()
Get an immutable reference on the Normalizer registry |
ObjectClassRegistry |
getObjectClassRegistry()
Get an immutable reference on the ObjectClass registry |
Registries |
getRegistries()
|
SyntaxCheckerRegistry |
getSyntaxCheckerRegistry()
Get an immutable reference on the SyntaxChecker registry |
void |
initialize()
Initializes the SchemaService |
boolean |
isDisabled(Schema schema)
Tells if the given Schema is disabled |
boolean |
isDisabled(java.lang.String schemaName)
Tells if the given Schema is disabled |
boolean |
isEnabled(Schema schema)
Tells if the given Schema is enabled |
boolean |
isEnabled(java.lang.String schemaName)
Tells if the given Schema is enabled |
boolean |
isSchemaLoaded(java.lang.String schemaName)
Tells if the specific schema is loaded |
java.util.Set<java.lang.String> |
listDependentSchemaNames(java.lang.String schemaName)
Get the list of Schema names which has the given schema name as a dependence |
boolean |
load(Schema... schemas)
Load some Schemas into the registries. |
boolean |
load(java.lang.String... schemas)
Load some Schemas into the registries. |
boolean |
loadAllEnabled()
Load all the enabled schema into the Registries. |
boolean |
loadAllEnabledRelaxed()
Load all the enabled schema into the Registries. |
boolean |
loadDisabled(Schema... schemas)
Load Schemas into the Registries, even if they are disabled. |
boolean |
loadDisabled(java.lang.String... schemas)
Load Schemas into the Registries, even if they are disabled. |
boolean |
loadRelaxed(Schema... schemas)
Load Schemas into the registries, even if there are some errors in the schemas. |
boolean |
loadRelaxed(java.lang.String... schemas)
Load Schemas into the registries, even if there are some errors in the schemas. |
boolean |
loadWithDeps(Schema... schemas)
Load some Schemas into the registries, and loads all of the schemas they depend on. |
boolean |
loadWithDeps(java.lang.String... schemas)
Load some Schemas into the registries, and loads all of the schemas they depend on. |
boolean |
loadWithDepsRelaxed(Schema... schemas)
Load some Schemas into the registries, and loads all of the schemas they depend on. |
boolean |
loadWithDepsRelaxed(java.lang.String... schemas)
Load some Schemas into the registries, and loads all of the schemas they depend on. |
AttributeType |
lookupAttributeTypeRegistry(java.lang.String oid)
Lookup for an AttributeType in the AttributeType registry |
LdapComparator<?> |
lookupComparatorRegistry(java.lang.String oid)
Lookup for a Comparator in the Comparator registry |
LdapSyntax |
lookupLdapSyntaxRegistry(java.lang.String oid)
Lookup for an LdapSyntax in the LdapSyntax registry |
MatchingRule |
lookupMatchingRuleRegistry(java.lang.String oid)
Lookup for a MatchingRule in the MatchingRule registry |
Normalizer |
lookupNormalizerRegistry(java.lang.String oid)
Lookup for a Normalizer in the Normalizer registry |
ObjectClass |
lookupObjectClassRegistry(java.lang.String oid)
Lookup for a ObjectClass in the ObjectClass registry |
SyntaxChecker |
lookupSyntaxCheckerRegistry(java.lang.String oid)
Lookup for a SyntaxChecker in the SyntaxChecker registry |
void |
setRegistries(Registries registries)
Associate a new Registries to the SchemaManager |
void |
setSchemaLoader(SchemaLoader schemaLoader)
Associate a Schema loader to this SchemaManager |
boolean |
unload(Schema... schemas)
Unload the given set of Schemas |
boolean |
unload(java.lang.String... schemas)
Unload the given set of Schemas |
SchemaObject |
unregisterAttributeType(java.lang.String attributeTypeOid)
Removes the registered attributeType from the attributeTypeRegistry |
SchemaObject |
unregisterComparator(java.lang.String comparatorOid)
Removes the registered Comparator from the ComparatorRegistry |
SchemaObject |
unregisterDitControlRule(java.lang.String ditControlRuleOid)
Removes the registered DitControlRule from the DitControlRuleRegistry |
SchemaObject |
unregisterDitStructureRule(java.lang.String ditStructureRuleOid)
Removes the registered DitStructureRule from the DitStructureRuleRegistry |
SchemaObject |
unregisterLdapSyntax(java.lang.String ldapSyntaxOid)
Removes the registered LdapSyntax from the LdapSyntaxRegistry |
SchemaObject |
unregisterMatchingRule(java.lang.String matchingRuleOid)
Removes the registered MatchingRule from the MatchingRuleRegistry |
SchemaObject |
unregisterMatchingRuleUse(java.lang.String matchingRuleUseOid)
Removes the registered MatchingRuleUse from the MatchingRuleUseRegistry |
SchemaObject |
unregisterNameForm(java.lang.String nameFormOid)
Removes the registered NameForm from the NameFormRegistry |
SchemaObject |
unregisterNormalizer(java.lang.String normalizerOid)
Removes the registered Normalizer from the NormalizerRegistry |
SchemaObject |
unregisterObjectClass(java.lang.String objectClassOid)
Removes the registered ObjectClass from the ObjectClassRegistry |
SchemaObject |
unregisterSyntaxChecker(java.lang.String syntaxCheckerOid)
Removes the registered SyntaxChecker from the SyntaxCheckerRegistry |
boolean |
verify(Schema... schemas)
Check that the Schemas are consistent regarding the current Registries. |
boolean |
verify(java.lang.String... schemas)
Check that the Schemas are consistent regarding the current Registries. |
Method Detail |
---|
boolean load(Schema... schemas) throws java.lang.Exception
getErrors()
method will contain them
schemas
- the Schemas to load
java.lang.Exception
- @TODOboolean load(java.lang.String... schemas) throws java.lang.Exception
getErrors()
method will contain them
schemas
- the Schemas' name to load
java.lang.Exception
- @TODOboolean loadWithDeps(Schema... schemas) throws java.lang.Exception
getErrors()
method will contain them
schemas
- the Schemas to load
java.lang.Exception
- @TODOboolean loadWithDeps(java.lang.String... schemas) throws java.lang.Exception
getErrors()
method will contain them
schemas
- the Schemas' name to load
java.lang.Exception
- @TODOboolean loadRelaxed(Schema... schemas) throws java.lang.Exception
getErrors()
method will contain them
schemas
- the Schemas to load, if enabled
java.lang.Exception
- @TODOboolean loadRelaxed(java.lang.String... schemas) throws java.lang.Exception
getErrors()
method will contain them
schemas
- the Schemas' name to load, if enabled
java.lang.Exception
- @TODOboolean loadWithDepsRelaxed(Schema... schemas) throws java.lang.Exception
getErrors()
method will contain them
schemas
- the Schemas to load
java.lang.Exception
- @TODOboolean loadWithDepsRelaxed(java.lang.String... schemas) throws java.lang.Exception
getErrors()
method will contain them
schemas
- the Schemas' name to load
java.lang.Exception
- @TODOboolean loadDisabled(Schema... schemas) throws java.lang.Exception
getErrors()
method will contain them
schemas
- The Schemas to load
java.lang.Exception
- @TODOboolean loadDisabled(java.lang.String... schemas) throws java.lang.Exception
getErrors()
method will contain them
schemas
- The Schemas' name to load
java.lang.Exception
- @TODOboolean loadAllEnabled() throws java.lang.Exception
java.lang.Exception
- @TODOboolean loadAllEnabledRelaxed() throws java.lang.Exception
java.lang.Exception
- @TODOboolean unload(Schema... schemas) throws java.lang.Exception
schemas
- The list of Schema to unload
java.lang.Exception
boolean unload(java.lang.String... schemas) throws java.lang.Exception
schemas
- The list of Schema to unload
java.lang.Exception
boolean enable(Schema... schemas) throws java.lang.Exception
schemas
- The list of schemas to enable
If
- something went wrong
java.lang.Exception
boolean enable(java.lang.String... schemas) throws java.lang.Exception
schemas
- The list of schema name to enable
If
- something went wrong
java.lang.Exception
boolean enableRelaxed(Schema... schemas)
schemas
- The list of schemas to enable
boolean enableRelaxed(java.lang.String... schemas)
schemas
- The list of schema names to enable
java.util.List<Schema> getEnabled()
boolean isEnabled(java.lang.String schemaName)
schemaName
- The schema name
boolean isEnabled(Schema schema)
schema
- The schema
boolean disable(Schema... schemas) throws java.lang.Exception
schemas
- The list of schemas to disable
If
- something went wrong
java.lang.Exception
boolean disable(java.lang.String... schemas) throws java.lang.Exception
schemas
- The list of schema names to disable
If
- something went wrong
java.lang.Exception
boolean disabledRelaxed(Schema... schemas)
schemas
- The list of schemas to disable
boolean disabledRelaxed(java.lang.String... schemas)
schemas
- The list of schema names to disable
java.util.List<Schema> getDisabled()
boolean isDisabled(java.lang.String schemaName)
schemaName
- The schema name
boolean isDisabled(Schema schema)
schema
- The schema
boolean verify(Schema... schemas) throws java.lang.Exception
schemas
- The schemas to check
java.lang.Exception
- if something went wrongboolean verify(java.lang.String... schemas) throws java.lang.Exception
schemas
- The schema names to check
java.lang.Exception
- if something went wrongRegistries getRegistries()
AttributeType lookupAttributeTypeRegistry(java.lang.String oid) throws LdapException
String
- oid the OID we are looking for
LdapException
- if the OID is not found in the AttributeType registryLdapComparator<?> lookupComparatorRegistry(java.lang.String oid) throws LdapException
String
- oid the OID we are looking for
LdapException
- if the OID is not found in the Comparator registryMatchingRule lookupMatchingRuleRegistry(java.lang.String oid) throws LdapException
String
- oid the OID we are looking for
LdapException
- if the OID is not found in the MatchingRule registryNormalizer lookupNormalizerRegistry(java.lang.String oid) throws LdapException
String
- oid the OID we are looking for
LdapException
- if the OID is not found in the Normalizer registryObjectClass lookupObjectClassRegistry(java.lang.String oid) throws LdapException
String
- oid the OID we are looking for
LdapException
- if the OID is not found in the ObjectClass registryLdapSyntax lookupLdapSyntaxRegistry(java.lang.String oid) throws LdapException
String
- oid the OID we are looking for
LdapException
- if the OID is not found in the LdapSyntax registrySyntaxChecker lookupSyntaxCheckerRegistry(java.lang.String oid) throws LdapException
String
- oid the OID we are looking for
LdapException
- if the OID is not found in the SyntaxChecker registryAttributeTypeRegistry getAttributeTypeRegistry()
ComparatorRegistry getComparatorRegistry()
DITContentRuleRegistry getDITContentRuleRegistry()
DITStructureRuleRegistry getDITStructureRuleRegistry()
MatchingRuleRegistry getMatchingRuleRegistry()
MatchingRuleUseRegistry getMatchingRuleUseRegistry()
NormalizerRegistry getNormalizerRegistry()
NameFormRegistry getNameFormRegistry()
ObjectClassRegistry getObjectClassRegistry()
LdapSyntaxRegistry getLdapSyntaxRegistry()
SyntaxCheckerRegistry getSyntaxCheckerRegistry()
java.util.Map<java.lang.String,OidNormalizer> getNormalizerMapping()
void setRegistries(Registries registries)
registries
- The new Registriesjava.util.List<java.lang.Throwable> getErrors()
void setSchemaLoader(SchemaLoader schemaLoader)
schemaLoader
- The schema loader to useDN getNamingContext()
void initialize() throws java.lang.Exception
java.lang.Exception
- If the initialization failsSchemaLoader getLoader()
boolean add(SchemaObject schemaObject) throws java.lang.Exception
schemaObject
- the SchemaObject to register
java.lang.Exception
- if the SchemaObject is already registered or
the registration operation is not supportedboolean delete(SchemaObject schemaObject) throws java.lang.Exception
schemaObject
- the SchemaObject to unregister
java.lang.Exception
- if the SchemaObject is not registered or
the deletion operation is not supportedSchemaObject unregisterAttributeType(java.lang.String attributeTypeOid) throws LdapException
String
- the attributeType OID to unregister
LdapException
- if the attributeType is invalidSchemaObject unregisterComparator(java.lang.String comparatorOid) throws LdapException
String
- the Comparator OID to unregister
LdapException
- if the Comparator is invalidSchemaObject unregisterDitControlRule(java.lang.String ditControlRuleOid) throws LdapException
String
- the DitControlRule OID to unregister
LdapException
- if the DitControlRule is invalidSchemaObject unregisterDitStructureRule(java.lang.String ditStructureRuleOid) throws LdapException
String
- the DitStructureRule OID to unregister
LdapException
- if the DitStructureRule is invalidSchemaObject unregisterMatchingRule(java.lang.String matchingRuleOid) throws LdapException
String
- the MatchingRuleRule OID to unregister
LdapException
- if the MatchingRule is invalidSchemaObject unregisterMatchingRuleUse(java.lang.String matchingRuleUseOid) throws LdapException
String
- the MatchingRuleUse OID to unregister
LdapException
- if the MatchingRuleUse is invalidSchemaObject unregisterNameForm(java.lang.String nameFormOid) throws LdapException
String
- the NameForm OID to unregister
LdapException
- if the NameForm is invalidSchemaObject unregisterNormalizer(java.lang.String normalizerOid) throws LdapException
String
- the Normalizer OID to unregister
LdapException
- if the Normalizer is invalidSchemaObject unregisterObjectClass(java.lang.String objectClassOid) throws LdapException
String
- the ObjectClass OID to unregister
LdapException
- if the ObjectClass is invalidSchemaObject unregisterLdapSyntax(java.lang.String ldapSyntaxOid) throws LdapException
String
- the LdapSyntax OID to unregister
LdapException
- if the LdapSyntax is invalidSchemaObject unregisterSyntaxChecker(java.lang.String syntaxCheckerOid) throws LdapException
String
- the SyntaxChecker OID to unregister
LdapException
- if the SyntaxChecker is invalidOidRegistry getGlobalOidRegistry()
Schema getLoadedSchema(java.lang.String schemaName)
schemaName
- the name of the schema to lookup
boolean isSchemaLoaded(java.lang.String schemaName)
schemaName
- The schema we want to check
java.util.Set<java.lang.String> listDependentSchemaNames(java.lang.String schemaName)
schemaName
- The Schema name for which we want to get the list of dependent schemas
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |