Top Description Methods
jakarta.security.auth.message

public Interface MessageInfo

Imports
java.util.Map
A container (message processing runtime) uses this interface to pass messages and message processing state to authentication contexts for processing by authentication mechanisms (modules).

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

Every implementation of this interface should provide a zero argument constructor, and a constructor which takes a single Map argument. Additional constructors may also be provided.

See Also
Map

Method Summary

Modifier and TypeMethod and Description
public Map<String, Object>

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.
getMap()

Get (a reference to) the Map object of this MessageInfo.

public Object

Returns:

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

Get the request message object from this MessageInfo.

public Object

Returns:

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

Get the response message object from this MessageInfo.

public void
setRequestMessage(Object
An object representing the request message.
request)

Set the request message object in this MessageInfo.

public void
setResponseMessage(Object
An object representing the response message.
response)

Set the response message object in this MessageInfo.

Method Detail

getMapback to summary
public Map<String, Object> getMap()

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

Returns:Map<String, Object>

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.

getRequestMessageback to summary
public Object getRequestMessage()

Get the request message object from this MessageInfo.

Returns:Object

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

getResponseMessageback to summary
public Object getResponseMessage()

Get the response message object from this MessageInfo.

Returns:Object

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

setRequestMessageback to summary
public void setRequestMessage(Object request)

Set the request message object in this MessageInfo.

Parameters
request:Object

An object representing the request message.

setResponseMessageback to summary
public void setResponseMessage(Object response)

Set the response message object in this MessageInfo.

Parameters
response:Object

An object representing the response message.