org.apache.directory.server.config.builder

Class ServiceBuilder

java.lang.Object

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

public final class ServiceBuilder
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.io.FilenameFilter	ldifFilter LDIF file filter
private static org.slf4j.Logger	LOG The logger for this class

Constructor Summary

Constructors

Modifier	Constructor and Description
private	ServiceBuilder()

Method Summary

Modifier and Type	Method and Description
static Authenticator	createAuthenticator(AuthenticatorBean authenticatorBean) Creates a Authenticator from the configuration
static Authenticator[]	createAuthenticators(java.util.List<AuthenticatorBean> list) Creates the array of transports read from the DIT
static ChangeLog	createChangeLog(ChangeLogBean changeLogBean) Read the configuration for the ChangeLog system
static DirectoryService	createDirectoryService(DirectoryServiceBean directoryServiceBean, InstanceLayout instanceLayout, org.apache.directory.api.ldap.model.schema.SchemaManager schemaManager) Instantiates a DirectoryService based on the configuration present in the partition
private static EncryptionType[]	createEncryptionTypes(java.util.List<java.lang.String> encryptionTypes) Helper method to create an Array of EncryptionTypes from an array of Strings
static HttpServer	createHttpServer(HttpServerBean httpServerBean, DirectoryService directoryService) Instantiates a HttpServer based on the configuration present in the partition
static java.util.Set<WebApp>	createHttpWebApps(java.util.List<HttpWebAppBean> httpWebAppBeans, DirectoryService directoryService) Instantiates the HttpWebApps based on the configuration present in the partition
static java.util.List<Interceptor>	createInterceptors(java.util.List<InterceptorBean> interceptorBeans) Creates the Interceptor instances from the configuration
static JdbmIndex<?>	createJdbmIndex(JdbmPartition partition, JdbmIndexBean jdbmIndexBean, DirectoryService directoryService) Create a new instance of a JdbmIndex from an instance of JdbmIndexBean
private static java.util.Set<Index<?,java.lang.String>>	createJdbmIndexes(JdbmPartition partition, java.util.List<IndexBean> indexesBeans, DirectoryService directoryService) Create the list of Index from the configuration
static JdbmPartition	createJdbmPartition(DirectoryService directoryService, JdbmPartitionBean jdbmPartitionBean) Create a new instance of a JdbmPartition
static Journal	createJournal(JournalBean journalBean) Instantiate the Journal object from the stored configuration
static KdcServer	createKdcServer(DirectoryServiceBean directoryServiceBean, DirectoryService directoryService) Instantiates a DhcpServer based on the configuration present in the partition
static LdapServer	createLdapServer(LdapServerBean ldapServerBean, DirectoryService directoryService) Instantiates a LdapServer based on the configuration present in the partition
static MavibotIndex<?>	createMavibotIndex(MavibotPartition partition, MavibotIndexBean mavobotIndexBean, DirectoryService directoryService) Create a new instance of a MavibotIndex from an instance of MavibotIndexBean
private static java.util.Set<Index<?,java.lang.String>>	createMavibotIndexes(MavibotPartition partition, java.util.List<IndexBean> indexesBeans, DirectoryService directoryService) Create the list of MavibotIndex from the configuration
static MavibotPartition	createMavibotPartition(DirectoryService directoryService, MavibotPartitionBean mvbtPartitionBean)
static NtpServer	createNtpServer(NtpServerBean ntpServerBean, DirectoryService directoryService) Instantiates a NtpServer based on the configuration present in the partition
static Partition	createPartition(DirectoryService directoryService, PartitionBean partitionBean) Create the a Partition instantiated from the configuration
static java.util.Map<java.lang.String,Partition>	createPartitions(DirectoryService directoryService, java.util.List<PartitionBean> partitionBeans) Create the set of Partitions instantiated from the configuration
static PasswordPolicyConfiguration	createPwdPolicyConfig(PasswordPolicyBean passwordPolicyBean) creates the PassworddPolicyConfiguration object after reading the config entry containing pwdpolicy OC
static java.util.List<ReplicationConsumer>	createReplConsumers(java.util.List<ReplConsumerBean> replConsumerBeans) instantiate the ReplicationConsumers based on the configuration present in ReplConsumerBeans
static MechanismHandler	createSaslMechHandler(SaslMechHandlerBean saslMechHandlerBean) Loads and instantiates a MechanismHandler from the configuration entry
static Transport	createTransport(TransportBean transportBean) Creates a Transport from the configuration
static Transport[]	createTransports(TransportBean[] transportBeans) Creates the array of transports read from the DIT
private static void	loadEntries(java.io.File ldifFile, java.util.List<org.apache.directory.api.ldap.model.ldif.LdifEntry> entries) Load the entries from a Ldif file recursively
static java.util.List<org.apache.directory.api.ldap.model.ldif.LdifEntry>	readTestEntries(java.lang.String entryFilePath) Load the Test entries
private static void	setContextEntry(PartitionBean bean, AbstractPartition partition) Sets the configured context entry if present in the given partition bean

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

ldifFilter

private static java.io.FilenameFilter ldifFilter

LDIF file filter

Constructor Detail

ServiceBuilder

private ServiceBuilder()

Method Detail

createInterceptors

public static java.util.List<Interceptor> createInterceptors(java.util.List<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:

java.lang.Exception - If the instanciation failed

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

createPwdPolicyConfig

public static PasswordPolicyConfiguration createPwdPolicyConfig(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 ChangeLog createChangeLog(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 Journal createJournal(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 java.util.List<org.apache.directory.api.ldap.model.ldif.LdifEntry> readTestEntries(java.lang.String entryFilePath)
                                                                                          throws ConfigurationException

Load the Test entries

Parameters:

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

Returns:

A list of LdifEntry elements

Throws:

ConfigurationException - If we weren't able to read the entries

loadEntries

private static void loadEntries(java.io.File ldifFile,
                                java.util.List<org.apache.directory.api.ldap.model.ldif.LdifEntry> entries)
                         throws org.apache.directory.api.ldap.model.ldif.LdapLdifException,
                                java.io.IOException

Load the entries from a Ldif file recursively

Throws:

org.apache.directory.api.ldap.model.ldif.LdapLdifException

java.io.IOException

createSaslMechHandler

public static MechanismHandler createSaslMechHandler(SaslMechHandlerBean saslMechHandlerBean)
                                              throws 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:

ConfigurationException - if the SASL mechanism handler cannot be created

createAuthenticator

public static Authenticator createAuthenticator(AuthenticatorBean authenticatorBean)
                                         throws 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:

ConfigurationException

createTransport

public static Transport createTransport(TransportBean transportBean)

Creates a Transport from the configuration

Parameters:

transportBean - The created instance of transport

Returns:

An instance of transport

createAuthenticators

public static Authenticator[] createAuthenticators(java.util.List<AuthenticatorBean> list)
                                            throws ConfigurationException

Creates the array of transports read from the DIT

Parameters:

transportBeans - The array of Transport configuration

Returns:

An arry of Transport instance

Throws:

ConfigurationException

createTransports

public static Transport[] createTransports(TransportBean[] transportBeans)

Creates the array of transports read from the DIT

Parameters:

transportBeans - The array of Transport configuration

Returns:

An arry of Transport instance

createEncryptionTypes

private static EncryptionType[] createEncryptionTypes(java.util.List<java.lang.String> encryptionTypes)

Helper method to create an Array of EncryptionTypes from an array of Strings

createNtpServer

public static NtpServer createNtpServer(NtpServerBean ntpServerBean,
                                        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 KdcServer createKdcServer(DirectoryServiceBean directoryServiceBean,
                                        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 java.util.Set<WebApp> createHttpWebApps(java.util.List<HttpWebAppBean> httpWebAppBeans,
                                                      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 HttpServer createHttpServer(HttpServerBean httpServerBean,
                                          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 LdapServer createLdapServer(LdapServerBean ldapServerBean,
                                          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 java.util.List<ReplicationConsumer> createReplConsumers(java.util.List<ReplConsumerBean> replConsumerBeans)
                                                               throws 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:

ConfigurationException

createJdbmIndex

public static JdbmIndex<?> createJdbmIndex(JdbmPartition partition,
                                           JdbmIndexBean jdbmIndexBean,
                                           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:

java.lang.Exception - If the instance cannot be created

createJdbmIndexes

private static java.util.Set<Index<?,java.lang.String>> createJdbmIndexes(JdbmPartition partition,
                                                                          java.util.List<IndexBean> indexesBeans,
                                                                          DirectoryService directoryService)

Create the list of Index from the configuration

createJdbmPartition

public static JdbmPartition createJdbmPartition(DirectoryService directoryService,
                                                JdbmPartitionBean jdbmPartitionBean)
                                         throws 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

java.lang.Exception - If the instance cannot be created

ConfigurationException

createPartition

public static Partition createPartition(DirectoryService directoryService,
                                        PartitionBean partitionBean)
                                 throws ConfigurationException

Create the a Partition instantiated from the configuration

Parameters:

partitionBean - the Partition bean

Returns:

The instantiated Partition

Throws:

ConfigurationException - If we cannot process the Partition

createPartitions

public static java.util.Map<java.lang.String,Partition> createPartitions(DirectoryService directoryService,
                                                                         java.util.List<PartitionBean> partitionBeans)
                                                                  throws 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:

ConfigurationException - If we cannot process some Partition

createDirectoryService

public static DirectoryService createDirectoryService(DirectoryServiceBean directoryServiceBean,
                                                      InstanceLayout instanceLayout,
                                                      org.apache.directory.api.ldap.model.schema.SchemaManager schemaManager)
                                               throws java.lang.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:

java.lang.Exception

createMavibotPartition

public static MavibotPartition createMavibotPartition(DirectoryService directoryService,
                                                      MavibotPartitionBean mvbtPartitionBean)
                                               throws ConfigurationException

Throws:

ConfigurationException

createMavibotIndexes

private static java.util.Set<Index<?,java.lang.String>> createMavibotIndexes(MavibotPartition partition,
                                                                             java.util.List<IndexBean> indexesBeans,
                                                                             DirectoryService directoryService)

Create the list of MavibotIndex from the configuration

createMavibotIndex

public static MavibotIndex<?> createMavibotIndex(MavibotPartition partition,
                                                 MavibotIndexBean mavobotIndexBean,
                                                 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:

java.lang.Exception - If the instance cannot be created

setContextEntry

private static void setContextEntry(PartitionBean bean,
                                    AbstractPartition partition)
                             throws ConfigurationException

Sets the configured context entry if present in the given partition bean

Parameters:

bean - the partition configuration bean

partition - the partition instance

Throws:

ConfigurationException