Event (Mule API 1.2.0-20210120 API)

All Known Subinterfaces:

InterceptionEvent
```
@NoImplement
public interface Event
```
Context of information related to the execution of the components.

Since:

1.0

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`BindingContext`	`asBindingContext()` Creates a `BindingContext` from the event.
`Optional<Authentication>`	`getAuthentication()` Returns the authentication information for the event
`EventContext`	`getContext()`
`String`	`getCorrelationId()` The returned value will depend on the flow source that created this event, and the flow that is executing the event.
`Optional<Error>`	`getError()` When a mule component throws an error then an `Error` object gets generated with all the data associated to the error.
`Optional<ItemSequenceInfo>`	`getItemSequenceInfo()` Returns the sequence metadata of this event.
`Message`	`getMessage()` Returns the message payload for this event
`Map<String,TypedValue<?>>`	`getVariables()` Returns the variables in the event

- Method Detail
  - getVariables
```
Map<String,TypedValue<?>> getVariables()
```
    Returns the variables in the event
    
    Returns:
    
    a map of TypedValue containing the variable's names and values.
  - getMessage
```
Message getMessage()
```
    Returns the message payload for this event
    
    Returns:
    
    the message payload for this event
  - getAuthentication
```
Optional<Authentication> getAuthentication()
```
    Returns the authentication information for the event
    
    Returns:
    
    authentication information for the event, may be Optional.empty().
  - getError
```
Optional<Error> getError()
```
    When a mule component throws an error then an Error object gets generated with all the data associated to the error. This field will only contain a value within the error handler defined to handle errors. After the error handler is executed the event error field will be cleared. If another flow is called from within the error handler the flow will still have access to the error field.
    To avoid losing the error field after the error handler the user can define a variable pointing to the error field.
    
    Returns:
    
    an optional of the error associated with the event. Will be empty if there's no error associated with the event.
  - getCorrelationId
```
String getCorrelationId()
```
    The returned value will depend on the flow source that created this event, and the flow that is executing the event.
    
    Returns:
    
    the correlation id to use for this event.
  - getItemSequenceInfo
```
Optional<ItemSequenceInfo> getItemSequenceInfo()
```
    Returns the sequence metadata of this event. See ItemSequenceInfo.
    The value can be an Optional.empty() meaning that this event does not belong to any specific sequence.
    
    Returns:
    
    the item sequence metadata of this event.
  - getContext
```
EventContext getContext()
```
    Returns:
    
    the context applicable to all events created from the same root Event from a source.
  - asBindingContext
```
BindingContext asBindingContext()
```
    Creates a BindingContext from the event.
    
    Returns:
    
    a BindingContext created from the event content.

Interface Event

Method Summary

Method Detail

getVariables

getMessage

getAuthentication

getError

getCorrelationId

getItemSequenceInfo

getContext

asBindingContext