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:

Component, DestructableComponent, InitializableComponent, org.opensaml.profile.action.ProfileAction, Aware, MessageSource, MessageSourceAware, 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 Function<SPSession,LogoutPropagationFlowDescriptor>	flowSelectorFunction Selection function to determine suitable LogoutPropagationFlowDescriptor for given SPSession.
private Logger	log Class logger.
private Function<org.opensaml.profile.context.ProfileRequestContext,LogoutPropagationContext>	logoutPropagationContextFunction Function to retrieve LogoutPropagationContext from context tree.

Constructor Summary

Constructors

Constructor and Description
SelectLogoutPropagationFlow(Function<SPSession,LogoutPropagationFlowDescriptor> selector) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	doExecute(org.opensaml.profile.context.ProfileRequestContext profileRequestContext)
void	setLogoutPropagationContextFunction(Function<org.opensaml.profile.context.ProfileRequestContext,LogoutPropagationContext> function) Sets the function used to retrieve the LogoutPropagationContext from the context tree.

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

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.

flowSelectorFunction

@Nonnull
private final Function<SPSession,LogoutPropagationFlowDescriptor> flowSelectorFunction

Selection function to determine suitable LogoutPropagationFlowDescriptor for given SPSession.

logoutPropagationContextFunction

@Nonnull
private Function<org.opensaml.profile.context.ProfileRequestContext,LogoutPropagationContext> logoutPropagationContextFunction

Function to retrieve LogoutPropagationContext from context tree.

Constructor Detail

SelectLogoutPropagationFlow

public SelectLogoutPropagationFlow(@Nonnull
                           Function<SPSession,LogoutPropagationFlowDescriptor> selector)

Constructor.

Parameters:

selector - mapping function from session to flow descriptor

Method Detail

setLogoutPropagationContextFunction

public void setLogoutPropagationContextFunction(@Nonnull
                                       Function<org.opensaml.profile.context.ProfileRequestContext,LogoutPropagationContext> function)

Sets the function used to retrieve the LogoutPropagationContext from the context tree.

Parameters:

function - Lookup function.

doExecute

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

Overrides:

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