Package org.forgerock.caf.authentication.framework

Class MessageContextImpl

java.lang.Object

org.forgerock.services.context.AbstractContext

org.forgerock.caf.authentication.framework.MessageContextImpl

All Implemented Interfaces:

MessageContext, MessageInfoContext, Context

public final class MessageContextImpl
extends AbstractContext
implements MessageContext

An implementation of MessageContext that holds contextual information and state for a given request and response message exchange.

Since:

2.0.0

See Also:

• MessageContext
• MessageInfoContext

Field Summary

Fields inherited from class org.forgerock.services.context.AbstractContext

data

Constructor Summary

Constructors

Constructor	Description
MessageContextImpl(JsonValue savedContext, ClassLoader classLoader)	Creates a new context from the JSON representation of a previously persisted context.

Method Summary

Modifier and Type	Method	Description
AuditTrail	getAuditTrail()	Gets the AuditTrail instance for this message exchange.
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.
<T extends AuthenticationState> T	getState(AsyncServerAuthContext authContext)	Gets the AuthenticationState instance that maintains any stateful information for the provided AsyncServerAuthContext.
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 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

Methods inherited from interface org.forgerock.services.context.Context

as, asContext, containsContext, containsContext, get, getContext, getContextName, getId, getParent, getRootId, isRootContext, toJsonValue

Constructor Details

MessageContextImpl

public MessageContextImpl(JsonValue savedContext,
 ClassLoader classLoader)

Creates a new context from the JSON representation of a previously persisted context.

Parameters:

savedContext - The JSON representation from which this context's attributes should be parsed.

classLoader - The ClassLoader which can properly resolve the persisted class-name.

Method Details

getRequest

public Request getRequest()

Description copied from interface: MessageInfoContext

Gets the request object from this MessageContextInfo.

Specified by:

getRequest in interface MessageInfoContext

Returns:

The Request object.

setRequest

public void setRequest(Request request)

Description copied from interface: MessageInfoContext

Sets the request object for this MessageContextInfo.

Specified by:

setRequest in interface MessageInfoContext

Parameters:

request - The Request object.

getResponse

public Response getResponse()

Description copied from interface: MessageInfoContext

Gets the response object from this MessageContextInfo.

Specified by:

getResponse in interface MessageInfoContext

Returns:

The Response object.

setResponse

public void setResponse(Response response)

Description copied from interface: MessageInfoContext

Sets the response object for this MessageContextInfo.

Specified by:

setResponse in interface MessageInfoContext

Parameters:

response - The Response object.

getRequestContextMap

public Map<String,Object> getRequestContextMap()

Description copied from interface: MessageInfoContext

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.

Specified by:

getRequestContextMap in interface MessageInfoContext

Returns:

The request context map.

getAuditTrail

public AuditTrail getAuditTrail()

Description copied from interface: MessageContext

Gets the AuditTrail instance for this message exchange.

Specified by:

getAuditTrail in interface MessageContext

Returns:

The AuditTrail

getState

public <T extends AuthenticationState> T getState(AsyncServerAuthContext authContext)

Description copied from interface: MessageContext

Gets the AuthenticationState instance that maintains any stateful information for the provided AsyncServerAuthContext.

Specified by:

getState in interface MessageContext

Type Parameters:

T - The type of state class.

Parameters:

authContext - The AsyncServerAuthContext for which the state applies.

Returns:

The AuthenticationState instance.