UserProfileContext (IG Aggregated Javadoc 2023.11.1 Documentation)

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

All Implemented Interfaces:

Context
```
public class UserProfileContext
extends AbstractContext
```
Used by the UserProfileFilter to make the user's profile attributes available in the context.

Field Summary

Fields
Modifier and Type Field Description

static String NAME
Context's name.
- 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()`	Get the raw JSON representation as a `JsonValue`.
`String`	`getCommonName()`	Get the user's common name (cn) or `null` if none.
`String`	`getDistinguishedName()`	Get the user's distinguished name (dn) or `null` if none.
`Map<String,Object>`	`getRawInfo()`	Returns the unmodifiable `Map` of the user profile info, not `null`.
`String`	`getRealm()`	Get the user's realm or `null` if none.
`String`	`getUsername()`	Get the user's username or `null` if none.

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

- Field Detail
  - NAME
```
public static final String NAME
```
    Context's name.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - getDistinguishedName
```
public String getDistinguishedName()
```
    Get the user's distinguished name (dn) or null if none.
    
    Returns:
    
    the distinguished name (dn) or null if none.
  - getCommonName
```
public String getCommonName()
```
    Get the user's common name (cn) or null if none.
    
    Returns:
    
    the common name (cn) or null if none.
  - getRawInfo
```
public Map<String,Object> getRawInfo()
```
    Returns the unmodifiable Map of the user profile info, not null.
    
    Returns:
    
    the unmodifiable Map of the user profile info, not null.
  - getRealm
```
public String getRealm()
```
    Get the user's realm or null if none.
    
    Returns:
    
    the realm or null if none.
  - getUsername
```
public String getUsername()
```
    Get the user's username or null if none.
    
    Returns:
    
    the username, or null if none.
  - asJsonValue
```
public JsonValue asJsonValue()
```
    Get the raw JSON representation as a JsonValue. This is not null and will contain the Access Management user profile object structure, though values may be null.
    
    Returns:
    
    the JSON representation, not null.