oracle.portal.utils
Class EnvLookup

java.lang.Object
  oracle.portal.utils.EnvLookup

public class EnvLookup
extends java.lang.Object

Field Summary

static java.lang.String	AUTO_RELOAD
static java.lang.String	ENCODE_DEFAULT_CHARACTERS
static java.lang.String	ENCODED_CHARACTERS
static java.lang.String	ESCAPE_STRINGS
static java.lang.String	FILE_PREF_STORE_LOCATION
static java.lang.String	GLOBAL The global keyword used in provider non-specific JNDI varibales to avoid name clashes.
static java.lang.String	HMAC_ENHANCED_AUTHENTICATION
static java.lang.String	HMAC_SHARED_KEY
static java.lang.String	HMAC_TIME_DIFFERENCE
static java.lang.String	JNDI_PREFIX JNDI_PREFIX is the java:comp/env part of a JNDI variable name.
static java.lang.String	LOAD_ALL_PROVIDERS
static java.lang.String	LOG_LEVEL The following are the names of the JNDI variables used globally in the PDK-Java.
static java.lang.String	MBEAN_SERVER_ID
static java.lang.String	OLD_VAR_PREFIX
static java.lang.String	PROVIDER_DEFINITION The following are names of the provider specific JNDI variables used in the PDK-Java.
static java.lang.String	PROVIDER_LOADER_CLASS
static java.lang.String	PROVIDER_SERVICE_CLASS
static java.lang.String	RESOURCE_URL_KEY
static java.lang.String	SEPARATOR A path separator for use when constructing JNDI variable names.
static java.lang.String	TEST_PAGE_FLAG
static java.lang.String	TRANSPORT_ENABLED
static java.lang.String	VAR_PREFIX VAR_PREFIX is the /oracle/portal/provider part of a provider specific JNDI variable name.

Constructor Summary

EnvLookup()
Constructor.

Method Summary

javax.naming.NamingEnumeration	listGlobalVariables() Lists all of the global JNDI variables in the web application.
javax.naming.NamingEnumeration	listProviderVariables(java.lang.String provider) Lists all of the JNDI variables for the specified provider.
java.lang.Object	lookup(java.lang.String var) Looks up the value of a non-provider specific JNDI variable.
java.lang.Object	lookup(java.lang.String var, java.lang.String provider) Looks up the value of a provider specific JNDI variable.

Methods inherited from class java.lang.Object

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

Field Detail

JNDI_PREFIX

public static final java.lang.String JNDI_PREFIX

JNDI_PREFIX is the java:comp/env part of a JNDI variable name.

See Also:

Constant Field Values

VAR_PREFIX

public static final java.lang.String VAR_PREFIX

VAR_PREFIX is the /oracle/portal/provider part of a provider specific JNDI variable name.

See Also:

Constant Field Values

OLD_VAR_PREFIX

public static final java.lang.String OLD_VAR_PREFIX

See Also:

Constant Field Values

PROVIDER_DEFINITION

public static final java.lang.String PROVIDER_DEFINITION

The following are names of the provider specific JNDI variables used in the PDK-Java.

See Also:

Constant Field Values

AUTO_RELOAD

public static final java.lang.String AUTO_RELOAD

See Also:

Constant Field Values

TEST_PAGE_FLAG

public static final java.lang.String TEST_PAGE_FLAG

See Also:

Constant Field Values

HMAC_TIME_DIFFERENCE

public static final java.lang.String HMAC_TIME_DIFFERENCE

See Also:

Constant Field Values

HMAC_SHARED_KEY

public static final java.lang.String HMAC_SHARED_KEY

See Also:

Constant Field Values

HMAC_ENHANCED_AUTHENTICATION

public static final java.lang.String HMAC_ENHANCED_AUTHENTICATION

See Also:

Constant Field Values

FILE_PREF_STORE_LOCATION

public static final java.lang.String FILE_PREF_STORE_LOCATION

See Also:

Constant Field Values

PROVIDER_LOADER_CLASS

public static final java.lang.String PROVIDER_LOADER_CLASS

See Also:

Constant Field Values

PROVIDER_SERVICE_CLASS

public static final java.lang.String PROVIDER_SERVICE_CLASS

See Also:

Constant Field Values

TRANSPORT_ENABLED

public static final java.lang.String TRANSPORT_ENABLED

See Also:

Constant Field Values

RESOURCE_URL_KEY

public static final java.lang.String RESOURCE_URL_KEY

See Also:

Constant Field Values

ENCODE_DEFAULT_CHARACTERS

public static final java.lang.String ENCODE_DEFAULT_CHARACTERS

See Also:

Constant Field Values

ENCODED_CHARACTERS

public static final java.lang.String ENCODED_CHARACTERS

See Also:

Constant Field Values

SEPARATOR

public static final java.lang.String SEPARATOR

A path separator for use when constructing JNDI variable names.

See Also:

Constant Field Values

GLOBAL

public static final java.lang.String GLOBAL

The global keyword used in provider non-specific JNDI varibales to avoid name clashes.

See Also:

Constant Field Values

LOG_LEVEL

public static final java.lang.String LOG_LEVEL

The following are the names of the JNDI variables used globally in the PDK-Java.

See Also:

Constant Field Values

LOAD_ALL_PROVIDERS

public static final java.lang.String LOAD_ALL_PROVIDERS

See Also:

Constant Field Values

MBEAN_SERVER_ID

public static final java.lang.String MBEAN_SERVER_ID

See Also:

Constant Field Values

ESCAPE_STRINGS

public static final java.lang.String ESCAPE_STRINGS

See Also:

Constant Field Values

Constructor Detail

EnvLookup

public EnvLookup()

Constructor. Initializes an InitialContext object to enable the lookup of JNDI Resources.

Throws:

{@link - javax.naming.NamingException} when the InitialContext object can't be created.

Method Detail

lookup

public java.lang.Object lookup(java.lang.String var,
                               java.lang.String provider)
                        throws javax.naming.NamingException

Looks up the value of a provider specific JNDI variable. Automatically adds the java:comp/env prefix needed to look up a JNDI variable in a J2EE container and builds up the rest of the variable including the provider name in the relevant place.

Parameters:

var - The name of the JNDI variable to lookup.

provider - The name of the web provider that the JNDI variable is related to.

Returns:

A Object representing the value of the JNDI variable being looked up.

Throws:

{@link - javax.naming.NamingException} when the JNDI variable can't be accessed.

javax.naming.NamingException

lookup

public java.lang.Object lookup(java.lang.String var)
                        throws javax.naming.NamingException

Looks up the value of a non-provider specific JNDI variable. Automatically adds the java:comp/env prefix needed to look up a JNDI variable in a J2EE container.

Parameters:

var - The name of the JNDI variable to lookup.

Returns:

A Object representing the value of the JNDI variable being looked up.

Throws:

{@link - javax.naming.NamingException} when the JNDI variable can't be accessed.

javax.naming.NamingException

listProviderVariables

public javax.naming.NamingEnumeration listProviderVariables(java.lang.String provider)
                                                     throws javax.naming.NamingException

Lists all of the JNDI variables for the specified provider.

Parameters:

provider - The provider you would like a listing of variables for.

Returns:

A {@link javax.naming.NamingEnumeration) of all of the JNDI variables for that provider.

Throws:

{@link - javax.naming.NamingException} when the list of JNDI variables can't be accessed.

javax.naming.NamingException

listGlobalVariables

public javax.naming.NamingEnumeration listGlobalVariables()
                                                   throws javax.naming.NamingException

Lists all of the global JNDI variables in the web application.

Returns:

A {@link javax.naming.NamingEnumeration) of all of the JNDI variables for the web application.

Throws:

{@link - javax.naming.NamingException} when the list of JNDI variables can't be accessed.

javax.naming.NamingException