EventContext (Mule Core 4.0.0-BETA.4 API)

All Known Implementing Classes:

DefaultEventContext
```
public interface EventContext
```
Context representing a message that is received by a Mule Runtime via a connector source. This context is immutable and maintained during all execution originating from a given source message and all instances of Event created as part of the processing of the source message will maintain a reference to this instance. Wherever a Flow references another Flow this EventContext will be maintained, while whenever there is a connector boundary a new instance will be created by the receiving source.

Since:

4.0

See Also:

Event

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`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 `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`.

- Method Detail
  - getId
```
String getId()
```
    Unique time-based id (UUID) for this EventContext.
    
    Returns:
    
    the UUID for this EventContext
  - getCorrelationId
```
String getCorrelationId()
```
    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 getId() is used.
    
    Returns:
    
    the correlation id.
  - getReceivedTime
```
OffsetTime getReceivedTime()
```
    Returns:
    
    a timestamp indicating when the message was received by the connector source
  - getOriginatingLocation
```
org.mule.runtime.api.component.location.ComponentLocation getOriginatingLocation()
```
    Returns:
    
    the location where this context's events come from
  - getOriginatingFlowName
```
String getOriginatingFlowName()
```
    Returns:
    
    the name of the flow that processes events of this context.
  - getOriginatingConnectorName
```
String getOriginatingConnectorName()
```
    Returns:
    
    the name of the component that generated the message for the first event of this context.
  - getOriginatingSourceName
```
String getOriginatingSourceName()
```
    Returns:
    
    the name of the source that generated the message for the first event of this context.
  - success
```
void success()
```
    Complete this EventContext successfully with no result Event.
  - success
```
void success(Event event)
```
    Complete this EventContext successfully with a result Event.
    
    Parameters:
    
    event - the result event.
  - error
```
void error(Throwable throwable)
```
    Complete this EventContext unsuccessfully with an error
    
    Parameters:
    
    throwable - the throwable.
  - getProcessingTime
```
ProcessingTime getProcessingTime()
```
  - getProcessorsTrace
```
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.
    This will only be enabled if DefaultMuleConfiguration.isFlowTrace() is true. If false, the list will always be empty.
    
    Returns:
    
    the message processors trace associated to this event.
    
    Since:
    
    3.8.0
  - isCorrelationIdFromSource
```
boolean isCorrelationIdFromSource()
```
    Used to determine if the correlation was set by the source connector or was generated.
    
    Returns:
    
    true if the source system provided a correlation id, false otherwise.
  - getParentContext
```
Optional<EventContext> getParentContext()
```
    Returns this context's parent if it has one
    
    Returns:
    
    this context's parent or Optional.empty() if it doesn't have one
  - getBeforeResponsePublisher
```
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 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.
    
    Returns:
    
    publisher that completes when this EventContext instance has a response of error.
    
    See Also:
    
    getResponsePublisher(), getCompletionPublisher()
  - getResponsePublisher
```
org.reactivestreams.Publisher<Event> getResponsePublisher()
```
    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.
    
    Returns:
    
    publisher that completes when this EventContext instance has a response of error.
    
    See Also:
    
    (), getCompletionPublisher()
  - getCompletionPublisher
```
org.reactivestreams.Publisher<Void> getCompletionPublisher()
```
    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.
    
    Returns:
    
    publisher that completes when this EventContext and all child context have completed.

Interface EventContext

Method Summary

Method Detail

getId

getCorrelationId

getReceivedTime

getOriginatingLocation

getOriginatingFlowName

getOriginatingConnectorName

getOriginatingSourceName

success

success

error

getProcessingTime

getProcessorsTrace

isCorrelationIdFromSource

getParentContext

getBeforeResponsePublisher

getResponsePublisher

getCompletionPublisher