Package org.forgerock.openig.config
Interface Environment
-
- All Known Implementing Classes:
DefaultEnvironment,EnvironmentDelegate,GatewayEnvironment,PlatformEnvironment,UnixEnvironment,WindowsEnvironment
public interface EnvironmentEncapsulate logic to access configuration files and other directories of the OpenIG base directory. A typical structure may looks like the following:This interface provides an abstraction over the directory layout to protect against changes of naming, ...config/config.json scripts/groovy/**.groovy tmp/
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description FilegetBaseDirectory()Returns the base directory of the OpenIG file system.FilegetConfigDirectory()Returns the directory that contains the configuration files.FilegetScriptDirectory(String type)Returns the directory that contains the files of the given type.FilegetTempDirectory()Returns the temporary directory of OpenIG (where we have read+write permissions).
-
-
-
Method Detail
-
getBaseDirectory
File getBaseDirectory()
Returns the base directory of the OpenIG file system. It can be used to access resources that are not part of the standard layout.- Returns:
- the base directory of the OpenIG file system.
-
getTempDirectory
File getTempDirectory()
Returns the temporary directory of OpenIG (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.
-
-