org.apache.directory.server.core.api

Class InstanceLayout

java.lang.Object

org.apache.directory.server.core.api.AbstractLayout

org.apache.directory.server.core.api.InstanceLayout

public class InstanceLayout
extends AbstractLayout

Convenience class to encapsulate paths to various directories and files within an instance.
The default layout is :

  <instance directory>
    |
    +-- conf/
    |    |
    |    +-- config.ldif
    |    |
    |    +-- wrapper.conf
    |    |
    |    +-- log4j.properties
    |
    +-- partitions/
    |    |
    |    +-- system/
    |    |    |
    |    |    +-- master.db
    |    |    |
    |    |    +-- objectclass.db
    |    |    |
    |    |    +-- objectclass.lg
    |    |    |
    |    |    +-- <index XXX lg and db files>
    |    |
    |    +-- schema/
    |    |    |
    |    |    :
    |    |
    |    +-- <partition XXX>/
    |    |    |
    |    :    :
    |
    +-- log/
    |    |
    |   [+-- journal.ldif]
    |    |
    |    +-- <log file>
    |
    +-- run/
    |
    +-- cache/
    |
    +-- syncrepl-data/
 

Author:

Apache Directory Project

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONF_NAME
static String	LOG_NAME Static directory names
static String	PARTITIONS_NAME
static String	RUN_NAME

Constructor Summary

Constructors

Constructor and Description
InstanceLayout(File instanceDirectory) Creates a new instance of InstanceLayout.
InstanceLayout(String instanceDirectoryPath) Creates a new instance of InstanceLayout.

Method Summary

Modifier and Type	Method and Description
File	getApacheDsConfigurationLdifFile() Gets the apacheds configuration ldif file ('<instance>/conf/config.ldif').
File	getCacheDirectory() Gets the 'cache' directory ('<instance>/cache').
File	getConfDirectory() Gets the 'conf' directory ('<instance>/conf').
File	getInstanceDirectory() Gets the instance directory.
File	getLogConfigurationFile() Gets the log configuration file ('<instance>/conf/log4j.properties').
File	getLogDirectory() Gets the 'log' directory ('<instance>/log').
File	getPartitionsDirectory() Gets the 'partitions' directory ('<instance>/partitions')
File	getReplDirectory() Gets the 'replication' directory where replication journals are stored ('<instance>/syncrepl-data').
File	getRunDirectory() Gets the 'run' directory in the installation directory ('<instance>/run').
File	getWrapperConfigurationFile() Gets the wrapper configuration file ('<instance>/conf/wrapper.conf').
void	setCacheDir(File cacheDir)
void	setConfDir(File confDir)
void	setLogDir(File logDir)
void	setPartitionsDir(File partitionsDir)
void	setReplDirectory(File replDir) Sets the directory where the replication data are stored
void	setRunDir(File runDir)
String	toString()

Methods inherited from class org.apache.directory.server.core.api.AbstractLayout

getDirectory, getRequiredDirectories, getRequiredFiles, mkdirs, setRequiredDirectories, setRequiredFiles, verifyInstallation

Methods inherited from class java.lang.Object

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

Field Detail

LOG_NAME

public static final String LOG_NAME

Static directory names

See Also:

Constant Field Values

RUN_NAME

public static final String RUN_NAME

See Also:

Constant Field Values

CONF_NAME

public static final String CONF_NAME

See Also:

Constant Field Values

PARTITIONS_NAME

public static final String PARTITIONS_NAME

See Also:

Constant Field Values

Constructor Detail

InstanceLayout

public InstanceLayout(File instanceDirectory)

Creates a new instance of InstanceLayout.

Parameters:

instanceDirectory - the instance directory

InstanceLayout

public InstanceLayout(String instanceDirectoryPath)

Creates a new instance of InstanceLayout.

Parameters:

instanceDirectoryPath - the path to the instance directory

Method Detail

getConfDirectory

public File getConfDirectory()

Gets the 'conf' directory ('<instance>/conf').

Returns:

the 'conf' directory

setConfDir

public void setConfDir(File confDir)

Parameters:

confDir - the confDir to set

getCacheDirectory

public File getCacheDirectory()

Gets the 'cache' directory ('<instance>/cache').

Returns:

the 'cache' directory

setCacheDir

public void setCacheDir(File cacheDir)

Parameters:

cacheDir - the confDir to set

getLogDirectory

public File getLogDirectory()

Gets the 'log' directory ('<instance>/log').

Returns:

the 'log' directory

setLogDir

public void setLogDir(File logDir)

Parameters:

logDir - the logDir to set

getPartitionsDirectory

public File getPartitionsDirectory()

Gets the 'partitions' directory ('<instance>/partitions')

Returns:

the 'partitions' directory

setPartitionsDir

public void setPartitionsDir(File partitionsDir)

Parameters:

partitionsDir - the partitionsDir to set

getRunDirectory

public File getRunDirectory()

Gets the 'run' directory in the installation directory ('<instance>/run').

Returns:

the 'run' directory

setRunDir

public void setRunDir(File runDir)

Parameters:

runDir - the runDir to set

getInstanceDirectory

public File getInstanceDirectory()

Gets the instance directory.

Returns:

the instance directory

getLogConfigurationFile

public File getLogConfigurationFile()

Gets the log configuration file ('<instance>/conf/log4j.properties').

Returns:

the log configuration file

getWrapperConfigurationFile

public File getWrapperConfigurationFile()

Gets the wrapper configuration file ('<instance>/conf/wrapper.conf').

Returns:

the wrapper configuration file

getApacheDsConfigurationLdifFile

public File getApacheDsConfigurationLdifFile()

Gets the apacheds configuration ldif file ('<instance>/conf/config.ldif').

Returns:

the apacheds configuration ldif file

getReplDirectory

public File getReplDirectory()

Gets the 'replication' directory where replication journals are stored ('<instance>/syncrepl-data').

Returns:

the 'replication' directory

setReplDirectory

public void setReplDirectory(File replDir)

Sets the directory where the replication data are stored

Parameters:

replDir - the replication journal data directory

toString

public String toString()

Overrides:

toString in class Object

See Also:

String.toString()