Skip navigation links

Oracle Fusion Middleware Java API Reference for Oracle ADF Share
11g Release 2 (11.1.2.3.0)

E17486-04


oracle.adf.share.statemanager.javacache
Class StateManagerImpl

java.lang.Object
  extended by oracle.adf.share.statemanager.javacache.StateManagerImpl

All Implemented Interfaces:
StateManager

public class StateManagerImpl
extends java.lang.Object
implements StateManager

A javacache based implementation of the StateManager.

Since the javacache is a shared JVM-level resource there are some restrictions that must be followed when using the javacache StateManager:

The javacache StateManager depends upon the distributed cache features of the javacache to persist and distribute state. If the javacache is configured externally for use elsewhere in the application it should be configured with the distribution option enabled and a disk path declared.

The javacache StateManager will create the StateManagerCacheAccess.STATE_MANAGER_CACHE_REGION region for the managed states. The StateManager will create subregions within that region for each managed scope.

An application developer may specify the ENV_CACHE_ATTRIBUTES environment parameter when acquiring the StateManager default context to initialize and configure the Cache. The parameter value should be a CacheAttributes instance. If the Cache has already been initialized (Cache.isReady) then the specified CacheAttributes will be ignored. If no CacheAttributes are specified and the Cache has not already been initialized then the StateManager implementation will configure and initialize the Cache with the distribution option enabled and with the disk path equal to the temporary system path (System.getProperty("java.io.tmpdir")).


Field Summary
static java.lang.String ENV_CACHE_ATTRIBUTES
           

 

Constructor Summary
StateManagerImpl()
           

 

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

 

Field Detail

ENV_CACHE_ATTRIBUTES

public static final java.lang.String ENV_CACHE_ATTRIBUTES
See Also:
Constant Field Values

Constructor Detail

StateManagerImpl

public StateManagerImpl()

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.

Skip navigation links

Oracle Fusion Middleware Java API Reference for Oracle ADF Share
11g Release 2 (11.1.2.3.0)

E17486-04


Copyright © 1997, 2012, Oracle. All rights reserved.