MessageContext (OpenAM Server Only 7.2.2 Documentation)

All Superinterfaces:

Context, MessageInfoContext

All Known Implementing Classes:

MessageContextImpl
```
public interface MessageContext
extends Context, MessageInfoContext
```
The authentication framework uses this MessageContext to pass messages and message processing state to authentication contexts for processing by authentication modules.

This class encapsulates a request and response message objects for a message exchange. This class may also be used to associate additional context in the form of key/value pairs, with the encapsulated messages.

Since:

2.0.0

See Also:

MessageInfo

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`AuditTrail`	`getAuditTrail()`	Gets the `AuditTrail` instance for this message exchange.
`<T extends AuthenticationState> T`	`getState(AsyncServerAuthContext authContext)`	Gets the `AuthenticationState` instance that maintains any stateful information for the provided `AsyncServerAuthContext`.

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

Methods inherited from interface org.forgerock.caf.authentication.api.MessageInfoContext
getRequest, getRequestContextMap, getResponse, setRequest, setResponse

- Method Detail
  - getAuditTrail
```
AuditTrail getAuditTrail()
```
    Gets the AuditTrail instance for this message exchange.
    
    Returns:
    
    The AuditTrail
  - getState
```
<T extends AuthenticationState> T getState(AsyncServerAuthContext authContext)
```
    Gets the AuthenticationState instance that maintains any stateful information for the provided AsyncServerAuthContext.
    
    Type Parameters:
    
    T - The type of state class.
    
    Parameters:
    
    authContext - The AsyncServerAuthContext for which the state applies.
    
    Returns:
    
    The AuthenticationState instance.