org.apache.directory.server

Class ApacheDsService

java.lang.Object

org.apache.directory.server.ApacheDsService

public class ApacheDsService
extends java.lang.Object

A class used to start various servers in a given InstanceLayout.

Field Summary

Fields

Modifier and Type	Field and Description
private static java.lang.String	BANNER_CHANGE_PWD
private static java.lang.String	BANNER_KERBEROS
private static java.lang.String	BANNER_LDAP
private static java.lang.String	BANNER_NTP
private LdifPartition	configPartition The configuration partition
private ConfigPartitionReader	cpReader The configuration reader instance
private org.apache.directory.api.ldap.model.schema.syntaxCheckers.CsnSyntaxChecker	csnChecker The CSN syntax checker instance
private HttpServer	httpServer The started HttpServer
private boolean	isSchemaPartitionFirstExtraction
private KdcServer	kdcServer The Change Password server instance * private ChangePasswordServer changePwdServer;/ /** The Kerberos server instance
private LdapServer	ldapServer The LDAP server instance
private static org.slf4j.Logger	LOG A logger for this class
private static java.lang.String[]	MANDATORY_ENTRY_ATOP_AT
private static java.util.Map<java.lang.String,org.apache.directory.api.ldap.model.schema.AttributeTypeOptions>	MANDATORY_ENTRY_ATOP_MAP
private NtpServer	ntpServer The NTP server instance
private LdifPartition	schemaLdifPartition The Schema partition
private org.apache.directory.api.ldap.model.schema.SchemaManager	schemaManager The SchemaManager instance
private org.apache.directory.api.ldap.model.schema.syntaxCheckers.GeneralizedTimeSyntaxChecker	timeChecker
private org.apache.directory.api.ldap.model.schema.syntaxCheckers.UuidSyntaxChecker	uuidChecker The UUID syntax checker instance

Constructor Summary

Constructors

Constructor and Description
ApacheDsService()

Method Summary

Modifier and Type	Method and Description
DirectoryService	getDirectoryService()
private void	initConfigPartition(InstanceLayout instanceLayout, DnFactory dnFactory, CacheService cacheService) initializes a LDIF partition for configuration
private DirectoryService	initDirectoryService(InstanceLayout instanceLayout, DirectoryServiceBean directoryServiceBean, CacheService cacheService, DnFactory dnFactory)
private void	initSchemaLdifPartition(InstanceLayout instanceLayout, DnFactory dnFactory) Initialize the schema partition
private void	initSchemaManager(InstanceLayout instanceLayout) Initialize the schema Manager by loading the schema LDIF files
static void	printBanner(java.lang.String bannerConstant) Print the banner for a server
void	start(InstanceLayout instanceLayout) starts various services configured according to the configuration present in the given instance's layout
private void	startHttpServer(HttpServerBean httpServerBean, DirectoryService directoryService) start the embedded HTTP server
private void	startKerberos(DirectoryServiceBean directoryServiceBean, DirectoryService directoryService) start the KERBEROS server
private void	startLdap(LdapServerBean ldapServerBean, DirectoryService directoryService) start the LDAP server
private void	startNtp(NtpServerBean ntpServerBean, DirectoryService directoryService) start the NTP server
void	stop()
void	synch()
void	updateMandatoryOpAttributes(Partition partition, DirectoryService dirService) adds mandatory operational attributes MANDATORY_ENTRY_ATOP_MAP and updates all the LDIF files.

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

A logger for this class

ldapServer

private LdapServer ldapServer

The LDAP server instance

ntpServer

private NtpServer ntpServer

The NTP server instance

kdcServer

private KdcServer kdcServer

The Change Password server instance * private ChangePasswordServer changePwdServer;/ /** The Kerberos server instance

httpServer

private HttpServer httpServer

The started HttpServer

schemaLdifPartition

private LdifPartition schemaLdifPartition

The Schema partition

schemaManager

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

The SchemaManager instance

configPartition

private LdifPartition configPartition

The configuration partition

cpReader

private ConfigPartitionReader cpReader

The configuration reader instance

uuidChecker

private org.apache.directory.api.ldap.model.schema.syntaxCheckers.UuidSyntaxChecker uuidChecker

The UUID syntax checker instance

csnChecker

private org.apache.directory.api.ldap.model.schema.syntaxCheckers.CsnSyntaxChecker csnChecker

The CSN syntax checker instance

timeChecker

private org.apache.directory.api.ldap.model.schema.syntaxCheckers.GeneralizedTimeSyntaxChecker timeChecker

MANDATORY_ENTRY_ATOP_MAP

private static final java.util.Map<java.lang.String,org.apache.directory.api.ldap.model.schema.AttributeTypeOptions> MANDATORY_ENTRY_ATOP_MAP

MANDATORY_ENTRY_ATOP_AT

private static final java.lang.String[] MANDATORY_ENTRY_ATOP_AT

isSchemaPartitionFirstExtraction

private boolean isSchemaPartitionFirstExtraction

BANNER_LDAP

private static final java.lang.String BANNER_LDAP

See Also:

Constant Field Values

BANNER_NTP

private static final java.lang.String BANNER_NTP

See Also:

Constant Field Values

BANNER_KERBEROS

private static final java.lang.String BANNER_KERBEROS

See Also:

Constant Field Values

BANNER_CHANGE_PWD

private static final java.lang.String BANNER_CHANGE_PWD

See Also:

Constant Field Values

Constructor Detail

ApacheDsService

public ApacheDsService()

Method Detail

start

public void start(InstanceLayout instanceLayout)
           throws java.lang.Exception

starts various services configured according to the configuration present in the given instance's layout

Parameters:

instanceLayout - the on disk location's layout of the intance to be started

Throws:

java.lang.Exception

initSchemaManager

private void initSchemaManager(InstanceLayout instanceLayout)
                        throws java.lang.Exception

Initialize the schema Manager by loading the schema LDIF files

Parameters:

instanceLayout - the instance layout

Throws:

java.lang.Exception - in case of any problems while extracting and writing the schema files

initSchemaLdifPartition

private void initSchemaLdifPartition(InstanceLayout instanceLayout,
                                     DnFactory dnFactory)
                              throws java.lang.Exception

Initialize the schema partition

Parameters:

instanceLayout - the instance layout

Throws:

java.lang.Exception - in case of any problems while initializing the SchemaPartition

initConfigPartition

private void initConfigPartition(InstanceLayout instanceLayout,
                                 DnFactory dnFactory,
                                 CacheService cacheService)
                          throws java.lang.Exception

initializes a LDIF partition for configuration

Parameters:

instanceLayout - the instance layout

cacheService - the Cache service

Throws:

java.lang.Exception - in case of any issues while extracting the schema

initDirectoryService

private DirectoryService initDirectoryService(InstanceLayout instanceLayout,
                                              DirectoryServiceBean directoryServiceBean,
                                              CacheService cacheService,
                                              DnFactory dnFactory)
                                       throws java.lang.Exception

Throws:

java.lang.Exception

startLdap

private void startLdap(LdapServerBean ldapServerBean,
                       DirectoryService directoryService)
                throws java.lang.Exception

start the LDAP server

Throws:

java.lang.Exception

startNtp

private void startNtp(NtpServerBean ntpServerBean,
                      DirectoryService directoryService)
               throws java.lang.Exception

start the NTP server

Throws:

java.lang.Exception

startKerberos

private void startKerberos(DirectoryServiceBean directoryServiceBean,
                           DirectoryService directoryService)
                    throws java.lang.Exception

start the KERBEROS server

Throws:

java.lang.Exception

startHttpServer

private void startHttpServer(HttpServerBean httpServerBean,
                             DirectoryService directoryService)
                      throws java.lang.Exception

start the embedded HTTP server

Throws:

java.lang.Exception

getDirectoryService

public DirectoryService getDirectoryService()

synch

public void synch()
           throws java.lang.Exception

Throws:

java.lang.Exception

stop

public void stop()
          throws java.lang.Exception

Throws:

java.lang.Exception

printBanner

public static void printBanner(java.lang.String bannerConstant)

Print the banner for a server

updateMandatoryOpAttributes

public void updateMandatoryOpAttributes(Partition partition,
                                        DirectoryService dirService)
                                 throws java.lang.Exception

adds mandatory operational attributes MANDATORY_ENTRY_ATOP_MAP and updates all the LDIF files. WARN: this method is only called for the first time when schema and config files are bootstrapped afterwards it is the responsibility of the user to ensure correctness of LDIF files if modified by hand Note: we do these modifications explicitly cause we have no idea if each entry's LDIF file has the correct values for all these mandatory attributes

Parameters:

partition - instance of the partition Note: should only be those which are loaded before starting the DirectoryService

dirService - the DirectoryService instance

Throws:

java.lang.Exception