org.mule.runtime.core

Class DefaultEventContext

java.lang.Object

org.mule.runtime.core.DefaultEventContext

All Implemented Interfaces:

Serializable, EventContext

public final class DefaultEventContext
extends Object
implements Serializable

Default immutable implementation of EventContext.

Since:

4.0

See Also:

Serialized Form

Method Summary

Modifier and Type	Method and Description
static EventContext	child(EventContext parent) Builds a new child execution context from a parent context.
static EventContext	create(FlowConstruct flow, org.mule.runtime.api.component.location.ComponentLocation location) Builds a new execution context with the given parameters.
static EventContext	create(FlowConstruct flow, org.mule.runtime.api.component.location.ComponentLocation location, String correlationId) Builds a new execution context with the given parameters and an empty publisher.
static EventContext	create(FlowConstruct flow, org.mule.runtime.api.component.location.ComponentLocation location, String correlationId, org.reactivestreams.Publisher<Void> externalCompletionPublisher) Builds a new execution context with the given parameters.
void	error(Throwable throwable) Complete this EventContext unsuccessfully with an error
org.reactivestreams.Publisher<Event>	getBeforeResponsePublisher() A Publisher that completes when a response is ready or an error was produced for this EventContext but importantly before the Response Publisher obtained via EventContext.getResponsePublisher() completes.
org.reactivestreams.Publisher<Void>	getCompletionPublisher() A Publisher that completes when a this EventContext and all child EventContext's have completed.
String	getCorrelationId() The correlation ID is used to correlate messages between different flows and systems.
String	getId() Unique time-based id (UUID) for this EventContext.
String	getOriginatingConnectorName()
String	getOriginatingFlowName()
org.mule.runtime.api.component.location.ComponentLocation	getOriginatingLocation()
String	getOriginatingSourceName()
Optional<EventContext>	getParentContext() Returns this context's parent if it has one
ProcessingTime	getProcessingTime()
ProcessorsTrace	getProcessorsTrace() Events have a list of message processor paths it went trough so that the execution path of an event can be reconstructed after it has executed.
OffsetTime	getReceivedTime()
org.reactivestreams.Publisher<Event>	getResponsePublisher() A Publisher that completes when a response is ready or an error was produced for this EventContext.
boolean	isCorrelationIdFromSource() Used to determine if the correlation was set by the source connector or was generated.
void	success() Complete this EventContext successfully with no result Event.
void	success(Event event) Complete this EventContext successfully with a result Event.
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

create

public static EventContext create(FlowConstruct flow,
                                  org.mule.runtime.api.component.location.ComponentLocation location)

Builds a new execution context with the given parameters.

Parameters:

flow - the flow that processes events of this context.

location - the location of the component that received the first message for this context.

create

public static EventContext create(FlowConstruct flow,
                                  org.mule.runtime.api.component.location.ComponentLocation location,
                                  String correlationId)

Builds a new execution context with the given parameters and an empty publisher.

Parameters:

flow - the flow that processes events of this context.

location - the location of the component that received the first message for this context.

correlationId - See EventContext.getCorrelationId().

create

public static EventContext create(FlowConstruct flow,
                                  org.mule.runtime.api.component.location.ComponentLocation location,
                                  String correlationId,
                                  org.reactivestreams.Publisher<Void> externalCompletionPublisher)

Builds a new execution context with the given parameters.

Parameters:

flow - the flow that processes events of this context.

location - the location of the component that received the first message for this context.

correlationId - See EventContext.getCorrelationId().

externalCompletionPublisher - void publisher that completes when source completes enabling completion of EventContext to depend on completion of source.

child

public static EventContext child(EventContext parent)

Builds a new child execution context from a parent context. A child context delegates all getters to the parent context but has it's own completion lifecycle. Completion of the child context will not cause the parent context to complete. This is typically used in flow-ref type scenarios where a the referenced Flow should complete the child context, but should not complete the parent context

Parameters:

parent - the parent context

Returns:

a new child context

getId

public String getId()

Description copied from interface: EventContext

Unique time-based id (UUID) for this EventContext.

Specified by:

getId in interface EventContext

Returns:

the UUID for this EventContext

getCorrelationId

public String getCorrelationId()

Description copied from interface: EventContext

The correlation ID is used to correlate messages between different flows and systems.

If the connector that receives the source message supports the concept of a correlation ID then the connector should create an instance of EventContext using this value. If on the other hand, no correlation ID is received by the source connector then a time-based UUID, also available via EventContext.getId() is used.

Specified by:

getCorrelationId in interface EventContext

Returns:

the correlation id.

getReceivedTime

public OffsetTime getReceivedTime()

Specified by:

getReceivedTime in interface EventContext

Returns:

a timestamp indicating when the message was received by the connector source

getOriginatingLocation

public org.mule.runtime.api.component.location.ComponentLocation getOriginatingLocation()

Specified by:

getOriginatingLocation in interface EventContext

Returns:

the location where this context's events come from

getOriginatingFlowName

public String getOriginatingFlowName()

Specified by:

getOriginatingFlowName in interface EventContext

Returns:

the name of the flow that processes events of this context.

getOriginatingConnectorName

public String getOriginatingConnectorName()

Specified by:

getOriginatingConnectorName in interface EventContext

Returns:

the name of the component that generated the message for the first event of this context.

getOriginatingSourceName

public String getOriginatingSourceName()

Specified by:

getOriginatingSourceName in interface EventContext

Returns:

the name of the source that generated the message for the first event of this context.

getProcessingTime

public ProcessingTime getProcessingTime()

Specified by:

getProcessingTime in interface EventContext

isCorrelationIdFromSource

public boolean isCorrelationIdFromSource()

Description copied from interface: EventContext

Used to determine if the correlation was set by the source connector or was generated.

Specified by:

isCorrelationIdFromSource in interface EventContext

Returns:

true if the source system provided a correlation id, false otherwise.

getProcessorsTrace

public ProcessorsTrace getProcessorsTrace()

Description copied from interface: EventContext

Events have a list of message processor paths it went trough so that the execution path of an event can be reconstructed after it has executed.

This will only be enabled if DefaultMuleConfiguration.isFlowTrace() is true. If false, the list will always be empty.

Specified by:

getProcessorsTrace in interface EventContext

Returns:

the message processors trace associated to this event.

getParentContext

public Optional<EventContext> getParentContext()

Description copied from interface: EventContext

Returns this context's parent if it has one

Specified by:

getParentContext in interface EventContext

Returns:

this context's parent or Optional.empty() if it doesn't have one

toString

public String toString()

Overrides:

toString in class Object

success

public final void success()

Complete this EventContext successfully with no result Event.

Specified by:

success in interface EventContext

success

public final void success(Event event)

Complete this EventContext successfully with a result Event.

Specified by:

success in interface EventContext

Parameters:

event - the result event.

error

public final void error(Throwable throwable)

Complete this EventContext unsuccessfully with an error

Specified by:

error in interface EventContext

Parameters:

throwable - the throwable.

getBeforeResponsePublisher

public org.reactivestreams.Publisher<Event> getBeforeResponsePublisher()

Description copied from interface: EventContext

A Publisher that completes when a response is ready or an error was produced for this EventContext but importantly before the Response Publisher obtained via EventContext.getResponsePublisher() completes. This allows for response subscribers that are executed before the source, client or parent flow receives to be registered. In order to subscribe after response processing you can use the response Publisher.

Any asynchronous processing initiated as part of processing the request Event maybe still be in process when this Publisher completes. The completion Publisher can be used to perform an action after all processing is complete.

Specified by:

getBeforeResponsePublisher in interface EventContext

Returns:

publisher that completes when this EventContext instance has a response of error.

See Also:

EventContext.getResponsePublisher(), EventContext.getCompletionPublisher()

getResponsePublisher

public org.reactivestreams.Publisher<Event> getResponsePublisher()

Description copied from interface: EventContext

A Publisher that completes when a response is ready or an error was produced for this EventContext. Any subscribers registered before the response completes will be executed after the response has been processed by the source, client or parent flow. In order to subscribe before response processing you can use the before response Publisher.

Any asynchronous processing initiated as part of processing the request Event maybe still be in process when this Publisher completes. The completion Publisher can be used to perform an action after all processing is complete.

Specified by:

getResponsePublisher in interface EventContext

Returns:

publisher that completes when this EventContext instance has a response of error.

See Also:

(), EventContext.getCompletionPublisher()

getCompletionPublisher

public org.reactivestreams.Publisher<Void> getCompletionPublisher()

Description copied from interface: EventContext

A Publisher that completes when a this EventContext and all child EventContext's have completed. In practice this means that this Publisher completes once all branches of execution have completed regardless of is they are synchronous or asynchronous. This Publisher will never complete with an error.

Specified by:

getCompletionPublisher in interface EventContext

Returns:

publisher that completes when this EventContext and all child context have completed.