org.apache.directory.api.ldap.schema.loader

Interface EntityFactory

All Known Implementing Classes:

SchemaEntityFactory

public interface EntityFactory

An interface to be implemented by classes needed to create Schema elements. The factory will creates schema elements based on an Entry.

Author:

Apache Directory Project

Method Summary

Modifier and Type	Method and Description
AttributeType	getAttributeType(SchemaManager schemaManager, Entry entry, Registries targetRegistries, String schemaName) Construct an AttributeType from an entry representing an AttributeType.
LdapComparator<?>	getLdapComparator(SchemaManager schemaManager, Entry entry, Registries targetRegistries, String schemaName) Retrieve and load a Comparator class from the DIT.
LdapComparator<?>	getLdapComparator(SchemaManager schemaManager, LdapComparatorDescription comparatorDescription, Registries targetRegistries, String schemaName) Construct a LdapComparator from a description of a comparator.
MatchingRule	getMatchingRule(SchemaManager schemaManager, Entry entry, Registries targetRegistries, String schemaName) Construct an MatchingRule from an entry get from the Dit
Normalizer	getNormalizer(SchemaManager schemaManager, Entry entry, Registries targetRegistries, String schemaName) Retrieve and load a Normalizer class from the DIT.
Normalizer	getNormalizer(SchemaManager schemaManager, NormalizerDescription normalizerDescription, Registries targetRegistries, String schemaName) Create a new instance of a Normalizer
ObjectClass	getObjectClass(SchemaManager schemaManager, Entry entry, Registries targetRegistries, String schemaName)
Schema	getSchema(Entry entry) Return an instance of the Schema associated to the entry
LdapSyntax	getSyntax(SchemaManager schemaManager, Entry entry, Registries targetRegistries, String schemaName)
SyntaxChecker	getSyntaxChecker(SchemaManager schemaManager, Entry entry, Registries targetRegistries, String schemaName) Retrieve and load a syntaxChecker class from the DIT.
SyntaxChecker	getSyntaxChecker(SchemaManager schemaManager, SyntaxCheckerDescription syntaxCheckerDescription, Registries targetRegistries, String schemaName) Create a new instance of a SyntaxChecker

Method Detail

getSchema

Schema getSchema(Entry entry)
          throws LdapException

Return an instance of the Schema associated to the entry

Parameters:

entry - The Schema entry

Returns:

An instance of a Schema

Throws:

LdapException - If the instance can't be created

getAttributeType

AttributeType getAttributeType(SchemaManager schemaManager,
                               Entry entry,
                               Registries targetRegistries,
                               String schemaName)
                        throws LdapException

Construct an AttributeType from an entry representing an AttributeType.

Parameters:

schemaManager - The Schema Manager

entry - The entry containing all the informations to build an AttributeType

targetRegistries - The registries containing all the enabled SchemaObjects

schemaName - The schema this SchemaObject will be part of

Returns:

An AttributeType SchemaObject

Throws:

LdapException - If the AttributeType is invalid

getLdapComparator

LdapComparator<?> getLdapComparator(SchemaManager schemaManager,
                                    LdapComparatorDescription comparatorDescription,
                                    Registries targetRegistries,
                                    String schemaName)
                             throws LdapException

Construct a LdapComparator from a description of a comparator.

Parameters:

schemaManager - The Schema Manager

comparatorDescription - The LdapComparator description object

targetRegistries - The registries containing all the enabled SchemaObjects

schemaName - The schema this SchemaObject will be part of

Returns:

A new instance of a LdapComparator

Throws:

LdapException - If the creation has failed

getLdapComparator

LdapComparator<?> getLdapComparator(SchemaManager schemaManager,
                                    Entry entry,
                                    Registries targetRegistries,
                                    String schemaName)
                             throws LdapException

Retrieve and load a Comparator class from the DIT.

Parameters:

schemaManager - The Schema Manager

entry - The entry containing all the informations to build a LdapComparator

targetRegistries - The registries containing all the enabled SchemaObjects

schemaName - The schema this SchemaObject will be part of

Returns:

the loaded Comparator

Throws:

LdapException - if anything fails during loading

getMatchingRule

MatchingRule getMatchingRule(SchemaManager schemaManager,
                             Entry entry,
                             Registries targetRegistries,
                             String schemaName)
                      throws LdapException

Construct an MatchingRule from an entry get from the Dit

Parameters:

schemaManager - The Schema Manager

entry - The entry containing all the informations to build a MatchingRule

targetRegistries - The registries containing all the enabled SchemaObjects

schemaName - The schema this SchemaObject will be part of

Returns:

A MatchingRule SchemaObject

Throws:

LdapException - If the MatchingRule is invalid

getNormalizer

Normalizer getNormalizer(SchemaManager schemaManager,
                         NormalizerDescription normalizerDescription,
                         Registries targetRegistries,
                         String schemaName)
                  throws LdapException

Create a new instance of a Normalizer

Parameters:

schemaManager - The Schema Manager

normalizerDescription - The Normalizer description object

targetRegistries - The registries containing all the enabled SchemaObjects

schemaName - The schema this SchemaObject will be part of

Returns:

A new instance of a normalizer

Throws:

LdapException - If the creation has failed

getNormalizer

Normalizer getNormalizer(SchemaManager schemaManager,
                         Entry entry,
                         Registries targetRegistries,
                         String schemaName)
                  throws LdapException

Retrieve and load a Normalizer class from the DIT.

Parameters:

schemaManager - The Schema Manager

entry - The entry containing all the informations to build a Normalizer

targetRegistries - The registries containing all the enabled SchemaObjects

schemaName - The schema this SchemaObject will be part of

Returns:

the loaded Normalizer

Throws:

LdapException - if anything fails during loading

getObjectClass

ObjectClass getObjectClass(SchemaManager schemaManager,
                           Entry entry,
                           Registries targetRegistries,
                           String schemaName)
                    throws LdapException

Parameters:

schemaManager - The Schema Manager

entry - The entry containing all the informations to build an ObjectClass

targetRegistries - The registries containing all the enabled SchemaObjects

schemaName - The schema this SchemaObject will be part of

Returns:

The loaded ObjectClass

Throws:

LdapException - if anything fails during loading

getSyntax

LdapSyntax getSyntax(SchemaManager schemaManager,
                     Entry entry,
                     Registries targetRegistries,
                     String schemaName)
              throws LdapException

Parameters:

schemaManager - The Schema Manager

entry - The entry containing all the informations to build a LdapSyntax

targetRegistries - The registries containing all the enabled SchemaObjects

schemaName - The schema this SchemaObject will be part of

Returns:

The loaded Syntax

Throws:

LdapException - if anything fails during loading

getSyntaxChecker

SyntaxChecker getSyntaxChecker(SchemaManager schemaManager,
                               Entry entry,
                               Registries targetRegistries,
                               String schemaName)
                        throws LdapException

Retrieve and load a syntaxChecker class from the DIT.

Parameters:

schemaManager - The Schema Manager

entry - The entry containing all the informations to build a SyntaxChecker

targetRegistries - The registries containing all the enabled SchemaObjects

schemaName - The schema this SchemaObject will be part of

Returns:

the loaded SyntaxChecker

Throws:

LdapException - if anything fails during loading

getSyntaxChecker

SyntaxChecker getSyntaxChecker(SchemaManager schemaManager,
                               SyntaxCheckerDescription syntaxCheckerDescription,
                               Registries targetRegistries,
                               String schemaName)
                        throws LdapException

Create a new instance of a SyntaxChecker

Parameters:

schemaManager - The Schema Manager

syntaxCheckerDescription - The SyntaxChecker description object

targetRegistries - The registries containing all the enabled SchemaObjects

schemaName - The schema this SchemaObject will be part of

Returns:

A new instance of a syntaxChecker

Throws:

LdapException - If the creation has failed