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 java.lang.Object
implements EntityFactory

Showing how it's done ...

Field Summary

Fields

Modifier and Type	Field and Description
private AttributeClassLoader	classLoader A special ClassLoader that loads a class from the bytecode attribute
private static java.lang.String[]	EMPTY_ARRAY The empty string array.
private static java.util.List<java.lang.String>	EMPTY_LIST The empty string list.
private static org.slf4j.Logger	LOG Slf4j logger

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
private void	checkDescription(SchemaObject description, java.lang.String schemaEntity) Check that the Description is not null
private void	checkEntry(Entry entry, java.lang.String schemaEntity) Check that the Entry is not null
private LdapComparator<?>	classLoadComparator(SchemaManager schemaManager, java.lang.String oid, java.lang.String className, Attribute byteCode) Class load a comparator instances
private Normalizer	classLoadNormalizer(SchemaManager schemaManager, java.lang.String oid, java.lang.String className, Attribute byteCode) Class load a normalizer instances
private SyntaxChecker	classLoadSyntaxChecker(SchemaManager schemaManager, java.lang.String oid, java.lang.String className, Attribute byteCode) Class load a syntaxChecker instance
AttributeType	getAttributeType(SchemaManager schemaManager, Entry entry, Registries targetRegistries, java.lang.String schemaName) Construct an AttributeType from an entry representing an AttributeType.
private Attribute	getByteCode(LoadableSchemaObject description, java.lang.String objectType) Process the ByteCode attribute
private java.lang.String	getFqcn(Entry entry, java.lang.String objectType) Process the FQCN attribute
private java.lang.String	getFqcn(LoadableSchemaObject description, java.lang.String objectType) Process the FQCN attribute
LdapComparator<?>	getLdapComparator(SchemaManager schemaManager, Entry entry, Registries targetRegistries, java.lang.String schemaName) Retrieve and load a Comparator class from the DIT.
LdapComparator<?>	getLdapComparator(SchemaManager schemaManager, LdapComparatorDescription comparatorDescription, Registries targetRegistries, java.lang.String schemaName) Construct a LdapComparator from a description of a comparator.
MatchingRule	getMatchingRule(SchemaManager schemaManager, Entry entry, Registries targetRegistries, java.lang.String schemaName) Construct an MatchingRule from an entry get from the Dit
Normalizer	getNormalizer(SchemaManager schemaManager, Entry entry, Registries targetRegistries, java.lang.String schemaName) Retrieve and load a Normalizer class from the DIT.
Normalizer	getNormalizer(SchemaManager schemaManager, NormalizerDescription normalizerDescription, Registries targetRegistries, java.lang.String schemaName) Create a new instance of a Normalizer
ObjectClass	getObjectClass(SchemaManager schemaManager, Entry entry, Registries targetRegistries, java.lang.String schemaName)
private java.lang.String	getOid(Entry entry, java.lang.String objectType, boolean strict) Get an OID from an entry.
private java.lang.String	getOid(SchemaObject description, java.lang.String objectType) Get an OID from an entry.
Schema	getSchema(Entry entry) Return an instance of the Schema associated to the entry
private Schema	getSchema(java.lang.String schemaName, Registries registries) Get the schema from its name.
private java.util.List<java.lang.String>	getStrings(Attribute attr) Create a list of string from a multivalued attribute's values
private java.lang.String	getStringValue(Attribute attribute) Return a String value, from teh given Valu, even if it's a binary value
LdapSyntax	getSyntax(SchemaManager schemaManager, Entry entry, Registries targetRegistries, java.lang.String schemaName)
SyntaxChecker	getSyntaxChecker(SchemaManager schemaManager, Entry entry, Registries targetRegistries, java.lang.String schemaName) Retrieve and load a syntaxChecker class from the DIT.
SyntaxChecker	getSyntaxChecker(SchemaManager schemaManager, SyntaxCheckerDescription syntaxCheckerDescription, Registries targetRegistries, java.lang.String schemaName) Create a new instance of a SyntaxChecker
private void	setSchemaObjectProperties(SchemaObject schemaObject, Entry entry, Schema schema) Process the common attributes to all SchemaObjects : - obsolete - description - names - schemaName - specification (if any) - extensions - isReadOnly - isEnabled
private void	setSchemaObjectProperties(SchemaObject schemaObject, SchemaObject description, Schema schema) Process the common attributes to all SchemaObjects : - obsolete - description - names - schemaName - specification (if any) - extensions - isReadOnly - isEnabled

Methods inherited from class java.lang.Object

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

Field Detail

LOG

private static final org.slf4j.Logger LOG

Slf4j logger

EMPTY_LIST

private static final java.util.List<java.lang.String> EMPTY_LIST

The empty string list.

EMPTY_ARRAY

private static final java.lang.String[] EMPTY_ARRAY

The empty string array.

classLoader

private final AttributeClassLoader classLoader

A special ClassLoader that loads a class from the bytecode attribute

Constructor Detail

SchemaEntityFactory

public SchemaEntityFactory()

Instantiates a new schema entity factory.

Method Detail

getOid

private java.lang.String getOid(Entry entry,
                                java.lang.String objectType,
                                boolean strict)
                         throws LdapInvalidAttributeValueException

Get an OID from an entry. Handles the bad cases (null OID, not a valid OID, ...)

Throws:

LdapInvalidAttributeValueException

getOid

private java.lang.String getOid(SchemaObject description,
                                java.lang.String objectType)
                         throws LdapInvalidAttributeValueException

Get an OID from an entry. Handles the bad cases (null OID, not a valid OID, ...)

Throws:

LdapInvalidAttributeValueException

checkEntry

private void checkEntry(Entry entry,
                        java.lang.String schemaEntity)

Check that the Entry is not null

checkDescription

private void checkDescription(SchemaObject description,
                              java.lang.String schemaEntity)

Check that the Description is not null

getSchema

private Schema getSchema(java.lang.String schemaName,
                         Registries registries)

Get the schema from its name. Return the Other reference if there is no schema name. Throws a NPE if the schema is not loaded.

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

classLoadSyntaxChecker

private SyntaxChecker classLoadSyntaxChecker(SchemaManager schemaManager,
                                             java.lang.String oid,
                                             java.lang.String className,
                                             Attribute byteCode)
                                      throws java.lang.Exception

Class load a syntaxChecker instance

Throws:

java.lang.Exception

getSyntaxChecker

public SyntaxChecker getSyntaxChecker(SchemaManager schemaManager,
                                      Entry entry,
                                      Registries targetRegistries,
                                      java.lang.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,
                                      java.lang.String schemaName)
                               throws java.lang.Exception

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:

java.lang.Exception - If the creation has failed

classLoadComparator

private LdapComparator<?> classLoadComparator(SchemaManager schemaManager,
                                              java.lang.String oid,
                                              java.lang.String className,
                                              Attribute byteCode)
                                       throws java.lang.Exception

Class load a comparator instances

Throws:

java.lang.Exception

getLdapComparator

public LdapComparator<?> getLdapComparator(SchemaManager schemaManager,
                                           LdapComparatorDescription comparatorDescription,
                                           Registries targetRegistries,
                                           java.lang.String schemaName)
                                    throws java.lang.Exception

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:

java.lang.Exception - If the creation has failed

getLdapComparator

public LdapComparator<?> getLdapComparator(SchemaManager schemaManager,
                                           Entry entry,
                                           Registries targetRegistries,
                                           java.lang.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

classLoadNormalizer

private Normalizer classLoadNormalizer(SchemaManager schemaManager,
                                       java.lang.String oid,
                                       java.lang.String className,
                                       Attribute byteCode)
                                throws java.lang.Exception

Class load a normalizer instances

Throws:

java.lang.Exception

getNormalizer

public Normalizer getNormalizer(SchemaManager schemaManager,
                                NormalizerDescription normalizerDescription,
                                Registries targetRegistries,
                                java.lang.String schemaName)
                         throws java.lang.Exception

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:

java.lang.Exception - If the creation has failed

getNormalizer

public Normalizer getNormalizer(SchemaManager schemaManager,
                                Entry entry,
                                Registries targetRegistries,
                                java.lang.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,
                            java.lang.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:

Throws:

LdapInvalidAttributeValueException

LdapUnwillingToPerformException

getMatchingRule

public MatchingRule getMatchingRule(SchemaManager schemaManager,
                                    Entry entry,
                                    Registries targetRegistries,
                                    java.lang.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:

LdapUnwillingToPerformException

LdapInvalidAttributeValueException

getStrings

private java.util.List<java.lang.String> getStrings(Attribute attr)

Create a list of string from a multivalued attribute's values

getObjectClass

public ObjectClass getObjectClass(SchemaManager schemaManager,
                                  Entry entry,
                                  Registries targetRegistries,
                                  java.lang.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:

Throws:

LdapException

getAttributeType

public AttributeType getAttributeType(SchemaManager schemaManager,
                                      Entry entry,
                                      Registries targetRegistries,
                                      java.lang.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

LdapUnwillingToPerformException

getFqcn

private java.lang.String getFqcn(Entry entry,
                                 java.lang.String objectType)
                          throws LdapInvalidAttributeValueException

Process the FQCN attribute

Throws:

LdapInvalidAttributeValueException

getFqcn

private java.lang.String getFqcn(LoadableSchemaObject description,
                                 java.lang.String objectType)

Process the FQCN attribute

getByteCode

private Attribute getByteCode(LoadableSchemaObject description,
                              java.lang.String objectType)

Process the ByteCode attribute

getStringValue

private java.lang.String getStringValue(Attribute attribute)

Return a String value, from teh given Valu, even if it's a binary value

setSchemaObjectProperties

private void setSchemaObjectProperties(SchemaObject schemaObject,
                                       Entry entry,
                                       Schema schema)
                                throws LdapInvalidAttributeValueException

Process the common attributes to all SchemaObjects : - obsolete - description - names - schemaName - specification (if any) - extensions - isReadOnly - isEnabled

Throws:

LdapInvalidAttributeValueException

setSchemaObjectProperties

private void setSchemaObjectProperties(SchemaObject schemaObject,
                                       SchemaObject description,
                                       Schema schema)

Process the common attributes to all SchemaObjects : - obsolete - description - names - schemaName - specification (if any) - extensions - isReadOnly - isEnabled