Package org.forgerock.openig.config.env

Class EnvironmentDelegate

java.lang.Object

org.forgerock.openig.config.env.EnvironmentDelegate

All Implemented Interfaces:

Environment

Direct Known Subclasses:

GatewayEnvironment, PlatformEnvironment, UnixEnvironment, WindowsEnvironment

public abstract class EnvironmentDelegate
extends Object
implements Environment

Environment delegate, particularly useful to share a default implementation.

Since:

2.2

Constructor Summary

Constructors

Constructor	Description
EnvironmentDelegate()

Method Summary

Modifier and Type	Method	Description
protected abstract Environment	delegate()	Returns the environment delegatee.
File	getBaseDirectory()	Returns the base directory of the OpenIG file system.
File	getConfigDirectory()	Returns the directory that contains the configuration files.
File	getScriptDirectory(String type)	Returns the directory that contains the files of the given type.
File	getTempDirectory()	Returns the temporary directory of OpenIG (where we have read+write permissions).

Methods inherited from class java.lang.Object

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

Constructor Detail

EnvironmentDelegate

public EnvironmentDelegate()

Method Detail

delegate

protected abstract Environment delegate()

Returns the environment delegatee.

Returns:

the environment delegatee.

getBaseDirectory

public File getBaseDirectory()

Description copied from interface: Environment

Returns the base directory of the OpenIG file system. It can be used to access resources that are not part of the standard layout.

Specified by:

getBaseDirectory in interface Environment

Returns:

the base directory of the OpenIG file system.

getTempDirectory

public File getTempDirectory()

Description copied from interface: Environment

Returns the temporary directory of OpenIG (where we have read+write permissions). It usually points to the tmp/ directory.

Specified by:

getTempDirectory in interface Environment

Returns:

the working directory.

getScriptDirectory

public File getScriptDirectory(String type)

Description copied from interface: Environment

Returns the directory that contains the files of the given type. It usually points to the scripts/<type>/ directory.

Specified by:

getScriptDirectory in interface Environment

Parameters:

type - script's type (could be groovy or js)

Returns:

the scripting directory.

getConfigDirectory

public File getConfigDirectory()

Description copied from interface: Environment

Returns the directory that contains the configuration files. It usually points to the config/ directory.

Specified by:

getConfigDirectory in interface Environment

Returns:

the configuration directory.