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

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

The empty string list.

EMPTY_ARRAY

private static final 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 String getOid(org.apache.directory.api.ldap.model.entry.Entry entry,
                      String objectType,
                      boolean strict)
               throws org.apache.directory.api.ldap.model.exception.LdapInvalidAttributeValueException

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

Throws:

org.apache.directory.api.ldap.model.exception.LdapInvalidAttributeValueException

getOid

private String getOid(org.apache.directory.api.ldap.model.schema.SchemaObject description,
                      String objectType)
               throws org.apache.directory.api.ldap.model.exception.LdapInvalidAttributeValueException

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

Throws:

org.apache.directory.api.ldap.model.exception.LdapInvalidAttributeValueException

checkEntry

private void checkEntry(org.apache.directory.api.ldap.model.entry.Entry entry,
                        String schemaEntity)

Check that the Entry is not null

checkDescription

private void checkDescription(org.apache.directory.api.ldap.model.schema.SchemaObject description,
                              String schemaEntity)

Check that the Description is not null

getSchema

private org.apache.directory.api.ldap.model.schema.registries.Schema getSchema(String schemaName,
                                                                               org.apache.directory.api.ldap.model.schema.registries.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 org.apache.directory.api.ldap.model.schema.registries.Schema getSchema(org.apache.directory.api.ldap.model.entry.Entry entry)
                                                                       throws org.apache.directory.api.ldap.model.exception.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:

org.apache.directory.api.ldap.model.exception.LdapException - If the instance can't be created

classLoadSyntaxChecker

private org.apache.directory.api.ldap.model.schema.SyntaxChecker classLoadSyntaxChecker(org.apache.directory.api.ldap.model.schema.SchemaManager schemaManager,
                                                                                        String oid,
                                                                                        String className,
                                                                                        org.apache.directory.api.ldap.model.entry.Attribute byteCode)
                                                                                 throws org.apache.directory.api.ldap.model.exception.LdapException

Class load a syntaxChecker instance

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

getSyntaxChecker

public org.apache.directory.api.ldap.model.schema.SyntaxChecker getSyntaxChecker(org.apache.directory.api.ldap.model.schema.SchemaManager schemaManager,
                                                                                 org.apache.directory.api.ldap.model.entry.Entry entry,
                                                                                 org.apache.directory.api.ldap.model.schema.registries.Registries targetRegistries,
                                                                                 String schemaName)
                                                                          throws org.apache.directory.api.ldap.model.exception.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:

org.apache.directory.api.ldap.model.exception.LdapException - if anything fails during loading

getSyntaxChecker

public org.apache.directory.api.ldap.model.schema.SyntaxChecker getSyntaxChecker(org.apache.directory.api.ldap.model.schema.SchemaManager schemaManager,
                                                                                 org.apache.directory.api.ldap.model.schema.parsers.SyntaxCheckerDescription syntaxCheckerDescription,
                                                                                 org.apache.directory.api.ldap.model.schema.registries.Registries targetRegistries,
                                                                                 String schemaName)
                                                                          throws org.apache.directory.api.ldap.model.exception.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:

org.apache.directory.api.ldap.model.exception.LdapException - If the creation has failed

classLoadComparator

private org.apache.directory.api.ldap.model.schema.LdapComparator<?> classLoadComparator(org.apache.directory.api.ldap.model.schema.SchemaManager schemaManager,
                                                                                         String oid,
                                                                                         String className,
                                                                                         org.apache.directory.api.ldap.model.entry.Attribute byteCode)
                                                                                  throws org.apache.directory.api.ldap.model.exception.LdapException

Class load a comparator instances

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

getLdapComparator

public org.apache.directory.api.ldap.model.schema.LdapComparator<?> getLdapComparator(org.apache.directory.api.ldap.model.schema.SchemaManager schemaManager,
                                                                                      org.apache.directory.api.ldap.model.schema.parsers.LdapComparatorDescription comparatorDescription,
                                                                                      org.apache.directory.api.ldap.model.schema.registries.Registries targetRegistries,
                                                                                      String schemaName)
                                                                               throws org.apache.directory.api.ldap.model.exception.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:

org.apache.directory.api.ldap.model.exception.LdapException - If the creation has failed

getLdapComparator

public org.apache.directory.api.ldap.model.schema.LdapComparator<?> getLdapComparator(org.apache.directory.api.ldap.model.schema.SchemaManager schemaManager,
                                                                                      org.apache.directory.api.ldap.model.entry.Entry entry,
                                                                                      org.apache.directory.api.ldap.model.schema.registries.Registries targetRegistries,
                                                                                      String schemaName)
                                                                               throws org.apache.directory.api.ldap.model.exception.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:

org.apache.directory.api.ldap.model.exception.LdapException - if anything fails during loading

classLoadNormalizer

private org.apache.directory.api.ldap.model.schema.Normalizer classLoadNormalizer(org.apache.directory.api.ldap.model.schema.SchemaManager schemaManager,
                                                                                  String oid,
                                                                                  String className,
                                                                                  org.apache.directory.api.ldap.model.entry.Attribute byteCode)
                                                                           throws org.apache.directory.api.ldap.model.exception.LdapException

Class load a normalizer instances

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

getNormalizer

public org.apache.directory.api.ldap.model.schema.Normalizer getNormalizer(org.apache.directory.api.ldap.model.schema.SchemaManager schemaManager,
                                                                           org.apache.directory.api.ldap.model.schema.parsers.NormalizerDescription normalizerDescription,
                                                                           org.apache.directory.api.ldap.model.schema.registries.Registries targetRegistries,
                                                                           String schemaName)
                                                                    throws org.apache.directory.api.ldap.model.exception.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:

org.apache.directory.api.ldap.model.exception.LdapException - If the creation has failed

getNormalizer

public org.apache.directory.api.ldap.model.schema.Normalizer getNormalizer(org.apache.directory.api.ldap.model.schema.SchemaManager schemaManager,
                                                                           org.apache.directory.api.ldap.model.entry.Entry entry,
                                                                           org.apache.directory.api.ldap.model.schema.registries.Registries targetRegistries,
                                                                           String schemaName)
                                                                    throws org.apache.directory.api.ldap.model.exception.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:

org.apache.directory.api.ldap.model.exception.LdapException - if anything fails during loading

getSyntax

public org.apache.directory.api.ldap.model.schema.LdapSyntax getSyntax(org.apache.directory.api.ldap.model.schema.SchemaManager schemaManager,
                                                                       org.apache.directory.api.ldap.model.entry.Entry entry,
                                                                       org.apache.directory.api.ldap.model.schema.registries.Registries targetRegistries,
                                                                       String schemaName)
                                                                throws org.apache.directory.api.ldap.model.exception.LdapInvalidAttributeValueException,
                                                                       org.apache.directory.api.ldap.model.exception.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:

org.apache.directory.api.ldap.model.exception.LdapInvalidAttributeValueException - If the Syntax does not exist

org.apache.directory.api.ldap.model.exception.LdapUnwillingToPerformException - If the schema is not loaded

getMatchingRule

public org.apache.directory.api.ldap.model.schema.MatchingRule getMatchingRule(org.apache.directory.api.ldap.model.schema.SchemaManager schemaManager,
                                                                               org.apache.directory.api.ldap.model.entry.Entry entry,
                                                                               org.apache.directory.api.ldap.model.schema.registries.Registries targetRegistries,
                                                                               String schemaName)
                                                                        throws org.apache.directory.api.ldap.model.exception.LdapUnwillingToPerformException,
                                                                               org.apache.directory.api.ldap.model.exception.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:

org.apache.directory.api.ldap.model.exception.LdapInvalidAttributeValueException - If the MatchingRule does not exist

org.apache.directory.api.ldap.model.exception.LdapUnwillingToPerformException - If the schema is not loaded

getStrings

private List<String> getStrings(org.apache.directory.api.ldap.model.entry.Attribute attr)

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

getObjectClass

public org.apache.directory.api.ldap.model.schema.ObjectClass getObjectClass(org.apache.directory.api.ldap.model.schema.SchemaManager schemaManager,
                                                                             org.apache.directory.api.ldap.model.entry.Entry entry,
                                                                             org.apache.directory.api.ldap.model.schema.registries.Registries targetRegistries,
                                                                             String schemaName)
                                                                      throws org.apache.directory.api.ldap.model.exception.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:

org.apache.directory.api.ldap.model.exception.LdapException - if anything fails during loading

getAttributeType

public org.apache.directory.api.ldap.model.schema.AttributeType getAttributeType(org.apache.directory.api.ldap.model.schema.SchemaManager schemaManager,
                                                                                 org.apache.directory.api.ldap.model.entry.Entry entry,
                                                                                 org.apache.directory.api.ldap.model.schema.registries.Registries targetRegistries,
                                                                                 String schemaName)
                                                                          throws org.apache.directory.api.ldap.model.exception.LdapInvalidAttributeValueException,
                                                                                 org.apache.directory.api.ldap.model.exception.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:

org.apache.directory.api.ldap.model.exception.LdapInvalidAttributeValueException - If the AttributeType does not exist

org.apache.directory.api.ldap.model.exception.LdapUnwillingToPerformException - If the schema is not loaded

getFqcn

private String getFqcn(org.apache.directory.api.ldap.model.entry.Entry entry,
                       String objectType)
                throws org.apache.directory.api.ldap.model.exception.LdapInvalidAttributeValueException

Process the FQCN attribute

Throws:

org.apache.directory.api.ldap.model.exception.LdapInvalidAttributeValueException

getFqcn

private String getFqcn(org.apache.directory.api.ldap.model.schema.LoadableSchemaObject description,
                       String objectType)

Process the FQCN attribute

getByteCode

private org.apache.directory.api.ldap.model.entry.Attribute getByteCode(org.apache.directory.api.ldap.model.schema.LoadableSchemaObject description,
                                                                        String objectType)

Process the ByteCode attribute

getStringValue

private String getStringValue(org.apache.directory.api.ldap.model.entry.Attribute attribute)

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

setSchemaObjectProperties

private void setSchemaObjectProperties(org.apache.directory.api.ldap.model.schema.SchemaObject schemaObject,
                                       org.apache.directory.api.ldap.model.entry.Entry entry,
                                       org.apache.directory.api.ldap.model.schema.registries.Schema schema)
                                throws org.apache.directory.api.ldap.model.exception.LdapInvalidAttributeValueException

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

Throws:

org.apache.directory.api.ldap.model.exception.LdapInvalidAttributeValueException

setSchemaObjectProperties

private void setSchemaObjectProperties(org.apache.directory.api.ldap.model.schema.SchemaObject schemaObject,
                                       org.apache.directory.api.ldap.model.schema.SchemaObject description,
                                       org.apache.directory.api.ldap.model.schema.registries.Schema schema)

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