Package net.shibboleth.sp.context

Class StateDataContext

java.lang.Object

org.opensaml.messaging.context.BaseContext

net.shibboleth.sp.context.StateDataContext

All Implemented Interfaces:

Iterable<BaseContext>

public class StateDataContext
extends BaseContext

A context to hold state information about a request.

Nested Class Summary

Nested classes/interfaces inherited from class org.opensaml.messaging.context.BaseContext

BaseContext.ContextSetNoRemoveIteratorDecorator, BaseContext.DeprecatedContextClassNameLookAside

Field Summary

Fields

Modifier and Type	Field	Description
private StateData	stateData	The request state data.
private String	stateToken	A string token that represents the preserved or "to be recovered" state data.

Constructor Summary

Constructors

Constructor	Description
StateDataContext()

Method Summary

Modifier and Type	Method	Description
StateData	getStateData()	Get the state tracked for a request.
String	getStateToken()	Get the token associated with the state after preservation or before recovery.
StateDataContext	setStateData(StateData state)	Sets the state tracked for a request.
StateDataContext	setStateToken(String token)	Set the token associated with the state after preservation or before recovery.

Methods inherited from class org.opensaml.messaging.context.BaseContext

addSubcontext, addSubcontext, clearSubcontexts, containsSubcontext, createSubcontext, ensureSubcontext, ensureSubcontext, getParent, getSubcontext, getSubcontext, getSubcontext, getSubcontext, iterator, removeFromParent, removeSubcontext, removeSubcontext, setParent

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Details

stateToken

@Nullable
private String stateToken

A string token that represents the preserved or "to be recovered" state data.

stateData

@Nullable
private StateData stateData

The request state data.

Constructor Details

StateDataContext

public StateDataContext()

Method Details

getStateToken

@Nullable
@NotEmpty
public String getStateToken()

Get the token associated with the state after preservation or before recovery.

Returns:

state token

setStateToken

@Nonnull
public StateDataContext setStateToken(@Nullable @NotEmpty
 String token)

Set the token associated with the state after preservation or before recovery.

Parameters:

token - state token

Returns:

this context

getStateData

@Nullable
public StateData getStateData()

Get the state tracked for a request.

Returns:

the state data object

setStateData

@Nonnull
public StateDataContext setStateData(@Nullable
 StateData state)

Sets the state tracked for a request.

Parameters:

state - state data to set

Returns:

this context