net.shibboleth.idp.authn

Class AbstractAuthenticationAction<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.authn.AbstractAuthenticationAction<InboundMessageType,OutboundMessageType>

Type Parameters:

InboundMessageType - type of in-bound message

OutboundMessageType - type of out-bound message

All Implemented Interfaces:

Component, DestructableComponent, InitializableComponent, ProfileAction<InboundMessageType,OutboundMessageType>, org.springframework.beans.factory.Aware, org.springframework.context.MessageSource, org.springframework.context.MessageSourceAware, org.springframework.webflow.execution.Action

Direct Known Subclasses:

AbstractExtractionAction, AbstractValidationAction

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

A base class for authentication related actions. In addition to the work performed by AbstractProfileAction, this action also looks up and makes available the AuthenticationContext. Authentication action implementations should override doExecute(ProfileRequestContext, AuthenticationContext)

Event:

AuthnEventIds.INVALID_AUTHN_CTX

Field Summary

Fields

Modifier and Type	Field and Description
private AuthenticationContext	authnContext AuthenticationContext to operate on.
private com.google.common.base.Function<ProfileRequestContext,AuthenticationContext>	authnCtxLookupStrategy Strategy used to extract, and create if necessary, the AuthenticationContext from the ProfileRequestContext.

Constructor Summary

Constructors

Constructor and Description
AbstractAuthenticationAction() Constructor.

Method Summary

Methods

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

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

doExecute, execute, getMessage, getMessage, getMessage, 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, 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

authnCtxLookupStrategy

@Nonnull
private com.google.common.base.Function<ProfileRequestContext,AuthenticationContext> authnCtxLookupStrategy

Strategy used to extract, and create if necessary, the AuthenticationContext from the ProfileRequestContext.

authnContext

@Nullable
private AuthenticationContext authnContext

AuthenticationContext to operate on.

Constructor Detail

AbstractAuthenticationAction

public AbstractAuthenticationAction()

Constructor.

Method Detail

setLookupStrategy

public void setLookupStrategy(@Nonnull
                     com.google.common.base.Function<ProfileRequestContext,AuthenticationContext> strategy)

Set the context lookup strategy.

Parameters:

strategy - lookup strategy function for AuthenticationContext.

doPreExecute

protected final boolean doPreExecute(@Nonnull
                   ProfileRequestContext<InboundMessageType,OutboundMessageType> profileRequestContext)

Overrides:

doPreExecute in class AbstractConditionalProfileAction<InboundMessageType,OutboundMessageType>

doExecute

protected final void doExecute(@Nonnull
             ProfileRequestContext<InboundMessageType,OutboundMessageType> profileRequestContext)

Overrides:

doExecute in class AbstractProfileAction<InboundMessageType,OutboundMessageType>

doPreExecute

protected boolean doPreExecute(@Nonnull
                   ProfileRequestContext<InboundMessageType,OutboundMessageType> profileRequestContext,
                   @Nonnull
                   AuthenticationContext authenticationContext)

Performs this authentication action's pre-execute step. Default implementation just returns true.

Parameters:

profileRequestContext - the current IdP profile request context

authenticationContext - the current authentication context

Returns:

true iff execution should continue

doExecute

protected void doExecute(@Nonnull
             ProfileRequestContext<InboundMessageType,OutboundMessageType> profileRequestContext,
             @Nonnull
             AuthenticationContext authenticationContext)

Performs this authentication action. Default implementation throws an exception.

Parameters:

profileRequestContext - the current IdP profile request context

authenticationContext - the current authentication context