Package org.spincast.plugins.session
Interface SpincastSessionManager
- All Known Implementing Classes:
SpincastSessionManagerDefault
public interface SpincastSessionManager
Manager for
SpincastSession
.-
Method Summary
Modifier and TypeMethodDescriptionCreates a new session.createSession
(String sessionId, Instant creationDate, Instant modificationDate, JsonObject attributes) Creates a session from infos, with existing attributes if any (null
otherwise)void
Deletes the current session in the request context, if any.void
deleteOldInactiveSession
(int sessionMaxInactiveMinutes) Deletes the deletes that were inactive for too long.void
deleteSession
(String sessionId) Deletes a saved session.void
Deletes the session id on the user.Generates a new session id.Gets the session of the current user, from the request context.getSavedSession
(String sessionId) Gets a session from the database/data source.void
saveSession
(SpincastSession session) Save session.void
saveSessionIdOnUser
(String sessionId, boolean permanent) Will save the session id to the user (by default using a cookie).void
Saves a session, but update its modification date first.
-
Method Details
-
generateNewSessionId
String generateNewSessionId()Generates a new session id. -
createNewSession
SpincastSession createNewSession()Creates a new session. -
createSession
SpincastSession createSession(String sessionId, Instant creationDate, Instant modificationDate, JsonObject attributes) Creates a session from infos, with existing attributes if any (null
otherwise) -
getCurrentSession
SpincastSession getCurrentSession()Gets the session of the current user, from the request context. If not in a request context, returnsnull
. -
getSavedSession
Gets a session from the database/data source.- Returns:
- the session or
null
if not found.
-
updateModificationDateAndSaveSession
Saves a session, but update its modification date first.The session to save must have a session id.
-
saveSession
Save session. -
deleteSession
Deletes a saved session. -
deleteCurrentSession
void deleteCurrentSession()Deletes the current session in the request context, if any. -
saveSessionIdOnUser
Will save the session id to the user (by default using a cookie).- Parameters:
permanent
- iftrue
, the session id will be kept when the browser session expires.
-
deleteSessionIdOnUser
void deleteSessionIdOnUser()Deletes the session id on the user. By default, will delete the session id cookie. -
deleteOldInactiveSession
void deleteOldInactiveSession(int sessionMaxInactiveMinutes) Deletes the deletes that were inactive for too long. This means their last "modification date" must be older than the specified number of mminutes.
-