Package net.shibboleth.sp.profile.impl

Class EncodeAgentResponse

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.EncodeAgentResponse

All Implemented Interfaces:

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

public class EncodeAgentResponse
extends AbstractAgentRequestAction

A profile action to encode an agent response from the output DDF in the AgentRequestContext.

This also ensures the final output is a structure, and contains an "event" member, setting it to "success" if not already set, and also populates target from a StateDataContext if available.

If enabled as a feature for the agent, the value of the session ID is also placed in a structure member in the output before encoding to relay it to the agent.

Event:

EventIds.PROCEED_EVENT_ID, EventIds.INVALID_PROFILE_CTX, EventIds.INVALID_MESSAGE, EventIds.IO_ERROR

Postcondition:

AgentRequestContext.getOutput().getmember("event").isstring()

Field Summary

Fields

Modifier and Type	Field	Description
private final org.slf4j.Logger	log	Class logger.
private DDF	outputMessage	Cached context containing the output message.
private Function<ProfileRequestContext,StateDataContext>	stateDataContextLookupStrategy	Strategy used to create the StateDataContext to populate.

Constructor Summary

Constructors

Constructor	Description
EncodeAgentResponse()	Constructor.

Method Summary

Modifier and Type	Method	Description
protected void	doExecute(ProfileRequestContext profileRequestContext)
protected boolean	doPreExecute(ProfileRequestContext profileRequestContext)
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.

stateDataContextLookupStrategy

@Nonnull
private Function<ProfileRequestContext,StateDataContext> stateDataContextLookupStrategy

Strategy used to create the StateDataContext to populate.

outputMessage

@NonnullBeforeExec
private DDF outputMessage

Cached context containing the output message.

Constructor Details

EncodeAgentResponse

public EncodeAgentResponse()

Constructor.

Method Details

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(@Nonnull
 ProfileRequestContext profileRequestContext)

Overrides:

doPreExecute in class AbstractAgentRequestAction

doExecute

protected void doExecute(@Nonnull
 ProfileRequestContext profileRequestContext)

Overrides:

doExecute in class AbstractProfileAction