org.apache.directory.server.core.api

Class AbstractLayout

java.lang.Object

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

Direct Known Subclasses:

InstallationLayout, InstanceLayout

public abstract class AbstractLayout
extends java.lang.Object

Convenience class to encapsulate paths to various directories and files within an layout.

Field Summary

Fields

Modifier and Type	Field and Description
private java.io.File	directory The base directory
private static org.slf4j.Logger	LOG The logger
private java.io.File[]	requiredDirectories The required directories
private java.io.File[]	requiredFiles The required files

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractLayout(java.io.File directory) Creates a new instance of AbstractLayout.
protected	AbstractLayout(java.lang.String directoryPath) Creates a new instance of AbstractLayout.

Method Summary

Modifier and Type	Method and Description
protected java.io.File	getDirectory() Gets the base directory.
java.io.File[]	getRequiredDirectories() Gets the required directories.
java.io.File[]	getRequiredFiles() Gets the required files.
void	mkdirs() Creates the required directories (if they don't already exist).
protected void	setRequiredDirectories(java.io.File[] requiredDirectories) Sets the required directories.
protected void	setRequiredFiles(java.io.File[] requiredFiles) Sets the required files.
void	verifyInstallation() Verifies the installation by checking required directories and 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

The logger

requiredDirectories

private java.io.File[] requiredDirectories

The required directories

requiredFiles

private java.io.File[] requiredFiles

The required files

directory

private java.io.File directory

The base directory

Constructor Detail

AbstractLayout

protected AbstractLayout(java.io.File directory)

Creates a new instance of AbstractLayout.

Parameters:

directory - the base directory

AbstractLayout

protected AbstractLayout(java.lang.String directoryPath)

Creates a new instance of AbstractLayout.

Parameters:

directoryPath - the path to the base directory

Method Detail

getDirectory

protected java.io.File getDirectory()

Gets the base directory.

Returns:

the base directory

getRequiredDirectories

public java.io.File[] getRequiredDirectories()

Gets the required directories.

Returns:

the required directories

getRequiredFiles

public java.io.File[] getRequiredFiles()

Gets the required files.

Returns:

the required files

mkdirs

public void mkdirs()
            throws java.io.IOException

Creates the required directories (if they don't already exist).

Throws:

java.io.IOException

setRequiredDirectories

protected void setRequiredDirectories(java.io.File[] requiredDirectories)

Sets the required directories.

Parameters:

requiredDirectories - an array of required directories

setRequiredFiles

protected void setRequiredFiles(java.io.File[] requiredFiles)

Sets the required files.

Parameters:

requiredFiles - an array of required files

verifyInstallation

public void verifyInstallation()

Verifies the installation by checking required directories and files.