oracle.adf.share.http
Class HttpSessionStateManagerImpl

java.lang.Object
  oracle.adf.share.http.HttpSessionStateManagerImpl

All Implemented Interfaces:

StateManager

public class HttpSessionStateManagerImpl
extends java.lang.Object
implements StateManager

The HttpSessionStateManagerImpl uses the HttpSession as a repository. This StateManager implementation may be used by applications that allow the use of the HttpSession. The advnantage of the HttpSession based repository is that an application may leverage the HttpSession state management facilities to manage their ADF state.

Since:

release specific (what release of product did this appear in)

Constructor Summary

HttpSessionStateManagerImpl()

Method Summary

void	clearStates(java.lang.Object context) Removes all states for the specified conext.
java.lang.Object	getState(java.lang.Object context, java.lang.Object id) Returns the specified state.
java.lang.Object	getUserAttributes(java.lang.Object context, java.lang.Object id) Returns the user attributes of the specified state.
void	init(java.util.Hashtable env) Invoked by the DefaultContext when the StateManager is instantiated.
java.util.Iterator	listStateIds(java.lang.Object context) Returns an iterator of the save point Ids.
java.lang.Object	putState(java.lang.Object context, java.lang.Object id, java.lang.Object state) Registers a state.
java.lang.Object	putState(java.lang.Object context, java.lang.Object id, java.lang.Object state, Policy policy) Registers a state with a management policy.
java.lang.Object	putState(java.lang.Object context, java.lang.Object id, java.lang.Object state, Policy policy, java.lang.Object userAttrs) Registers a state with a management policy.
java.lang.Object	removeState(java.lang.Object context, java.lang.Object id) Removes the specified state.

Methods inherited from class java.lang.Object

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

Constructor Detail

HttpSessionStateManagerImpl

public HttpSessionStateManagerImpl()

Method Detail

init

public void init(java.util.Hashtable env)

Description copied from interface: StateManager

Invoked by the DefaultContext when the StateManager is instantiated. Custom implementations may use the environment to perform custom initialization of the StateManager implementation.

Specified by:

init in interface StateManager

Parameters:

env - the default context environment

getState

public java.lang.Object getState(java.lang.Object context,
                                 java.lang.Object id)

Description copied from interface: StateManager

Returns the specified state. If the state does not exist returns null.

Specified by:

getState in interface StateManager

Parameters:

context - the ADF context of the required state

id - the state id

Returns:

the specified state

putState

public java.lang.Object putState(java.lang.Object context,
                                 java.lang.Object id,
                                 java.lang.Object state)

Description copied from interface: StateManager

Registers a state.

Specified by:

putState in interface StateManager

Parameters:

context - the ADF context of the state

id - the state id

state - the state

Returns:

the registered state

putState

public java.lang.Object putState(java.lang.Object context,
                                 java.lang.Object id,
                                 java.lang.Object state,
                                 Policy policy)

Description copied from interface: StateManager

Registers a state with a management policy. Management policies may be defined to customize how a state will be managed. The StateManager defines default management policies for most contexts. If a management policy is specified then that policy will override the default policy.

Specified by:

putState in interface StateManager

Parameters:

context - the ADF context of the state

id - the state id

state - the state

policy - the management policy.

Returns:

the registered state

putState

public java.lang.Object putState(java.lang.Object context,
                                 java.lang.Object id,
                                 java.lang.Object state,
                                 Policy policy,
                                 java.lang.Object userAttrs)

Description copied from interface: StateManager

Registers a state with a management policy. Management policies may be defined to customize how a state will be managed. The StateManager defines default management policies for most contexts. If a management policy is specified then that policy will override the default policy.

Specified by:

putState in interface StateManager

Parameters:

context - the ADF context of the state

id - the state id

state - the state

policy - the management policy.

userAttrs - user attributes to be associated with the state.

Returns:

the registered state

removeState

public java.lang.Object removeState(java.lang.Object context,
                                    java.lang.Object id)

Description copied from interface: StateManager

Removes the specified state. If the state does not exist returns null.

Specified by:

removeState in interface StateManager

Parameters:

context - the ADF context of the required state

id - the state id

Returns:

the specified state

clearStates

public void clearStates(java.lang.Object context)

Description copied from interface: StateManager

Removes all states for the specified conext.

Specified by:

clearStates in interface StateManager

Parameters:

context - an ADF context

getUserAttributes

public java.lang.Object getUserAttributes(java.lang.Object context,
                                          java.lang.Object id)

Description copied from interface: StateManager

Returns the user attributes of the specified state. If the state does not exist returns null.

Specified by:

getUserAttributes in interface StateManager

Parameters:

context - the ADF context of the required state

id - the state id

Returns:

the user attributes of the specified state

listStateIds

public java.util.Iterator listStateIds(java.lang.Object context)

Description copied from interface: StateManager

Returns an iterator of the save point Ids.

Specified by:

listStateIds in interface StateManager

Parameters:

context - the ADF context of the required state

Returns:

Iterator of state Ids.