Package net.shibboleth.idp.session
Interface SessionManager
- All Known Implementing Classes:
StorageBackedSessionManager
@ThreadSafe
public interface SessionManager
Component that manages sessions between the IdP and client devices.
-
Method Summary
Modifier and TypeMethodDescriptioncreateSession
(String principalName) Create and return a newIdPSession
object for a subject.void
destroySession
(String sessionId, boolean unbind) Invalidates or otherwise removes a session from persistent storage and/or unbinds it from a client.
-
Method Details
-
createSession
Create and return a newIdPSession
object for a subject.Implementations may perform additional work to persist or associate the session with the client.
- Parameters:
principalName
- canonical name of the subject of the session- Returns:
- the newly created session
- Throws:
SessionException
- if the session cannot be created
-
destroySession
Invalidates or otherwise removes a session from persistent storage and/or unbinds it from a client.After calling this method, no further method calls on a corresponding
IdPSession
object that may be in hand are guaranteed to function correctly. Their behavior is unspecified.- Parameters:
sessionId
- the unique ID of the session to destroyunbind
- whether the session should be unbound from the client- Throws:
SessionException
- if the session cannot be destroyed
-