org.apache.directory.server

Class InstallationLayout

java.lang.Object

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

org.apache.directory.server.InstallationLayout

public class InstallationLayout
extends AbstractLayout

Convenience class to encapsulate paths to various directories and files within an installation. The default installation layout will be :

 apacheds-<version>/ : installation directory
  |
  +-- bin : binDirectory
  |    |
  |    +-- apacheds* : scriptFile
  |    |
  |    +-- wrapper* : wrapperFile
  |
  +-- conf/ : confDirectory
  |    |
  |    +-- wrapper.conf : wrapperConfFile
  |
  +-- lib/ : LibDirectory
  |
  +-- LICENSE
  |
  +-- NOTICE
 

Constructor Summary

Constructors

Constructor and Description
InstallationLayout(java.io.File installationDirectory) Creates a new instance of InstallationLayout.
InstallationLayout(java.lang.String installationDirectoryPath) Creates a new instance of InstallationLayout.

Method Summary

Modifier and Type	Method and Description
java.io.File	getBinDirectory() Gets the 'bin' directory in the installation directory.
java.io.File	getConfDirectory() Gets the 'conf' directory in the installation directory.
java.io.File	getInstallationDirectory() Gets the installation directory.
java.io.File	getLibDirectory() Gets the 'lib' directory in the installation directory.
java.io.File	getLicenseFile() Gets the LICENSE file ('/LICENSE').
java.io.File	getNoticeFile() Gets the NOTICE file ('/NOTICE').
java.io.File	getScriptFile() Gets the script file ('/bin/apacheds').
java.io.File	getWrapperConfigurationFile() Gets the wrapper configuration file ('/conf/wrapper.conf').
java.io.File	getWrapperFile() Gets the wrapper file ('/bin/wrapper').
private void	init() Initializes the InstallationLayout.
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

Constructor Detail

InstallationLayout

public InstallationLayout(java.io.File installationDirectory)

Creates a new instance of InstallationLayout.

Parameters:

installationDirectory - the installation directory

InstallationLayout

public InstallationLayout(java.lang.String installationDirectoryPath)

Creates a new instance of InstallationLayout.

Parameters:

installationDirectoryPath - the path to the installation directory

Method Detail

init

private void init()

Initializes the InstallationLayout.

getBinDirectory

public java.io.File getBinDirectory()

Gets the 'bin' directory in the installation directory.

Returns:

the 'bin' directory

getConfDirectory

public java.io.File getConfDirectory()

Gets the 'conf' directory in the installation directory.

Returns:

the 'conf' directory

getInstallationDirectory

public java.io.File getInstallationDirectory()

Gets the installation directory.

Returns:

the installation directory

getLibDirectory

public java.io.File getLibDirectory()

Gets the 'lib' directory in the installation directory.

Returns:

the 'lib' directory

getLicenseFile

public java.io.File getLicenseFile()

Gets the LICENSE file ('/LICENSE').

Returns:

the LICENSE file

getNoticeFile

public java.io.File getNoticeFile()

Gets the NOTICE file ('/NOTICE').

Returns:

the NOTICE file

getScriptFile

public java.io.File getScriptFile()

Gets the script file ('/bin/apacheds').

Returns:

the script file

getWrapperConfigurationFile

public java.io.File getWrapperConfigurationFile()

Gets the wrapper configuration file ('/conf/wrapper.conf').

Returns:

the wrapper configuration file

getWrapperFile

public java.io.File getWrapperFile()

Gets the wrapper file ('/bin/wrapper').

Returns:

the wrapper file

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

See Also:

Object.toString()