com.ibm.itim.apps

Class InitialPlatformContext

java.lang.Object

com.ibm.itim.apps.InitialPlatformContext

All Implemented Interfaces:

PlatformContext

public class InitialPlatformContext
extends java.lang.Object
implements PlatformContext

Provides a starting point for establishing a platform context. This class will establish the context using the PlatformContextFactory class provided in the context environment parameter.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CONTEXT_FACTORY PlatformContextFactory class property name.

Fields inherited from interface com.ibm.itim.apps.PlatformContext

PLATFORM_CREDENTIALS, PLATFORM_PRINCIPAL, PLATFORM_REALM, PLATFORM_URL

Constructor Summary

Constructors

Constructor and Description
InitialPlatformContext(java.util.Hashtable env) Constructs a platform context with the given environment.

Method Summary

Modifier and Type	Method and Description
void	close() Closes the platform context, freeing up any system resources that may have been allocated for the context.
java.util.Hashtable	getEnvironment() Returns the environment the client used to define the context.
java.lang.Object	getEnvProperty(java.lang.Object propertyName) Returns the environment property with the given name.
java.lang.Long	getID() Returns the unique identifier of the platform context.

Methods inherited from class java.lang.Object

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

Field Detail

CONTEXT_FACTORY

public static final java.lang.String CONTEXT_FACTORY

PlatformContextFactory class property name. The value of the constant is enrole.platform.contextFactory. This string must be present in the enRole.properties file if creating the context using the properties file environment option.

See Also:

Constant Field Values

Constructor Detail

InitialPlatformContext

public InitialPlatformContext(java.util.Hashtable env)
                       throws java.rmi.RemoteException,
                              ApplicationException

Constructs a platform context with the given environment. The environment must hold the PlatformContextFactory class name and all other required parameters as specified in the PlatformContext interface.

Parameters:

env - the environment used to create the InitialPlatformContext.

Throws:

java.rmi.RemoteException - if unable to establish the context.

ApplicationException - if unable to establish the context.

Method Detail

getEnvironment

public java.util.Hashtable getEnvironment()

Returns the environment the client used to define the context.

Specified by:

getEnvironment in interface PlatformContext

Returns:

Hashtable holding the environment parameters.

getEnvProperty

public java.lang.Object getEnvProperty(java.lang.Object propertyName)

Returns the environment property with the given name.

Specified by:

getEnvProperty in interface PlatformContext

Parameters:

propertyName - Name of the property to retrieve.

Returns:

Object representing the property value.

getID

public java.lang.Long getID()

Returns the unique identifier of the platform context. This identitifer is generated and used by the identity platform itself.

Specified by:

getID in interface PlatformContext

Returns:

Unique ID of the context.

close

public void close()

Closes the platform context, freeing up any system resources that may have been allocated for the context. Failure to close platform contexts may result in the resource unavailability and the degredation of performance over time.

Specified by:

close in interface PlatformContext