org.opensaml.messaging.context

Class MessageContext<MessageType>

java.lang.Object

org.opensaml.messaging.context.BaseContext

org.opensaml.messaging.context.MessageContext<MessageType>

Type Parameters:

MessageType - the message type of the message context

All Implemented Interfaces:

Iterable<BaseContext>

public class MessageContext<MessageType>
extends BaseContext

A context component which holds the state related to the processing of a single message.

Additional information associated with the message represented by the context may be held by the context as subordinate subcontext instances. Subcontext instances may simply hold state information related to the message, in which case they may be seen as a type-safe variant of the ubiquitous properties map pattern. They may also be more functional or operational in nature, for example providing "views" onto the message and/or message context data.

Nested Class Summary

Nested classes/interfaces inherited from class org.opensaml.messaging.context.BaseContext

BaseContext.ContextSetNoRemoveIteratorDecorator

Field Summary

Fields

Modifier and Type	Field and Description
private MessageType	msg The message represented.

Constructor Summary

Constructors

Constructor and Description
MessageContext()

Method Summary

Methods

Modifier and Type	Method and Description
MessageType	getMessage() Get the message represented by the message context.
void	setMessage(MessageType message) Set the message represented by the message context.

Methods inherited from class org.opensaml.messaging.context.BaseContext

addSubcontext, addSubcontext, clearSubcontexts, containsSubcontext, createSubcontext, getParent, getSubcontext, getSubcontext, getSubcontext, getSubcontext, isAutoCreateSubcontexts, iterator, removeSubcontext, removeSubcontext, setAutoCreateSubcontexts, setParent

Methods inherited from class java.lang.Object

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

Field Detail

msg

@Nullable
private MessageType msg

The message represented.

Constructor Detail

MessageContext

public MessageContext()

Method Detail

getMessage

@Nullable
public MessageType getMessage()

Get the message represented by the message context.

Returns:

the message

setMessage

public void setMessage(@Nullable
              MessageType message)

Set the message represented by the message context.

Parameters:

message - the message