Package org.eclipse.jetty.server.session

Class NullSessionDataStore

  • 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.LifeCycle
    @ManagedObject
public class NullSessionDataStore
extends AbstractSessionDataStore
    NullSessionDataStore Does not actually store anything, useful for testing.

    • Nested Class Summary

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

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

      • 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.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> doGetExpired​(java.util.Set<java.lang.String> candidates)
      Implemented by subclasses to resolve which sessions this node should attempt to expire.
      SessionData doLoad​(java.lang.String id)
      Load the session from persistent store.
      void doStore​(java.lang.String id, SessionData data, long lastSaveTime)
      Store the session data persistently.
      boolean exists​(java.lang.String id)
      Test if data exists for a given session id.
      boolean isPassivating()
      True if this type of datastore will passivate session objects
      SessionData newSessionData​(java.lang.String id, long created, long accessed, long lastAccessed, long maxInactiveMs)
      Create a new SessionData

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

        addBean, addBean, addEventListener, addManaged, contains, destroy, doStop, dump, dump, dump, dump, dump, dumpBeans, dumpObject, dumpObjects, dumpStdErr, dumpThis, getBean, getBeans, getBeans, getContainedBeans, getContainedBeans, isAuto, isManaged, isUnmanaged, manage, removeBean, removeBeans, removeEventListener, setBeans, setStopTimeout, start, stop, 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

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

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

        dumpSelf

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

        addLifeCycleListener, isFailed, isRunning, isStarted, isStarting, isStopped, isStopping, removeLifeCycleListener, start, stop

    • Constructor Detail

      • NullSessionDataStore

        public NullSessionDataStore()

    • Method Detail

      • 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

      • newSessionData

        public SessionData newSessionData​(java.lang.String id,
                                  long created,
                                  long accessed,
                                  long lastAccessed,
                                  long maxInactiveMs)
        Description copied from interface: SessionDataStore
        Create a new SessionData
        Specified by:
        newSessionData in interface SessionDataStore
        Overrides:
        newSessionData in class AbstractSessionDataStore
        Parameters:
        id - the id
        created - the timestamp when created
        accessed - the timestamp when accessed
        lastAccessed - the timestamp when last accessed
        maxInactiveMs - the max inactive time in milliseconds
        Returns:
        a new SessionData object

      • 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

      • doGetExpired

        public java.util.Set<java.lang.String> doGetExpired​(java.util.Set<java.lang.String> candidates)
        Description copied from class: AbstractSessionDataStore
        Implemented by subclasses to resolve which sessions this node should attempt to expire.
        Specified by:
        doGetExpired in class AbstractSessionDataStore
        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

      • 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

      • exists

        public boolean exists​(java.lang.String id)
        Description copied from interface: SessionDataStore
        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