Interface SessionStore
-
- All Superinterfaces:
Component
- All Known Implementing Classes:
AbstractLettuceSessionStore
,AbstractSessionStore
,ClusterLettuceSessionStore
,DefaultLettuceSessionStore
,FileSessionStore
,MasterReplicaLettuceSessionStore
public interface SessionStore extends Component
A SessionStore is a mechanism for (persistently) storing data associated with sessions.Created: 2017. 6. 15.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description boolean
delete(java.lang.String id)
Delete session data.boolean
exists(java.lang.String id)
Test if data exists for a given session id.java.util.Set<java.lang.String>
getExpired(java.util.Set<java.lang.String> candidates)
Called periodically, this method should search the data store for sessions that have been expired for a 'reasonable' amount of time.java.util.Set<java.lang.String>
getNonPersistentAttributes()
Returns the names of the attributes that should be excluded from serialization.SessionData
load(java.lang.String id)
Read in session data.void
save(java.lang.String id, SessionData data)
Save the session data.-
Methods inherited from interface com.aspectran.core.component.Component
destroy, getComponentName, initialize, isAvailable, isDestroyed, isDestroying, isInitialized
-
-
-
-
Method Detail
-
load
SessionData load(java.lang.String id) throws java.lang.Exception
Read in session data.- Parameters:
id
- identity of session to load- Returns:
- the SessionData matching the id
- Throws:
java.lang.Exception
- if unable to load session data
-
save
void save(java.lang.String id, SessionData data) throws java.lang.Exception
Save the session data.- Parameters:
id
- identity of session to storedata
- info of session to store- Throws:
java.lang.Exception
- if unable to write session data
-
delete
boolean delete(java.lang.String id) throws java.lang.Exception
Delete session data.- Parameters:
id
- identity of session to delete- Returns:
- true if the session was deleted
- Throws:
java.lang.Exception
- if unable to delete session data
-
exists
boolean exists(java.lang.String id) throws java.lang.Exception
Test if data exists for a given session id.- Parameters:
id
- Identity of session whose existence should be checked- Returns:
- true if valid, non-expired session exists
- Throws:
java.lang.Exception
- if there is a problem checking the existence with persistence layer
-
getExpired
java.util.Set<java.lang.String> getExpired(java.util.Set<java.lang.String> candidates)
Called periodically, this method should search the data store for sessions that have been expired for a 'reasonable' amount of time.- Parameters:
candidates
- if provided, these are keys of sessions that the SessionStore thinks has expired and should be verified by the SessionStore- Returns:
- set of session ids
-
getNonPersistentAttributes
java.util.Set<java.lang.String> getNonPersistentAttributes()
Returns the names of the attributes that should be excluded from serialization.- Returns:
- the attribute names to be excluded from serialization
-
-