MessageInfoContext (OpenAM Server Only 7.4.1 Documentation)

All Superinterfaces:

Context

All Known Subinterfaces:

MessageContext

All Known Implementing Classes:

MessageContextImpl
```
public interface MessageInfoContext
extends Context
```
The authentication framework uses this MessageContextInfo to pass messages and message processing state to authentication modules for processing of messages.

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
`Request`	`getRequest()`	Gets the request object from this `MessageContextInfo`.
`Map<String,Object>`	`getRequestContextMap()`	Gets the context map for this message exchange.
`Response`	`getResponse()`	Gets the response object from this `MessageContextInfo`.
`void`	`setRequest(Request request)`	Sets the request object for this `MessageContextInfo`.
`void`	`setResponse(Response response)`	Sets the response object for this `MessageContextInfo`.

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

- Method Detail
  - getRequest
```
Request getRequest()
```
    Gets the request object from this MessageContextInfo.
    
    Returns:
    
    The Request object.
  - getResponse
```
Response getResponse()
```
    Gets the response object from this MessageContextInfo.
    
    Returns:
    
    The Response object.
  - setRequest
```
void setRequest(Request request)
```
    Sets the request object for this MessageContextInfo.
    
    Parameters:
    
    request - The Request object.
  - setResponse
```
void setResponse(Response response)
```
    Sets the response object for this MessageContextInfo.
    
    Parameters:
    
    response - The Response object.
  - getRequestContextMap
```
Map<String,Object> getRequestContextMap()
```
    Gets the context map for this message exchange.
    
    This Map can contain shared information between AsyncServerAuthContexts and AsyncServerAuthModules which will be maintained for a single request.
    
    Returns:
    
    The request context map.