SessionInfo (OpenIG doc 6.5.4 Documentation)

java.lang.Object
- org.forgerock.openig.tools.session.SessionInfo

```
public class SessionInfo
extends Object
```
The SessionInfo class is responsible to store session info for a given SSO Token.

Constructor Summary

Constructors
Constructor and Description

SessionInfo(String ssoToken, JsonValue rawInfo)
Builds a new SessionInfo.

Constructors
Constructor and Description
`SessionInfo(String ssoToken, JsonValue rawInfo)` Builds a new `SessionInfo`.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Map<String,Object>`	`getInfo()` Returns the session info as `Map` for the given SSO Token if any, or `null` if none.
`Instant`	`getLatestAccessTime()` Returns the latest access time as an `Instant`.
`Instant`	`getMaxIdleExpirationTime()` Returns the max idle expiration time as an `Instant`.
`Instant`	`getMaxSessionExpirationTime()` Returns the max session expiration time as an `Instant`.
`Map<String,String>`	`getProperties()` Returns the unmodifiable map of properties bound to the session (can be empty, but never `null`).
`JsonValue`	`getRawInfo()` Returns the session info for the given SSO Token as `JsonValue` if any, or `null` if none.
`String`	`getRealm()` Returns the realm as specified by Access Management.
`String`	`getSessionHandle()` Returns the session handle, which may be used to logout of the session.
`String`	`getSsoToken()` Returns the SSO Token of this `SessionInfo`.
`String`	`getUniversalId()` Returns the universal id.
`String`	`getUsername()` Returns the user-friendly version of the username.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - SessionInfo
```
public SessionInfo(String ssoToken,
                   JsonValue rawInfo)
```
    Builds a new SessionInfo.
    
    Parameters:
    
    ssoToken - The SSO Token.
    
    rawInfo - The session info linked for this SSO Token.
- Method Detail
  - getSsoToken
```
public String getSsoToken()
```
    Returns the SSO Token of this SessionInfo.
    
    Returns:
    
    The SSO Token of this SessionInfo.
  - getRawInfo
```
public JsonValue getRawInfo()
```
    Returns the session info for the given SSO Token as JsonValue if any, or null if none.
    
    Returns:
    
    the session info for the given SSO Token as JsonValue if any, or null if none.
  - getInfo
```
public Map<String,Object> getInfo()
```
    Returns the session info as Map for the given SSO Token if any, or null if none.
    
    Returns:
    
    the session info as Map for the given SSO Token if any, or null if none.
  - 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

Class SessionInfo

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SessionInfo

Method Detail

getSsoToken

getRawInfo

getInfo

getUsername

getUniversalId

getRealm

getSessionHandle

getLatestAccessTime

getMaxIdleExpirationTime

getMaxSessionExpirationTime

getProperties