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:

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

public class LdifSchemaLoader
extends org.apache.directory.api.ldap.model.schema.registries.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

Field Summary

Fields

Modifier and Type	Field and Description
private File	baseDirectory directory containing the schema LDIF file for ou=schema
private static String	LDIF_EXT ldif file extension used
private FilenameFilter	ldifFilter a filter for listing all the LDIF files within a directory
private static org.slf4j.Logger	LOG static class logger
private static 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(File baseDirectory) Creates a new LDIF based SchemaLoader.

Method Summary

Modifier and Type	Method and Description
private File	getSchemaDirectory(org.apache.directory.api.ldap.model.schema.registries.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.
List<org.apache.directory.api.ldap.model.entry.Entry>	loadAttributeTypes(org.apache.directory.api.ldap.model.schema.registries.Schema... schemas)
List<org.apache.directory.api.ldap.model.entry.Entry>	loadComparators(org.apache.directory.api.ldap.model.schema.registries.Schema... schemas)
List<org.apache.directory.api.ldap.model.entry.Entry>	loadDitContentRules(org.apache.directory.api.ldap.model.schema.registries.Schema... schemas)
List<org.apache.directory.api.ldap.model.entry.Entry>	loadDitStructureRules(org.apache.directory.api.ldap.model.schema.registries.Schema... schemas)
List<org.apache.directory.api.ldap.model.entry.Entry>	loadMatchingRules(org.apache.directory.api.ldap.model.schema.registries.Schema... schemas)
List<org.apache.directory.api.ldap.model.entry.Entry>	loadMatchingRuleUses(org.apache.directory.api.ldap.model.schema.registries.Schema... schemas)
List<org.apache.directory.api.ldap.model.entry.Entry>	loadNameForms(org.apache.directory.api.ldap.model.schema.registries.Schema... schemas)
List<org.apache.directory.api.ldap.model.entry.Entry>	loadNormalizers(org.apache.directory.api.ldap.model.schema.registries.Schema... schemas)
List<org.apache.directory.api.ldap.model.entry.Entry>	loadObjectClasses(org.apache.directory.api.ldap.model.schema.registries.Schema... schemas)
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)

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 String LDIF_EXT

ldif file extension used

See Also:

Constant Field Values

OU_SCHEMA_LDIF

private static final 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

baseDirectory

private final File baseDirectory

directory containing the schema LDIF file for ou=schema

ldifFilter

private final FilenameFilter ldifFilter

a filter for listing all the LDIF files within a directory

Constructor Detail

LdifSchemaLoader

public LdifSchemaLoader(File baseDirectory)
                 throws org.apache.directory.api.ldap.model.exception.LdapException,
                        IOException

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:

org.apache.directory.api.ldap.model.exception.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

initializeSchemas

private void initializeSchemas()
                        throws org.apache.directory.api.ldap.model.exception.LdapException,
                               IOException

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

Throws:

org.apache.directory.api.ldap.model.exception.LdapException - if the schemas can't be initialized

IOException - If teh schema can't be read

getSchemaDirectory

private File getSchemaDirectory(org.apache.directory.api.ldap.model.schema.registries.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 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

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

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

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

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

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

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

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

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

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