org.forgerock.openig.http

Class GatewayEnvironment

java.lang.Object

org.forgerock.openig.config.env.EnvironmentDelegate

org.forgerock.openig.http.GatewayEnvironment

All Implemented Interfaces:

Environment

public class GatewayEnvironment
extends EnvironmentDelegate

Represents an Environment built from a webapp. It tries to create an environment from different sources (init-params, process-scoped values or default location). It goes from the most specific one (servlet's init-params) to the default one (default platform specific location).

Since:

2.2

Field Summary

Fields

Modifier and Type	Field and Description
static String	BASE_ENV_VARIABLE Environment variable name.
static String	BASE_INIT_PARAM Servlet's init-param name.
static String	BASE_SYSTEM_PROPERTY System property name that can be specified through command line.

Constructor Summary

Constructors

Constructor and Description
GatewayEnvironment() Builds a new web environment.

Method Summary

Modifier and Type	Method and Description
protected Environment	delegate() Returns the environment delegatee.

Methods inherited from class org.forgerock.openig.config.env.EnvironmentDelegate

getBaseDirectory, getConfigDirectory, getScriptDirectory, getTempDirectory

Methods inherited from class java.lang.Object

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

Field Detail

BASE_INIT_PARAM

public static final String BASE_INIT_PARAM

Servlet's init-param name.

 <servlet>
   <servlet-name>GatewayServlet</servlet-name>
   <servlet-class>org.forgerock.openig.servlet.GatewayServlet</servlet-class>
   <init-param>
     <param-name>openig-base</param-name>
     <param-value>/my/openig/path</param-value>
   </init-param>
 </servlet>
 

See Also:

Constant Field Values

BASE_SYSTEM_PROPERTY

public static final String BASE_SYSTEM_PROPERTY

System property name that can be specified through command line. java -Dopenig.base=/my/openig/path ....

See Also:

Constant Field Values

BASE_ENV_VARIABLE

public static final String BASE_ENV_VARIABLE

Environment variable name. Under UNIX: export OPENIG_BASE=/my/openig/path Under Windows: set OPENIG_BASE=c:\my\openig\path

See Also:

Constant Field Values

Constructor Detail

GatewayEnvironment

public GatewayEnvironment()

Builds a new web environment.

Method Detail

delegate

protected Environment delegate()

Description copied from class: EnvironmentDelegate

Returns the environment delegatee.

Specified by:

delegate in class EnvironmentDelegate

Returns:

the environment delegatee.