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

Class AbstractSchemaLoader

java.lang.Object

org.apache.directory.api.ldap.model.schema.registries.AbstractSchemaLoader

All Implemented Interfaces:

SchemaLoader

Direct Known Subclasses:

DefaultSchemaLoader, JarLdifSchemaLoader, LdifSchemaLoader, SingleLdifSchemaLoader

public abstract class AbstractSchemaLoader
extends java.lang.Object
implements SchemaLoader

An abstract class with a utility method and setListener() implemented.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	AbstractSchemaLoader.LowerCaseKeyMap a map implementation which converts the keys to lower case before inserting

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	relaxed The flag that tells about the SchemaLoader mode : relaxed or strict
protected java.util.Map<java.lang.String,Schema>	schemaMap A map of all available schema names to schema objects.

Constructor Summary

Constructors

Constructor and Description
AbstractSchemaLoader()

Method Summary

Modifier and Type	Method and Description
void	addSchema(Schema schema) Add a new schema to the schema's list
private Schema[]	buildSchemaArray(java.lang.String... schemaNames)
java.util.Collection<Schema>	getAllEnabled()
java.util.Collection<Schema>	getAllSchemas()
protected Schema	getSchema(Entry entry) Gets the schema.
Schema	getSchema(java.lang.String schemaName) Gets a schema object based on it's name.
boolean	isRelaxed()
boolean	isStrict()
java.util.List<Entry>	loadAttributeTypes(java.lang.String... schemaNames) Build a list of AttributeTypes read from the underlying storage for a list of specific schema, using their name
java.util.List<Entry>	loadComparators(java.lang.String... schemaNames) Build a list of Comparators read from the underlying storage for a list of specific schema, using their name
java.util.List<Entry>	loadDitContentRules(java.lang.String... schemaNames) Build a list of DitContentRules read from the underlying storage for a list of specified schema names
java.util.List<Entry>	loadDitStructureRules(java.lang.String... schemaNames) Build a list of DitStructureRules read from the underlying storage for a list of specified schema names
java.util.List<Entry>	loadMatchingRules(java.lang.String... schemaNames) Build a list of MatchingRules read from the underlying storage for a list of specific schema, using their name
java.util.List<Entry>	loadMatchingRuleUses(java.lang.String... schemaNames) Build a list of MatchingRuleUses read from the underlying storage for a list of specified schema names
java.util.List<Entry>	loadNameForms(java.lang.String... schemaNames) Build a list of NameForms read from the underlying storage for a list of specified schema names
java.util.List<Entry>	loadNormalizers(java.lang.String... schemaNames) Build a list of Normalizers read from the underlying storage for a list of specified schema names
java.util.List<Entry>	loadObjectClasses(java.lang.String... schemaNames) Build a list of ObjectClasses read from the underlying storage for a list of specified schema names
java.util.List<Entry>	loadSyntaxCheckers(java.lang.String... schemaNames) Build a list of SyntaxCheckers read from the underlying storage for a list of specified schema names
java.util.List<Entry>	loadSyntaxes(java.lang.String... schemaNames) Build a list of Syntaxes read from the underlying storage for a list of specified schema names
void	removeSchema(Schema schema) Remove a schema from the schema's list
void	setRelaxed(boolean relaxed) Set the SchemzLoader in STRICT or RELAXED mode.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.directory.api.ldap.model.schema.registries.SchemaLoader

loadAttributeTypes, loadComparators, loadDitContentRules, loadDitStructureRules, loadMatchingRules, loadMatchingRuleUses, loadNameForms, loadNormalizers, loadObjectClasses, loadSyntaxCheckers, loadSyntaxes

Field Detail

schemaMap

protected final java.util.Map<java.lang.String,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.

relaxed

private boolean relaxed

The flag that tells about the SchemaLoader mode : relaxed or strict

Constructor Detail

AbstractSchemaLoader

public AbstractSchemaLoader()

Method Detail

getAllEnabled

public final java.util.Collection<Schema> getAllEnabled()
                                                 throws java.lang.Exception

Specified by:

getAllEnabled in interface SchemaLoader

Returns:

the list of enabled schemas

Throws:

java.lang.Exception - TODO

getAllSchemas

public final java.util.Collection<Schema> getAllSchemas()
                                                 throws java.lang.Exception

Specified by:

getAllSchemas in interface SchemaLoader

Returns:

the list of all schemas

Throws:

java.lang.Exception - TODO

getSchema

public Schema getSchema(java.lang.String schemaName)

Gets a schema object based on it's name.

Specified by:

getSchema in interface SchemaLoader

Parameters:

schemaName - the name of the schema to load

Returns:

the Schema object associated with the name

addSchema

public void addSchema(Schema schema)

Add a new schema to the schema's list

Specified by:

addSchema in interface SchemaLoader

removeSchema

public void removeSchema(Schema schema)

Remove a schema from the schema's list

Specified by:

removeSchema in interface SchemaLoader

Parameters:

schema - The schema to remove

getSchema

protected Schema getSchema(Entry entry)
                    throws java.lang.Exception

Gets the schema.

Parameters:

entry - the entry

Returns:

the schema

Throws:

java.lang.Exception - the exception

buildSchemaArray

private Schema[] buildSchemaArray(java.lang.String... schemaNames)
                           throws java.lang.Exception

Throws:

java.lang.Exception

loadAttributeTypes

public java.util.List<Entry> loadAttributeTypes(java.lang.String... schemaNames)
                                         throws java.lang.Exception

Build a list of AttributeTypes read from the underlying storage for a list of specific schema, using their name

Specified by:

loadAttributeTypes in interface SchemaLoader

Parameters:

schemaNames - the schema names from which AttributeTypes are loaded

Throws:

java.lang.Exception - if there are failures accessing AttributeType information

loadComparators

public java.util.List<Entry> loadComparators(java.lang.String... schemaNames)
                                      throws java.lang.Exception

Build a list of Comparators read from the underlying storage for a list of specific schema, using their name

Specified by:

loadComparators in interface SchemaLoader

Parameters:

schemaNames - the schema names from which Comparators are loaded

Throws:

java.lang.Exception - if there are failures accessing Comparator information

loadDitContentRules

public java.util.List<Entry> loadDitContentRules(java.lang.String... schemaNames)
                                          throws java.lang.Exception

Build a list of DitContentRules read from the underlying storage for a list of specified schema names

Specified by:

loadDitContentRules in interface SchemaLoader

Parameters:

schemaNames - the schema names from which DitContentRules are loaded

Throws:

java.lang.Exception - if there are failures accessing DitContentRule information

loadDitStructureRules

public java.util.List<Entry> loadDitStructureRules(java.lang.String... schemaNames)
                                            throws java.lang.Exception

Build a list of DitStructureRules read from the underlying storage for a list of specified schema names

Specified by:

loadDitStructureRules in interface SchemaLoader

Parameters:

schemaNames - the schema names from which DitStructureRules are loaded

Throws:

java.lang.Exception - if there are failures accessing DitStructureRule information

loadMatchingRules

public java.util.List<Entry> loadMatchingRules(java.lang.String... schemaNames)
                                        throws java.lang.Exception

Build a list of MatchingRules read from the underlying storage for a list of specific schema, using their name

Specified by:

loadMatchingRules in interface SchemaLoader

Parameters:

schemaNames - the schema names from which MatchingRules are loaded

Throws:

java.lang.Exception - if there are failures accessing MatchingRule information

loadMatchingRuleUses

public java.util.List<Entry> loadMatchingRuleUses(java.lang.String... schemaNames)
                                           throws java.lang.Exception

Build a list of MatchingRuleUses read from the underlying storage for a list of specified schema names

Specified by:

loadMatchingRuleUses in interface SchemaLoader

Parameters:

schemaNames - the schema names from which MatchingRuleUses are loaded

Throws:

java.lang.Exception - if there are failures accessing MatchingRuleUses information

loadNameForms

public java.util.List<Entry> loadNameForms(java.lang.String... schemaNames)
                                    throws java.lang.Exception

Build a list of NameForms read from the underlying storage for a list of specified schema names

Specified by:

loadNameForms in interface SchemaLoader

Parameters:

schemaNames - the schema names from which NameForms are loaded

Throws:

java.lang.Exception - if there are failures accessing NameForms information

loadNormalizers

public java.util.List<Entry> loadNormalizers(java.lang.String... schemaNames)
                                      throws java.lang.Exception

Build a list of Normalizers read from the underlying storage for a list of specified schema names

Specified by:

loadNormalizers in interface SchemaLoader

Parameters:

schemaNames - the schema names from which Normalizers are loaded

Throws:

java.lang.Exception - if there are failures accessing Normalizer information

loadObjectClasses

public java.util.List<Entry> loadObjectClasses(java.lang.String... schemaNames)
                                        throws java.lang.Exception

Build a list of ObjectClasses read from the underlying storage for a list of specified schema names

Specified by:

loadObjectClasses in interface SchemaLoader

Parameters:

schemaNames - the schema names from which ObjectClasses are loaded

Throws:

java.lang.Exception - if there are failures accessing ObjectClasses information

loadSyntaxes

public java.util.List<Entry> loadSyntaxes(java.lang.String... schemaNames)
                                   throws java.lang.Exception

Build a list of Syntaxes read from the underlying storage for a list of specified schema names

Specified by:

loadSyntaxes in interface SchemaLoader

Parameters:

schemaNames - the schema names from which Syntaxes are loaded

Throws:

java.lang.Exception - if there are failures accessing Syntax information

loadSyntaxCheckers

public java.util.List<Entry> loadSyntaxCheckers(java.lang.String... schemaNames)
                                         throws java.lang.Exception

Build a list of SyntaxCheckers read from the underlying storage for a list of specified schema names

Specified by:

loadSyntaxCheckers in interface SchemaLoader

Parameters:

schemaNames - the schema names from which SyntaxCheckers are loaded

Throws:

java.lang.Exception - if there are failures accessing SyntaxChecker information

isRelaxed

public boolean isRelaxed()

Specified by:

isRelaxed in interface SchemaLoader

Returns:

Tells if the SchemaLoader is in RELAXED mode

isStrict

public boolean isStrict()

Specified by:

isStrict in interface SchemaLoader

Returns:

Tells if the SchemaLoader is in STRICT mode

setRelaxed

public void setRelaxed(boolean relaxed)

Set the SchemzLoader in STRICT or RELAXED mode.

Specified by:

setRelaxed in interface SchemaLoader

Parameters:

relaxed - if true, the SchemaLoader will be in relaxed mode, otherwise it will be in strict mode (the default)