net.shibboleth.idp.session.impl

Class SelectLogoutPropagationFlow

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

net.shibboleth.idp.session.impl.SelectLogoutPropagationFlow

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, Aware, MessageSource, MessageSourceAware, org.springframework.webflow.execution.Action

public class SelectLogoutPropagationFlow
extends net.shibboleth.idp.profile.AbstractProfileAction

A profile action that selects a logout propagation flow to invoke.

This is the heart of the logout propagation processing sequence, and runs after the LogoutContext has been populated. It uses the potential flows, and their associated activation conditions to decide how to proceed.

This is a rare case in that the standard default event, EventIds.PROCEED_EVENT_ID, cannot be returned, because the action must either dispatch to a flow by name, or signal an error.

Event:

AuthnEventIds.NO_POTENTIAL_FLOW, Selected flow ID to execute

Field Summary

Fields

Modifier and Type	Field and Description
private List<LogoutPropagationFlowDescriptor>	availableFlows The available flows for use.
private Logger	log Class logger.

Constructor Summary

Constructors

Constructor and Description
SelectLogoutPropagationFlow() Constructor.

Method Summary

Modifier and Type	Method and Description
protected void	doExecute(org.opensaml.profile.context.ProfileRequestContext profileRequestContext)
private LogoutPropagationFlowDescriptor	selectUnattemptedFlow(org.opensaml.profile.context.ProfileRequestContext profileRequestContext) Select the first potential flow that is applicable to the context.
void	setAvailableFlows(List<LogoutPropagationFlowDescriptor> flows) Set the available flows to choose from.

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

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

availableFlows

@Nonnull
 @NonnullElements
private List<LogoutPropagationFlowDescriptor> availableFlows

The available flows for use.

Constructor Detail

SelectLogoutPropagationFlow

public SelectLogoutPropagationFlow()

Constructor.

Method Detail

setAvailableFlows

public void setAvailableFlows(@Nonnull @NonnullElements
                              List<LogoutPropagationFlowDescriptor> flows)

Set the available flows to choose from.

Parameters:

flows - available flows

doExecute

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

Overrides:

doExecute in class org.opensaml.profile.action.AbstractProfileAction

selectUnattemptedFlow

@Nullable
private LogoutPropagationFlowDescriptor selectUnattemptedFlow(@Nonnull
                                                                        org.opensaml.profile.context.ProfileRequestContext profileRequestContext)

Select the first potential flow that is applicable to the context.

Parameters:

profileRequestContext - the current IdP profile request context

Returns:

an eligible flow, or null