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
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.
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)
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
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

Method Detail

getSchema

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

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

getAttributeType

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.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:

org.apache.directory.api.ldap.model.exception.LdapException - If the AttributeType is invalid

getLdapComparator

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.

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

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.

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

getMatchingRule

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.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:

org.apache.directory.api.ldap.model.exception.LdapException - If the MatchingRule is invalid

getNormalizer

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

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

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.

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

getObjectClass

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

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

getSyntax

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.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:

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

getSyntaxChecker

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.

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

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

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