org.forgerock.openig.config

Interface Environment

All Known Implementing Classes:

DefaultEnvironment, EnvironmentDelegate, GatewayEnvironment, PlatformEnvironment, UnixEnvironment, WindowsEnvironment

public interface Environment

Encapsulate logic to access configuration files and other directories of the IG base directory. A typical structure may looks like the following:

     
     config/config.json
     scripts/groovy/**.groovy
     tmp/
     
 

This interface provides an abstraction over the directory layout to protect against changes of naming, ...

Method Summary

Modifier and Type	Method and Description
File	getBaseDirectory() Returns the base directory of the IG 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 IG (where we have read+write permissions).

Method Detail

getBaseDirectory

File getBaseDirectory()

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

Returns:

the base directory of the IG file system.

getTempDirectory

File getTempDirectory()

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

Returns:

the working directory.

getScriptDirectory

File getScriptDirectory(String type)

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

Parameters:

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

Returns:

the scripting directory.

getConfigDirectory

File getConfigDirectory()

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

Returns:

the configuration directory.