Package net.shibboleth.sp.profile

Class AbstractAgentRequestAction

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

All Implemented Interfaces:

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

Direct Known Subclasses:

AbstractAgentAction, CreateOutputMessage, DoPing, EncodeAgentResponse, PrepareAgentErrorResponse

public abstract class AbstractAgentRequestAction
extends AbstractProfileAction

Base class for agent profile actions that handles lookup of the AgentRequestContext.

This class guarantees that the context exists after doPreExecute(ProfileRequestContext) runs and returns true.

Event:

EventIds.PROCEED_EVENT_ID, EventIds.INVALID_PROFILE_CTX

Field Summary

Fields

Modifier and Type	Field	Description
private AgentRequestContext	agentRequestContext	Cached context to populate.
private Function<ProfileRequestContext,AgentRequestContext>	agentRequestContextLookupStrategy	Lookup strategy for AgentRequestContext.
private final org.slf4j.Logger	log	Class logger.

Constructor Summary

Constructors

Constructor	Description
AbstractAgentRequestAction()	Constructor.

Method Summary

Modifier and Type	Method	Description
protected boolean	doPreExecute(ProfileRequestContext profileRequestContext)
AgentRequestContext	ensureAgentRequestContext()	Gets the cached request context located by the lookup strategy.
AgentRequestContext	getAgentRequestContext()	Gets the cached request context located by the lookup strategy.
void	setAgentRequestContextLookupStrategy(Function<ProfileRequestContext,AgentRequestContext> strategy)	Sets the lookup strategy for the AgentRequestContext.

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

doExecute, 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.

agentRequestContextLookupStrategy

@Nonnull
private Function<ProfileRequestContext,AgentRequestContext> agentRequestContextLookupStrategy

Lookup strategy for AgentRequestContext.

agentRequestContext

@NonnullBeforeExec
private AgentRequestContext agentRequestContext

Cached context to populate.

Constructor Details

AbstractAgentRequestAction

public AbstractAgentRequestAction()

Constructor.

Method Details

getAgentRequestContext

@Nullable
public AgentRequestContext getAgentRequestContext()

Gets the cached request context located by the lookup strategy.

Returns:

cached request context or null

ensureAgentRequestContext

@Nonnull
public AgentRequestContext ensureAgentRequestContext()

Gets the cached request context located by the lookup strategy.

Returns:

cached request context

setAgentRequestContextLookupStrategy

public void setAgentRequestContextLookupStrategy(@Nonnull
 Function<ProfileRequestContext,AgentRequestContext> strategy)

Sets the lookup strategy for the AgentRequestContext.

Parameters:

strategy - lookup strategy

doPreExecute

protected boolean doPreExecute(@Nonnull
 ProfileRequestContext profileRequestContext)

Overrides:

doPreExecute in class AbstractConditionalProfileAction