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

Class LdifSchemaLoader

java.lang.Object

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

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

All Implemented Interfaces:

SchemaLoader

public class LdifSchemaLoader
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.

Field Summary

Fields

Modifier and Type	Field and Description
private java.io.File	baseDirectory directory containing the schema LDIF file for ou=schema
private static boolean	IS_DEBUG Speedup for DEBUG mode
private static java.lang.String	LDIF_EXT ldif file extension used
private java.io.FilenameFilter	ldifFilter a filter for listing all the LDIF files within a directory
private static org.slf4j.Logger	LOG static class logger
private static java.lang.String	OU_SCHEMA_LDIF ou=schema LDIF file name

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

schemaMap

Constructor Summary

Constructors

Constructor and Description
LdifSchemaLoader(java.io.File baseDirectory) Creates a new LDIF based SchemaLoader.

Method Summary

Modifier and Type	Method and Description
private java.io.File	getSchemaDirectory(Schema schema) Utility method to get the file for a schema directory.
private void	initializeSchemas() Scans for LDIF files just describing the various schema contained in the schema repository.
java.util.List<Entry>	loadAttributeTypes(Schema... schemas) Build a list of AttributeTypes read from the underlying storage for a list of specified schema
java.util.List<Entry>	loadComparators(Schema... schemas) Build a list of Comparators read from the underlying storage for a list of specific schema.
java.util.List<Entry>	loadDitContentRules(Schema... schemas) Build a list of DitContentRules read from the underlying storage for a list of specific schema.
java.util.List<Entry>	loadDitStructureRules(Schema... schemas) Build a list of DitStructureRules read from the underlying storage for a list of specific schema.
java.util.List<Entry>	loadMatchingRules(Schema... schemas) Build a list of MatchingRules read from the underlying storage for a list of specific schema
java.util.List<Entry>	loadMatchingRuleUses(Schema... schemas) Build a list of MatchingRuleUses read from the underlying storage for a list of specific schema.
java.util.List<Entry>	loadNameForms(Schema... schemas) Build a list of NameForms read from the underlying storage for a list of specific schema.
java.util.List<Entry>	loadNormalizers(Schema... schemas) Build a list of Normalizers read from the underlying storage for a list of specified schema
java.util.List<Entry>	loadObjectClasses(Schema... schemas) Build a list of ObjectClasses read from the underlying storage for a list of specific schema.
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

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

LDIF_EXT

private static final java.lang.String LDIF_EXT

ldif file extension used

See Also:

Constant Field Values

OU_SCHEMA_LDIF

private static final java.lang.String OU_SCHEMA_LDIF

ou=schema LDIF file name

See Also:

Constant Field Values

LOG

private static final org.slf4j.Logger LOG

static class logger

IS_DEBUG

private static final boolean IS_DEBUG

Speedup for DEBUG mode

baseDirectory

private final java.io.File baseDirectory

directory containing the schema LDIF file for ou=schema

ldifFilter

private final java.io.FilenameFilter ldifFilter

a filter for listing all the LDIF files within a directory

Constructor Detail

LdifSchemaLoader

public LdifSchemaLoader(java.io.File baseDirectory)
                 throws java.lang.Exception

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.

Parameters:

baseDirectory - the schema LDIF base directory

Throws:

java.lang.Exception - if the base directory does not exist or does not a valid schema.ldif file

Method Detail

initializeSchemas

private void initializeSchemas()
                        throws java.lang.Exception

Scans for LDIF files just describing the various schema contained in the schema repository.

Throws:

java.lang.Exception

getSchemaDirectory

private java.io.File getSchemaDirectory(Schema schema)

Utility method to get the file for a schema directory.

Parameters:

schema - the schema to get the file for

Returns:

the file for the specific schema directory

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

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

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

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

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

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

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

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

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

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