Package org.sourceid.saml20.service.session.data

Class SessionGroupData

  • public class SessionGroupData
extends Object
    The class that encapsulates information for a group of authentication sessions linked to the same browser instance. The storage implementation is responsible for saving all the fields in this object to the underlying storage, and returning them unchanged upon request.
    Since:
    10.3

    • Constructor Detail

      • SessionGroupData

        public SessionGroupData()

    • Method Detail

      • getId

        public String getId()
        Get the unique static ID for this session group.
        Returns:
        The unique static ID for this session group.

      • setId

        public void setId​(String id)
        Set the unique static ID for this session group.
        Parameters:
        id - The unique static ID for this session group.

      • getParentGroupId

        public String getParentGroupId()
        Get the ID of the parent session group. Currently this field is not used.

      • setParentGroupId

        public void setParentGroupId​(String parentGroupId)
        Set the ID of the parent session group. Currently, this field is not used.
        Parameters:
        parentGroupId - The ID of the parent session group.

      • getPrevHashedSessionId

        public String getPrevHashedSessionId()
        Get the previous hashed session ID for this session group. This is a hash of the previous session cookie value from the user's browser. When the session group is updated, this is the value that storage implementations should use to retrieve the existing session group. This field will be null if the session group is being created.
        Returns:
        The previous hashed session ID for this session group, or null if the session group is being created.

      • setPrevHashedSessionId

        public void setPrevHashedSessionId​(String prevHashedSessionId)
        Set the previous hashed session ID for this session group. This field does not need to be populated by the storage implementation when the session group is retrieved.
        Parameters:
        prevHashedSessionId - The previous hashed session ID for this session group.

      • getHashedSessionId

        public String getHashedSessionId()
        Get the current hashed session ID for this session group. This is a hash of the new session cookie value that will be written back to the user's browser. If the session is being updated, implementations must ensure that the session group is stored under the updated hashed session ID and is no longer available under the previous hashed session ID.
        Returns:
        The current hashed session ID for this session group.

      • setHashedSessionId

        public void setHashedSessionId​(String hashedSessionId)
        Set the current hashed session ID for this session group.
        Parameters:
        hashedSessionId - The current hashed session ID for the session group.

      • getExpiryTimeMillis

        public long getExpiryTimeMillis()
        Get the overall expiry time for the session group, in milliseconds since the epoch. This is the time when all authentication sessions in the session group are guaranteed to have expired. Storage implementations are free to implement their own cleanup mechanism to purge the session group and its authentication sessions when this time is reached. Note that this expiration time may change based on user activity. PingFederate will call SessionStorageManager.updateSessionGroup(SessionGroupData) whenever the expiration time for the session group changes.
        Returns:
        The overall expiry time for the session group, in milliseconds since the epoch.

      • setExpiryTimeMillis

        public void setExpiryTimeMillis​(long expiryTimeMillis)
        Set the overall expiry time for the session group, in milliseconds since the epoch.
        Parameters:
        expiryTimeMillis - The overall expiry time for the session group, in milliseconds since the epoch.

      • getLastActivityTimeMillis

        public long getLastActivityTimeMillis()
        Get the last activity time for the session group, in milliseconds since the epoch. This is the time when the user was last active in the associated browser.
        Returns:
        The last activity time for the session group, in milliseconds since the epoch.

      • setLastActivityTimeMillis

        public void setLastActivityTimeMillis​(long lastActivityTimeMillis)
        Set the last activity time for the session group, in milliseconds since the epoch.
        Parameters:
        lastActivityTimeMillis - The last activity time for the session group, in milliseconds since the epoch.

      • getMetadata

        public String getMetadata()
        Get the string containing additional metadata about the session group. The format of this string may change in future versions. Storage implementations should treat it as opaque.
        Returns:
        A string containing additional metadata about the session group.

      • setMetadata

        public void setMetadata​(String metadata)
        Set the string containing additional metadata about the session group. The format of this string may change in future versions. Storage implementations should treat it as opaque.
        Parameters:
        metadata - A string containing additional metadata about the session group.