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

Nested Class Summary

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

BaseContext.ContextSetNoRemoveIteratorDecorator

Field Summary

Fields

Modifier and Type	Field	Description
private Collection<IdPSession>	idpSessions	Primary sessions to destroy.
private Map<String,SPSession>	keyedSessionMap	An index of the session objects by an externally assigned key.
private Multimap<String,SPSession>	sessionMap	SP sessions needing logout.

Constructor Summary

Constructors

Constructor	Description
LogoutContext()	Constructor.

Method Summary

Modifier and Type	Method	Description
Collection<IdPSession>	getIdPSessions()	Get a live collection of the IdP Sessions being destroyed.
Map<String,SPSession>	getKeyedSessionMap()	Get a live view of the map of sessions keyed by an external value.
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, iterator, removeSubcontext, removeSubcontext, setParent

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

idpSessions

@Nonnull
@NonnullElements
private final Collection<IdPSession> idpSessions

Primary sessions to destroy.

sessionMap

@Nonnull
@NonnullElements
private final 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

getIdPSessions

@Nonnull
@NonnullElements
@Live
public Collection<IdPSession> getIdPSessions()

Get a live collection of the IdP Sessions being destroyed.

Returns:

sessions being destroyed

Since:

4.0.0

getSessionMap

@Nonnull
@NonnullElements
@Live
public 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