Package org.eclipse.jetty.server.session

Class FileSessionDataStore

  • 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 FileSessionDataStore
extends AbstractSessionDataStore
    FileSessionDataStore A file-based store of session data.

    • Field Detail

      • _storeDir

        protected File _storeDir

      • _deleteUnrestorableFiles

        protected boolean _deleteUnrestorableFiles

      • _contextString

        protected String _contextString

      • _lastSweepTime

        protected long _lastSweepTime

    • Constructor Detail

      • FileSessionDataStore

        public FileSessionDataStore()

    • Method Detail

      • doStop

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

      • getStoreDir

        @ManagedAttribute(value="dir where sessions are stored",
                  readonly=true)
public File getStoreDir()

      • setStoreDir

        public void setStoreDir​(File storeDir)

      • isDeleteUnrestorableFiles

        public boolean isDeleteUnrestorableFiles()

      • setDeleteUnrestorableFiles

        public void setDeleteUnrestorableFiles​(boolean deleteUnrestorableFiles)

      • delete

        public boolean delete​(String id)
               throws Exception
        Delete a session
        Parameters:
        id - session id
        Returns:
        true if the session was deleted
        Throws:
        Exception - if unable to delete session data

      • deleteFile

        public boolean deleteFile​(String filename)
                   throws Exception
        Delete the file associated with a session
        Parameters:
        filename - name of the file containing the session's information
        Returns:
        true if file was deleted, false otherwise
        Throws:
        Exception - indicating delete failure

      • doGetExpired

        public Set<String> doGetExpired​(Set<String> candidates)
        Check to see which sessions have expired.
        Specified by:
        doGetExpired in class AbstractSessionDataStore
        Parameters:
        candidates - the set of session ids that the SessionCache believes have expired
        Returns:
        the complete set of sessions that have expired, including those that are not currently loaded into the SessionCache

      • sweepDisk

        public void sweepDisk()
        Check all session files that do not belong to this context and remove any that expired long ago (ie at least 5 gracePeriods ago).

      • sweepFile

        public void sweepFile​(long now,
                      Path p)
               throws Exception
        Check to see if the expiry on the file is very old, and delete the file if so. "Old" means that it expired at least 5 gracePeriods ago. The session can belong to any context.
        Parameters:
        now - the time now in msec
        p - the file to check
        Throws:
        Exception - indicating error in sweep

      • initializeStore

        public void initializeStore()
                     throws Exception
        Read the names of the existing session files and build a map of fully qualified session ids (ie with context) to filename. If there is more than one file for the same session, only the most recently modified will be kept and the rest deleted. At the same time, any files - for any context - that expired a long time ago will be cleaned up.
        Throws:
        Exception - if storeDir doesn't exist, isn't readable/writeable or contains 2 files with the same lastmodify time for the same session. Throws IOException if the lastmodifytimes can't be read.

      • isPassivating

        @ManagedAttribute(value="are sessions serialized by this store",
                  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​(String id)
               throws Exception
        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
        Throws:
        Exception - if problem checking existence with persistence layer

      • getIdWithContext

        protected String getIdWithContext​(String id)
        Get the session id with its context.
        Parameters:
        id - identity of session
        Returns:
        the session id plus context

      • getIdWithContextAndExpiry

        protected String getIdWithContextAndExpiry​(SessionData data)
        Get the session id with its context and its expiry time
        Parameters:
        data -
        Returns:
        the session id plus context and expiry

      • getIdFromFilename

        protected String getIdFromFilename​(String filename)

      • getExpiryFromFilename

        protected long getExpiryFromFilename​(String filename)

      • getContextFromFilename

        protected String getContextFromFilename​(String filename)

      • getIdWithContextFromFilename

        protected String getIdWithContextFromFilename​(String filename)
        Extract the session id and context from the filename
        Parameters:
        filename - the name of the file to use
        Returns:
        the session id plus context

      • isSessionFilename

        protected boolean isSessionFilename​(String filename)
        Check if the filename is a session filename.
        Parameters:
        filename - the filename to check
        Returns:
        true if the filename has the correct filename format

      • isOurContextSessionFilename

        protected boolean isOurContextSessionFilename​(String filename)
        Check if the filename matches our session pattern and is a session for our context.
        Parameters:
        filename - the filename to check
        Returns:
        true if the filename has the correct filename format and is for this context

      • load

        protected SessionData load​(InputStream is,
                           String expectedId)
                    throws Exception
        Load the session data from a file.
        Parameters:
        is - file input stream containing session data
        expectedId - the id we've been told to load
        Returns:
        the session data
        Throws:
        Exception