Package org.wildfly.security.auth.jaspi.impl

Class ElytronMessageInfo

java.lang.Object

org.wildfly.security.auth.jaspi.impl.ElytronMessageInfo

All Implemented Interfaces:

MessageInfo

Direct Known Subclasses:

ServletMessageInfo

public class ElytronMessageInfo
extends Object
implements MessageInfo

An implementation of the MessageInfo interface.

Author:

Darran Lofthouse

See Also:

MessageInfo

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	ElytronMessageInfo.State

Constructor Summary

Constructors

Constructor	Description
ElytronMessageInfo()

Method Summary

Modifier and Type	Method	Description
Map	getMap()	Get (a reference to) the Map object of this MessageInfo.
Object	getRequestMessage()	Get the request message object from this MessageInfo.
Object	getResponseMessage()	Get the response message object from this MessageInfo.
protected ElytronMessageInfo.State	getState()	Get the current state for how this MessageInfo is being used.
void	setRequestMessage(Object requestMessage)	Set the request message object in this MessageInfo.
void	setResponseMessage(Object responseMessage)	Set the response message object in this MessageInfo.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ElytronMessageInfo

public ElytronMessageInfo()

Method Detail

getMap

public Map getMap()

Description copied from interface: MessageInfo

Get (a reference to) the Map object of this MessageInfo. Operations performed on the acquired Map must effect the Map within the MessageInfo.

Specified by:

getMap in interface MessageInfo

Returns:

the Map object of this MessageInfo. This method never returns null. If a Map has not been associated with the MessageInfo, this method instantiates a Map, associates it with this MessageInfo, and then returns it.

See Also:

MessageInfo.getMap()

getRequestMessage

public Object getRequestMessage()

Description copied from interface: MessageInfo

Get the request message object from this MessageInfo.

Specified by:

getRequestMessage in interface MessageInfo

Returns:

An object representing the request message, or null if no request message is set within the MessageInfo.

See Also:

MessageInfo.getRequestMessage()

getResponseMessage

public Object getResponseMessage()

Description copied from interface: MessageInfo

Get the response message object from this MessageInfo.

Specified by:

getResponseMessage in interface MessageInfo

Returns:

an object representing the response message, or null if no response message is set within the MessageInfo.

See Also:

MessageInfo.getResponseMessage()

setRequestMessage

public void setRequestMessage(Object requestMessage)

Description copied from interface: MessageInfo

Set the request message object in this MessageInfo.

Specified by:

setRequestMessage in interface MessageInfo

Parameters:

requestMessage - An object representing the request message.

See Also:

MessageInfo.setRequestMessage(java.lang.Object)

setResponseMessage

public void setResponseMessage(Object responseMessage)

Description copied from interface: MessageInfo

Set the response message object in this MessageInfo.

Specified by:

setResponseMessage in interface MessageInfo

Parameters:

responseMessage - An object representing the response message.

See Also:

MessageInfo.setResponseMessage(java.lang.Object)

getState

protected ElytronMessageInfo.State getState()

Get the current state for how this MessageInfo is being used.

Returns:

the current processing state for this MessageInfo.