org.apache.directory.server.config

Class ConfigPartitionReader

java.lang.Object

org.apache.directory.server.config.ConfigPartitionReader

public class ConfigPartitionReader
extends java.lang.Object

A class used for reading the configuration present in a Partition and instantiate the necessary objects like DirectoryService, Interceptors etc.

Field Summary

Fields

Modifier and Type	Field and Description
private static java.lang.String	ADS_PREFIX The prefix for all the configuration ObjectClass names
private static java.lang.String	ADS_SUFFIX The suffix for the bean
private AbstractBTreePartition	configPartition the partition which holds the configuration data
private static org.slf4j.Logger	LOG The logger for this class
private org.apache.directory.api.ldap.model.schema.SchemaManager	schemaManager the schema manager set in the config partition
private SearchEngine	se the search engine of the partition

Constructor Summary

Constructors

Constructor and Description
ConfigPartitionReader(AbstractBTreePartition configPartition) Creates a new instance of ConfigPartitionReader.

Method Summary

Modifier and Type	Method and Description
private AdsBaseBean	createBean(org.apache.directory.api.ldap.model.schema.ObjectClass objectClass) Create the base Bean from the ObjectClass name.
private org.apache.directory.api.ldap.model.schema.ObjectClass	findObjectClass(org.apache.directory.api.ldap.model.entry.Attribute objectClass) Find the upper objectclass in a hierarchy.
private boolean	isMultiple(java.lang.Class<?> clazz) Indicates the given type is multiple.
java.util.List<AdsBaseBean>	read(org.apache.directory.api.ldap.model.name.Dn baseDn, java.lang.String name, org.apache.directory.api.ldap.model.message.SearchScope scope, boolean mandatory) Read some configuration element from the DIT using its name
ConfigBean	readConfig() Read the configuration from the DIT, returning a bean containing all of it.
ConfigBean	readConfig(org.apache.directory.api.ldap.model.name.Dn baseDn) Read the configuration from the DIT, returning a bean containing all of it.
ConfigBean	readConfig(org.apache.directory.api.ldap.model.name.Dn baseDn, java.lang.String objectClass) Read the configuration from the DIT, returning a bean containing all of it.
AdsBaseBean	readConfig(org.apache.directory.api.ldap.model.entry.Entry entry) Creates a configuration bean from the given entry.
ConfigBean	readConfig(java.lang.String baseDn) Read the configuration from the DIT, returning a bean containing all of it.
ConfigBean	readConfig(java.lang.String baseDn, java.lang.String objectClass) Read the configuration from the DIT, returning a bean containing all of it.
private void	readFieldValue(AdsBaseBean bean, java.lang.reflect.Field field, org.apache.directory.api.ldap.model.entry.Entry entry, java.lang.String attributeTypeName, boolean mandatory)
private void	readMultiValuedField(AdsBaseBean bean, java.lang.reflect.Field field, org.apache.directory.api.ldap.model.entry.Attribute attribute) Read the multiple entry value for an AttributeType, and feed the Bean field with this value
private void	readSingleValueField(AdsBaseBean bean, java.lang.reflect.Field beanField, org.apache.directory.api.ldap.model.entry.Attribute fieldAttr) Read the single entry value for an AttributeType, and feed the Bean field with this value

Methods inherited from class java.lang.Object

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

Field Detail

LOG

private static final org.slf4j.Logger LOG

The logger for this class

configPartition

private AbstractBTreePartition configPartition

the partition which holds the configuration data

se

private SearchEngine se

the search engine of the partition

schemaManager

private org.apache.directory.api.ldap.model.schema.SchemaManager schemaManager

the schema manager set in the config partition

ADS_PREFIX

private static final java.lang.String ADS_PREFIX

The prefix for all the configuration ObjectClass names

See Also:

Constant Field Values

ADS_SUFFIX

private static final java.lang.String ADS_SUFFIX

The suffix for the bean

See Also:

Constant Field Values

Constructor Detail

ConfigPartitionReader

public ConfigPartitionReader(AbstractBTreePartition configPartition)

Creates a new instance of ConfigPartitionReader.

Parameters:

configPartition - the non null config partition

Method Detail

findObjectClass

private org.apache.directory.api.ldap.model.schema.ObjectClass findObjectClass(org.apache.directory.api.ldap.model.entry.Attribute objectClass)
                                                                        throws java.lang.Exception

Find the upper objectclass in a hierarchy. All the inherited ObjectClasses will be removed.

Throws:

java.lang.Exception

createBean

private AdsBaseBean createBean(org.apache.directory.api.ldap.model.schema.ObjectClass objectClass)
                        throws ConfigurationException

Create the base Bean from the ObjectClass name. The bean name is constructed using the OjectClass name, by removing the ADS prefix, upper casing the first letter and adding "Bean" at the end. For instance, ads-directoryService wil become DirectoryServiceBean

Throws:

ConfigurationException

readSingleValueField

private void readSingleValueField(AdsBaseBean bean,
                                  java.lang.reflect.Field beanField,
                                  org.apache.directory.api.ldap.model.entry.Attribute fieldAttr)
                           throws ConfigurationException

Read the single entry value for an AttributeType, and feed the Bean field with this value

Throws:

ConfigurationException

readMultiValuedField

private void readMultiValuedField(AdsBaseBean bean,
                                  java.lang.reflect.Field field,
                                  org.apache.directory.api.ldap.model.entry.Attribute attribute)
                           throws ConfigurationException

Read the multiple entry value for an AttributeType, and feed the Bean field with this value

Throws:

ConfigurationException

readFieldValue

private void readFieldValue(AdsBaseBean bean,
                            java.lang.reflect.Field field,
                            org.apache.directory.api.ldap.model.entry.Entry entry,
                            java.lang.String attributeTypeName,
                            boolean mandatory)
                     throws ConfigurationException

Throws:

ConfigurationException

read

public java.util.List<AdsBaseBean> read(org.apache.directory.api.ldap.model.name.Dn baseDn,
                                        java.lang.String name,
                                        org.apache.directory.api.ldap.model.message.SearchScope scope,
                                        boolean mandatory)
                                 throws ConfigurationException

Read some configuration element from the DIT using its name

Throws:

ConfigurationException

readConfig

public AdsBaseBean readConfig(org.apache.directory.api.ldap.model.entry.Entry entry)
                       throws java.lang.Exception

Creates a configuration bean from the given entry.

Parameters:

entry - any configuration entry of thetype "ads-base"

Returns:

Throws:

java.lang.Exception

isMultiple

private boolean isMultiple(java.lang.Class<?> clazz)

Indicates the given type is multiple.

Parameters:

clazz - the class

Returns:

true if the given is multiple, false if not.

readConfig

public ConfigBean readConfig()
                      throws org.apache.directory.api.ldap.model.exception.LdapException

Read the configuration from the DIT, returning a bean containing all of it.

This method implicitly uses "ou=config" as base Dn

Returns:

The Config bean, containing the whole configuration

Throws:

ConfigurationException - If we had some issue reading the configuration

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

readConfig

public ConfigBean readConfig(java.lang.String baseDn)
                      throws org.apache.directory.api.ldap.model.exception.LdapException

Read the configuration from the DIT, returning a bean containing all of it.

Parameters:

base - The base Dn in the DIT where the configuration is stored

Returns:

The Config bean, containing the whole configuration

Throws:

ConfigurationException - If we had some issue reading the configuration

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

readConfig

public ConfigBean readConfig(org.apache.directory.api.ldap.model.name.Dn baseDn)
                      throws ConfigurationException

Read the configuration from the DIT, returning a bean containing all of it.

Parameters:

base - The base Dn in the DIT where the configuration is stored

Returns:

The Config bean, containing the whole configuration

Throws:

ConfigurationException - If we had some issue reading the configuration

readConfig

public ConfigBean readConfig(java.lang.String baseDn,
                             java.lang.String objectClass)
                      throws org.apache.directory.api.ldap.model.exception.LdapException

Read the configuration from the DIT, returning a bean containing all of it.

Parameters:

baseDn - The base Dn in the DIT where the configuration is stored

objectClass - The element to read from the DIT

Returns:

The bean containing the configuration for the required element

Throws:

ConfigurationException

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

readConfig

public ConfigBean readConfig(org.apache.directory.api.ldap.model.name.Dn baseDn,
                             java.lang.String objectClass)
                      throws ConfigurationException

Read the configuration from the DIT, returning a bean containing all of it.

Parameters:

baseDn - The base Dn in the DIT where the configuration is stored

objectClass - The element to read from the DIT

Returns:

The bean containing the configuration for the required element

Throws:

ConfigurationException