Package org.forgerock.openig.openam

Class SessionInfoContext

java.lang.Object
org.forgerock.services.context.AbstractContext
org.forgerock.openig.openam.SessionInfoContext
All Implemented Interfaces:
Context
public class SessionInfoContext extends AbstractContext
Context to store Access Management session info and properties.

  • Field Details

  • Method Details

    • getUsername

      public String getUsername()
      Returns the user-friendly version of the username. This may be null if the DN is not resident on the SSO token or may be empty if it cannot be obtained from the DN.
      Returns:
      the username

    • getUniversalId

      public String getUniversalId()
      Returns the universal id. This is a DN that Access Management uses to uniquely identify the user. It may be null if it cannot be obtained from the SSO token.
      Returns:
      the universal id

    • getRealm

      public String getRealm()
      Returns the realm as specified by Access Management. This is in a user-friendly slash (/) separated format. This may be null if the DN is not resident on the SSO token.
      Returns:
      the realm

    • getSessionHandle

      public String getSessionHandle()
      Returns the session handle, which may be used to logout of the session. This may be null if the handle is not available for the session.
      Returns:
      the sessionHandle

    • getLatestAccessTime

      public Instant getLatestAccessTime()
      Returns the latest access time as an Instant. This is the timestamp of when the session was last used. This may be null if the DN is not resident on the SSO token or the time cannot be obtained from the session.
      Returns:
      the latest access time

    • getMaxIdleExpirationTime

      public Instant getMaxIdleExpirationTime()
      Returns the max idle expiration time as an Instant. This is the timestamp of when the session would time out due to no activity. This may be null if the DN is not resident on the SSO token or the time cannot be obtained from the session.
      Returns:
      the max idle expiration time

    • getMaxSessionExpirationTime

      public Instant getMaxSessionExpirationTime()
      Returns the max session expiration time as an Instant. This is the timestamp of when the session would time out regardless of activity. This may be null if the DN is not resident on the SSO token or the time cannot be obtained from the session.
      Returns:
      the max session expiration time

    • getProperties

      public Map<String,String> getProperties()
      Returns the unmodifiable map of properties bound to the session (can be empty, but never null).
      Returns:
      the map of session properties bound to the session

    • getInfo

      public Map<String,Object> getInfo()
      Returns the information of the SessionInfo object.
      Returns:
      the information as a Map.

    • asJsonValue

      public JsonValue asJsonValue()
      Returns the raw information of the SessionInfo object as JsonValue.
      Returns:
      the raw information as JsonValue.