Package org.apache.catalina

Interface Session

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void access()
      Update the accessed time information for this session.
      void addSessionListener​(SessionListener listener)
      Add a session event listener to this component.
      void endAccess()
      End access to the session.
      void expire()
      Perform the internal processing required to invalidate this session, without triggering an exception if the session has already expired.
      Map<String,​Object> getAttributes()
      Gets the attributes of this session.
      String getAuthType()
      Return the authentication type used to authenticate our cached Principal, if any.
      long getCreationTime()
      Return the creation time for this session.
      String getId()
      Return the session identifier for this session.
      String getIdInternal()
      Return the session identifier for this session.
      String getInfo()
      Return descriptive information about this Session implementation and the corresponding version number, in the format <description>/<version>.
      boolean getIsValid()
      Return the isValid flag for this session.
      long getLastAccessedTime()
      Return the last time the client sent a request associated with this session, as the number of milliseconds since midnight, January 1, 1970 GMT.
      Manager getManager()
      Return the Manager within which this Session is valid.
      int getMaxInactiveInterval()
      Return the maximum time interval, in seconds, between client requests before the servlet container will invalidate the session.
      Object getNote​(String name)
      Return the object bound with the specified name to the internal notes for this session, or null if no such binding exists.
      Iterator getNoteNames()
      Return an Iterator containing the String names of all notes bindings that exist for this session.
      Principal getPrincipal()
      Return the authenticated Principal that is associated with this Session.
      jakarta.servlet.http.HttpSession getSession()
      Return the HttpSession for which this object is the facade.
      String getSsoId()
      Return the single sign on id.
      long getSsoVersion()
      Return the single sign on version.
      long getVersion()
      Gets the version number of this Session
      boolean hasExpired()
      Checks whether this Session has expired.
      boolean isValid()
      Expire the expired session if necessary and return the isValid flag for this session.
      boolean lockForeground()
      lock the session for background returns true if successful; false if unsuccessful
      void recycle()
      Release all object references, and initialize instance variables, in preparation for reuse of this object.
      void removeNote​(String name)
      Remove any object bound to the specified name in the internal notes for this session.
      void removeSessionListener​(SessionListener listener)
      Remove a session event listener from this component.
      void setAuthType​(String authType)
      Set the authentication type used to authenticate our cached Principal, if any.
      void setCreationTime​(long time)
      Set the creation time for this session.
      void setId​(String id)
      Set the session identifier for this session.
      void setManager​(Manager manager)
      Set the Manager within which this Session is valid.
      void setMaxInactiveInterval​(int interval)
      Set the maximum time interval, in seconds, between client requests before the servlet container will invalidate the session.
      void setNew​(boolean isNew)
      Set the isNew flag for this session.
      void setNote​(String name, Object value)
      Bind an object to a specified name in the internal notes associated with this session, replacing any existing binding for this name.
      void setPrincipal​(Principal principal)
      Set the authenticated Principal that is associated with this Session.
      void setSsoId​(String ssoId)
      Set the single sign on id.
      void setSsoVersion​(long ssoVersion)
      Set the single sign on version.
      void setValid​(boolean isValid)
      Set the isValid flag for this session.
      void unlockForeground()
      unlock the session from foreground

    • Field Detail

      • SESSION_CREATED_EVENT

        static final String SESSION_CREATED_EVENT
        The SessionEvent event type when a session is created.
        See Also:
        Constant Field Values

      • SESSION_DESTROYED_EVENT

        static final String SESSION_DESTROYED_EVENT
        The SessionEvent event type when a session is destroyed.
        See Also:
        Constant Field Values

    • Method Detail

      • getAuthType

        String getAuthType()
        Return the authentication type used to authenticate our cached Principal, if any.

      • setAuthType

        void setAuthType​(String authType)
        Set the authentication type used to authenticate our cached Principal, if any.
        Parameters:
        authType - The new cached authentication type

      • getCreationTime

        long getCreationTime()
        Return the creation time for this session.

      • setCreationTime

        void setCreationTime​(long time)
        Set the creation time for this session. This method is called by the Manager when an existing Session instance is reused.
        Parameters:
        time - The new creation time

      • getId

        String getId()
        Return the session identifier for this session.

      • getIdInternal

        String getIdInternal()
        Return the session identifier for this session.

      • setId

        void setId​(String id)
        Set the session identifier for this session.
        Parameters:
        id - The new session identifier

      • getInfo

        String getInfo()
        Return descriptive information about this Session implementation and the corresponding version number, in the format <description>/<version>.

      • getLastAccessedTime

        long getLastAccessedTime()
        Return the last time the client sent a request associated with this session, as the number of milliseconds since midnight, January 1, 1970 GMT. Actions that your application takes, such as getting or setting a value associated with the session, do not affect the access time.

      • getManager

        Manager getManager()
        Return the Manager within which this Session is valid.

      • setManager

        void setManager​(Manager manager)
        Set the Manager within which this Session is valid.
        Parameters:
        manager - The new Manager

      • getMaxInactiveInterval

        int getMaxInactiveInterval()
        Return the maximum time interval, in seconds, between client requests before the servlet container will invalidate the session. A negative time indicates that the session should never time out.

      • setMaxInactiveInterval

        void setMaxInactiveInterval​(int interval)
        Set the maximum time interval, in seconds, between client requests before the servlet container will invalidate the session. A negative time indicates that the session should never time out.
        Parameters:
        interval - The new maximum interval

      • setNew

        void setNew​(boolean isNew)
        Set the isNew flag for this session.
        Parameters:
        isNew - The new value for the isNew flag

      • getPrincipal

        Principal getPrincipal()
        Return the authenticated Principal that is associated with this Session. This provides an Authenticator with a means to cache a previously authenticated Principal, and avoid potentially expensive Realm.authenticate() calls on every request. If there is no current associated Principal, return null.

      • setPrincipal

        void setPrincipal​(Principal principal)
        Set the authenticated Principal that is associated with this Session. This provides an Authenticator with a means to cache a previously authenticated Principal, and avoid potentially expensive Realm.authenticate() calls on every request.
        Parameters:
        principal - The new Principal, or null if none

      • getSession

        jakarta.servlet.http.HttpSession getSession()
        Return the HttpSession for which this object is the facade.

      • setValid

        void setValid​(boolean isValid)
        Set the isValid flag for this session.
        Parameters:
        isValid - The new value for the isValid flag

      • isValid

        boolean isValid()
        Expire the expired session if necessary and return the isValid flag for this session.

      • getIsValid

        boolean getIsValid()
        Return the isValid flag for this session.

      • access

        void access()
        Update the accessed time information for this session. This method should be called by the context when a request comes in for a particular session, even if the application does not reference it.

      • addSessionListener

        void addSessionListener​(SessionListener listener)
        Add a session event listener to this component.

      • endAccess

        void endAccess()
        End access to the session.

      • expire

        void expire()
        Perform the internal processing required to invalidate this session, without triggering an exception if the session has already expired.

      • getNote

        Object getNote​(String name)
        Return the object bound with the specified name to the internal notes for this session, or null if no such binding exists.
        Parameters:
        name - Name of the note to be returned

      • getNoteNames

        Iterator getNoteNames()
        Return an Iterator containing the String names of all notes bindings that exist for this session.

      • recycle

        void recycle()
        Release all object references, and initialize instance variables, in preparation for reuse of this object.

      • removeNote

        void removeNote​(String name)
        Remove any object bound to the specified name in the internal notes for this session.
        Parameters:
        name - Name of the note to be removed

      • removeSessionListener

        void removeSessionListener​(SessionListener listener)
        Remove a session event listener from this component.

      • setNote

        void setNote​(String name,
             Object value)
        Bind an object to a specified name in the internal notes associated with this session, replacing any existing binding for this name.
        Parameters:
        name - Name to which the object should be bound
        value - Object to be bound to the specified name

      • hasExpired

        boolean hasExpired()
        Checks whether this Session has expired.
        Returns:
        true if this Session has expired, false otherwise

      • getVersion

        long getVersion()
        Gets the version number of this Session

      • getAttributes

        Map<String,​Object> getAttributes()
        Gets the attributes of this session.
        Returns:
        the attributes of this session

      • getSsoId

        String getSsoId()
        Return the single sign on id. It is null if there is no SSO.

      • setSsoId

        void setSsoId​(String ssoId)
        Set the single sign on id.

      • getSsoVersion

        long getSsoVersion()
        Return the single sign on version.

      • setSsoVersion

        void setSsoVersion​(long ssoVersion)
        Set the single sign on version.

      • lockForeground

        boolean lockForeground()
        lock the session for background returns true if successful; false if unsuccessful

      • unlockForeground

        void unlockForeground()
        unlock the session from foreground