PlatformContext

Overview

Package

Class

Tree

Serialized

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.ibm.itim.apps
Interface PlatformContext

All Known Implementing Classes:: InitialPlatformContext

public interface PlatformContext

Interface representing a client context with the provisioning platform. A context must be established with the platform before any users can make use of the platform's applications. Users must be authenticated to the platform individually. However, the platform itself also requires that the client of the applications at a system level must also authenticate. This authentication is performed at the the platform context level. Since the client may be remote, network location information will also be required.

Field Summary

static java.lang.String PLATFORM_CREDENTIALS
          Property name of the principal's authentication credentials.

static java.lang.String PLATFORM_PRINCIPAL
          Property name of the system level calling principal of the context.

static java.lang.String PLATFORM_URL
          Platform URL property name.

Method Summary

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.

Field Summary
`static java.lang.String`	`PLATFORM_CREDENTIALS` Property name of the principal's authentication credentials.
`static java.lang.String`	`PLATFORM_PRINCIPAL` Property name of the system level calling principal of the context.
`static java.lang.String`	`PLATFORM_URL` Platform URL property name.

Method Summary
`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.

Field Detail

PLATFORM_URL

public static final java.lang.String PLATFORM_URL

Platform URL property name. The value of the constant is enrole.appServer.url.

See Also:: Constant Field Values

PLATFORM_PRINCIPAL

public static final java.lang.String PLATFORM_PRINCIPAL

Property name of the system level calling principal of the context. The value of the constant is enrole.appServer.ejbuser.principal.

See Also:: Constant Field Values

PLATFORM_CREDENTIALS

public static final java.lang.String PLATFORM_CREDENTIALS

Property name of the principal's authentication credentials. The value of the constant is enrole.appServer.ejbuser.credentials.

See Also:: Constant Field Values

Method Detail

getEnvironment

public java.util.Hashtable getEnvironment()

Returns the environment the client used to define the context.

Returns:: Hashtable holding the environment parameters.

getEnvProperty

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

Returns the environment property with the given name.

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.

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.