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:

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

public class DefaultSchemaLoader
extends org.apache.directory.api.ldap.model.schema.registries.AbstractSchemaLoader

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

Author:

Apache Directory Project

Field Summary

Fields

Modifier and Type	Field and Description
private static org.apache.directory.api.ldap.model.schema.parsers.AttributeTypeDescriptionSchemaParser	AT_DESCR_SCHEMA_PARSER The SubschemaSubentry descriptions parsers
private static org.apache.directory.api.ldap.model.schema.parsers.LdapComparatorDescriptionSchemaParser	C_DESCR_SCHEMA_PARSER
private LdapConnection	connection the connection to the ldap server
private static org.apache.directory.api.ldap.model.schema.parsers.DitContentRuleDescriptionSchemaParser	DCR_DESCR_SCHEMA_PARSER
private static String	DEFAULT_APACHEDS_VENDOR_NAME
private static org.apache.directory.api.ldap.model.schema.parsers.DitStructureRuleDescriptionSchemaParser	DSR_DESCR_SCHEMA_PARSER
private static org.slf4j.Logger	LOG the logger
private static org.apache.directory.api.ldap.model.schema.parsers.LdapSyntaxDescriptionSchemaParser	LS_DESCR_SCHEMA_PARSER
private static org.apache.directory.api.ldap.model.schema.parsers.MatchingRuleDescriptionSchemaParser	MR_DESCR_SCHEMA_PARSER
private static org.apache.directory.api.ldap.model.schema.parsers.MatchingRuleUseDescriptionSchemaParser	MRU_DESCR_SCHEMA_PARSER
private static org.apache.directory.api.ldap.model.schema.parsers.NormalizerDescriptionSchemaParser	N_DESCR_SCHEMA_PARSER
private static org.apache.directory.api.ldap.model.schema.parsers.NameFormDescriptionSchemaParser	NF_DESCR_SCHEMA_PARSER
private static org.apache.directory.api.ldap.model.schema.parsers.ObjectClassDescriptionSchemaParser	OC_DESCR_SCHEMA_PARSER
private static org.apache.directory.api.ldap.model.schema.parsers.SyntaxCheckerDescriptionSchemaParser	SC_DESCR_SCHEMA_PARSER
private org.apache.directory.api.ldap.model.name.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, org.apache.directory.api.ldap.model.name.Dn subschemaSubentryDn) Creates a new instance of NetworkSchemaLoader.

Method Summary

Modifier and Type	Method and Description
private org.apache.directory.api.ldap.model.entry.Entry	getEntry(org.apache.directory.api.ldap.model.schema.parsers.LdapComparatorDescription comparatorDescription)
private org.apache.directory.api.ldap.model.entry.Entry	getEntry(org.apache.directory.api.ldap.model.schema.parsers.NormalizerDescription normalizerDescription)
private org.apache.directory.api.ldap.model.entry.Entry	getEntry(org.apache.directory.api.ldap.model.schema.parsers.SyntaxCheckerDescription syntaxCheckerDescription)
private boolean	isApacheDs(org.apache.directory.api.ldap.model.entry.Entry rootDse) Indicates if the given Root DSE corresponds to an ApacheDS server.
private void	loadAttributeTypes(org.apache.directory.api.ldap.model.entry.Attribute attributeTypes)
List<org.apache.directory.api.ldap.model.entry.Entry>	loadAttributeTypes(org.apache.directory.api.ldap.model.schema.registries.Schema... schemas)
private void	loadComparators(org.apache.directory.api.ldap.model.entry.Attribute comparators)
List<org.apache.directory.api.ldap.model.entry.Entry>	loadComparators(org.apache.directory.api.ldap.model.schema.registries.Schema... schemas)
private void	loadDitContentRules(org.apache.directory.api.ldap.model.entry.Attribute ditContentRules)
List<org.apache.directory.api.ldap.model.entry.Entry>	loadDitContentRules(org.apache.directory.api.ldap.model.schema.registries.Schema... schemas)
private void	loadDitStructureRules(org.apache.directory.api.ldap.model.entry.Attribute ditStructureRules)
List<org.apache.directory.api.ldap.model.entry.Entry>	loadDitStructureRules(org.apache.directory.api.ldap.model.schema.registries.Schema... schemas)
private void	loadLdapSyntaxes(org.apache.directory.api.ldap.model.entry.Attribute ldapSyntaxes)
private void	loadMatchingRules(org.apache.directory.api.ldap.model.entry.Attribute matchingRules)
List<org.apache.directory.api.ldap.model.entry.Entry>	loadMatchingRules(org.apache.directory.api.ldap.model.schema.registries.Schema... schemas)
private void	loadMatchingRuleUses(org.apache.directory.api.ldap.model.entry.Attribute matchingRuleUses)
List<org.apache.directory.api.ldap.model.entry.Entry>	loadMatchingRuleUses(org.apache.directory.api.ldap.model.schema.registries.Schema... schemas)
private void	loadNameForms(org.apache.directory.api.ldap.model.entry.Attribute nameForms)
List<org.apache.directory.api.ldap.model.entry.Entry>	loadNameForms(org.apache.directory.api.ldap.model.schema.registries.Schema... schemas)
private void	loadNormalizers(org.apache.directory.api.ldap.model.entry.Attribute normalizers)
List<org.apache.directory.api.ldap.model.entry.Entry>	loadNormalizers(org.apache.directory.api.ldap.model.schema.registries.Schema... schemas)
private void	loadObjectClasses(org.apache.directory.api.ldap.model.entry.Attribute objectClasses)
List<org.apache.directory.api.ldap.model.entry.Entry>	loadObjectClasses(org.apache.directory.api.ldap.model.schema.registries.Schema... schemas)
private void	loadSchemas() Load all the schemas.
private void	loadSyntaxCheckers(org.apache.directory.api.ldap.model.entry.Attribute syntaxCheckers)
List<org.apache.directory.api.ldap.model.entry.Entry>	loadSyntaxCheckers(org.apache.directory.api.ldap.model.schema.registries.Schema... schemas)
List<org.apache.directory.api.ldap.model.entry.Entry>	loadSyntaxes(org.apache.directory.api.ldap.model.schema.registries.Schema... schemas)
void	setQuirksMode(boolean enabled) Sets the quirks mode for all the internal parsers.
private void	updateSchemas(org.apache.directory.api.ldap.model.schema.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 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 org.apache.directory.api.ldap.model.name.Dn subschemaSubentryDn

the subschemaSubentry DN

AT_DESCR_SCHEMA_PARSER

private static final org.apache.directory.api.ldap.model.schema.parsers.AttributeTypeDescriptionSchemaParser AT_DESCR_SCHEMA_PARSER

The SubschemaSubentry descriptions parsers

DSR_DESCR_SCHEMA_PARSER

private static final org.apache.directory.api.ldap.model.schema.parsers.DitStructureRuleDescriptionSchemaParser DSR_DESCR_SCHEMA_PARSER

DCR_DESCR_SCHEMA_PARSER

private static final org.apache.directory.api.ldap.model.schema.parsers.DitContentRuleDescriptionSchemaParser DCR_DESCR_SCHEMA_PARSER

MR_DESCR_SCHEMA_PARSER

private static final org.apache.directory.api.ldap.model.schema.parsers.MatchingRuleDescriptionSchemaParser MR_DESCR_SCHEMA_PARSER

MRU_DESCR_SCHEMA_PARSER

private static final org.apache.directory.api.ldap.model.schema.parsers.MatchingRuleUseDescriptionSchemaParser MRU_DESCR_SCHEMA_PARSER

NF_DESCR_SCHEMA_PARSER

private static final org.apache.directory.api.ldap.model.schema.parsers.NameFormDescriptionSchemaParser NF_DESCR_SCHEMA_PARSER

OC_DESCR_SCHEMA_PARSER

private static final org.apache.directory.api.ldap.model.schema.parsers.ObjectClassDescriptionSchemaParser OC_DESCR_SCHEMA_PARSER

LS_DESCR_SCHEMA_PARSER

private static final org.apache.directory.api.ldap.model.schema.parsers.LdapSyntaxDescriptionSchemaParser LS_DESCR_SCHEMA_PARSER

C_DESCR_SCHEMA_PARSER

private static final org.apache.directory.api.ldap.model.schema.parsers.LdapComparatorDescriptionSchemaParser C_DESCR_SCHEMA_PARSER

N_DESCR_SCHEMA_PARSER

private static final org.apache.directory.api.ldap.model.schema.parsers.NormalizerDescriptionSchemaParser N_DESCR_SCHEMA_PARSER

SC_DESCR_SCHEMA_PARSER

private static final org.apache.directory.api.ldap.model.schema.parsers.SyntaxCheckerDescriptionSchemaParser SC_DESCR_SCHEMA_PARSER

Constructor Detail

DefaultSchemaLoader

public DefaultSchemaLoader(LdapConnection connection)
                    throws org.apache.directory.api.ldap.model.exception.LdapException

Creates a new instance of DefaultSchemaLoader.

Parameters:

connection - the LDAP connection

Throws:

org.apache.directory.api.ldap.model.exception.LdapException - if the connection is not authenticated or if there are any problems while loading the schema entries

DefaultSchemaLoader

public DefaultSchemaLoader(LdapConnection connection,
                           boolean relaxed)
                    throws org.apache.directory.api.ldap.model.exception.LdapException

Creates a new instance of DefaultSchemaLoader.

Parameters:

connection - the LDAP connection

relaxed - initial setting for the relaxed mode

Throws:

org.apache.directory.api.ldap.model.exception.LdapException - if the connection is not authenticated or if there are any problems while loading the schema entries

DefaultSchemaLoader

public DefaultSchemaLoader(LdapConnection connection,
                           org.apache.directory.api.ldap.model.name.Dn subschemaSubentryDn)
                    throws org.apache.directory.api.ldap.model.exception.LdapException

Creates a new instance of NetworkSchemaLoader.

Parameters:

connection - the LDAP connection

subschemaSubentryDn - The SubschemaSubentry

Throws:

org.apache.directory.api.ldap.model.exception.LdapException - if the connection is not authenticated or if there are any problems while loading the schema entries

Method Detail

isApacheDs

private boolean isApacheDs(org.apache.directory.api.ldap.model.entry.Entry rootDse)
                    throws org.apache.directory.api.ldap.model.exception.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:

org.apache.directory.api.ldap.model.exception.LdapInvalidAttributeValueException - If the vendorName attribute contains an invalid value

loadSchemas

private void loadSchemas()
                  throws org.apache.directory.api.ldap.model.exception.LdapException

Load all the schemas.

Throws:

org.apache.directory.api.ldap.model.exception.LdapException - If one schema can't be loaded

loadAttributeTypes

private void loadAttributeTypes(org.apache.directory.api.ldap.model.entry.Attribute attributeTypes)
                         throws org.apache.directory.api.ldap.model.exception.LdapException

Throws:

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

loadComparators

private void loadComparators(org.apache.directory.api.ldap.model.entry.Attribute comparators)
                      throws org.apache.directory.api.ldap.model.exception.LdapException

Throws:

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

loadDitContentRules

private void loadDitContentRules(org.apache.directory.api.ldap.model.entry.Attribute ditContentRules)
                          throws org.apache.directory.api.ldap.model.exception.LdapException

Throws:

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

loadDitStructureRules

private void loadDitStructureRules(org.apache.directory.api.ldap.model.entry.Attribute ditStructureRules)
                            throws org.apache.directory.api.ldap.model.exception.LdapException

Throws:

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

loadLdapSyntaxes

private void loadLdapSyntaxes(org.apache.directory.api.ldap.model.entry.Attribute ldapSyntaxes)
                       throws org.apache.directory.api.ldap.model.exception.LdapException

Throws:

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

loadMatchingRules

private void loadMatchingRules(org.apache.directory.api.ldap.model.entry.Attribute matchingRules)
                        throws org.apache.directory.api.ldap.model.exception.LdapException

Throws:

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

loadMatchingRuleUses

private void loadMatchingRuleUses(org.apache.directory.api.ldap.model.entry.Attribute matchingRuleUses)
                           throws org.apache.directory.api.ldap.model.exception.LdapException

Throws:

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

loadNameForms

private void loadNameForms(org.apache.directory.api.ldap.model.entry.Attribute nameForms)
                    throws org.apache.directory.api.ldap.model.exception.LdapException

Throws:

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

loadNormalizers

private void loadNormalizers(org.apache.directory.api.ldap.model.entry.Attribute normalizers)
                      throws org.apache.directory.api.ldap.model.exception.LdapException

Throws:

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

loadObjectClasses

private void loadObjectClasses(org.apache.directory.api.ldap.model.entry.Attribute objectClasses)
                        throws org.apache.directory.api.ldap.model.exception.LdapException

Throws:

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

loadSyntaxCheckers

private void loadSyntaxCheckers(org.apache.directory.api.ldap.model.entry.Attribute syntaxCheckers)
                         throws org.apache.directory.api.ldap.model.exception.LdapException

Throws:

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

updateSchemas

private void updateSchemas(org.apache.directory.api.ldap.model.schema.SchemaObject schemaObject)

loadAttributeTypes

public List<org.apache.directory.api.ldap.model.entry.Entry> loadAttributeTypes(org.apache.directory.api.ldap.model.schema.registries.Schema... schemas)
                                                                         throws org.apache.directory.api.ldap.model.exception.LdapException,
                                                                                IOException

Throws:

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

IOException

loadComparators

public List<org.apache.directory.api.ldap.model.entry.Entry> loadComparators(org.apache.directory.api.ldap.model.schema.registries.Schema... schemas)
                                                                      throws org.apache.directory.api.ldap.model.exception.LdapException,
                                                                             IOException

Throws:

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

IOException

loadDitContentRules

public List<org.apache.directory.api.ldap.model.entry.Entry> loadDitContentRules(org.apache.directory.api.ldap.model.schema.registries.Schema... schemas)
                                                                          throws org.apache.directory.api.ldap.model.exception.LdapException,
                                                                                 IOException

Throws:

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

IOException

loadDitStructureRules

public List<org.apache.directory.api.ldap.model.entry.Entry> loadDitStructureRules(org.apache.directory.api.ldap.model.schema.registries.Schema... schemas)
                                                                            throws org.apache.directory.api.ldap.model.exception.LdapException,
                                                                                   IOException

Throws:

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

IOException

loadMatchingRuleUses

public List<org.apache.directory.api.ldap.model.entry.Entry> loadMatchingRuleUses(org.apache.directory.api.ldap.model.schema.registries.Schema... schemas)
                                                                           throws org.apache.directory.api.ldap.model.exception.LdapException,
                                                                                  IOException

Throws:

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

IOException

loadMatchingRules

public List<org.apache.directory.api.ldap.model.entry.Entry> loadMatchingRules(org.apache.directory.api.ldap.model.schema.registries.Schema... schemas)
                                                                        throws org.apache.directory.api.ldap.model.exception.LdapException,
                                                                               IOException

Throws:

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

IOException

loadNameForms

public List<org.apache.directory.api.ldap.model.entry.Entry> loadNameForms(org.apache.directory.api.ldap.model.schema.registries.Schema... schemas)
                                                                    throws org.apache.directory.api.ldap.model.exception.LdapException,
                                                                           IOException

Throws:

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

IOException

loadNormalizers

public List<org.apache.directory.api.ldap.model.entry.Entry> loadNormalizers(org.apache.directory.api.ldap.model.schema.registries.Schema... schemas)
                                                                      throws org.apache.directory.api.ldap.model.exception.LdapException,
                                                                             IOException

Throws:

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

IOException

loadObjectClasses

public List<org.apache.directory.api.ldap.model.entry.Entry> loadObjectClasses(org.apache.directory.api.ldap.model.schema.registries.Schema... schemas)
                                                                        throws org.apache.directory.api.ldap.model.exception.LdapException,
                                                                               IOException

Throws:

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

IOException

loadSyntaxCheckers

public List<org.apache.directory.api.ldap.model.entry.Entry> loadSyntaxCheckers(org.apache.directory.api.ldap.model.schema.registries.Schema... schemas)
                                                                         throws org.apache.directory.api.ldap.model.exception.LdapException,
                                                                                IOException

Throws:

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

IOException

loadSyntaxes

public List<org.apache.directory.api.ldap.model.entry.Entry> loadSyntaxes(org.apache.directory.api.ldap.model.schema.registries.Schema... schemas)
                                                                   throws org.apache.directory.api.ldap.model.exception.LdapException,
                                                                          IOException

Throws:

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

IOException

getEntry

private org.apache.directory.api.ldap.model.entry.Entry getEntry(org.apache.directory.api.ldap.model.schema.parsers.LdapComparatorDescription comparatorDescription)

getEntry

private org.apache.directory.api.ldap.model.entry.Entry getEntry(org.apache.directory.api.ldap.model.schema.parsers.SyntaxCheckerDescription syntaxCheckerDescription)

getEntry

private org.apache.directory.api.ldap.model.entry.Entry getEntry(org.apache.directory.api.ldap.model.schema.parsers.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