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

Interface SchemaLoader

All Known Implementing Classes:

AbstractSchemaLoader, DefaultSchemaLoader, JarLdifSchemaLoader, LdifSchemaLoader, SingleLdifSchemaLoader

public interface SchemaLoader

Loads schemas into registries.

Method Summary

Modifier and Type	Method and Description
void	addSchema(Schema schema) Add a new schema to the schema's list
java.util.Collection<Schema>	getAllEnabled()
java.util.Collection<Schema>	getAllSchemas()
Schema	getSchema(java.lang.String schemaName) Gets a schema object based on it's name.
boolean	isRelaxed()
boolean	isStrict()
java.util.List<Entry>	loadAttributeTypes(Schema... schemas) Build a list of AttributeTypes read from the underlying storage for a list of specified schema
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(Schema... schemas) Build a list of Comparators read from the underlying storage for a list of specific schema.
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(Schema... schemas) Build a list of DitContentRules read from the underlying storage for a list of specific schema.
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(Schema... schemas) Build a list of DitStructureRules read from the underlying storage for a list of specific schema.
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(Schema... schemas) Build a list of MatchingRules read from the underlying storage for a list of specific schema
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(Schema... schemas) Build a list of MatchingRuleUses read from the underlying storage for a list of specific schema.
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(Schema... schemas) Build a list of NameForms read from the underlying storage for a list of specific schema.
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(Schema... schemas) Build a list of Normalizers read from the underlying storage for a list of specified schema
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(Schema... schemas) Build a list of ObjectClasses read from the underlying storage for a list of specific schema.
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(Schema... schemas) Build a list of SyntaxCheckers read from the underlying storage for a list of specified schema
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(Schema... schemas) Build a list of Syntaxes read from the underlying storage for a list of specified schema
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.

Method Detail

getSchema

Schema getSchema(java.lang.String schemaName)

Gets a schema object based on it's name.

Parameters:

schemaName - the name of the schema to load

Returns:

the Schema object associated with the name

loadAttributeTypes

java.util.List<Entry> loadAttributeTypes(Schema... schemas)
                                  throws LdapException,
                                         java.io.IOException

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

Parameters:

schemas - the schemas from which AttributeTypes are loaded

Throws:

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

LdapException

java.io.IOException

loadAttributeTypes

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

Parameters:

schemaNames - the schema names from which AttributeTypes are loaded

Throws:

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

loadComparators

java.util.List<Entry> loadComparators(Schema... schemas)
                               throws LdapException,
                                      java.io.IOException

Build a list of Comparators read from the underlying storage for a list of specific schema.

Parameters:

schemas - the schemas from which Comparators are loaded

Throws:

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

LdapException

java.io.IOException

loadComparators

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

Parameters:

schemaNames - the schema names from which Comparators are loaded

Throws:

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

loadDitContentRules

java.util.List<Entry> loadDitContentRules(Schema... schemas)
                                   throws LdapException,
                                          java.io.IOException

Build a list of DitContentRules read from the underlying storage for a list of specific schema.

Parameters:

schemas - the schemas from which DitContentRules are loaded

Throws:

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

LdapException

java.io.IOException

loadDitContentRules

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

Parameters:

schemaNames - the schema names from which DitContentRules are loaded

Throws:

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

loadDitStructureRules

java.util.List<Entry> loadDitStructureRules(Schema... schemas)
                                     throws LdapException,
                                            java.io.IOException

Build a list of DitStructureRules read from the underlying storage for a list of specific schema.

Parameters:

schemas - the schemas from which DitStructureRules are loaded

Throws:

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

LdapException

java.io.IOException

loadDitStructureRules

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

Parameters:

schemaNames - the schema names from which DitStructureRules are loaded

Throws:

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

loadMatchingRules

java.util.List<Entry> loadMatchingRules(Schema... schemas)
                                 throws LdapException,
                                        java.io.IOException

Build a list of MatchingRules read from the underlying storage for a list of specific schema

Parameters:

schemas - the schemas from which MatchingRules are loaded

Throws:

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

LdapException

java.io.IOException

loadMatchingRules

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

Parameters:

schemaNames - the schema names from which MatchingRules are loaded

Throws:

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

loadMatchingRuleUses

java.util.List<Entry> loadMatchingRuleUses(Schema... schemas)
                                    throws LdapException,
                                           java.io.IOException

Build a list of MatchingRuleUses read from the underlying storage for a list of specific schema.

Parameters:

schemas - the schemas from which MatchingRuleUses are loaded

Throws:

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

LdapException

java.io.IOException

loadMatchingRuleUses

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

Parameters:

schemaNames - the schema names from which MatchingRuleUses are loaded

Throws:

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

loadNameForms

java.util.List<Entry> loadNameForms(Schema... schemas)
                             throws LdapException,
                                    java.io.IOException

Build a list of NameForms read from the underlying storage for a list of specific schema.

Parameters:

schemas - the schemas from which NameForms are loaded

Throws:

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

LdapException

java.io.IOException

loadNameForms

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

Parameters:

schemaNames - the schema names from which NameForms are loaded

Throws:

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

loadNormalizers

java.util.List<Entry> loadNormalizers(Schema... schemas)
                               throws LdapException,
                                      java.io.IOException

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

Parameters:

schemas - the schemas from which Normalizers are loaded

Throws:

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

LdapException

java.io.IOException

loadNormalizers

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

Parameters:

schemaNames - the schema names from which Normalizers are loaded

Throws:

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

loadObjectClasses

java.util.List<Entry> loadObjectClasses(Schema... schemas)
                                 throws LdapException,
                                        java.io.IOException

Build a list of ObjectClasses read from the underlying storage for a list of specific schema.

Parameters:

schemas - the schemas from which ObjectClasses are loaded

Throws:

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

LdapException

java.io.IOException

loadObjectClasses

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

Parameters:

schemaNames - the schema names from which ObjectClasses are loaded

Throws:

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

loadSyntaxes

java.util.List<Entry> loadSyntaxes(Schema... schemas)
                            throws LdapException,
                                   java.io.IOException

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

Parameters:

schemas - the schemas from which Syntaxes are loaded

Throws:

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

LdapException

java.io.IOException

loadSyntaxes

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

Parameters:

schemaNames - the schema names from which Syntaxes are loaded

Throws:

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

loadSyntaxCheckers

java.util.List<Entry> loadSyntaxCheckers(Schema... schemas)
                                  throws LdapException,
                                         java.io.IOException

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

Parameters:

schemas - the schemas from which SyntaxCheckers are loaded

Throws:

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

LdapException

java.io.IOException

loadSyntaxCheckers

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

Parameters:

schemaNames - the schema names from which SyntaxCheckers are loaded

Throws:

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

getAllEnabled

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

Returns:

the list of enabled schemas

Throws:

java.lang.Exception - TODO

getAllSchemas

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

Returns:

the list of all schemas

Throws:

java.lang.Exception - TODO

addSchema

void addSchema(Schema schema)

Add a new schema to the schema's list

removeSchema

void removeSchema(Schema schema)

Remove a schema from the schema's list

Parameters:

schema - The schema to remove

isRelaxed

boolean isRelaxed()

Returns:

Tells if the SchemaLoader is in RELAXED mode

isStrict

boolean isStrict()

Returns:

Tells if the SchemaLoader is in STRICT mode

setRelaxed

void setRelaxed(boolean relaxed)

Set the SchemzLoader in STRICT or RELAXED mode.

Parameters:

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