Package net.shibboleth.sp.profile.impl

Class PrepareAgentErrorResponse

java.lang.Object

net.shibboleth.shared.component.AbstractInitializableComponent

org.opensaml.profile.action.AbstractProfileAction

org.opensaml.profile.action.AbstractConditionalProfileAction

net.shibboleth.idp.profile.AbstractProfileAction

net.shibboleth.sp.profile.AbstractAgentRequestAction

net.shibboleth.sp.profile.impl.PrepareAgentErrorResponse

All Implemented Interfaces:

Component, DestructableComponent, InitializableComponent, ProfileAction, Aware, MessageSource, MessageSourceAware, Action

public class PrepareAgentErrorResponse
extends AbstractAgentRequestAction

A profile action to encode the current event (typically an error) into an agent response in an AgentRequestContext.

If no event can be identified a generic event of EventIds.MESSAGE_PROC_ERROR is used.

Event:

EventIds.PROCEED_EVENT_ID, EventIds.INVALID_PROFILE_CTX

Precondition:

AgentRequestContext.getOutput().isstruct()

Field Summary

Fields

Modifier and Type	Field	Description
private Function<ProfileRequestContext,EventContext>	eventContextLookupStrategy	Strategy function for access to EventContext to check.
private final org.slf4j.Logger	log	Class logger.
private DDF	output	Cached output object.
private Function<ProfileRequestContext,StateDataContext>	stateDataContextLookupStrategy	Strategy used to create the StateDataContext to populate.

Constructor Summary

Constructors

Constructor	Description
PrepareAgentErrorResponse()	Constructor.

Method Summary

Modifier and Type	Method	Description
protected void	doExecute(ProfileRequestContext profileRequestContext)
protected boolean	doPreExecute(ProfileRequestContext profileRequestContext)
void	setEventContextLookupStrategy(Function<ProfileRequestContext,EventContext> strategy)	Set lookup strategy for EventContext to check.
void	setStateDataContextLookupStrategy(Function<ProfileRequestContext,StateDataContext> strategy)	Sets the strategy used to lookup the StateDataContext.

Methods inherited from class net.shibboleth.sp.profile.AbstractAgentRequestAction

ensureAgentRequestContext, getAgentRequestContext, setAgentRequestContextLookupStrategy

Methods inherited from class net.shibboleth.idp.profile.AbstractProfileAction

doExecute, execute, getBean, getBean, getMessage, getMessage, getMessage, getParameter, getParameter, getProfileContextLookupStrategy, getRequestContext, getResult, setMessageSource, setProfileContextLookupStrategy

Methods inherited from class org.opensaml.profile.action.AbstractConditionalProfileAction

getActivationCondition, setActivationCondition

Methods inherited from class org.opensaml.profile.action.AbstractProfileAction

doPostExecute, doPostExecute, ensureHttpServletRequest, ensureHttpServletResponse, execute, getHttpServletRequest, getHttpServletRequestSupplier, getHttpServletResponse, getHttpServletResponseSupplier, getLogPrefix, isPreExecuteCalled, setHttpServletRequestSupplier, setHttpServletResponseSupplier

Methods inherited from class net.shibboleth.shared.component.AbstractInitializableComponent

checkComponentActive, checkSetterPreconditions, destroy, doDestroy, doInitialize, ifDestroyedThrowDestroyedComponentException, ifInitializedThrowUnmodifiabledComponentException, ifNotInitializedThrowUninitializedComponentException, initialize, isDestroyed, isInitialized

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.shibboleth.shared.component.InitializableComponent

initialize, isInitialized

Field Details

log

@Nonnull
private final org.slf4j.Logger log

Class logger.

eventContextLookupStrategy

@Nonnull
private Function<ProfileRequestContext,EventContext> eventContextLookupStrategy

Strategy function for access to EventContext to check.

stateDataContextLookupStrategy

@Nonnull
private Function<ProfileRequestContext,StateDataContext> stateDataContextLookupStrategy

Strategy used to create the StateDataContext to populate.

output

@NonnullBeforeExec
private DDF output

Cached output object.

Constructor Details

PrepareAgentErrorResponse

public PrepareAgentErrorResponse()

Constructor.

Method Details

setEventContextLookupStrategy

public void setEventContextLookupStrategy(@Nonnull
 Function<ProfileRequestContext,EventContext> strategy)

Set lookup strategy for EventContext to check.

Parameters:

strategy - lookup strategy

setStateDataContextLookupStrategy

public void setStateDataContextLookupStrategy(@Nonnull
 Function<ProfileRequestContext,StateDataContext> strategy)

Sets the strategy used to lookup the StateDataContext.

Parameters:

strategy - lookup strategy

doPreExecute

protected boolean doPreExecute(ProfileRequestContext profileRequestContext)

Overrides:

doPreExecute in class AbstractAgentRequestAction

doExecute

protected void doExecute(@Nonnull
 ProfileRequestContext profileRequestContext)

Overrides:

doExecute in class AbstractProfileAction