Module org.eclipse.jetty.server
Package org.eclipse.jetty.server.session

Class JDBCSessionDataStore

  • All Implemented Interfaces:
    SessionDataMap, SessionDataStore, org.eclipse.jetty.util.component.Container, org.eclipse.jetty.util.component.Destroyable, org.eclipse.jetty.util.component.Dumpable, org.eclipse.jetty.util.component.Dumpable.DumpableContainer, org.eclipse.jetty.util.component.LifeCycle
    @ManagedObject
public class JDBCSessionDataStore
extends AbstractSessionDataStore
    JDBCSessionDataStore Session data stored in database

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  JDBCSessionDataStore.SessionTableSchema
      SessionTableSchema

      • Nested classes/interfaces inherited from class org.eclipse.jetty.util.component.AbstractLifeCycle

        org.eclipse.jetty.util.component.AbstractLifeCycle.AbstractLifeCycleListener, org.eclipse.jetty.util.component.AbstractLifeCycle.StopException

      • Nested classes/interfaces inherited from interface org.eclipse.jetty.util.component.Container

        org.eclipse.jetty.util.component.Container.InheritedListener, org.eclipse.jetty.util.component.Container.Listener

      • Nested classes/interfaces inherited from interface org.eclipse.jetty.util.component.Dumpable

        org.eclipse.jetty.util.component.Dumpable.DumpableContainer

      • Nested classes/interfaces inherited from interface org.eclipse.jetty.util.component.LifeCycle

        org.eclipse.jetty.util.component.LifeCycle.Listener

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean delete​(java.lang.String id)
      Delete session data
      java.util.Set<java.lang.String> doCheckExpired​(java.util.Set<java.lang.String> candidates, long time)
      Implemented by subclasses to resolve which sessions in this context that are being managed by this node that should be expired.
      void doCleanOrphans​(long time)
      Implemented by subclasses to delete sessions for other contexts that expired at or before the timeLimit.
      boolean doExists​(java.lang.String id)
      Check if a session for the given id exists.
      java.util.Set<java.lang.String> doGetExpired​(long timeLimit)
      Implemented by subclasses to find sessions for this context in the store that expired at or before the time limit and thus not being actively managed by any node.
      protected void doInsert​(java.lang.String id, SessionData data)  
      SessionData doLoad​(java.lang.String id)
      Load the session from persistent store.
      protected void doStart()  
      protected void doStop()  
      void doStore​(java.lang.String id, SessionData data, long lastSaveTime)
      Store the session data persistently.
      protected void doUpdate​(java.lang.String id, SessionData data)  
      void initialize()  
      boolean isPassivating()
      True if this type of datastore will passivate session objects
      void setDatabaseAdaptor​(DatabaseAdaptor dbAdaptor)  
      void setSessionTableSchema​(JDBCSessionDataStore.SessionTableSchema schema)  

      • Methods inherited from class org.eclipse.jetty.util.component.ContainerLifeCycle

        addBean, addBean, addEventListener, addManaged, contains, destroy, dump, dump, dump, dumpObjects, dumpStdErr, getBean, getBeans, getBeans, getContainedBeans, getContainedBeans, isAuto, isManaged, isUnmanaged, manage, removeBean, removeBeans, removeEventListener, setBeans, start, stop, unmanage, updateBean, updateBean, updateBeans, updateBeans

      • Methods inherited from class org.eclipse.jetty.util.component.AbstractLifeCycle

        getEventListeners, getState, getState, isFailed, isRunning, isStarted, isStarting, isStopped, isStopping, setEventListeners, start, stop

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

      • Methods inherited from interface org.eclipse.jetty.util.component.Container

        getCachedBeans, getEventListeners

      • Methods inherited from interface org.eclipse.jetty.util.component.Dumpable

        dumpSelf

      • Methods inherited from interface org.eclipse.jetty.util.component.Dumpable.DumpableContainer

        isDumpable

      • Methods inherited from interface org.eclipse.jetty.util.component.LifeCycle

        addEventListener, isFailed, isRunning, isStarted, isStarting, isStopped, isStopping, removeEventListener, start, stop

    • Field Detail

      • NULL_CONTEXT_PATH

        public static final java.lang.String NULL_CONTEXT_PATH
        Used for Oracle and other databases where "" is treated as NULL
        See Also:
        Constant Field Values

      • _initialized

        protected boolean _initialized

      • _schemaProvided

        protected boolean _schemaProvided

    • Constructor Detail

      • JDBCSessionDataStore

        public JDBCSessionDataStore()

    • Method Detail

      • doStop

        protected void doStop()
               throws java.lang.Exception
        Overrides:
        doStop in class org.eclipse.jetty.util.component.ContainerLifeCycle
        Throws:
        java.lang.Exception

      • initialize

        public void initialize()
                throws java.lang.Exception
        Throws:
        java.lang.Exception

      • doLoad

        public SessionData doLoad​(java.lang.String id)
                   throws java.lang.Exception
        Description copied from class: AbstractSessionDataStore
        Load the session from persistent store.
        Specified by:
        doLoad in class AbstractSessionDataStore
        Parameters:
        id - the id of the session to load
        Returns:
        the re-inflated session
        Throws:
        java.lang.Exception - if unable to load the session

      • delete

        public boolean delete​(java.lang.String id)
               throws java.lang.Exception
        Description copied from interface: SessionDataMap
        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

      • doStore

        public void doStore​(java.lang.String id,
                    SessionData data,
                    long lastSaveTime)
             throws java.lang.Exception
        Description copied from class: AbstractSessionDataStore
        Store the session data persistently.
        Specified by:
        doStore in class AbstractSessionDataStore
        Parameters:
        id - identity of session to store
        data - info of the session
        lastSaveTime - time of previous save or 0 if never saved
        Throws:
        java.lang.Exception - if unable to store data

      • doInsert

        protected void doInsert​(java.lang.String id,
                        SessionData data)
                 throws java.lang.Exception
        Throws:
        java.lang.Exception

      • doUpdate

        protected void doUpdate​(java.lang.String id,
                        SessionData data)
                 throws java.lang.Exception
        Throws:
        java.lang.Exception

      • doCheckExpired

        public java.util.Set<java.lang.String> doCheckExpired​(java.util.Set<java.lang.String> candidates,
                                                      long time)
        Description copied from class: AbstractSessionDataStore
        Implemented by subclasses to resolve which sessions in this context that are being managed by this node that should be expired.
        Specified by:
        doCheckExpired in class AbstractSessionDataStore
        Parameters:
        candidates - the ids of sessions the SessionCache thinks has expired
        time - the time at which to check for expiry
        Returns:
        the reconciled set of session ids that have been checked in the store

      • doGetExpired

        public java.util.Set<java.lang.String> doGetExpired​(long timeLimit)
        Description copied from class: AbstractSessionDataStore
        Implemented by subclasses to find sessions for this context in the store that expired at or before the time limit and thus not being actively managed by any node. This method is only called periodically (the period is configurable) to avoid putting too much load on the store.
        Specified by:
        doGetExpired in class AbstractSessionDataStore
        Parameters:
        timeLimit - the upper limit of expiry times to check. Sessions expired at or before this timestamp will match.
        Returns:
        the empty set if there are no sessions expired as at the time, or otherwise a set of session ids.

      • doCleanOrphans

        public void doCleanOrphans​(long time)
        Description copied from class: AbstractSessionDataStore
        Implemented by subclasses to delete sessions for other contexts that expired at or before the timeLimit. These are 'orphaned' sessions that are no longer being actively managed by any node. These are explicitly sessions that do NOT belong to this context (other mechanisms such as doGetExpired take care of those). As they don't belong to this context, they cannot be loaded by us. This is called only periodically to avoid placing excessive load on the store.
        Specified by:
        doCleanOrphans in class AbstractSessionDataStore
        Parameters:
        time - the upper limit of the expiry time to check in msec

      • setDatabaseAdaptor

        public void setDatabaseAdaptor​(DatabaseAdaptor dbAdaptor)

      • isPassivating

        @ManagedAttribute(value="does this store serialize sessions",
                  readonly=true)
public boolean isPassivating()
        Description copied from interface: SessionDataStore
        True if this type of datastore will passivate session objects
        Returns:
        true if this store can passivate sessions, false otherwise

      • doExists

        public boolean doExists​(java.lang.String id)
                 throws java.lang.Exception
        Description copied from class: AbstractSessionDataStore
        Check if a session for the given id exists.
        Specified by:
        doExists in class AbstractSessionDataStore
        Parameters:
        id - the session id to check
        Returns:
        true if the session exists in the persistent store, false otherwise
        Throws:
        java.lang.Exception