org.apache.directory.ldap.client.api

Class DefaultSchemaLoader

java.lang.Object

org.apache.directory.api.ldap.model.schema.registries.AbstractSchemaLoader

org.apache.directory.ldap.client.api.DefaultSchemaLoader

All Implemented Interfaces:

SchemaLoader

public class DefaultSchemaLoader
extends AbstractSchemaLoader

A schema loader which uses LdapConnection to load schema from a ApacheDS serveur

Field Summary

Fields

Modifier and Type	Field and Description
private static AttributeTypeDescriptionSchemaParser	AT_DESCR_SCHEMA_PARSER The SubschemaSubentry descriptions parsers
private static LdapComparatorDescriptionSchemaParser	C_DESCR_SCHEMA_PARSER
private LdapConnection	connection the connection to the ldap server
private static DitContentRuleDescriptionSchemaParser	DCR_DESCR_SCHEMA_PARSER
private static java.lang.String	DEFAULT_APACHEDS_VENDOR_NAME
private static DitStructureRuleDescriptionSchemaParser	DSR_DESCR_SCHEMA_PARSER
private static org.slf4j.Logger	LOG the logger
private static LdapSyntaxDescriptionSchemaParser	LS_DESCR_SCHEMA_PARSER
private static MatchingRuleDescriptionSchemaParser	MR_DESCR_SCHEMA_PARSER
private static MatchingRuleUseDescriptionSchemaParser	MRU_DESCR_SCHEMA_PARSER
private static NormalizerDescriptionSchemaParser	N_DESCR_SCHEMA_PARSER
private static NameFormDescriptionSchemaParser	NF_DESCR_SCHEMA_PARSER
private static ObjectClassDescriptionSchemaParser	OC_DESCR_SCHEMA_PARSER
private static SyntaxCheckerDescriptionSchemaParser	SC_DESCR_SCHEMA_PARSER
private Dn	subschemaSubentryDn the subschemaSubentry DN

Fields inherited from class org.apache.directory.api.ldap.model.schema.registries.AbstractSchemaLoader

schemaMap

Constructor Summary

Constructors

Constructor and Description
DefaultSchemaLoader(LdapConnection connection) Creates a new instance of DefaultSchemaLoader.
DefaultSchemaLoader(LdapConnection connection, boolean relaxed) Creates a new instance of DefaultSchemaLoader.
DefaultSchemaLoader(LdapConnection connection, Dn subschemaSubentryDn) Creates a new instance of NetworkSchemaLoader.

Method Summary

Modifier and Type	Method and Description
private Entry	getEntry(LdapComparatorDescription comparatorDescription)
private Entry	getEntry(NormalizerDescription normalizerDescription)
private Entry	getEntry(SyntaxCheckerDescription syntaxCheckerDescription)
private boolean	isApacheDs(Entry rootDse) Indicates if the given Root DSE corresponds to an ApacheDS server.
private void	loadAttributeTypes(Attribute attributeTypes)
java.util.List<Entry>	loadAttributeTypes(Schema... schemas) Build a list of AttributeTypes read from the underlying storage for a list of specified schema
private void	loadComparators(Attribute comparators)
java.util.List<Entry>	loadComparators(Schema... schemas) Build a list of Comparators read from the underlying storage for a list of specific schema.
private void	loadDitContentRules(Attribute ditContentRules)
java.util.List<Entry>	loadDitContentRules(Schema... schemas) Build a list of DitContentRules read from the underlying storage for a list of specific schema.
private void	loadDitStructureRules(Attribute ditStructureRules)
java.util.List<Entry>	loadDitStructureRules(Schema... schemas) Build a list of DitStructureRules read from the underlying storage for a list of specific schema.
private void	loadLdapSyntaxes(Attribute ldapSyntaxes)
private void	loadMatchingRules(Attribute matchingRules)
java.util.List<Entry>	loadMatchingRules(Schema... schemas) Build a list of MatchingRules read from the underlying storage for a list of specific schema
private void	loadMatchingRuleUses(Attribute matchingRuleUses)
java.util.List<Entry>	loadMatchingRuleUses(Schema... schemas) Build a list of MatchingRuleUses read from the underlying storage for a list of specific schema.
private void	loadNameForms(Attribute nameForms)
java.util.List<Entry>	loadNameForms(Schema... schemas) Build a list of NameForms read from the underlying storage for a list of specific schema.
private void	loadNormalizers(Attribute normalizers)
java.util.List<Entry>	loadNormalizers(Schema... schemas) Build a list of Normalizers read from the underlying storage for a list of specified schema
private void	loadObjectClasses(Attribute objectClasses)
java.util.List<Entry>	loadObjectClasses(Schema... schemas) Build a list of ObjectClasses read from the underlying storage for a list of specific schema.
private void	loadSchemas() Load all the schemas.
private void	loadSyntaxCheckers(Attribute syntaxCheckers)
java.util.List<Entry>	loadSyntaxCheckers(Schema... schemas) Build a list of SyntaxCheckers read from the underlying storage for a list of specified schema
java.util.List<Entry>	loadSyntaxes(Schema... schemas) Build a list of Syntaxes read from the underlying storage for a list of specified schema
void	setQuirksMode(boolean enabled) Sets the quirks mode for all the internal parsers.
private void	updateSchemas(SchemaObject schemaObject)

Methods inherited from class org.apache.directory.api.ldap.model.schema.registries.AbstractSchemaLoader

addSchema, getAllEnabled, getAllSchemas, getSchema, getSchema, isRelaxed, isStrict, loadAttributeTypes, loadComparators, loadDitContentRules, loadDitStructureRules, loadMatchingRules, loadMatchingRuleUses, loadNameForms, loadNormalizers, loadObjectClasses, loadSyntaxCheckers, loadSyntaxes, removeSchema, setRelaxed

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_APACHEDS_VENDOR_NAME

private static final java.lang.String DEFAULT_APACHEDS_VENDOR_NAME

See Also:

Constant Field Values

LOG

private static final org.slf4j.Logger LOG

the logger

connection

private LdapConnection connection

the connection to the ldap server

subschemaSubentryDn

private Dn subschemaSubentryDn

the subschemaSubentry DN

AT_DESCR_SCHEMA_PARSER

private static final AttributeTypeDescriptionSchemaParser AT_DESCR_SCHEMA_PARSER

The SubschemaSubentry descriptions parsers

DSR_DESCR_SCHEMA_PARSER

private static final DitStructureRuleDescriptionSchemaParser DSR_DESCR_SCHEMA_PARSER

DCR_DESCR_SCHEMA_PARSER

private static final DitContentRuleDescriptionSchemaParser DCR_DESCR_SCHEMA_PARSER

MR_DESCR_SCHEMA_PARSER

private static final MatchingRuleDescriptionSchemaParser MR_DESCR_SCHEMA_PARSER

MRU_DESCR_SCHEMA_PARSER

private static final MatchingRuleUseDescriptionSchemaParser MRU_DESCR_SCHEMA_PARSER

NF_DESCR_SCHEMA_PARSER

private static final NameFormDescriptionSchemaParser NF_DESCR_SCHEMA_PARSER

OC_DESCR_SCHEMA_PARSER

private static final ObjectClassDescriptionSchemaParser OC_DESCR_SCHEMA_PARSER

LS_DESCR_SCHEMA_PARSER

private static final LdapSyntaxDescriptionSchemaParser LS_DESCR_SCHEMA_PARSER

C_DESCR_SCHEMA_PARSER

private static final LdapComparatorDescriptionSchemaParser C_DESCR_SCHEMA_PARSER

N_DESCR_SCHEMA_PARSER

private static final NormalizerDescriptionSchemaParser N_DESCR_SCHEMA_PARSER

SC_DESCR_SCHEMA_PARSER

private static final SyntaxCheckerDescriptionSchemaParser SC_DESCR_SCHEMA_PARSER

Constructor Detail

DefaultSchemaLoader

public DefaultSchemaLoader(LdapConnection connection)
                    throws LdapException

Creates a new instance of DefaultSchemaLoader.

Parameters:

connection - the LDAP connection

Throws:

java.lang.Exception - if the connection is not authenticated or if there are any problems while loading the schema entries

LdapException

DefaultSchemaLoader

public DefaultSchemaLoader(LdapConnection connection,
                           boolean relaxed)
                    throws LdapException

Creates a new instance of DefaultSchemaLoader.

Parameters:

connection - the LDAP connection

initial - setting for the relaxed mode

Throws:

java.lang.Exception - if the connection is not authenticated or if there are any problems while loading the schema entries

LdapException

DefaultSchemaLoader

public DefaultSchemaLoader(LdapConnection connection,
                           Dn subschemaSubentryDn)
                    throws java.lang.Exception

Creates a new instance of NetworkSchemaLoader.

Parameters:

connection - the LDAP connection

Throws:

java.lang.Exception - if the connection is not authenticated or if there are any problems while loading the schema entries

Method Detail

isApacheDs

private boolean isApacheDs(Entry rootDse)
                    throws LdapInvalidAttributeValueException

Indicates if the given Root DSE corresponds to an ApacheDS server.

Parameters:

rootDse - the Root DSE

Returns:

true if this is an ApacheDS server, false if not.

Throws:

LdapInvalidAttributeValueException

loadSchemas

private void loadSchemas()
                  throws LdapException

Load all the schemas.

Parameters:

subschemaSubentryDn -

Throws:

java.lang.Exception

LdapException

loadAttributeTypes

private void loadAttributeTypes(Attribute attributeTypes)
                         throws LdapException

Throws:

LdapException

loadComparators

private void loadComparators(Attribute comparators)
                      throws LdapException

Throws:

LdapException

loadDitContentRules

private void loadDitContentRules(Attribute ditContentRules)
                          throws LdapException

Throws:

LdapException

loadDitStructureRules

private void loadDitStructureRules(Attribute ditStructureRules)
                            throws LdapException

Throws:

LdapException

loadLdapSyntaxes

private void loadLdapSyntaxes(Attribute ldapSyntaxes)
                       throws LdapException

Throws:

LdapException

loadMatchingRules

private void loadMatchingRules(Attribute matchingRules)
                        throws LdapException

Throws:

LdapException

loadMatchingRuleUses

private void loadMatchingRuleUses(Attribute matchingRuleUses)
                           throws LdapException

Throws:

LdapException

loadNameForms

private void loadNameForms(Attribute nameForms)
                    throws LdapException

Throws:

LdapException

loadNormalizers

private void loadNormalizers(Attribute normalizers)
                      throws LdapException

Throws:

LdapException

loadObjectClasses

private void loadObjectClasses(Attribute objectClasses)
                        throws LdapException

Throws:

LdapException

loadSyntaxCheckers

private void loadSyntaxCheckers(Attribute syntaxCheckers)
                         throws LdapException

Throws:

LdapException

updateSchemas

private void updateSchemas(SchemaObject schemaObject)

loadAttributeTypes

public java.util.List<Entry> loadAttributeTypes(Schema... schemas)
                                         throws LdapException,
                                                java.io.IOException

Build a list of AttributeTypes read from the underlying storage for a list of specified schema

Parameters:

schemas - the schemas from which AttributeTypes are loaded

Throws:

LdapException

java.io.IOException

loadComparators

public java.util.List<Entry> loadComparators(Schema... schemas)
                                      throws LdapException,
                                             java.io.IOException

Build a list of Comparators read from the underlying storage for a list of specific schema.

Parameters:

schemas - the schemas from which Comparators are loaded

Throws:

LdapException

java.io.IOException

loadDitContentRules

public java.util.List<Entry> loadDitContentRules(Schema... schemas)
                                          throws LdapException,
                                                 java.io.IOException

Build a list of DitContentRules read from the underlying storage for a list of specific schema.

Parameters:

schemas - the schemas from which DitContentRules are loaded

Throws:

LdapException

java.io.IOException

loadDitStructureRules

public java.util.List<Entry> loadDitStructureRules(Schema... schemas)
                                            throws LdapException,
                                                   java.io.IOException

Build a list of DitStructureRules read from the underlying storage for a list of specific schema.

Parameters:

schemas - the schemas from which DitStructureRules are loaded

Throws:

LdapException

java.io.IOException

loadMatchingRuleUses

public java.util.List<Entry> loadMatchingRuleUses(Schema... schemas)
                                           throws LdapException,
                                                  java.io.IOException

Build a list of MatchingRuleUses read from the underlying storage for a list of specific schema.

Parameters:

schemas - the schemas from which MatchingRuleUses are loaded

Throws:

LdapException

java.io.IOException

loadMatchingRules

public java.util.List<Entry> loadMatchingRules(Schema... schemas)
                                        throws LdapException,
                                               java.io.IOException

Build a list of MatchingRules read from the underlying storage for a list of specific schema

Parameters:

schemas - the schemas from which MatchingRules are loaded

Throws:

LdapException

java.io.IOException

loadNameForms

public java.util.List<Entry> loadNameForms(Schema... schemas)
                                    throws LdapException,
                                           java.io.IOException

Build a list of NameForms read from the underlying storage for a list of specific schema.

Parameters:

schemas - the schemas from which NameForms are loaded

Throws:

LdapException

java.io.IOException

loadNormalizers

public java.util.List<Entry> loadNormalizers(Schema... schemas)
                                      throws LdapException,
                                             java.io.IOException

Build a list of Normalizers read from the underlying storage for a list of specified schema

Parameters:

schemas - the schemas from which Normalizers are loaded

Throws:

LdapException

java.io.IOException

loadObjectClasses

public java.util.List<Entry> loadObjectClasses(Schema... schemas)
                                        throws LdapException,
                                               java.io.IOException

Build a list of ObjectClasses read from the underlying storage for a list of specific schema.

Parameters:

schemas - the schemas from which ObjectClasses are loaded

Throws:

LdapException

java.io.IOException

loadSyntaxCheckers

public java.util.List<Entry> loadSyntaxCheckers(Schema... schemas)
                                         throws LdapException,
                                                java.io.IOException

Build a list of SyntaxCheckers read from the underlying storage for a list of specified schema

Parameters:

schemas - the schemas from which SyntaxCheckers are loaded

Throws:

LdapException

java.io.IOException

loadSyntaxes

public java.util.List<Entry> loadSyntaxes(Schema... schemas)
                                   throws LdapException,
                                          java.io.IOException

Build a list of Syntaxes read from the underlying storage for a list of specified schema

Parameters:

schemas - the schemas from which Syntaxes are loaded

Throws:

LdapException

java.io.IOException

getEntry

private Entry getEntry(LdapComparatorDescription comparatorDescription)

getEntry

private Entry getEntry(SyntaxCheckerDescription syntaxCheckerDescription)

getEntry

private Entry getEntry(NormalizerDescription normalizerDescription)

setQuirksMode

public void setQuirksMode(boolean enabled)

Sets the quirks mode for all the internal parsers. If enabled the parser accepts non-numeric OIDs and some special characters in descriptions.

Parameters:

enabled - the new quirks mode