net.shibboleth.idp.profile.interceptor

Class AbstractProfileInterceptorAction<InboundMessageType,OutboundMessageType>

java.lang.Object

net.shibboleth.utilities.java.support.component.AbstractInitializableComponent

org.opensaml.profile.action.AbstractProfileAction<InboundMessageType,OutboundMessageType>

org.opensaml.profile.action.AbstractConditionalProfileAction<InboundMessageType,OutboundMessageType>

net.shibboleth.idp.profile.AbstractProfileAction<InboundMessageType,OutboundMessageType>

net.shibboleth.idp.profile.interceptor.AbstractProfileInterceptorAction<InboundMessageType,OutboundMessageType>

Type Parameters:

InboundMessageType - type of in-bound message

OutboundMessageType - type of out-bound message

All Implemented Interfaces:

net.shibboleth.utilities.java.support.component.Component, net.shibboleth.utilities.java.support.component.DestructableComponent, net.shibboleth.utilities.java.support.component.InitializableComponent, org.opensaml.profile.action.ProfileAction<InboundMessageType,OutboundMessageType>, Aware, MessageSource, MessageSourceAware, org.springframework.webflow.execution.Action

public abstract class AbstractProfileInterceptorAction<InboundMessageType,OutboundMessageType>
extends AbstractProfileAction<InboundMessageType,OutboundMessageType>

A base class for profile interceptor actions. In addition to the work performed by AbstractProfileAction, this action also looks up and makes available the ProfileInterceptorContext. Interceptor action implementations should override doExecute(ProfileRequestContext, ProfileInterceptorContext)

Field Summary

Fields

Modifier and Type	Field and Description
private com.google.common.base.Function<org.opensaml.profile.context.ProfileRequestContext,ProfileInterceptorContext>	interceptorContextlookupStrategy Strategy used to find the ProfileInterceptorContext from the ProfileRequestContext.
private Logger	log Class logger.
private ProfileInterceptorContext	profileInterceptorContext The ProfileInterceptorContext to operate on.

Constructor Summary

Constructors

Constructor and Description
AbstractProfileInterceptorAction() Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	doExecute(org.opensaml.profile.context.ProfileRequestContext<InboundMessageType,OutboundMessageType> profileRequestContext)
protected void	doExecute(org.opensaml.profile.context.ProfileRequestContext<InboundMessageType,OutboundMessageType> profileRequestContext, ProfileInterceptorContext interceptorContext) Performs this profile interceptor action.
protected boolean	doPreExecute(org.opensaml.profile.context.ProfileRequestContext profileRequestContext)
protected boolean	doPreExecute(org.opensaml.profile.context.ProfileRequestContext<InboundMessageType,OutboundMessageType> profileRequestContext, ProfileInterceptorContext interceptorContext) Performs this profile interceptor action's pre-execute step.
void	setLookupStrategy(com.google.common.base.Function<org.opensaml.profile.context.ProfileRequestContext,ProfileInterceptorContext> strategy) Set the context lookup strategy for ProfileInterceptorContext.

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

doExecute, execute, getMessage, getMessage, getMessage, getProfileContextLookupStrategy, 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, execute, getHttpServletRequest, getHttpServletResponse, getLogPrefix, setHttpServletRequest, setHttpServletResponse

Methods inherited from class net.shibboleth.utilities.java.support.component.AbstractInitializableComponent

destroy, doDestroy, doInitialize, 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.utilities.java.support.component.InitializableComponent

initialize, isInitialized

Field Detail

log

@Nonnull
private final Logger log

Class logger.

interceptorContextlookupStrategy

@Nonnull
private com.google.common.base.Function<org.opensaml.profile.context.ProfileRequestContext,ProfileInterceptorContext> interceptorContextlookupStrategy

Strategy used to find the ProfileInterceptorContext from the ProfileRequestContext.

profileInterceptorContext

@Nullable
private ProfileInterceptorContext profileInterceptorContext

The ProfileInterceptorContext to operate on.

Constructor Detail

AbstractProfileInterceptorAction

public AbstractProfileInterceptorAction()

Constructor.

Method Detail

setLookupStrategy

public void setLookupStrategy(@Nonnull
                     com.google.common.base.Function<org.opensaml.profile.context.ProfileRequestContext,ProfileInterceptorContext> strategy)

Set the context lookup strategy for ProfileInterceptorContext.

Parameters:

strategy - lookup strategy function

doPreExecute

protected boolean doPreExecute(@Nonnull
                   org.opensaml.profile.context.ProfileRequestContext profileRequestContext)

Overrides:

doPreExecute in class org.opensaml.profile.action.AbstractConditionalProfileAction<InboundMessageType,OutboundMessageType>

doPreExecute

protected boolean doPreExecute(@Nonnull
                   org.opensaml.profile.context.ProfileRequestContext<InboundMessageType,OutboundMessageType> profileRequestContext,
                   @Nonnull
                   ProfileInterceptorContext interceptorContext)

Performs this profile interceptor action's pre-execute step. Default implementation returns true.

Parameters:

profileRequestContext - the current profile request context

interceptorContext - the current profile interceptor context

Returns:

true iff execution should continue

doExecute

protected final void doExecute(@Nonnull
             org.opensaml.profile.context.ProfileRequestContext<InboundMessageType,OutboundMessageType> profileRequestContext)

Overrides:

doExecute in class org.opensaml.profile.action.AbstractProfileAction<InboundMessageType,OutboundMessageType>

doExecute

protected void doExecute(@Nonnull
             org.opensaml.profile.context.ProfileRequestContext<InboundMessageType,OutboundMessageType> profileRequestContext,
             @Nonnull
             ProfileInterceptorContext interceptorContext)

Performs this profile interceptor action. Default implementation does nothing.

Parameters:

profileRequestContext - the current profile request context

interceptorContext - the current profile interceptor context