Package org.eclipse.jetty.server.session

Class Session

  • All Implemented Interfaces:
    HttpSession, SessionHandler.SessionIf
    @Deprecated(since="2021-05-27")
public class Session
extends java.lang.Object
implements SessionHandler.SessionIf
    Deprecated.
    The Eclipse Jetty and Apache Felix Http Jetty packages are no longer supported.
    Session A heavy-weight Session object representing an HttpSession. Session objects relating to a context are kept in a SessionCache. The purpose of the SessionCache is to keep the working set of Session objects in memory so that they may be accessed quickly, and facilitate the sharing of a Session object amongst multiple simultaneous requests referring to the same session id. The SessionHandler coordinates the lifecycle of Session objects with the help of the SessionCache.
    See Also:
    SessionHandler, SessionIdManager

    • Field Detail

      • SESSION_CREATED_SECURE

        public static final java.lang.String SESSION_CREATED_SECURE
        Deprecated.
        See Also:
        Constant Field Values

    • Constructor Detail

      • Session

        public Session​(SessionHandler handler,
               HttpServletRequest request,
               SessionData data)
        Deprecated.
        Create a new session
        Parameters:
        handler - the SessionHandler that manages this session
        request - the request the session should be based on
        data - the session data

      • Session

        public Session​(SessionHandler handler,
               SessionData data)
        Deprecated.
        Re-inflate an existing session from some eg persistent store.
        Parameters:
        handler - the SessionHandler managing the session
        data - the session data

    • Method Detail

      • getRequests

        public long getRequests()
        Deprecated.
        Returns the current number of requests that are active in the Session.
        Returns:
        the number of active requests for this session

      • setExtendedId

        public void setExtendedId​(java.lang.String extendedId)
        Deprecated.

      • didActivate

        public void didActivate()
        Deprecated.
        Call the activation listeners. This must be called holding the lock.

      • willPassivate

        public void willPassivate()
        Deprecated.
        Call the passivation listeners. This must be called holding the lock

      • isValid

        public boolean isValid()
        Deprecated.

      • isInvalid

        public boolean isInvalid()
        Deprecated.

      • isChanging

        public boolean isChanging()
        Deprecated.

      • getCookieSetTime

        public long getCookieSetTime()
        Deprecated.

      • getCreationTime

        public long getCreationTime()
                     throws java.lang.IllegalStateException
        Deprecated.
        Description copied from interface: HttpSession
        Returns the time when this session was created, measured in milliseconds since midnight January 1, 1970 GMT.
        Specified by:
        getCreationTime in interface HttpSession
        Returns:
        a long specifying when this session was created, expressed in milliseconds since 1/1/1970 GMT
        Throws:
        java.lang.IllegalStateException - if this method is called on an invalidated session

      • getId

        public java.lang.String getId()
        Deprecated.
        Description copied from interface: HttpSession
        Returns a string containing the unique identifier assigned to this session. The identifier is assigned by the servlet container and is implementation dependent.
        Specified by:
        getId in interface HttpSession
        Returns:
        a string specifying the identifier assigned to this session
        See Also:
        HttpSession.getId()

      • getExtendedId

        public java.lang.String getExtendedId()
        Deprecated.

      • getContextPath

        public java.lang.String getContextPath()
        Deprecated.

      • getVHost

        public java.lang.String getVHost()
        Deprecated.

      • getLastAccessedTime

        public long getLastAccessedTime()
        Deprecated.
        Description copied from interface: HttpSession
        Returns the last time the client sent a request associated with this session, as the number of milliseconds since midnight January 1, 1970 GMT, and marked by the time the container received the request.

        Actions that your application takes, such as getting or setting a value associated with the session, do not affect the access time.

        Specified by:
        getLastAccessedTime in interface HttpSession
        Returns:
        a long representing the last time the client sent a request associated with this session, expressed in milliseconds since 1/1/1970 GMT
        See Also:
        HttpSession.getLastAccessedTime()

      • setMaxInactiveInterval

        public void setMaxInactiveInterval​(int secs)
        Deprecated.
        Description copied from interface: HttpSession
        Specifies the time, in seconds, between client requests before the servlet container will invalidate this session. A zero or negative time indicates that the session should never timeout.
        Specified by:
        setMaxInactiveInterval in interface HttpSession
        Parameters:
        secs - An integer specifying the number of seconds
        See Also:
        HttpSession.setMaxInactiveInterval(int)

      • updateInactivityTimer

        @Deprecated
public void updateInactivityTimer()
        Deprecated.

      • calculateInactivityTimeout

        public long calculateInactivityTimeout​(long now)
        Deprecated.
        Calculate what the session timer setting should be based on: the time remaining before the session expires and any idle eviction time configured. The timer value will be the lesser of the above.
        Parameters:
        now - the time at which to calculate remaining expiry
        Returns:
        the time remaining before expiry or inactivity timeout

      • getMaxInactiveInterval

        public int getMaxInactiveInterval()
        Deprecated.
        Description copied from interface: HttpSession
        Returns the maximum time interval, in seconds, that the servlet container will keep this session open between client accesses. After this interval, the servlet container will invalidate the session. The maximum time interval can be set with the setMaxInactiveInterval method. A zero or negative time indicates that the session should never timeout.
        Specified by:
        getMaxInactiveInterval in interface HttpSession
        Returns:
        an integer specifying the number of seconds this session remains open between client requests
        See Also:
        HttpSession.getMaxInactiveInterval()

      • getSessionHandler

        public SessionHandler getSessionHandler()
        Deprecated.

      • getAttribute

        public java.lang.Object getAttribute​(java.lang.String name)
        Deprecated.
        Description copied from interface: HttpSession
        Returns the object bound with the specified name in this session, or null if no object is bound under the name.
        Specified by:
        getAttribute in interface HttpSession
        Parameters:
        name - a string specifying the name of the object
        Returns:
        the object with the specified name
        See Also:
        HttpSession.getAttribute(java.lang.String)

      • getValue

        @Deprecated
public java.lang.Object getValue​(java.lang.String name)
        Deprecated.
        Specified by:
        getValue in interface HttpSession
        Parameters:
        name - a string specifying the name of the object
        Returns:
        the object with the specified name
        See Also:
        HttpSession.getValue(java.lang.String)

      • getAttributeNames

        public java.util.Enumeration<java.lang.String> getAttributeNames()
        Deprecated.
        Description copied from interface: HttpSession
        Returns an Enumeration of String objects containing the names of all the objects bound to this session.
        Specified by:
        getAttributeNames in interface HttpSession
        Returns:
        an Enumeration of String objects specifying the names of all the objects bound to this session
        See Also:
        HttpSession.getAttributeNames()

      • getAttributes

        public int getAttributes()
        Deprecated.

      • getNames

        public java.util.Set<java.lang.String> getNames()
        Deprecated.

      • getValueNames

        @Deprecated
public java.lang.String[] getValueNames()
                                 throws java.lang.IllegalStateException
        Deprecated.
        As of Version 2.2, this method is replaced by getAttributeNames()
        Specified by:
        getValueNames in interface HttpSession
        Returns:
        an array of String objects specifying the names of all the objects bound to this session
        Throws:
        java.lang.IllegalStateException - if this method is called on an invalidated session

      • setAttribute

        public void setAttribute​(java.lang.String name,
                         java.lang.Object value)
        Deprecated.
        Description copied from interface: HttpSession
        Binds an object to this session, using the name specified. If an object of the same name is already bound to the session, the object is replaced.

        After this method executes, and if the new object implements HttpSessionBindingListener, the container calls HttpSessionBindingListener.valueBound. The container then notifies any HttpSessionAttributeListeners in the web application.

        If an object was already bound to this session of this name that implements HttpSessionBindingListener, its HttpSessionBindingListener.valueUnbound method is called.

        If the value passed in is null, this has the same effect as calling removeAttribute().

        Specified by:
        setAttribute in interface HttpSession
        Parameters:
        name - the name to which the object is bound; cannot be null
        value - the object to be bound
        See Also:
        HttpSession.setAttribute(java.lang.String, java.lang.Object)

      • removeAttribute

        public void removeAttribute​(java.lang.String name)
        Deprecated.
        Description copied from interface: HttpSession
        Removes the object bound with the specified name from this session. If the session does not have an object bound with the specified name, this method does nothing.

        After this method executes, and if the object implements HttpSessionBindingListener, the container calls HttpSessionBindingListener.valueUnbound. The container then notifies any HttpSessionAttributeListeners in the web application.

        Specified by:
        removeAttribute in interface HttpSession
        Parameters:
        name - the name of the object to remove from this session
        See Also:
        HttpSession.removeAttribute(java.lang.String)

      • renewId

        public void renewId​(HttpServletRequest request)
        Deprecated.
        Force a change to the id of a session.
        Parameters:
        request - the Request associated with the call to change id.

      • invalidate

        public void invalidate()
        Deprecated.
        Called by users to invalidate a session, or called by the access method as a request enters the session if the session has expired, or called by manager as a result of scavenger expiring session
        Specified by:
        invalidate in interface HttpSession
        See Also:
        HttpSession.invalidate()

      • lock

        public Locker.Lock lock()
        Deprecated.
        Grab the lock on the session
        Returns:
        the lock

      • isNew

        public boolean isNew()
              throws java.lang.IllegalStateException
        Deprecated.
        Description copied from interface: HttpSession
        Returns true if the client does not yet know about the session or if the client chooses not to join the session. For example, if the server used only cookie-based sessions, and the client had disabled the use of cookies, then a session would be new on each request.
        Specified by:
        isNew in interface HttpSession
        Returns:
        true if the server has created a session, but the client has not yet joined
        Throws:
        java.lang.IllegalStateException - if this method is called on an already invalidated session

      • setIdChanged

        public void setIdChanged​(boolean changed)
        Deprecated.

      • isIdChanged

        public boolean isIdChanged()
        Deprecated.

      • setResident

        public void setResident​(boolean resident)
        Deprecated.

      • isResident

        public boolean isResident()
        Deprecated.

      • toString

        public java.lang.String toString()
        Deprecated.
        Overrides:
        toString in class java.lang.Object