org.sourceid.saml20.service
Interface InterRequestStateMgmt

All Known Implementing Classes:

InterReqStateMgmtMapImpl, InterRequestStateMgmtMulticastImpl, InterRequestStateMgmtProxy

public interface InterRequestStateMgmt

Defines the methods needed by PingFederate to keep short lived state between user requests. Some examples are keeping track of state between issuing a request to a partner and processing the response and keeping track of state during asynchronous adapter interactions.

Author:

Brian Campbell

Method Summary

void	cleanup(java.lang.String sessionId) Clean up any orphaned state associated with this session id.
org.sourceid.saml20.state.State	retrieveAndRemoveState(java.lang.String stateKey) Retrieve the state associated with the given key.
void	saveState(java.lang.String sessionId, java.lang.String stateKey, org.sourceid.saml20.state.State state) Associate the state object with the given key (so that it can be retrieved by retrieveAndRemoveState(String)).

Method Detail

saveState

void saveState(java.lang.String sessionId,
               java.lang.String stateKey,
               org.sourceid.saml20.state.State state)

Associate the state object with the given key (so that it can be retrieved by retrieveAndRemoveState(String)). Also keep an association with the session id in order to clean up any state that was orphaned by errant users.

Parameters:

sessionId - the session id of the user that this state is associated with.

stateKey - the key against which the state is stored.

state - the state to store.

retrieveAndRemoveState

org.sourceid.saml20.state.State retrieveAndRemoveState(java.lang.String stateKey)

Retrieve the state associated with the given key.

Parameters:

stateKey -

Returns:

the state object associated with the key

cleanup

void cleanup(java.lang.String sessionId)

Clean up any orphaned state associated with this session id.

Parameters:

sessionId -