org.apache.directory.shared.ldap.schema.registries
Interface SchemaLoader

All Known Implementing Classes:
AbstractSchemaLoader, JarLdifSchemaLoader, LdifSchemaLoader

public interface SchemaLoader

Loads schemas into registres.

Version:
$Rev$
Author:
Apache Directory Project

Method Summary
 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.
 java.util.List<Entry> loadAttributeTypes(Schema... schemas)
          Loads a set of schemas.
 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 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(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 java.lang.Exception
Loads a set of schemas. A best effort should be made to load the dependended schemas that these schemas may rely on even if they are not included in the collection.

Parameters:
registries - the registries to populate with these schemas
check - tells if the Registries must be checked after having been loaded
schemas - the set of schemas to load
registries - the registry to load all enabled schemas into
check - tells if the Registries must be checked after having been loaded
schema - the schema to load
registries - the registries to populate with these schemas
isDepLoad - tells the loader if this load request is to satisfy a dependency
schemas - the schemas from which AttributeTypes are loaded
Returns:
the list of erros we met during the loading of schemas
Throws:
java.lang.Exception - if any kind of problems are encountered during the load List loadWithDependencies( Registries registries, boolean check, Schema... schemas ) throws Exception; /** Loads all available enabled schemas.
java.lang.Exception - if there are any failures List loadAllEnabled( Registries registries, boolean check ) throws Exception; /** Loads a single schema. Do not try to resolve dependencies while implementing this method.
java.lang.Exception - if any kind of problems are encountered during the load void load( Schema schema, Registries registries, boolean isDepLoad ) throws Exception; /** Build a list of AttributeTypes read from the underlying storage for a list of specified schema
java.lang.Exception - if there are failures accessing AttributeType information

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 java.lang.Exception
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

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 java.lang.Exception
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

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 java.lang.Exception
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

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 java.lang.Exception
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

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 java.lang.Exception
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

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 java.lang.Exception
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

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 java.lang.Exception
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

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 java.lang.Exception
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

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 java.lang.Exception
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

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 java.lang.Exception
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

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



Copyright © 2003-2011 Apache Software Foundation. All Rights Reserved.