Package net.shibboleth.idp.profile.context

Class ProfileInterceptorContext

java.lang.Object

org.opensaml.messaging.context.BaseContext

net.shibboleth.idp.profile.context.ProfileInterceptorContext

All Implemented Interfaces:

Iterable<org.opensaml.messaging.context.BaseContext>

public final class ProfileInterceptorContext
extends org.opensaml.messaging.context.BaseContext

A BaseContext which holds flows that are available to be executed, the last flow attempted, and any flow result.

Nested Class Summary

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

org.opensaml.messaging.context.BaseContext.ContextSetNoRemoveIteratorDecorator

Field Summary

Fields

Modifier and Type	Field	Description
private ProfileInterceptorFlowDescriptor	attemptedFlow	The last flow attempted.
private Map<String,ProfileInterceptorFlowDescriptor>	availableFlows	Flows that need to be executed.
private List<ProfileInterceptorResult>	results	Results of the flow to be written to storage.

Constructor Summary

Constructors

Constructor	Description
ProfileInterceptorContext()	Constructor.

Method Summary

Modifier and Type	Method	Description
ProfileInterceptorFlowDescriptor	getAttemptedFlow()	Get the last flow that was attempted.
Map<String,ProfileInterceptorFlowDescriptor>	getAvailableFlows()	Get the flows that are available to be executed.
List<ProfileInterceptorResult>	getResults()	Get the results of the flow to be written to storage.
void	setAttemptedFlow(ProfileInterceptorFlowDescriptor flow)	Set the last flow that was attempted.

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

addSubcontext, addSubcontext, clearSubcontexts, containsSubcontext, createSubcontext, getParent, getSubcontext, getSubcontext, getSubcontext, getSubcontext, iterator, 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 Detail

attemptedFlow

@Nullable
private ProfileInterceptorFlowDescriptor attemptedFlow

The last flow attempted.

availableFlows

@Nonnull
@NonnullElements
private final Map<String,ProfileInterceptorFlowDescriptor> availableFlows

Flows that need to be executed.

results

@Nonnull
@NonnullElements
private final List<ProfileInterceptorResult> results

Results of the flow to be written to storage.

Constructor Detail

ProfileInterceptorContext

public ProfileInterceptorContext()

Constructor.

Method Detail

getAttemptedFlow

@Nullable
public ProfileInterceptorFlowDescriptor getAttemptedFlow()

Get the last flow that was attempted.

Returns:

last flow that was attempted

setAttemptedFlow

public void setAttemptedFlow(@Nullable
                             ProfileInterceptorFlowDescriptor flow)

Set the last flow that was attempted.

Parameters:

flow - last flow that was attempted

getAvailableFlows

@Nonnull
@NonnullElements
@Live
public Map<String,ProfileInterceptorFlowDescriptor> getAvailableFlows()

Get the flows that are available to be executed.

Returns:

the available flows

getResults

@Nonnull
@NonnullElements
@Live
public List<ProfileInterceptorResult> getResults()

Get the results of the flow to be written to storage.

Returns:

the results of the flow to be written to storage