Interface SessionTracker

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void checkGlobalSession​(long sessionId, java.lang.Object owner)
      Strictly check that a given session is a global session or not
      void checkSession​(long sessionId, java.lang.Object owner)
      Checks whether the SessionTracker is aware of this session, the session is still active, and the owner matches.
      boolean commitSession​(long id, int to)
      Add the session to the local session map or global one in zkDB.
      long createSession​(int sessionTimeout)  
      void dumpSessions​(java.io.PrintWriter pwriter)
      Text dump of session information, suitable for debugging.
      long getLocalSessionCount()
      If this session tracker supports local sessions, return how many.
      java.util.Map<java.lang.Long,​java.util.Set<java.lang.Long>> getSessionExpiryMap()
      Returns a mapping of time to session IDs that expire at that time.
      java.util.Set<java.lang.Long> globalSessions()
      Get a set of global session IDs
      boolean isLocalSessionsEnabled()  
      boolean isTrackingSession​(long sessionId)  
      java.util.Set<java.lang.Long> localSessions()
      Get a set of local session IDs
      void removeSession​(long sessionId)  
      void setOwner​(long id, java.lang.Object owner)  
      void setSessionClosing​(long sessionId)
      Mark that the session is in the process of closing.
      void shutdown()  
      boolean touchSession​(long sessionId, int sessionTimeout)  
      boolean trackSession​(long id, int to)
      Track the session expire, not add to ZkDb.
    • Method Detail

      • createSession

        long createSession​(int sessionTimeout)
      • trackSession

        boolean trackSession​(long id,
                             int to)
        Track the session expire, not add to ZkDb.
        Parameters:
        id - sessionId
        to - sessionTimeout
        Returns:
        whether the session was newly tracked (if false, already tracked)
      • commitSession

        boolean commitSession​(long id,
                              int to)
        Add the session to the local session map or global one in zkDB.
        Parameters:
        id - sessionId
        to - sessionTimeout
        Returns:
        whether the session was newly added (if false, already existed)
      • touchSession

        boolean touchSession​(long sessionId,
                             int sessionTimeout)
        Parameters:
        sessionId -
        sessionTimeout -
        Returns:
        false if session is no longer active
      • setSessionClosing

        void setSessionClosing​(long sessionId)
        Mark that the session is in the process of closing.
        Parameters:
        sessionId -
      • shutdown

        void shutdown()
      • removeSession

        void removeSession​(long sessionId)
        Parameters:
        sessionId -
      • isTrackingSession

        boolean isTrackingSession​(long sessionId)
        Parameters:
        sessionId -
        Returns:
        whether or not the SessionTracker is aware of this session
      • dumpSessions

        void dumpSessions​(java.io.PrintWriter pwriter)
        Text dump of session information, suitable for debugging.
        Parameters:
        pwriter - the output writer
      • getSessionExpiryMap

        java.util.Map<java.lang.Long,​java.util.Set<java.lang.Long>> getSessionExpiryMap()
        Returns a mapping of time to session IDs that expire at that time.
      • getLocalSessionCount

        long getLocalSessionCount()
        If this session tracker supports local sessions, return how many. otherwise returns 0;
      • isLocalSessionsEnabled

        boolean isLocalSessionsEnabled()
      • globalSessions

        java.util.Set<java.lang.Long> globalSessions()
        Get a set of global session IDs
      • localSessions

        java.util.Set<java.lang.Long> localSessions()
        Get a set of local session IDs