Package org.pac4j.core.context.session
Interface SessionStore
public interface SessionStore
To store data in session.
- Since:
- 1.8.1
- Author:
- Jerome Leleu
-
Method Summary
Modifier and TypeMethodDescriptionbuildFromTrackableSession
(WebContext context, Object trackableSession) Build a new session store from a trackable session.boolean
destroySession
(WebContext context) Destroy the web session.get
(WebContext context, String key) Get the object from its key in store.getSessionId
(WebContext context, boolean createSession) Get or create the session identifier and initialize the session with it if necessary.getTrackableSession
(WebContext context) Get the native session as a trackable object.boolean
renewSession
(WebContext context) Renew the native session by copying all data to a new one.void
set
(WebContext context, String key, Object value) Save an object in the store by its key.
-
Method Details
-
getSessionId
Get or create the session identifier and initialize the session with it if necessary.- Parameters:
context
- the web context- Returns:
- the optional session identifier
-
get
Get the object from its key in store.- Parameters:
context
- the web contextkey
- the key of the object- Returns:
- the optional object in store
-
set
Save an object in the store by its key.- Parameters:
context
- the web contextkey
- the key of the objectvalue
- the value to save in store
-
destroySession
Destroy the web session.- Parameters:
context
- the web context- Returns:
- whether the session has been destroyed
-
getTrackableSession
Get the native session as a trackable object.- Parameters:
context
- the web context- Returns:
- the optional trackable object
-
buildFromTrackableSession
Build a new session store from a trackable session.- Parameters:
context
- the web contexttrackableSession
- the trackable session- Returns:
- the optional new session store
-
renewSession
Renew the native session by copying all data to a new one.- Parameters:
context
- the web context- Returns:
- whether the session store has renewed the session
-