Package org.apache.directory.api.ldap.schema.loader

Class JarLdifSchemaLoader

java.lang.Object

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

org.apache.directory.api.ldap.schema.loader.JarLdifSchemaLoader

All Implemented Interfaces:

SchemaLoader

public class JarLdifSchemaLoader
extends AbstractSchemaLoader

Loads schema data from LDIF files containing entries representing schema objects, using the meta schema format. This class is used only for tests.

Author:

Apache Directory Project

Constructor Summary

Constructors

Constructor	Description
JarLdifSchemaLoader()	Creates a new LDIF based SchemaLoader.
JarLdifSchemaLoader(boolean allowDuplicateResources)	Creates a new LDIF based SchemaLoader.

Method Summary

Modifier and Type	Method	Description
boolean	isAllowDuplicateResources()	Returns true, if loading duplicate resources is allowed.
List<Entry>	loadAttributeTypes(Schema... schemas)	Build a list of AttributeTypes read from the underlying storage for a list of specified schema
List<Entry>	loadComparators(Schema... schemas)	Build a list of Comparators read from the underlying storage for a list of specific schema.
List<Entry>	loadDitContentRules(Schema... schemas)	Build a list of DitContentRules read from the underlying storage for a list of specific schema.
List<Entry>	loadDitStructureRules(Schema... schemas)	Build a list of DitStructureRules read from the underlying storage for a list of specific schema.
List<Entry>	loadMatchingRules(Schema... schemas)	Build a list of MatchingRules read from the underlying storage for a list of specific schema
List<Entry>	loadMatchingRuleUses(Schema... schemas)	Build a list of MatchingRuleUses read from the underlying storage for a list of specific schema.
List<Entry>	loadNameForms(Schema... schemas)	Build a list of NameForms read from the underlying storage for a list of specific schema.
List<Entry>	loadNormalizers(Schema... schemas)	Build a list of Normalizers read from the underlying storage for a list of specified schema
List<Entry>	loadObjectClasses(Schema... schemas)	Build a list of ObjectClasses read from the underlying storage for a list of specific schema.
List<Entry>	loadSyntaxCheckers(Schema... schemas)	Build a list of SyntaxCheckers read from the underlying storage for a list of specified schema
List<Entry>	loadSyntaxes(Schema... schemas)	Build a list of Syntaxes read from the underlying storage for a list of specified schema

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

JarLdifSchemaLoader

public JarLdifSchemaLoader()
                    throws IOException,
                           LdapException

Creates a new LDIF based SchemaLoader. The constructor checks to make sure the supplied base directory exists and contains a schema.ldif file and if not complains about it.

Throws:

LdapException - if the base directory does not exist or does not a valid schema.ldif file

IOException - If we can't load the schema

JarLdifSchemaLoader

public JarLdifSchemaLoader(boolean allowDuplicateResources)
                    throws IOException,
                           LdapException

Creates a new LDIF based SchemaLoader. The constructor checks to make sure the supplied base directory exists and contains a schema.ldif file and if not complains about it.

Throws:

LdapException - if the base directory does not exist or does not a valid schema.ldif file

IOException - If we can't load the schema

Method Detail

isAllowDuplicateResources

public boolean isAllowDuplicateResources()

Returns true, if loading duplicate resources is allowed. E.g. loading schema definitions that are loaded several times on the classpath. In case of several files with the same name, it returns any of them. This is useful in cases when the same artefacts are loaded several times, e.g. in some testing scenarios or weird classloading situations.

loadComparators

public List<Entry> loadComparators(Schema... schemas)
                            throws LdapException,
                                   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

Returns:

The list of loaded Comparators

Throws:

LdapException - if there are failures accessing Comparator information

IOException - If we can't read the schemaObject

loadSyntaxCheckers

public List<Entry> loadSyntaxCheckers(Schema... schemas)
                               throws LdapException,
                                      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

Returns:

The list of loaded SyntaxeCheckers

Throws:

LdapException - if there are failures accessing SyntaxChecker information

IOException - If we can't read the schemaObject

loadNormalizers

public List<Entry> loadNormalizers(Schema... schemas)
                            throws LdapException,
                                   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

Returns:

The list of loaded Normalizers

Throws:

LdapException - if there are failures accessing Normalizer information

IOException - If we can't read the schemaObject

loadMatchingRules

public List<Entry> loadMatchingRules(Schema... schemas)
                              throws LdapException,
                                     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

Returns:

The list of loaded MatchingRules

Throws:

LdapException - if there are failures accessing MatchingRule information

IOException - If we can't read the schemaObject

loadSyntaxes

public List<Entry> loadSyntaxes(Schema... schemas)
                         throws LdapException,
                                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

Returns:

The list of loaded Syntaxes

Throws:

LdapException - if there are failures accessing Syntax information

IOException - If we can't read the schemaObject

loadAttributeTypes

public List<Entry> loadAttributeTypes(Schema... schemas)
                               throws LdapException,
                                      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

Returns:

The list of loaded AttributeTypes

Throws:

LdapException - if there are failures accessing AttributeType information

IOException - If we can't read the schemaObject

loadMatchingRuleUses

public List<Entry> loadMatchingRuleUses(Schema... schemas)
                                 throws LdapException,
                                        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

Returns:

The list of loaded MatchingRuleUses

Throws:

LdapException - if there are failures accessing MatchingRuleUse information

IOException - If we can't read the schemaObject

loadNameForms

public List<Entry> loadNameForms(Schema... schemas)
                          throws LdapException,
                                 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

Returns:

The list of loaded NameForms

Throws:

LdapException - if there are failures accessing NameForm information

IOException - If we can't read the schemaObject

loadDitContentRules

public List<Entry> loadDitContentRules(Schema... schemas)
                                throws LdapException,
                                       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

Returns:

The list of loaded DitContentRules

Throws:

LdapException - if there are failures accessing DitContentRule information

IOException - If we can't read the schemaObject

loadDitStructureRules

public List<Entry> loadDitStructureRules(Schema... schemas)
                                  throws LdapException,
                                         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

Returns:

The list of loaded DitStructureRules

Throws:

LdapException - if there are failures accessing DitStructureRule information

IOException - If we can't read the schemaObject

loadObjectClasses

public List<Entry> loadObjectClasses(Schema... schemas)
                              throws LdapException,
                                     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

Returns:

The list of loaded ObjectClasses

Throws:

LdapException - if there are failures accessing ObjectClass information

IOException - If we can't read the schemaObject