Package net.shibboleth.sp.profile

Class AbstractAgentAction

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

All Implemented Interfaces:

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

Direct Known Subclasses:

AbstractApplicationAction, DecodeAgentRequest, DoSealerOperation, DoSessionCacheOperation, DoStorageOperation, ResolveApplication, ValidateAgentAddress, ValidateCachedAuthentication

public abstract class AbstractAgentAction
extends AbstractAgentRequestAction

Base class for actions that need access to the Agent in an AgentRequestContext.

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

Event:

EventIds.PROCEED_EVENT_ID, EventIds.INVALID_PROFILE_CTX

Precondition:

ensureAgentRequestContext().getAgent() != null

Field Summary

Fields

Modifier and Type	Field	Description
private Agent	agent	Cached agent from context.
private final org.slf4j.Logger	log	Class logger.

Constructor Summary

Constructors

Constructor	Description
AbstractAgentAction()

Method Summary

Modifier and Type	Method	Description
protected boolean	doPreExecute(ProfileRequestContext profileRequestContext)
Agent	ensureAgent()	Gets the Agent for this request.
Agent	getAgent()	Gets the Agent for this request.

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

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.

agent

@NonnullBeforeExec
private Agent agent

Cached agent from context.

Constructor Details

AbstractAgentAction

public AbstractAgentAction()

Method Details

doPreExecute

protected boolean doPreExecute(@Nonnull
 ProfileRequestContext profileRequestContext)

Overrides:

doPreExecute in class AbstractAgentRequestAction

getAgent

@Nullable
public Agent getAgent()

Gets the Agent for this request.

Returns:

the agent, or null

ensureAgent

@Nonnull
public Agent ensureAgent()

Gets the Agent for this request.

Returns:

the agent