org.apache.directory.server.config

Class ConfigPartitionReader

java.lang.Object

org.apache.directory.server.config.ConfigPartitionReader

public class ConfigPartitionReader
extends Object

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

Author:

Apache Directory Project

Constructor Summary

Constructors

Constructor and Description
ConfigPartitionReader(org.apache.directory.server.core.partition.impl.btree.AbstractBTreePartition configPartition) Creates a new instance of ConfigPartitionReader.

Method Summary

Modifier and Type	Method and Description
List<AdsBaseBean>	read(org.apache.directory.api.ldap.model.name.Dn baseDn, 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, 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(String baseDn) Read the configuration from the DIT, returning a bean containing all of it.
ConfigBean	readConfig(String baseDn, String objectClass) Read the configuration from the DIT, returning a bean containing all of it.

Methods inherited from class java.lang.Object

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

Constructor Detail

ConfigPartitionReader

public ConfigPartitionReader(org.apache.directory.server.core.partition.impl.btree.AbstractBTreePartition configPartition)

Creates a new instance of ConfigPartitionReader.

Parameters:

configPartition - the non null config partition

Method Detail

read

public List<AdsBaseBean> read(org.apache.directory.api.ldap.model.name.Dn baseDn,
                              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

Parameters:

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

name - The element to read

scope - The search scope

mandatory - If the element is mandatory or not

Returns:

The list of beans read

Throws:

ConfigurationException - If the configuration cannot be read

readConfig

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

Creates a configuration bean from the given entry.

Parameters:

entry - any configuration entry of the type "ads-base"

Returns:

The ApacheDS base configuration

Throws:

Exception - If the configuration cannot be read

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(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:

baseDn - 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:

baseDn - 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(String baseDn,
                             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 - If the configuration cannot be read

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

readConfig

public ConfigBean readConfig(org.apache.directory.api.ldap.model.name.Dn baseDn,
                             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 - If the configuration cannot be read