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.

Author:

Apache Directory Project

Method Summary

Modifier and Type	Method and Description
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.
boolean	isRelaxed()
boolean	isStrict()
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	setRelaxed(boolean relaxed) Set the SchemzLoader in STRICT or RELAXED mode.

Method Detail

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

Returns:

The list of loaded AttributeTypes

Throws:

LdapException - if there are failures accessing AttributeType information

IOException - If we can't read the schemaObject

loadAttributeTypes

List<Entry> loadAttributeTypes(String... schemaNames)
                        throws LdapException,
                               IOException

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

Returns:

The list of loaded AttributeTypes

Throws:

LdapException - if there are failures accessing AttributeType information

IOException - If we can't read the schemaObject

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

Returns:

The list of loaded Comparators

Throws:

LdapException - if there are failures accessing Comparator information

IOException - If we can't read the schemaObject

loadComparators

List<Entry> loadComparators(String... schemaNames)
                     throws LdapException,
                            IOException

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

Returns:

The list of loaded Comparators

Throws:

LdapException - if there are failures accessing Comparator information

IOException - If we can't read the schemaObject

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

Returns:

The list of loaded DitContentRules

Throws:

LdapException - if there are failures accessing DitContentRule information

IOException - If we can't read the schemaObject

loadDitContentRules

List<Entry> loadDitContentRules(String... schemaNames)
                         throws LdapException,
                                IOException

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

Returns:

The list of loaded DitContentRules

Throws:

LdapException - if there are failures accessing DitContentRule information

IOException - If we can't read the schemaObject

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

Returns:

The list of loaded DitStructureRules

Throws:

LdapException - if there are failures accessing DitStructureRule information

IOException - If we can't read the schemaObject

loadDitStructureRules

List<Entry> loadDitStructureRules(String... schemaNames)
                           throws LdapException,
                                  IOException

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

Returns:

The list of loaded DitStructureRules

Throws:

LdapException - if there are failures accessing DitStructureRule information

IOException - If we can't read the schemaObject

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

Returns:

The list of loaded MatchingRules

Throws:

LdapException - if there are failures accessing MatchingRule information

IOException - If we can't read the schemaObject

loadMatchingRules

List<Entry> loadMatchingRules(String... schemaNames)
                       throws LdapException,
                              IOException

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

Returns:

The list of loaded MatchingRules

Throws:

LdapException - if there are failures accessing MatchingRule information

IOException - If we can't read the schemaObject

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

Returns:

The list of loaded MatchingRuleUses

Throws:

LdapException - if there are failures accessing MatchingRuleUse information

IOException - If we can't read the schemaObject

loadMatchingRuleUses

List<Entry> loadMatchingRuleUses(String... schemaNames)
                          throws LdapException,
                                 IOException

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

Returns:

The list of loaded MatchingRuleUses

Throws:

LdapException - if there are failures accessing MatchingRuleUses information

IOException - If we can't read the schemaObject

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

Returns:

The list of loaded NameForms

Throws:

LdapException - if there are failures accessing NameForm information

IOException - If we can't read the schemaObject

loadNameForms

List<Entry> loadNameForms(String... schemaNames)
                   throws LdapException,
                          IOException

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

Returns:

The list of loaded NameForms

Throws:

LdapException - if there are failures accessing NameForms information

IOException - If we can't read the schemaObject

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

Returns:

The list of loaded Normalizers

Throws:

LdapException - if there are failures accessing Normalizer information

IOException - If we can't read the schemaObject

loadNormalizers

List<Entry> loadNormalizers(String... schemaNames)
                     throws LdapException,
                            IOException

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

Returns:

The list of loaded Normalizers

Throws:

LdapException - if there are failures accessing Normalizer information

IOException - If we can't read the schemaObject

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

Returns:

The list of loaded ObjectClasses

Throws:

LdapException - if there are failures accessing ObjectClass information

IOException - If we can't read the schemaObject

loadObjectClasses

List<Entry> loadObjectClasses(String... schemaNames)
                       throws LdapException,
                              IOException

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

Returns:

The list of loaded ObjectClasses

Throws:

LdapException - if there are failures accessing ObjectClasses information

IOException - If we can't read the schemaObject

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

Returns:

The list of loaded Syntaxes

Throws:

LdapException - if there are failures accessing Syntax information

IOException - If we can't read the schemaObject

loadSyntaxes

List<Entry> loadSyntaxes(String... schemaNames)
                  throws LdapException,
                         IOException

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

Returns:

The list of loaded Syntaxes

Throws:

LdapException - if there are failures accessing Syntax information

IOException - If we can't read the schemaObject

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

Returns:

The list of loaded SyntaxeCheckers

Throws:

LdapException - if there are failures accessing SyntaxChecker information

IOException - If we can't read the schemaObject

loadSyntaxCheckers

List<Entry> loadSyntaxCheckers(String... schemaNames)
                        throws LdapException,
                               IOException

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

Returns:

A list of loaded SyntaxCheckers

Throws:

LdapException - if there are failures accessing SyntaxChecker information

IOException - If we had some issues loading the schemas

IOException - If we can't read the schemaObject

getAllEnabled

Collection<Schema> getAllEnabled()

Returns:

the list of enabled schemas

getAllSchemas

Collection<Schema> getAllSchemas()

Returns:

the list of all schemas

addSchema

void addSchema(Schema schema)

Add a new schema to the schema's list

Parameters:

schema - The schema to add

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)