org.apache.directory.server.configuration

Class ApacheDS

java.lang.Object

org.apache.directory.server.configuration.ApacheDS

public class ApacheDS
extends java.lang.Object

Apache Directory Server top level.

Field Summary

Fields

Modifier and Type	Field and Description
private static long	DEFAULT_SYNC_PERIOD_MILLIS Default delay between two flushes to the backend
private DirectoryService	directoryService The directory service
private LdapServer	ldapServer The LDAP server protocol handler
private java.io.File	ldifDirectory Directory where are stored the LDIF files to be loaded at startup
private java.util.List<LdifLoadFilter>	ldifFilters
private static org.slf4j.Logger	LOG
private long	synchPeriodMillis Wainting period between two flushes to the backend

Constructor Summary

Constructors

Constructor and Description
ApacheDS(LdapServer ldapServer) Creates a new instance of the ApacheDS server

Method Summary

Modifier and Type	Method and Description
private void	addFileEntry(java.io.File ldif)
private org.apache.directory.api.ldap.model.name.Dn	buildProtectedFileEntryDn(java.io.File ldif) Create a string containing a hex dump of the loaded ldif file name.
private void	ensureLdifFileBase() Check that the entry where are stored the loaded Ldif files is created.
private java.lang.String	getCanonical(java.io.File file)
DirectoryService	getDirectoryService()
LdapServer	getLdapServer()
java.io.File	getLdifDirectory() Get the directory where the LDIF files are stored
long	getSynchPeriodMillis()
private void	initSchema() initialize the schema partition by loading the schema LDIF files
boolean	isStarted()
private void	loadLdif(java.io.File ldifFile) Load a ldif into the directory.
void	loadLdifs() Load the existing LDIF files in alphabetic order
void	setLdifDirectory(java.io.File ldifDirectory)
void	setSynchPeriodMillis(long synchPeriodMillis)
void	shutdown()
void	startup() Start the server : initialize the DirectoryService start the LDAP server start the LDAPS server

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

DEFAULT_SYNC_PERIOD_MILLIS

private static final long DEFAULT_SYNC_PERIOD_MILLIS

Default delay between two flushes to the backend

See Also:

Constant Field Values

synchPeriodMillis

private long synchPeriodMillis

Wainting period between two flushes to the backend

ldifDirectory

private java.io.File ldifDirectory

Directory where are stored the LDIF files to be loaded at startup

ldifFilters

private final java.util.List<LdifLoadFilter> ldifFilters

ldapServer

private final LdapServer ldapServer

The LDAP server protocol handler

directoryService

private DirectoryService directoryService

The directory service

Constructor Detail

ApacheDS

public ApacheDS(LdapServer ldapServer)
         throws java.lang.Exception

Creates a new instance of the ApacheDS server

Parameters:

ldapServer - The ldap server protocol handler

Throws:

java.lang.Exception

Method Detail

startup

public void startup()
             throws java.lang.Exception

Start the server :

initialize the DirectoryService start the LDAP server start the LDAPS server

Throws:

NamingException - If the server cannot be started

java.io.IOException - If an IO error occurred while reading some file

java.lang.Exception

isStarted

public boolean isStarted()

shutdown

public void shutdown()
              throws java.lang.Exception

Throws:

java.lang.Exception

getLdapServer

public LdapServer getLdapServer()

getDirectoryService

public DirectoryService getDirectoryService()

getSynchPeriodMillis

public long getSynchPeriodMillis()

setSynchPeriodMillis

public void setSynchPeriodMillis(long synchPeriodMillis)

getLdifDirectory

public java.io.File getLdifDirectory()

Get the directory where the LDIF files are stored

Returns:

The directory where the LDIF files are stored

setLdifDirectory

public void setLdifDirectory(java.io.File ldifDirectory)

ensureLdifFileBase

private void ensureLdifFileBase()
                         throws java.lang.Exception

Check that the entry where are stored the loaded Ldif files is created. If not, create it. The files are stored in ou=loadedLdifFiles,ou=configuration,ou=system

Throws:

java.lang.Exception

buildProtectedFileEntryDn

private org.apache.directory.api.ldap.model.name.Dn buildProtectedFileEntryDn(java.io.File ldif)
                                                                       throws java.lang.Exception

Create a string containing a hex dump of the loaded ldif file name. It is associated with the attributeType wrt to the underlying system.

Throws:

java.lang.Exception

addFileEntry

private void addFileEntry(java.io.File ldif)
                   throws java.lang.Exception

Throws:

java.lang.Exception

getCanonical

private java.lang.String getCanonical(java.io.File file)

loadLdif

private void loadLdif(java.io.File ldifFile)
               throws java.lang.Exception

Load a ldif into the directory.

Parameters:

root - The context in which we will inject the entries

ldifFile - The ldif file to read

Throws:

NamingException - If something went wrong while loading the entries

java.lang.Exception

loadLdifs

public void loadLdifs()
               throws java.lang.Exception

Load the existing LDIF files in alphabetic order

Throws:

java.lang.Exception

initSchema

private void initSchema()
                 throws java.lang.Exception

initialize the schema partition by loading the schema LDIF files

Throws:

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