net.shibboleth.idp.session.context

Class LogoutContext

java.lang.Object

org.opensaml.messaging.context.BaseContext

net.shibboleth.idp.session.context.LogoutContext

All Implemented Interfaces:

Iterable<BaseContext>

public final class LogoutContext
extends BaseContext

A BaseContext that holds a multimap of SPSession objects.

This context is used primarily to expose the SPSession objects for which logout is implicated. It also tracks the processing of actions that populate a net.shibboleth.idp.profile.context.MultiRelyingPartyContext tree containing detailed information on each relying party, typically for user interface considerations.

Nested Class Summary

Nested classes/interfaces inherited from class org.opensaml.messaging.context.BaseContext

BaseContext.ContextSetNoRemoveIteratorDecorator

Field Summary

Fields

Modifier and Type	Field and Description
private Map<String,SPSession>	keyedSessionMap An index of the session objects by an externally assigned key.
private com.google.common.collect.Multimap<String,SPSession>	sessionMap SP sessions needing logout.

Constructor Summary

Constructors

Constructor and Description
LogoutContext() Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
Map<String,SPSession>	getKeyedSessionMap() Get a live view of the map of sessions keyed by an external value.
com.google.common.collect.Multimap<String,SPSession>	getSessionMap() Get a live view of the map of service ID/session mappings.
Collection<SPSession>	getSessions(String id) Get a live collection of sessions associated with a service.

Methods inherited from class org.opensaml.messaging.context.BaseContext

addSubcontext, addSubcontext, clearSubcontexts, containsSubcontext, createSubcontext, getParent, getSubcontext, getSubcontext, getSubcontext, getSubcontext, isAutoCreateSubcontexts, iterator, removeSubcontext, removeSubcontext, setAutoCreateSubcontexts, setParent

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

sessionMap

@Nonnull
@NonnullElements
private final com.google.common.collect.Multimap<String,SPSession> sessionMap

SP sessions needing logout.

keyedSessionMap

@Nonnull
@NonnullElements
private final Map<String,SPSession> keyedSessionMap

An index of the session objects by an externally assigned key.

Constructor Detail

LogoutContext

public LogoutContext()

Constructor.

Method Detail

getSessionMap

@Nonnull
@NonnullElements
@Live
public com.google.common.collect.Multimap<String,SPSession> getSessionMap()

Get a live view of the map of service ID/session mappings.

Returns:

service ID/session mappings

getKeyedSessionMap

@Nonnull
@NonnullElements
@Live
public Map<String,SPSession> getKeyedSessionMap()

Get a live view of the map of sessions keyed by an external value.

This map can be used to index the sessions in the context according to a particular use case.

Returns:

keyed session mappings

getSessions

@Nonnull
@NonnullElements
@Live
public Collection<SPSession> getSessions(@Nonnull@NotEmpty
                                                             String id)

Get a live collection of sessions associated with a service.

Parameters:

id - name of service to retrieve

Returns:

the sessions for the service