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

Class SchemaEntityFactory

java.lang.Object

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

All Implemented Interfaces:

EntityFactory

public class SchemaEntityFactory
extends Object
implements EntityFactory

Showing how it's done ...

Author:

Apache Directory Project

Constructor Summary

Constructors

Constructor	Description
SchemaEntityFactory()	Instantiates a new schema entity factory.

Method Summary

Modifier and Type	Method	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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SchemaEntityFactory

public SchemaEntityFactory()

Instantiates a new schema entity factory.

Method Detail

getSchema

public Schema getSchema(Entry entry)
                 throws LdapException

Return an instance of the Schema associated to the entry

Specified by:

getSchema in interface EntityFactory

Parameters:

entry - The Schema entry

Returns:

An instance of a Schema

Throws:

LdapException - If the instance can't be created

getSyntaxChecker

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

Retrieve and load a syntaxChecker class from the DIT.

Specified by:

getSyntaxChecker in interface EntityFactory

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

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

Create a new instance of a SyntaxChecker

Specified by:

getSyntaxChecker in interface EntityFactory

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

getLdapComparator

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

Construct a LdapComparator from a description of a comparator.

Specified by:

getLdapComparator in interface EntityFactory

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

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

Retrieve and load a Comparator class from the DIT.

Specified by:

getLdapComparator in interface EntityFactory

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

getNormalizer

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

Create a new instance of a Normalizer

Specified by:

getNormalizer in interface EntityFactory

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

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

Retrieve and load a Normalizer class from the DIT.

Specified by:

getNormalizer in interface EntityFactory

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

getSyntax

public LdapSyntax getSyntax(SchemaManager schemaManager,
                            Entry entry,
                            Registries targetRegistries,
                            String schemaName)
                     throws LdapInvalidAttributeValueException,
                            LdapUnwillingToPerformException

Specified by:

getSyntax in interface EntityFactory

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:

LdapInvalidAttributeValueException - If the Syntax does not exist

LdapUnwillingToPerformException - If the schema is not loaded

getMatchingRule

public MatchingRule getMatchingRule(SchemaManager schemaManager,
                                    Entry entry,
                                    Registries targetRegistries,
                                    String schemaName)
                             throws LdapUnwillingToPerformException,
                                    LdapInvalidAttributeValueException

Construct an MatchingRule from an entry get from the Dit

Specified by:

getMatchingRule in interface EntityFactory

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:

LdapInvalidAttributeValueException - If the MatchingRule does not exist

LdapUnwillingToPerformException - If the schema is not loaded

getObjectClass

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

Specified by:

getObjectClass in interface EntityFactory

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

getAttributeType

public AttributeType getAttributeType(SchemaManager schemaManager,
                                      Entry entry,
                                      Registries targetRegistries,
                                      String schemaName)
                               throws LdapInvalidAttributeValueException,
                                      LdapUnwillingToPerformException

Construct an AttributeType from an entry representing an AttributeType.

Specified by:

getAttributeType in interface EntityFactory

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:

LdapInvalidAttributeValueException - If the AttributeType does not exist

LdapUnwillingToPerformException - If the schema is not loaded