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.

  • Field Details

  • Constructor Details

    • LogoutContext

      public LogoutContext()
      Constructor.
  • Method Details

    • 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