net.shibboleth.idp.session.impl

Class ProcessLogout

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.ProcessLogout

All Implemented Interfaces:

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

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

Profile action that resolves an active session from the profile request, and destroys it, populating the associated SPSession objects into a LogoutContext.

A SubjectContext and SessionContext are also populated.

Each SPSession is also assigned a unique number and inserted into the map returned by LogoutContext.getKeyedSessionMap().

Event:

EventIds.PROCEED_EVENT_ID, EventIds.INVALID_PROFILE_CTX, EventIds.IO_ERROR

Postcondition:

The matching IdPSession is destroyed., If a IdPSession was found, then a SubjectContext and LogoutContext will be populated.

Field Summary

Fields

Modifier and Type	Field and Description
private com.google.common.base.Predicate<ProfileRequestContext>	checkAddressCondition Condition to determine whether to enforce address binding on the session.
private org.slf4j.Logger	log Class logger.
private com.google.common.base.Function<ProfileRequestContext,LogoutContext>	logoutContextCreationStrategy Creation/lookup function for LogoutContext.
private com.google.common.base.Function<ProfileRequestContext,SessionContext>	sessionContextCreationStrategy Creation/lookup function for SessionContext.
private SessionManager	sessionManager Session manager.
private SessionResolver	sessionResolver Session resolver.
private com.google.common.base.Function<ProfileRequestContext,CriteriaSet>	sessionResolverCriteriaStrategy Function to return CriteriaSet to give to session resolver.
private com.google.common.base.Function<ProfileRequestContext,SubjectContext>	subjectContextCreationStrategy Creation/lookup function for SubjectContext.

Constructor Summary

Constructors

Constructor and Description
ProcessLogout() Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	doExecute(ProfileRequestContext profileRequestContext)
protected void	doInitialize()
void	setCheckAddressCondition(com.google.common.base.Predicate<ProfileRequestContext> condition) Set condition to determine whether to perform address binding check before use of session.
void	setLogoutContextCreationStrategy(com.google.common.base.Function<ProfileRequestContext,LogoutContext> strategy) Set the creation/lookup strategy for the LogoutContext to populate.
void	setSessionContextCreationStrategy(com.google.common.base.Function<ProfileRequestContext,SessionContext> strategy) Set the creation/lookup strategy for the SessionContext to populate.
void	setSessionManager(SessionManager manager) Set the SessionManager to use.
void	setSessionResolver(SessionResolver resolver) Set the SessionResolver to use.
void	setSessionResolverCriteriaStrategy(com.google.common.base.Function<ProfileRequestContext,CriteriaSet> strategy) Set the strategy for building the CriteriaSet to feed into the SessionResolver.
void	setSubjectContextCreationStrategy(com.google.common.base.Function<ProfileRequestContext,SubjectContext> strategy) Set the creation/lookup strategy for the SubjectContext to populate.

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

sessionResolver

@NonnullAfterInit
private SessionResolver sessionResolver

Session resolver.

sessionManager

@NonnullAfterInit
private SessionManager sessionManager

Session manager.

checkAddressCondition

@Nonnull
private com.google.common.base.Predicate<ProfileRequestContext> checkAddressCondition

Condition to determine whether to enforce address binding on the session.

subjectContextCreationStrategy

@Nonnull
private com.google.common.base.Function<ProfileRequestContext,SubjectContext> subjectContextCreationStrategy

Creation/lookup function for SubjectContext.

sessionContextCreationStrategy

@Nonnull
private com.google.common.base.Function<ProfileRequestContext,SessionContext> sessionContextCreationStrategy

Creation/lookup function for SessionContext.

logoutContextCreationStrategy

@Nonnull
private com.google.common.base.Function<ProfileRequestContext,LogoutContext> logoutContextCreationStrategy

Creation/lookup function for LogoutContext.

sessionResolverCriteriaStrategy

@Nonnull
private com.google.common.base.Function<ProfileRequestContext,CriteriaSet> sessionResolverCriteriaStrategy

Function to return CriteriaSet to give to session resolver.

Constructor Detail

ProcessLogout

public ProcessLogout()

Constructor.

Method Detail

setCheckAddressCondition

public void setCheckAddressCondition(@Nonnull
                            com.google.common.base.Predicate<ProfileRequestContext> condition)

Set condition to determine whether to perform address binding check before use of session.

Defaults to true insofar as the decision is then delegated back to the resolver.

Parameters:

condition - condition to apply

Since:

3.4.0

setSessionResolver

public void setSessionResolver(@Nonnull
                      SessionResolver resolver)

Set the SessionResolver to use.

Parameters:

resolver - session resolver to use

setSessionManager

public void setSessionManager(@Nonnull
                     SessionManager manager)

Set the SessionManager to use.

Parameters:

manager - session manager to use

setSubjectContextCreationStrategy

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

Set the creation/lookup strategy for the SubjectContext to populate.

Parameters:

strategy - creation/lookup strategy

setSessionContextCreationStrategy

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

Set the creation/lookup strategy for the SessionContext to populate.

Parameters:

strategy - creation/lookup strategy

setLogoutContextCreationStrategy

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

Set the creation/lookup strategy for the LogoutContext to populate.

Parameters:

strategy - creation/lookup strategy

setSessionResolverCriteriaStrategy

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

Set the strategy for building the CriteriaSet to feed into the SessionResolver.

Parameters:

strategy - building strategy

doInitialize

protected void doInitialize()
                     throws ComponentInitializationException

Overrides:

doInitialize in class AbstractInitializableComponent

Throws:

ComponentInitializationException

doExecute

protected void doExecute(@Nonnull
             ProfileRequestContext profileRequestContext)

Overrides:

doExecute in class AbstractProfileAction