Package org.forgerock.openig.config
Interface Environment
- 
- All Known Implementing Classes:
- DefaultEnvironment
 
 public interface EnvironmentEncapsulate 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/
- 
- 
Method SummaryAll Methods Instance Methods Abstract Methods Default Methods Deprecated Methods Modifier and Type Method Description default FilegetBaseDirectory()Deprecated.in 7.0, usegetInstanceDirectory()as a replacementFilegetConfigDirectory()Returns the directory that contains the configuration files.FilegetInstanceDirectory()Returns the instance directory of the IG file system.FilegetScriptDirectory(String type)Returns the directory that contains the files of the given type.FilegetTempDirectory()Returns the temporary directory of IG (where we have read+write permissions).
 
- 
- 
- 
Method Detail- 
getBaseDirectory@Deprecated(since="7.0.0") default File getBaseDirectory() Deprecated.in 7.0, usegetInstanceDirectory()as a replacementReturns the instance directory of the IG file system. It can be used to access resources that are not part of the standard layout.- Returns:
- the instance directory of the IG file system.
 
 - 
getInstanceDirectoryFile getInstanceDirectory() Returns the instance directory of the IG file system. It can be used to access resources that are not part of the standard layout.- Returns:
- the instance directory of the IG file system.
 
 - 
getTempDirectoryFile getTempDirectory() Returns the temporary directory of IG (where we have read+write permissions). It usually points to the tmp/ directory.- Returns:
- the working directory.
 
 - 
getScriptDirectoryFile 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.
 
 - 
getConfigDirectoryFile getConfigDirectory() Returns the directory that contains the configuration files. It usually points to the config/ directory.- Returns:
- the configuration directory.
 
 
- 
 
-