Class AuthnSessionData


  • public class AuthnSessionData
    extends Object
    An class containing data for an end user session associated with a specific authentication source. Storage implementations are responsible for saving all the fields in this object and returning them unchanged upon request.
    Since:
    10.3
    • Constructor Detail

      • AuthnSessionData

        public AuthnSessionData()
        Create an empty instance.
      • AuthnSessionData

        public AuthnSessionData​(String sessionGroupId,
                                String attributeHash,
                                String sessionData)
        Create an instance with the specified field values.
        Parameters:
        sessionGroupId - ID of the session group this authentication session belongs to
        attributeHash - A hash of this session's attributes
        sessionData - The session data string
    • Method Detail

      • getSessionGroupId

        public String getSessionGroupId()
        Get the ID of the session group this authentication session belongs to.
        Returns:
        The ID of the session group
      • setSessionGroupId

        public void setSessionGroupId​(String sessionGroupId)
        Set the ID of the session group this authentication session belongs to.
        Parameters:
        sessionGroupId - The ID of the session group.
      • getAttributeHash

        public String getAttributeHash()
        Get the attribute hash for this authentication session. This hash is only guaranteed to be unique within the session group. The authentication session is uniquely identified by the combination of the session group ID and the attribute hash.
        Returns:
        A hash of the authentication session's attributes
      • setAttributeHash

        public void setAttributeHash​(String attributeHash)
        Set the attribute hash for the authentication session.
        Parameters:
        attributeHash - The attribute hash for the authentication session.
      • getSessionData

        public String getSessionData()
        Get the actual data for the authentication session. This is an opaque string whose format may change in future versions of PingFederate.
        Returns:
        The actual data for this authentication session.
      • setSessionData

        public void setSessionData​(String sessionData)
        Set the actual data for the authentication session.
        Parameters:
        sessionData - The actual data for this authentication session.