SsoTokenContext (IG Aggregated Javadoc 2023.11.0 Documentation)

java.lang.Object
- org.forgerock.services.context.AbstractContext
- - org.forgerock.openig.openam.SsoTokenContext

All Implemented Interfaces:

Context
```
public class SsoTokenContext
extends AbstractContext
```
The SsoTokenContext provides access to the token and user information related to this session.
It is used by the SingleSignOnFilter.

Field Summary
- Fields inherited from class org.forgerock.services.context.AbstractContext
  data

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`JsonValue`	`asJsonValue()`	Returns the info associated with this context as a `JsonValue`.
`Map<String,Object>`	`getInfo()`	Returns the session info associated with this context.
`String`	`getLoginEndpoint()`	The login endpoint URI evaluated from `SingleSignOnFilter` configuration.
`String`	`getUniversalId()`	Returns the universalId of the user associated with this session.
`String`	`getUsername()`	Returns the username of the user associated with this session.
`String`	`getValue()`	Returns the token associated with this SsoTokenContext context.

Methods inherited from class org.forgerock.services.context.AbstractContext
as, asContext, containsContext, containsContext, get, getContext, getContextName, getId, getParent, getRootId, isRootContext, toJsonValue, toString

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

- Method Detail
  - getUsername
```
public String getUsername()
```
    Returns the username of the user associated with this session.
    
    Returns:
    
    the username
  - getUniversalId
```
public String getUniversalId()
```
    Returns the universalId of the user associated with this session.
    
    Returns:
    
    the user's universalId
  - getInfo
```
public Map<String,Object> getInfo()
```
    Returns the session info associated with this context.
    
    Returns:
    
    the info JSON as a map.
  - asJsonValue
```
public JsonValue asJsonValue()
```
    Returns the info associated with this context as a JsonValue.
    
    Returns:
    
    the info associated with this context as a JsonValue.
  - getValue
```
public String getValue()
```
    Returns the token associated with this SsoTokenContext context.
    
    Returns:
    
    the token associated with this SsoTokenContext context.
  - getLoginEndpoint
```
public String getLoginEndpoint()
```
    The login endpoint URI evaluated from SingleSignOnFilter configuration.
    
    Returns:
    
    the login endpoint associated with this SsoTokenContext context.