org.apache.directory.server.config.builder

Class ServiceBuilder

java.lang.Object

org.apache.directory.server.config.builder.ServiceBuilder

public final class ServiceBuilder
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

Method Summary

Modifier and Type	Method and Description
static org.apache.directory.server.core.authn.Authenticator	createAuthenticator(org.apache.directory.server.config.beans.AuthenticatorBean authenticatorBean) Creates a Authenticator from the configuration
static org.apache.directory.server.core.authn.Authenticator[]	createAuthenticators(List<org.apache.directory.server.config.beans.AuthenticatorBean> list) Creates the array of transports read from the DIT
static org.apache.directory.server.core.api.changelog.ChangeLog	createChangeLog(org.apache.directory.server.config.beans.ChangeLogBean changeLogBean) Read the configuration for the ChangeLog system
static org.apache.directory.server.core.api.DirectoryService	createDirectoryService(org.apache.directory.server.config.beans.DirectoryServiceBean directoryServiceBean, org.apache.directory.server.core.api.InstanceLayout instanceLayout, org.apache.directory.api.ldap.model.schema.SchemaManager schemaManager) Instantiates a DirectoryService based on the configuration present in the partition
static org.apache.directory.server.integration.http.HttpServer	createHttpServer(org.apache.directory.server.config.beans.HttpServerBean httpServerBean, org.apache.directory.server.core.api.DirectoryService directoryService) Instantiates a HttpServer based on the configuration present in the partition
static Set<org.apache.directory.server.integration.http.WebApp>	createHttpWebApps(List<org.apache.directory.server.config.beans.HttpWebAppBean> httpWebAppBeans, org.apache.directory.server.core.api.DirectoryService directoryService) Instantiates the HttpWebApps based on the configuration present in the partition
static List<org.apache.directory.server.core.api.interceptor.Interceptor>	createInterceptors(List<org.apache.directory.server.config.beans.InterceptorBean> interceptorBeans) Creates the Interceptor instances from the configuration
static org.apache.directory.server.core.partition.impl.btree.jdbm.JdbmIndex<?>	createJdbmIndex(org.apache.directory.server.core.partition.impl.btree.jdbm.JdbmPartition partition, org.apache.directory.server.config.beans.JdbmIndexBean jdbmIndexBean, org.apache.directory.server.core.api.DirectoryService directoryService) Create a new instance of a JdbmIndex from an instance of JdbmIndexBean
static org.apache.directory.server.core.partition.impl.btree.jdbm.JdbmPartition	createJdbmPartition(org.apache.directory.server.core.api.DirectoryService directoryService, org.apache.directory.server.config.beans.JdbmPartitionBean jdbmPartitionBean) Create a new instance of a JdbmPartition
static org.apache.directory.server.core.api.journal.Journal	createJournal(org.apache.directory.server.config.beans.JournalBean journalBean) Instantiate the Journal object from the stored configuration
static org.apache.directory.server.kerberos.kdc.KdcServer	createKdcServer(org.apache.directory.server.config.beans.DirectoryServiceBean directoryServiceBean, org.apache.directory.server.core.api.DirectoryService directoryService) Instantiates a DhcpServer based on the configuration present in the partition
static org.apache.directory.server.ldap.LdapServer	createLdapServer(org.apache.directory.server.config.beans.LdapServerBean ldapServerBean, org.apache.directory.server.core.api.DirectoryService directoryService) Instantiates a LdapServer based on the configuration present in the partition
static org.apache.directory.server.core.partition.impl.btree.mavibot.MavibotIndex<?>	createMavibotIndex(org.apache.directory.server.core.partition.impl.btree.mavibot.MavibotPartition partition, org.apache.directory.server.config.beans.MavibotIndexBean mavobotIndexBean, org.apache.directory.server.core.api.DirectoryService directoryService) Create a new instance of a MavibotIndex from an instance of MavibotIndexBean
static org.apache.directory.server.core.partition.impl.btree.mavibot.MavibotPartition	createMavibotPartition(org.apache.directory.server.core.api.DirectoryService directoryService, org.apache.directory.server.config.beans.MavibotPartitionBean mvbtPartitionBean)
static org.apache.directory.server.ntp.NtpServer	createNtpServer(org.apache.directory.server.config.beans.NtpServerBean ntpServerBean, org.apache.directory.server.core.api.DirectoryService directoryService) Instantiates a NtpServer based on the configuration present in the partition
static org.apache.directory.server.core.api.partition.Partition	createPartition(org.apache.directory.server.core.api.DirectoryService directoryService, org.apache.directory.server.config.beans.PartitionBean partitionBean) Create the a Partition instantiated from the configuration
static Map<String,org.apache.directory.server.core.api.partition.Partition>	createPartitions(org.apache.directory.server.core.api.DirectoryService directoryService, List<org.apache.directory.server.config.beans.PartitionBean> partitionBeans) Create the set of Partitions instantiated from the configuration
static org.apache.directory.server.core.api.authn.ppolicy.PasswordPolicyConfiguration	createPwdPolicyConfig(org.apache.directory.server.config.beans.PasswordPolicyBean passwordPolicyBean) creates the PassworddPolicyConfiguration object after reading the config entry containing pwdpolicy OC
static List<org.apache.directory.server.ldap.replication.consumer.ReplicationConsumer>	createReplConsumers(List<org.apache.directory.server.config.beans.ReplConsumerBean> replConsumerBeans) instantiate the ReplicationConsumers based on the configuration present in ReplConsumerBeans
static org.apache.directory.server.ldap.handlers.sasl.MechanismHandler	createSaslMechHandler(org.apache.directory.server.config.beans.SaslMechHandlerBean saslMechHandlerBean) Loads and instantiates a MechanismHandler from the configuration entry
static org.apache.directory.server.protocol.shared.transport.Transport	createTransport(org.apache.directory.server.config.beans.TransportBean transportBean) Creates a Transport from the configuration
static org.apache.directory.server.protocol.shared.transport.Transport[]	createTransports(org.apache.directory.server.config.beans.TransportBean[] transportBeans) Creates the array of transports read from the DIT
static List<org.apache.directory.api.ldap.model.ldif.LdifEntry>	readTestEntries(String entryFilePath) Load the Test entries

Methods inherited from class java.lang.Object

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

Method Detail

createInterceptors

public static List<org.apache.directory.server.core.api.interceptor.Interceptor> createInterceptors(List<org.apache.directory.server.config.beans.InterceptorBean> interceptorBeans)
                                                                                             throws org.apache.directory.api.ldap.model.exception.LdapException

Creates the Interceptor instances from the configuration

Parameters:

dirServiceDN - the Dn under which interceptors are configured

Returns:

a list of instantiated Interceptor objects

Throws:

Exception - If the instanciation failed

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

createPwdPolicyConfig

public static org.apache.directory.server.core.api.authn.ppolicy.PasswordPolicyConfiguration createPwdPolicyConfig(org.apache.directory.server.config.beans.PasswordPolicyBean passwordPolicyBean)

creates the PassworddPolicyConfiguration object after reading the config entry containing pwdpolicy OC

Parameters:

PasswordPolicyBean - The Bean containing the PasswordPolicy configuration

Returns:

the PasswordPolicyConfiguration object, null if the pwdpolicy entry is not present or disabled

createChangeLog

public static org.apache.directory.server.core.api.changelog.ChangeLog createChangeLog(org.apache.directory.server.config.beans.ChangeLogBean changeLogBean)

Read the configuration for the ChangeLog system

Parameters:

changelogBean - The Bean containing the ChangeLog configuration

Returns:

The instantiated ChangeLog element

createJournal

public static org.apache.directory.server.core.api.journal.Journal createJournal(org.apache.directory.server.config.beans.JournalBean journalBean)

Instantiate the Journal object from the stored configuration

Parameters:

changelogBean - The Bean containing the ChangeLog configuration

Returns:

An instance of Journal

readTestEntries

public static List<org.apache.directory.api.ldap.model.ldif.LdifEntry> readTestEntries(String entryFilePath)
                                                                                throws org.apache.directory.server.config.ConfigurationException

Load the Test entries

Parameters:

entryFilePath - The place on disk where the test entries are stored

Returns:

A list of LdifEntry elements

Throws:

org.apache.directory.server.config.ConfigurationException - If we weren't able to read the entries

createSaslMechHandler

public static org.apache.directory.server.ldap.handlers.sasl.MechanismHandler createSaslMechHandler(org.apache.directory.server.config.beans.SaslMechHandlerBean saslMechHandlerBean)
                                                                                             throws org.apache.directory.server.config.ConfigurationException

Loads and instantiates a MechanismHandler from the configuration entry

Parameters:

saslMechHandlerEntry - the entry of OC type ConfigSchemaConstants#ADS_LDAP_SERVER_SASL_MECH_HANDLER_OC

Returns:

an instance of the MechanismHandler type

Throws:

org.apache.directory.server.config.ConfigurationException - if the SASL mechanism handler cannot be created

createAuthenticator

public static org.apache.directory.server.core.authn.Authenticator createAuthenticator(org.apache.directory.server.config.beans.AuthenticatorBean authenticatorBean)
                                                                                throws org.apache.directory.server.config.ConfigurationException

Creates a Authenticator from the configuration

Parameters:

authenticatorBean - The created instance of authenticator

Returns:

An instance of authenticator if the given authenticatorBean is not disabled

Throws:

org.apache.directory.server.config.ConfigurationException

createTransport

public static org.apache.directory.server.protocol.shared.transport.Transport createTransport(org.apache.directory.server.config.beans.TransportBean transportBean)

Creates a Transport from the configuration

Parameters:

transportBean - The created instance of transport

Returns:

An instance of transport

createAuthenticators

public static org.apache.directory.server.core.authn.Authenticator[] createAuthenticators(List<org.apache.directory.server.config.beans.AuthenticatorBean> list)
                                                                                   throws org.apache.directory.server.config.ConfigurationException

Creates the array of transports read from the DIT

Parameters:

transportBeans - The array of Transport configuration

Returns:

An arry of Transport instance

Throws:

org.apache.directory.server.config.ConfigurationException

createTransports

public static org.apache.directory.server.protocol.shared.transport.Transport[] createTransports(org.apache.directory.server.config.beans.TransportBean[] transportBeans)

Creates the array of transports read from the DIT

Parameters:

transportBeans - The array of Transport configuration

Returns:

An arry of Transport instance

createNtpServer

public static org.apache.directory.server.ntp.NtpServer createNtpServer(org.apache.directory.server.config.beans.NtpServerBean ntpServerBean,
                                                                        org.apache.directory.server.core.api.DirectoryService directoryService)
                                                                 throws org.apache.directory.api.ldap.model.exception.LdapException

Instantiates a NtpServer based on the configuration present in the partition

Parameters:

ntpServerBean - The NtpServerBean containing the NtpServer configuration

Returns:

Instance of NtpServer

Throws:

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

createKdcServer

public static org.apache.directory.server.kerberos.kdc.KdcServer createKdcServer(org.apache.directory.server.config.beans.DirectoryServiceBean directoryServiceBean,
                                                                                 org.apache.directory.server.core.api.DirectoryService directoryService)
                                                                          throws org.apache.directory.api.ldap.model.exception.LdapException

Instantiates a DhcpServer based on the configuration present in the partition

Parameters:

dhcpServerBean - The DhcpServerBean containing the DhcpServer configuration

kdcServerBean - The KdcServerBean containing the KdcServer configuration

Returns:

Instance of DhcpServer

Throws:

org.apache.directory.api.ldap.model.exception.LdapException - public static DhcpServer createDhcpServer( DhcpServerBean dhcpServerBean, DirectoryService directoryService ) throws LdapException { // Fist, do nothing if the DhcpServer is disabled if ( !dhcpServerBean.isEnabled() ) { return null; } DhcpServer dhcpServer = new DhcpServer(); // The service ID dhcpServer.setServiceId( dhcpServerBean.getServerId() ); // The transports Transport[] transports = createTransports( dhcpServerBean.getTransports() ); dhcpServer.setTransports( transports ); return dhcpServer; } /** Instantiates a KdcServer based on the configuration present in the partition

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

createHttpWebApps

public static Set<org.apache.directory.server.integration.http.WebApp> createHttpWebApps(List<org.apache.directory.server.config.beans.HttpWebAppBean> httpWebAppBeans,
                                                                                         org.apache.directory.server.core.api.DirectoryService directoryService)
                                                                                  throws org.apache.directory.api.ldap.model.exception.LdapException

Instantiates the HttpWebApps based on the configuration present in the partition

Parameters:

httpWebAppBeans - The list of HttpWebAppBeans containing the HttpWebAppBeans configuration

Returns:

Instances of HttpWebAppBean

Throws:

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

createHttpServer

public static org.apache.directory.server.integration.http.HttpServer createHttpServer(org.apache.directory.server.config.beans.HttpServerBean httpServerBean,
                                                                                       org.apache.directory.server.core.api.DirectoryService directoryService)
                                                                                throws org.apache.directory.api.ldap.model.exception.LdapException

Instantiates a HttpServer based on the configuration present in the partition

Parameters:

httpServerBean - The HttpServerBean containing the HttpServer configuration

Returns:

Instance of LdapServer

Throws:

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

createLdapServer

public static org.apache.directory.server.ldap.LdapServer createLdapServer(org.apache.directory.server.config.beans.LdapServerBean ldapServerBean,
                                                                           org.apache.directory.server.core.api.DirectoryService directoryService)
                                                                    throws org.apache.directory.api.ldap.model.exception.LdapException

Instantiates a LdapServer based on the configuration present in the partition

Parameters:

ldapServerBean - The LdapServerBean containing the LdapServer configuration

Returns:

Instance of LdapServer

Throws:

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

createReplConsumers

public static List<org.apache.directory.server.ldap.replication.consumer.ReplicationConsumer> createReplConsumers(List<org.apache.directory.server.config.beans.ReplConsumerBean> replConsumerBeans)
                                                                                                           throws org.apache.directory.server.config.ConfigurationException

instantiate the ReplicationConsumers based on the configuration present in ReplConsumerBeans

Parameters:

replConsumerBeans - the list of consumers configured

Returns:

a list of ReplicationConsumer instances

Throws:

org.apache.directory.server.config.ConfigurationException

createJdbmIndex

public static org.apache.directory.server.core.partition.impl.btree.jdbm.JdbmIndex<?> createJdbmIndex(org.apache.directory.server.core.partition.impl.btree.jdbm.JdbmPartition partition,
                                                                                                      org.apache.directory.server.config.beans.JdbmIndexBean jdbmIndexBean,
                                                                                                      org.apache.directory.server.core.api.DirectoryService directoryService)

Create a new instance of a JdbmIndex from an instance of JdbmIndexBean

Parameters:

JdbmIndexBean - The JdbmIndexBean to convert

Returns:

An JdbmIndex instance

Throws:

Exception - If the instance cannot be created

createJdbmPartition

public static org.apache.directory.server.core.partition.impl.btree.jdbm.JdbmPartition createJdbmPartition(org.apache.directory.server.core.api.DirectoryService directoryService,
                                                                                                           org.apache.directory.server.config.beans.JdbmPartitionBean jdbmPartitionBean)
                                                                                                    throws org.apache.directory.server.config.ConfigurationException

Create a new instance of a JdbmPartition

Parameters:

jdbmPartitionBean - the JdbmPartition bean

Returns:

The instantiated JdbmPartition

Throws:

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

Exception - If the instance cannot be created

org.apache.directory.server.config.ConfigurationException

createPartition

public static org.apache.directory.server.core.api.partition.Partition createPartition(org.apache.directory.server.core.api.DirectoryService directoryService,
                                                                                       org.apache.directory.server.config.beans.PartitionBean partitionBean)
                                                                                throws org.apache.directory.server.config.ConfigurationException

Create the a Partition instantiated from the configuration

Parameters:

partitionBean - the Partition bean

Returns:

The instantiated Partition

Throws:

org.apache.directory.server.config.ConfigurationException - If we cannot process the Partition

createPartitions

public static Map<String,org.apache.directory.server.core.api.partition.Partition> createPartitions(org.apache.directory.server.core.api.DirectoryService directoryService,
                                                                                                    List<org.apache.directory.server.config.beans.PartitionBean> partitionBeans)
                                                                                             throws org.apache.directory.server.config.ConfigurationException

Create the set of Partitions instantiated from the configuration

Parameters:

partitionBeans - the list of Partition beans

Returns:

A Map of all the instantiated partitions

Throws:

org.apache.directory.server.config.ConfigurationException - If we cannot process some Partition

createDirectoryService

public static org.apache.directory.server.core.api.DirectoryService createDirectoryService(org.apache.directory.server.config.beans.DirectoryServiceBean directoryServiceBean,
                                                                                           org.apache.directory.server.core.api.InstanceLayout instanceLayout,
                                                                                           org.apache.directory.api.ldap.model.schema.SchemaManager schemaManager)
                                                                                    throws Exception

Instantiates a DirectoryService based on the configuration present in the partition

Parameters:

directoryServiceBean - The bean containing the configuration

baseDirectory - The working path for this DirectoryService

Returns:

An instance of DirectoryService

Throws:

Exception

createMavibotPartition

public static org.apache.directory.server.core.partition.impl.btree.mavibot.MavibotPartition createMavibotPartition(org.apache.directory.server.core.api.DirectoryService directoryService,
                                                                                                                    org.apache.directory.server.config.beans.MavibotPartitionBean mvbtPartitionBean)
                                                                                                             throws org.apache.directory.server.config.ConfigurationException

Throws:

org.apache.directory.server.config.ConfigurationException

createMavibotIndex

public static org.apache.directory.server.core.partition.impl.btree.mavibot.MavibotIndex<?> createMavibotIndex(org.apache.directory.server.core.partition.impl.btree.mavibot.MavibotPartition partition,
                                                                                                               org.apache.directory.server.config.beans.MavibotIndexBean mavobotIndexBean,
                                                                                                               org.apache.directory.server.core.api.DirectoryService directoryService)

Create a new instance of a MavibotIndex from an instance of MavibotIndexBean

Parameters:

MavibotIndexBean - The MavibotIndexBean to convert

Returns:

An MavibotIndex instance

Throws:

Exception - If the instance cannot be created