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/

Field Summary

Fields
Modifier and Type	Field and Description
`private static java.lang.String`	`CACHE_NAME`
`private java.io.File`	`cacheDir` The cache directory
`static java.lang.String`	`CONF_NAME`
`private java.io.File`	`confDir` The Conf directory
`private static java.lang.String`	`CONFIG_LDIF`
`private static java.lang.String`	`LOG_DIR`
`static java.lang.String`	`LOG_NAME` Static directory names
`private static java.lang.String`	`LOG4J_PROPERTIES` Static file names
`private java.io.File`	`logDir` The Log directory
`static java.lang.String`	`PARTITIONS_NAME`
`private java.io.File`	`partitionsDir` The Partitions directory
`private static java.lang.String`	`REPL_NAME`
`private java.io.File`	`replDir` The replication data directory
`private static java.lang.String`	`RUN_DIR`
`static java.lang.String`	`RUN_NAME`
`private java.io.File`	`runDir` The Run directory
`private static java.lang.String`	`WRAPPER_CONF`

Constructor Summary

Constructors
Constructor and Description
`InstanceLayout(java.io.File instanceDirectory)` Creates a new instance of InstanceLayout.
`InstanceLayout(java.lang.String instanceDirectoryPath)` Creates a new instance of InstanceLayout.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.io.File`	`getApacheDsConfigurationLdifFile()` Gets the apacheds configuration ldif file ('<instance>/conf/config.ldif').
`java.io.File`	`getCacheDirectory()` Gets the 'cache' directory ('<instance>/cache').
`java.io.File`	`getConfDirectory()` Gets the 'conf' directory ('<instance>/conf').
`java.io.File`	`getInstanceDirectory()` Gets the instance directory.
`java.io.File`	`getLogConfigurationFile()` Gets the log configuration file ('<instance>/conf/log4j.properties').
`java.io.File`	`getLogDirectory()` Gets the 'log' directory ('<instance>/log').
`java.io.File`	`getPartitionsDirectory()` Gets the 'partitions' directory ('<instance>/partitions')
`java.io.File`	`getReplDirectory()` Gets the 'replication' directory where replication journals are stored ('<instance>/syncrepl-data').
`java.io.File`	`getRunDirectory()` Gets the 'run' directory in the installation directory ('<instance>/run').
`java.io.File`	`getWrapperConfigurationFile()` Gets the wrapper configuration file ('<instance>/conf/wrapper.conf').
`private void`	`init()` Initializes the InstanceLayout.
`void`	`setCacheDir(java.io.File cacheDir)`
`void`	`setConfDir(java.io.File confDir)`
`void`	`setLogDir(java.io.File logDir)`
`void`	`setPartitionsDir(java.io.File partitionsDir)`
`void`	`setReplDirectory(java.io.File replDir)` Sets the directory where the replication data are stored
`void`	`setRunDir(java.io.File runDir)`
`java.lang.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_DIR
```
private static final java.lang.String LOG_DIR
```
    See Also:
    
    Constant Field Values
  - RUN_DIR
```
private static final java.lang.String RUN_DIR
```
    See Also:
    
    Constant Field Values
  - LOG_NAME
```
public static final java.lang.String LOG_NAME
```
    Static directory names
    
    See Also:
    
    Constant Field Values
  - RUN_NAME
```
public static final java.lang.String RUN_NAME
```
    See Also:
    
    Constant Field Values
  - CONF_NAME
```
public static final java.lang.String CONF_NAME
```
    See Also:
    
    Constant Field Values
  - PARTITIONS_NAME
```
public static final java.lang.String PARTITIONS_NAME
```
    See Also:
    
    Constant Field Values
  - REPL_NAME
```
private static final java.lang.String REPL_NAME
```
    See Also:
    
    Constant Field Values
  - CACHE_NAME
```
private static final java.lang.String CACHE_NAME
```
    See Also:
    
    Constant Field Values
  - LOG4J_PROPERTIES
```
private static final java.lang.String LOG4J_PROPERTIES
```
    Static file names
    
    See Also:
    
    Constant Field Values
  - WRAPPER_CONF
```
private static final java.lang.String WRAPPER_CONF
```
    See Also:
    
    Constant Field Values
  - CONFIG_LDIF
```
private static final java.lang.String CONFIG_LDIF
```
    See Also:
    
    Constant Field Values
  - logDir
```
private java.io.File logDir
```
    The Log directory
  - partitionsDir
```
private java.io.File partitionsDir
```
    The Partitions directory
  - runDir
```
private java.io.File runDir
```
    The Run directory
  - confDir
```
private java.io.File confDir
```
    The Conf directory
  - replDir
```
private java.io.File replDir
```
    The replication data directory
  - cacheDir
```
private java.io.File cacheDir
```
    The cache directory
- Constructor Detail
  - InstanceLayout
```
public InstanceLayout(java.io.File instanceDirectory)
```
    Creates a new instance of InstanceLayout.
    
    Parameters:
    
    instanceDirectory - the instance directory
  - InstanceLayout
```
public InstanceLayout(java.lang.String instanceDirectoryPath)
```
    Creates a new instance of InstanceLayout.
    
    Parameters:
    
    instanceDirectoryPath - the path to the instance directory
- Method Detail
  - init
```
private void init()
```
    Initializes the InstanceLayout.
  - getConfDirectory
```
public java.io.File getConfDirectory()
```
    Gets the 'conf' directory ('<instance>/conf').
    
    Returns:
    
    the 'conf' directory
  - setConfDir
```
public void setConfDir(java.io.File confDir)
```
    Parameters:
    
    confDir - the confDir to set
  - getCacheDirectory
```
public java.io.File getCacheDirectory()
```
    Gets the 'cache' directory ('<instance>/cache').
    
    Returns:
    
    the 'cache' directory
  - setCacheDir
```
public void setCacheDir(java.io.File cacheDir)
```
    Parameters:
    
    cacheDir - the confDir to set
  - getLogDirectory
```
public java.io.File getLogDirectory()
```
    Gets the 'log' directory ('<instance>/log').
    
    Returns:
    
    the 'log' directory
  - setLogDir
```
public void setLogDir(java.io.File logDir)
```
    Parameters:
    
    logDir - the logDir to set
  - getPartitionsDirectory
```
public java.io.File getPartitionsDirectory()
```
    Gets the 'partitions' directory ('<instance>/partitions')
    
    Returns:
    
    the 'partitions' directory
  - setPartitionsDir
```
public void setPartitionsDir(java.io.File partitionsDir)
```
    Parameters:
    
    partitionsDir - the partitionsDir to set
  - getRunDirectory
```
public java.io.File getRunDirectory()
```
    Gets the 'run' directory in the installation directory ('<instance>/run').
    
    Returns:
    
    the 'run' directory
  - setRunDir
```
public void setRunDir(java.io.File runDir)
```
    Parameters:
    
    runDir - the runDir to set
  - getInstanceDirectory
```
public java.io.File getInstanceDirectory()
```
    Gets the instance directory.
    
    Returns:
    
    the instance directory
  - getLogConfigurationFile
```
public java.io.File getLogConfigurationFile()
```
    Gets the log configuration file ('<instance>/conf/log4j.properties').
    
    Returns:
    
    the log configuration file
  - getWrapperConfigurationFile
```
public java.io.File getWrapperConfigurationFile()
```
    Gets the wrapper configuration file ('<instance>/conf/wrapper.conf').
    
    Returns:
    
    the wrapper configuration file
  - getApacheDsConfigurationLdifFile
```
public java.io.File getApacheDsConfigurationLdifFile()
```
    Gets the apacheds configuration ldif file ('<instance>/conf/config.ldif').
    
    Returns:
    
    the apacheds configuration ldif file
  - getReplDirectory
```
public java.io.File getReplDirectory()
```
    Gets the 'replication' directory where replication journals are stored ('<instance>/syncrepl-data').
    
    Returns:
    
    the 'replication' directory
  - setReplDirectory
```
public void setReplDirectory(java.io.File replDir)
```
    Sets the directory where the replication data are stored
    
    Parameters:
    
    replDir - the replication journal data directory
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
    
    See Also:
    
    String.toString()

Class InstanceLayout

Field Summary

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Field Detail

LOG_DIR

RUN_DIR

LOG_NAME

RUN_NAME

CONF_NAME

PARTITIONS_NAME

REPL_NAME

CACHE_NAME

LOG4J_PROPERTIES

WRAPPER_CONF

CONFIG_LDIF

logDir

partitionsDir

runDir

confDir

replDir

cacheDir

Constructor Detail

InstanceLayout

InstanceLayout

Method Detail

init

getConfDirectory

setConfDir

getCacheDirectory

setCacheDir

getLogDirectory

setLogDir

getPartitionsDirectory

setPartitionsDir

getRunDirectory

setRunDir

getInstanceDirectory

getLogConfigurationFile

getWrapperConfigurationFile

getApacheDsConfigurationLdifFile

getReplDirectory

setReplDirectory

toString