Package org.eclipse.jetty.server.session
Class AbstractSessionDataStore
- java.lang.Object
-
- org.eclipse.jetty.util.component.AbstractLifeCycle
-
- org.eclipse.jetty.util.component.ContainerLifeCycle
-
- org.eclipse.jetty.server.session.AbstractSessionDataStore
-
- All Implemented Interfaces:
SessionDataMap
,SessionDataStore
,Container
,Destroyable
,Dumpable
,Dumpable.DumpableContainer
,LifeCycle
- Direct Known Subclasses:
FileSessionDataStore
,JDBCSessionDataStore
,NullSessionDataStore
@ManagedObject @Deprecated(since="2021-05-27") public abstract class AbstractSessionDataStore extends ContainerLifeCycle implements SessionDataStore
Deprecated.The Eclipse Jetty and Apache Felix Http Jetty packages are no longer supported.AbstractSessionDataStore
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class org.eclipse.jetty.util.component.AbstractLifeCycle
AbstractLifeCycle.AbstractLifeCycleListener
-
Nested classes/interfaces inherited from interface org.eclipse.jetty.util.component.Container
Container.InheritedListener, Container.Listener
-
Nested classes/interfaces inherited from interface org.eclipse.jetty.util.component.Dumpable
Dumpable.DumpableContainer
-
Nested classes/interfaces inherited from interface org.eclipse.jetty.util.component.LifeCycle
LifeCycle.Listener
-
-
Constructor Summary
Constructors Constructor Description AbstractSessionDataStore()
Deprecated.
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods Modifier and Type Method Description abstract java.util.Set<java.lang.String>
doGetExpired(java.util.Set<java.lang.String> candidates)
Deprecated.Implemented by subclasses to resolve which sessions this node should attempt to expire.abstract SessionData
doLoad(java.lang.String id)
Deprecated.Load the session from persistent store.abstract void
doStore(java.lang.String id, SessionData data, long lastSaveTime)
Deprecated.Store the session data persistently.java.util.Set<java.lang.String>
getExpired(java.util.Set<java.lang.String> candidates)
Deprecated.Called periodically, this method should search the data store for sessions that have been expired for a 'reasonable' amount of time.int
getGracePeriodSec()
Deprecated.int
getSavePeriodSec()
Deprecated.void
initialize(SessionContext context)
Deprecated.Initialize this data map for the given context.SessionData
load(java.lang.String id)
Deprecated.Read in session data.SessionData
newSessionData(java.lang.String id, long created, long accessed, long lastAccessed, long maxInactiveMs)
Deprecated.Create a new SessionDatavoid
setGracePeriodSec(int sec)
Deprecated.void
setSavePeriodSec(int savePeriodSec)
Deprecated.The minimum time in seconds between save operations.void
store(java.lang.String id, SessionData data)
Deprecated.Store the session data.java.lang.String
toString()
Deprecated.-
Methods inherited from class org.eclipse.jetty.util.component.ContainerLifeCycle
addBean, addBean, addEventListener, addManaged, contains, destroy, dump, dump, dump, dump, dump, dumpObject, dumpStdErr, getBean, getBeans, getBeans, getContainedBeans, isAuto, isManaged, isUnmanaged, manage, removeBean, removeBeans, removeEventListener, setBeans, setStopTimeout, unmanage, updateBean, updateBean, updateBeans
-
Methods inherited from class org.eclipse.jetty.util.component.AbstractLifeCycle
addLifeCycleListener, getState, getState, getStopTimeout, isFailed, isRunning, isStarted, isStarting, isStopped, isStopping, removeLifeCycleListener, start, stop
-
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface org.eclipse.jetty.util.component.Dumpable.DumpableContainer
isDumpable
-
Methods inherited from interface org.eclipse.jetty.util.component.LifeCycle
addLifeCycleListener, isFailed, isRunning, isStarted, isStarting, isStopped, isStopping, removeLifeCycleListener, start, stop
-
Methods inherited from interface org.eclipse.jetty.server.session.SessionDataMap
delete
-
Methods inherited from interface org.eclipse.jetty.server.session.SessionDataStore
exists, isPassivating
-
-
-
-
Method Detail
-
doStore
public abstract void doStore(java.lang.String id, SessionData data, long lastSaveTime) throws java.lang.Exception
Deprecated.Store the session data persistently.- Parameters:
id
- identity of session to storedata
- info of the sessionlastSaveTime
- time of previous save or 0 if never saved- Throws:
java.lang.Exception
- if unable to store data
-
doLoad
public abstract SessionData doLoad(java.lang.String id) throws java.lang.Exception
Deprecated.Load the session from persistent store.- Parameters:
id
- the id of the session to load- Returns:
- the re-inflated session
- Throws:
java.lang.Exception
- if unable to load the session
-
doGetExpired
public abstract java.util.Set<java.lang.String> doGetExpired(java.util.Set<java.lang.String> candidates)
Deprecated.Implemented by subclasses to resolve which sessions this node should attempt to expire.- Parameters:
candidates
- the ids of sessions the SessionDataStore thinks has expired- Returns:
- the reconciled set of session ids that this node should attempt to expire
-
initialize
public void initialize(SessionContext context) throws java.lang.Exception
Deprecated.Description copied from interface:SessionDataMap
Initialize this data map for the given context. A SessionDataMap can only be used by one context(/session manager).- Specified by:
initialize
in interfaceSessionDataMap
- Parameters:
context
- context associated- Throws:
java.lang.Exception
- if unable to initialize the
-
load
public SessionData load(java.lang.String id) throws java.lang.Exception
Deprecated.Description copied from interface:SessionDataMap
Read in session data.- Specified by:
load
in interfaceSessionDataMap
- Parameters:
id
- identity of session to load- Returns:
- the SessionData matching the id
- Throws:
java.lang.Exception
- if unable to load session data
-
store
public void store(java.lang.String id, SessionData data) throws java.lang.Exception
Deprecated.Description copied from interface:SessionDataMap
Store the session data.- Specified by:
store
in interfaceSessionDataMap
- Parameters:
id
- identity of session to storedata
- info of session to store- Throws:
java.lang.Exception
- if unable to write session data
-
getExpired
public java.util.Set<java.lang.String> getExpired(java.util.Set<java.lang.String> candidates)
Deprecated.Description copied from interface:SessionDataStore
Called periodically, this method should search the data store for sessions that have been expired for a 'reasonable' amount of time.- Specified by:
getExpired
in interfaceSessionDataStore
- Parameters:
candidates
- if provided, these are keys of sessions that the SessionDataStore thinks has expired and should be verified by the SessionDataStore- Returns:
- set of session ids
-
newSessionData
public SessionData newSessionData(java.lang.String id, long created, long accessed, long lastAccessed, long maxInactiveMs)
Deprecated.Description copied from interface:SessionDataStore
Create a new SessionData- Specified by:
newSessionData
in interfaceSessionDataStore
- Parameters:
id
- the idcreated
- the timestamp when createdaccessed
- the timestamp when accessedlastAccessed
- the timestamp when last accessedmaxInactiveMs
- the max inactive time in milliseconds- Returns:
- a new SessionData object
-
getGracePeriodSec
@ManagedAttribute(value="interval in secs to prevent too eager session scavenging", readonly=true) public int getGracePeriodSec()
Deprecated.
-
setGracePeriodSec
public void setGracePeriodSec(int sec)
Deprecated.
-
getSavePeriodSec
@ManagedAttribute(value="min secs between saves", readonly=true) public int getSavePeriodSec()
Deprecated.- Returns:
- the savePeriodSec
-
setSavePeriodSec
public void setSavePeriodSec(int savePeriodSec)
Deprecated.The minimum time in seconds between save operations. Saves normally occur every time the last request exits as session. If nothing changes on the session except for the access time and the persistence technology is slow, this can cause delays.By default the value is 0, which means we save after the last request exists. A non zero value means that we will skip doing the save if the session isn't dirty if the elapsed time since the session was last saved does not exceed this value.
- Parameters:
savePeriodSec
- the savePeriodSec to set
-
toString
public java.lang.String toString()
Deprecated.- Overrides:
toString
in classAbstractLifeCycle
-
-