java.lang.Object
- de.quantummaid.eventmaid.processingContext.ProcessingContext<T>

Type Parameters:

T - the type of the processing Channel
```
public final class ProcessingContext<T>
extends Object
```
Message specific root object for all information related to the processing of a message.
Each ProcessingContext envelopes the sent message. The message can be accesses with the getPayload() and #setPayload(T) setPayload() methods. All Actions and Filter get access to the ProcessingContext object. This allows them to share data using the ProcessingContext's context meta date object. It is a Map<Object, Object, that can be accessed with getContextMetaData().

In case several Channels are chained together, a message traverses different channel in a specific order. The transitions are handled via Actions. Given such a chained Channel scenario, the history can be of interest. The history is represented in form of a linked list of ChannelProcessingFrames. For each traversed Channel, a new ChannelProcessingFrame is added at the end of the list. Once the final Action is reached, it is also saved in the frame. The ProcessingContext object gives access to the initial ChannelProcessingFrame with getInitialProcessingFrame(). The frame of the current Channel ( or last if outside of one), can be accessed with getCurrentProcessingFrame(). An exception is the Call Action. This Action is always executed once it was created and will never be the final action of a Channel. In case a Call is executed, an extra ChannelProcessingFrame is added with the Call Action, to represent the branching of the flow. All subsequent Channel will be contained normally in the list of frames.

See Also:

EventMaid Documentation

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`actionWasChanged()`	Returns, whether the default `Action` was overwritten for the current `Channel`
`void`	`changeAction(Action<T> action)`	Overwrites the `Channel's` default `Action`.
`CorrelationId`	`generateCorrelationIdForAnswer()`	Creates a `CorrelationId` matching the current `ProcessingContext'sMessageId`.
`Action<T>`	`getAction()`	Returns the `Action`, that overwrites the default one, if existing.
`Map<Object,Object>`	`getContextMetaData()`
`CorrelationId`	`getCorrelationId()`
`ChannelProcessingFrame<T>`	`getCurrentProcessingFrame()`
`Object`	`getErrorPayload()`
`EventType`	`getEventType()`
`ChannelProcessingFrame<T>`	`getInitialProcessingFrame()`
`MessageId`	`getMessageId()`
`T`	`getPayload()`
`static <T> ProcessingContext<T>`	`processingContext(EventType eventType, MessageId messageId, CorrelationId correlationId, T payload, Object errorPayload)`	Factory method to create a new `ProcessingContext`.
`static <T> ProcessingContext<T>`	`processingContext(EventType eventType, MessageId messageId, CorrelationId correlationId, T payload, Object errorPayload, Map<Object,Object> contextMetaData, ChannelProcessingFrame<T> initialProcessingFrame, ChannelProcessingFrame<T> currentProcessingFrame)`	Factory method to create a new `ProcessingContext`.
`static <T> ProcessingContext<T>`	`processingContext(EventType eventType, MessageId messageId, T payload)`	Factory method to create a new `ProcessingContext`.
`static <T> ProcessingContext<T>`	`processingContext(EventType eventType, T payload)`	Factory method to create a new `ProcessingContext`.
`static <T> ProcessingContext<T>`	`processingContext(EventType eventType, T payload, CorrelationId correlationId)`	Factory method to create a new `ProcessingContext`.
`static <T> ProcessingContext<T>`	`processingContextForError(EventType eventType, Object errorPayload)`	Factory method to create a new `ProcessingContext`.
`static <T> ProcessingContext<T>`	`processingContextForPayloadAndError(EventType eventType, CorrelationId correlationId, T payload, Object errorPayload)`	Factory method to create a new `ProcessingContext`.
`static <T> ProcessingContext<T>`	`processingContextForPayloadAndError(EventType eventType, T payload, Object errorPayload)`	Factory method to create a new `ProcessingContext`.
`void`	`setCorrelationId(CorrelationId correlationId)`
`void`	`setCurrentProcessingFrame(ChannelProcessingFrame<T> currentProcessingFrame)`
`void`	`setErrorPayload(Object errorPayload)`
`void`	`setInitialProcessingFrame(ChannelProcessingFrame<T> initialProcessingFrame)`
`void`	`setPayload(T payload)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait