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

All Known Implementing Classes:

AbstractSchemaLoader

public interface SchemaLoader

Loads schemas into registries.

Author:

Apache Directory Project

Method Summary

void	addSchema(Schema schema) Add a new schema to the schema's list
Collection<Schema>	getAllEnabled()
Collection<Schema>	getAllSchemas()
Schema	getSchema(String schemaName) Gets a schema object based on it's name.
List<Entry>	loadAttributeTypes(Schema... schemas) Build a list of AttributeTypes read from the underlying storage for a list of specified schema
List<Entry>	loadAttributeTypes(String... schemaNames) Build a list of AttributeTypes read from the underlying storage for a list of specific schema, using their name
List<Entry>	loadComparators(Schema... schemas) Build a list of Comparators read from the underlying storage for a list of specific schema.
List<Entry>	loadComparators(String... schemaNames) Build a list of Comparators read from the underlying storage for a list of specific schema, using their name
List<Entry>	loadDitContentRules(Schema... schemas) Build a list of DitContentRules read from the underlying storage for a list of specific schema.
List<Entry>	loadDitContentRules(String... schemaNames) Build a list of DitContentRules read from the underlying storage for a list of specified schema names
List<Entry>	loadDitStructureRules(Schema... schemas) Build a list of DitStructureRules read from the underlying storage for a list of specific schema.
List<Entry>	loadDitStructureRules(String... schemaNames) Build a list of DitStructureRules read from the underlying storage for a list of specified schema names
List<Entry>	loadMatchingRules(Schema... schemas) Build a list of MatchingRules read from the underlying storage for a list of specific schema
List<Entry>	loadMatchingRules(String... schemaNames) Build a list of MatchingRules read from the underlying storage for a list of specific schema, using their name
List<Entry>	loadMatchingRuleUses(Schema... schemas) Build a list of MatchingRuleUses read from the underlying storage for a list of specific schema.
List<Entry>	loadMatchingRuleUses(String... schemaNames) Build a list of MatchingRuleUses read from the underlying storage for a list of specified schema names
List<Entry>	loadNameForms(Schema... schemas) Build a list of NameForms read from the underlying storage for a list of specific schema.
List<Entry>	loadNameForms(String... schemaNames) Build a list of NameForms read from the underlying storage for a list of specified schema names
List<Entry>	loadNormalizers(Schema... schemas) Build a list of Normalizers read from the underlying storage for a list of specified schema
List<Entry>	loadNormalizers(String... schemaNames) Build a list of Normalizers read from the underlying storage for a list of specified schema names
List<Entry>	loadObjectClasses(Schema... schemas) Build a list of ObjectClasses read from the underlying storage for a list of specific schema.
List<Entry>	loadObjectClasses(String... schemaNames) Build a list of ObjectClasses read from the underlying storage for a list of specified schema names
List<Entry>	loadSyntaxCheckers(Schema... schemas) Build a list of SyntaxCheckers read from the underlying storage for a list of specified schema
List<Entry>	loadSyntaxCheckers(String... schemaNames) Build a list of SyntaxCheckers read from the underlying storage for a list of specified schema names
List<Entry>	loadSyntaxes(Schema... schemas) Build a list of Syntaxes read from the underlying storage for a list of specified schema
List<Entry>	loadSyntaxes(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	setListener(SchemaLoaderListener listener) Sets listener used to notify of newly loaded schemas.

Method Detail

setListener

void setListener(SchemaLoaderListener listener)

Sets listener used to notify of newly loaded schemas.

Parameters:

listener - the listener to notify (only one is enough for us)

getSchema

Schema getSchema(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

List<Entry> loadAttributeTypes(Schema... schemas)
                               throws LdapException,
                                      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:

Exception - if there are failures accessing AttributeType information

LdapException

IOException

loadAttributeTypes

List<Entry> loadAttributeTypes(String... schemaNames)
                               throws 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:

Exception - if there are failures accessing AttributeType information

loadComparators

List<Entry> loadComparators(Schema... schemas)
                            throws LdapException,
                                   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:

Exception - if there are failures accessing Comparator information

LdapException

IOException

loadComparators

List<Entry> loadComparators(String... schemaNames)
                            throws 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:

Exception - if there are failures accessing Comparator information

loadDitContentRules

List<Entry> loadDitContentRules(Schema... schemas)
                                throws LdapException,
                                       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:

Exception - if there are failures accessing DitContentRule information

LdapException

IOException

loadDitContentRules

List<Entry> loadDitContentRules(String... schemaNames)
                                throws 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:

Exception - if there are failures accessing DitContentRule information

loadDitStructureRules

List<Entry> loadDitStructureRules(Schema... schemas)
                                  throws LdapException,
                                         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:

Exception - if there are failures accessing DitStructureRule information

LdapException

IOException

loadDitStructureRules

List<Entry> loadDitStructureRules(String... schemaNames)
                                  throws 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:

Exception - if there are failures accessing DitStructureRule information

loadMatchingRules

List<Entry> loadMatchingRules(Schema... schemas)
                              throws LdapException,
                                     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:

Exception - if there are failures accessing MatchingRule information

LdapException

IOException

loadMatchingRules

List<Entry> loadMatchingRules(String... schemaNames)
                              throws 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:

Exception - if there are failures accessing MatchingRule information

loadMatchingRuleUses

List<Entry> loadMatchingRuleUses(Schema... schemas)
                                 throws LdapException,
                                        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:

Exception - if there are failures accessing MatchingRuleUse information

LdapException

IOException

loadMatchingRuleUses

List<Entry> loadMatchingRuleUses(String... schemaNames)
                                 throws 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:

Exception - if there are failures accessing MatchingRuleUses information

loadNameForms

List<Entry> loadNameForms(Schema... schemas)
                          throws LdapException,
                                 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:

Exception - if there are failures accessing NameForm information

LdapException

IOException

loadNameForms

List<Entry> loadNameForms(String... schemaNames)
                          throws 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:

Exception - if there are failures accessing NameForms information

loadNormalizers

List<Entry> loadNormalizers(Schema... schemas)
                            throws LdapException,
                                   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:

Exception - if there are failures accessing Normalizer information

LdapException

IOException

loadNormalizers

List<Entry> loadNormalizers(String... schemaNames)
                            throws 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:

Exception - if there are failures accessing Normalizer information

loadObjectClasses

List<Entry> loadObjectClasses(Schema... schemas)
                              throws LdapException,
                                     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:

Exception - if there are failures accessing ObjectClass information

LdapException

IOException

loadObjectClasses

List<Entry> loadObjectClasses(String... schemaNames)
                              throws 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:

Exception - if there are failures accessing ObjectClasses information

loadSyntaxes

List<Entry> loadSyntaxes(Schema... schemas)
                         throws LdapException,
                                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:

Exception - if there are failures accessing Syntax information

LdapException

IOException

loadSyntaxes

List<Entry> loadSyntaxes(String... schemaNames)
                         throws 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:

Exception - if there are failures accessing Syntax information

loadSyntaxCheckers

List<Entry> loadSyntaxCheckers(Schema... schemas)
                               throws LdapException,
                                      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:

Exception - if there are failures accessing SyntaxChecker information

LdapException

IOException

loadSyntaxCheckers

List<Entry> loadSyntaxCheckers(String... schemaNames)
                               throws 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:

Exception - if there are failures accessing SyntaxChecker information

getAllEnabled

Collection<Schema> getAllEnabled()
                                 throws Exception

Returns:

the list of enabled schemas

Throws:

Exception - TODO

getAllSchemas

Collection<Schema> getAllSchemas()
                                 throws Exception

Returns:

the list of all schemas

Throws:

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