net.shibboleth.idp.profile.interceptor.impl

Class PopulateProfileInterceptorContext

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

net.shibboleth.idp.profile.interceptor.impl.PopulateProfileInterceptorContext

All Implemented Interfaces:

Component, DestructableComponent, InitializableComponent, org.opensaml.profile.action.ProfileAction, org.springframework.beans.factory.Aware, org.springframework.context.MessageSource, org.springframework.context.MessageSourceAware, org.springframework.webflow.execution.Action

public class PopulateProfileInterceptorContext
extends AbstractProfileInterceptorAction

An profile interceptor action that populates a ProfileInterceptorContext with ProfileInterceptorFlowDescriptor objects based on flow IDs from a lookup function.

The flow IDs used for filtering must omit the ProfileInterceptorFlowDescriptor.FLOW_ID_PREFIX prefix.

Event:

EventIds.PROCEED_EVENT_ID, IdPEventIds.INVALID_PROFILE_CONFIG

Postcondition:

The ProfileInterceptorContext is modified as above.

Field Summary

Fields

Modifier and Type	Field and Description
private Function<org.opensaml.profile.context.ProfileRequestContext,Collection<String>>	activeFlowsLookupStrategy Lookup function for the flow IDs to activate from within the available set.
private Collection<ProfileInterceptorFlowDescriptor>	availableFlows The flows to make available for possible use.
private org.slf4j.Logger	log Class logger.

Constructor Summary

Constructors

Constructor and Description
PopulateProfileInterceptorContext() Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	doExecute(org.opensaml.profile.context.ProfileRequestContext profileRequestContext, ProfileInterceptorContext interceptorContext)
protected void	doInitialize()
void	setActiveFlowsLookupStrategy(Function<org.opensaml.profile.context.ProfileRequestContext,Collection<String>> strategy) Set the lookup strategy to use for the interceptor flows to activate.
void	setAvailableFlows(Collection<ProfileInterceptorFlowDescriptor> flows) Set the flows available for possible use.

Methods inherited from class net.shibboleth.idp.profile.interceptor.AbstractProfileInterceptorAction

doExecute, doPreExecute, doPreExecute, setLookupStrategy

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, 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 org.slf4j.Logger log

Class logger.

availableFlows

@Nonnull
@NonnullElements
private Collection<ProfileInterceptorFlowDescriptor> availableFlows

The flows to make available for possible use.

activeFlowsLookupStrategy

@NonnullAfterInit
private Function<org.opensaml.profile.context.ProfileRequestContext,Collection<String>> activeFlowsLookupStrategy

Lookup function for the flow IDs to activate from within the available set.

Constructor Detail

PopulateProfileInterceptorContext

public PopulateProfileInterceptorContext()

Constructor.

Method Detail

setAvailableFlows

public void setAvailableFlows(@Nonnull@NonnullElements
                     Collection<ProfileInterceptorFlowDescriptor> flows)

Set the flows available for possible use.

Parameters:

flows - the flows available for possible use

setActiveFlowsLookupStrategy

public void setActiveFlowsLookupStrategy(@Nonnull
                                Function<org.opensaml.profile.context.ProfileRequestContext,Collection<String>> strategy)

Set the lookup strategy to use for the interceptor flows to activate.

Parameters:

strategy - lookup strategy

doInitialize

protected void doInitialize()
                     throws ComponentInitializationException

Overrides:

doInitialize in class AbstractInitializableComponent

Throws:

ComponentInitializationException

doExecute

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

Overrides:

doExecute in class AbstractProfileInterceptorAction