org.mule.runtime.core.api

Interface Event

All Superinterfaces:

Serializable

All Known Implementing Classes:

DefaultEventBuilder.EventImplementation

public interface Event
extends Serializable

Represents any data event occurring in the Mule environment. All data sent or received within the mule environment will be passed between components as an Event.

Holds a Message payload and provides helper methods for obtaining the data in a format that the receiving Mule component understands. The event can also maintain any number of properties that can be set and retrieved by Mule components.

See Also:

Message

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	Event.Builder
static class	Event.CurrentEventHolder

Method Summary

Modifier and Type	Method and Description
static Event.Builder	builder(Event event) Create new Event.Builder based on an existing Event instance.
static Event.Builder	builder(EventContext context) Create new Event.Builder.
static Event.Builder	builder(EventContext context, Event event) Create new Event.Builder based on an existing Event instance and and EventContext.
EventContext	getContext()
String	getCorrelationId() The returned value will depend on the MessageSource that created this event, and the flow that is executing the event.
static Event	getCurrentEvent() Return the event associated with the currently executing thread.
Optional<org.mule.runtime.api.message.Error>	getError() When a mule component throws an error then an Error object gets generated with all the data associated to the error.
FlowCallStack	getFlowCallStack() Events have a stack of executed flows (same as a call stack), so that at any given instant an application developer can determine where this event came from.
FlowConstruct	getFlowConstruct() Deprecated. TODO MULE-10013 remove this
GroupCorrelation	getGroupCorrelation() Returns the correlation metadata of this message.
String	getLegacyCorrelationId() Deprecated. TODO MULE-10706 Mule 4: remove this
org.mule.runtime.api.message.Message	getMessage() Returns the message payload for this event
byte[]	getMessageAsBytes(MuleContext muleContext) Deprecated. TODO MULE-10013 Move message serialization logic from within the message to an external service
String	getMessageAsString(Charset encoding, MuleContext muleContext) Deprecated. TODO MULE-10013 Move message serialization logic from within the message to an external service
String	getMessageAsString(MuleContext muleContext) Deprecated. TODO MULE-10013 Move message serialization logic from within the message to an external service
MuleContext	getMuleContext() Deprecated. TODO MULE-10013 remove this
Map<String,org.mule.runtime.api.metadata.TypedValue<Object>>	getParameters() Returns the complete set of parameters in the current event
Map<String,org.mule.runtime.api.metadata.TypedValue<Object>>	getProperties() Returns the complete set of properties in the current event
Object	getReplyToDestination() Deprecated. TODO MULE-10739 Move ReplyToHandler to compatibility module.
ReplyToHandler	getReplyToHandler() Deprecated. TODO MULE-10739 Move ReplyToHandler to compatibility module.
SecurityContext	getSecurityContext() The security context for this session.
MuleSession	getSession() Deprecated. Transport infrastructure is deprecated.
<T> org.mule.runtime.api.metadata.TypedValue<T>	getVariable(String key) Returns the variable registered under the given key
Set<String>	getVariableNames() Returns an immutable Set of variable names.
static <T> T	getVariableValueOrNull(String key, Event event) Helper method to get the value of a given variable in a null-safe manner such that null is returned for non-existent variables rather than a NoSuchElementException exception being thrown.
boolean	isNotificationsEnabled() Indicates if notifications should be fired when processing this message.
static void	setCurrentEvent(Event event) Set the event to be associated with the currently executing thread.
<T> T	transformMessage(Class<T> outputType, MuleContext muleContext) Deprecated. TODO MULE-10013 Move message serialization logic from within the message to an external service
Object	transformMessage(org.mule.runtime.api.metadata.DataType outputType, MuleContext muleContext) Deprecated. TODO MULE-10013 Move message serialization logic from within the message to an external service
String	transformMessageToString(MuleContext muleContext) Deprecated. TODO MULE-10013 Move message serialization logic from within the message to an external service

Method Detail

getContext

EventContext getContext()

Returns:

the context applicable to all events created from the same root Event from a MessageSource.

getGroupCorrelation

GroupCorrelation getGroupCorrelation()

Returns the correlation metadata of this message. See GroupCorrelation.

Returns:

the correlation metadata of this message.

getCorrelationId

String getCorrelationId()

The returned value will depend on the MessageSource that created this event, and the flow that is executing the event.

Returns:

the correlation id to use for this event.

getVariable

<T> org.mule.runtime.api.metadata.TypedValue<T> getVariable(String key)

Returns the variable registered under the given key

Type Parameters:

T - the type of the variable value.

Parameters:

key - the name or key of the variable. This must be non-null.

Returns:

a TypedValue containing the variable's value and DataType

Throws:

NoSuchElementException - if the flow variable does not exist.

getVariableNames

Set<String> getVariableNames()

Returns an immutable Set of variable names.

Returns:

the set of names

getProperties

Map<String,org.mule.runtime.api.metadata.TypedValue<Object>> getProperties()

Returns the complete set of properties in the current event

Returns:

a Map containing the properties' name as key and the TypedValue as value

getParameters

Map<String,org.mule.runtime.api.metadata.TypedValue<Object>> getParameters()

Returns the complete set of parameters in the current event

Returns:

a Map containing the parameters' name as key and the TypedValue as value

getMessage

org.mule.runtime.api.message.Message getMessage()

Returns the message payload for this event

Returns:

the message payload for this event

getError

Optional<org.mule.runtime.api.message.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.

getMessageAsBytes

@Deprecated
byte[] getMessageAsBytes(MuleContext muleContext)
                              throws org.mule.runtime.api.exception.MuleException

Deprecated. TODO MULE-10013 Move message serialization logic from within the message to an external service

Returns the contents of the message as a byte array.

Parameters:

muleContext - the Mule node.

Returns:

the contents of the message as a byte array

Throws:

org.mule.runtime.api.exception.MuleException - if the message cannot be converted into an array of bytes

transformMessage

@Deprecated
<T> T transformMessage(Class<T> outputType,
                                   MuleContext muleContext)
                            throws TransformerException

Deprecated. TODO MULE-10013 Move message serialization logic from within the message to an external service

Transforms the message into the requested format. The transformer used is the one configured on the endpoint through which this event was received.

Parameters:

outputType - The requested output type.

muleContext - the Mule node.

Returns:

the message transformed into it's recognized or expected format.

Throws:

TransformerException - if a failure occurs in the transformer

See Also:

if the transform fails or the outputtype is null

transformMessage

@Deprecated
Object transformMessage(org.mule.runtime.api.metadata.DataType outputType,
                                    MuleContext muleContext)
                             throws TransformerException

Deprecated. TODO MULE-10013 Move message serialization logic from within the message to an external service

Transforms the message into the requested format. The transformer used is the one configured on the endpoint through which this event was received.

Parameters:

outputType - The requested output type.

muleContext - the Mule node.

Returns:

the message transformed into it's recognized or expected format.

Throws:

TransformerException - if a failure occurs in the transformer

See Also:

if the transform fails or the outputtype is null

transformMessageToString

@Deprecated
String transformMessageToString(MuleContext muleContext)
                                     throws TransformerException

Deprecated. TODO MULE-10013 Move message serialization logic from within the message to an external service

Returns the message transformed into it's recognized or expected format and then into a String. The transformer used is the one configured on the endpoint through which this event was received. If necessary this will use the encoding set on the event.

Parameters:

muleContext - the Mule node.

Returns:

the message transformed into it's recognized or expected format as a Strings.

Throws:

TransformerException - if a failure occurs in the transformer

See Also:

Transformer

getMessageAsString

@Deprecated
String getMessageAsString(MuleContext muleContext)
                               throws org.mule.runtime.api.exception.MuleException

Deprecated. TODO MULE-10013 Move message serialization logic from within the message to an external service

Returns the message contents as a string If necessary this will use the encoding set on the event

Parameters:

muleContext - the Mule node.

Returns:

the message contents as a string

Throws:

org.mule.runtime.api.exception.MuleException - if the message cannot be converted into a string

getMessageAsString

@Deprecated
String getMessageAsString(Charset encoding,
                                      MuleContext muleContext)
                               throws org.mule.runtime.api.exception.MuleException

Deprecated. TODO MULE-10013 Move message serialization logic from within the message to an external service

Returns the message contents as a string

Parameters:

encoding - the encoding to use when converting the message to string

muleContext - the Mule node.

Returns:

the message contents as a string

Throws:

org.mule.runtime.api.exception.MuleException - if the message cannot be converted into a string

getSession

@Deprecated
MuleSession getSession()

Deprecated. Transport infrastructure is deprecated.

Retrieves the service session for the current event

Returns:

the service session for the event

getFlowConstruct

@Deprecated
FlowConstruct getFlowConstruct()

Deprecated. TODO MULE-10013 remove this

Retrieves the service for the current event

Returns:

the service for the event

getMuleContext

@Deprecated
MuleContext getMuleContext()

Deprecated. TODO MULE-10013 remove this

Returns the muleContext for the Mule node that this event was received in

Returns:

the muleContext for the Mule node that this event was received in

getReplyToHandler

@Deprecated
ReplyToHandler getReplyToHandler()

Deprecated. TODO MULE-10739 Move ReplyToHandler to compatibility module.

Return the replyToHandler (if any) that will be used to perform async reply

getReplyToDestination

@Deprecated
Object getReplyToDestination()

Deprecated. TODO MULE-10739 Move ReplyToHandler to compatibility module.

Return the destination (if any) that will be passed to the reply-to handler.

isNotificationsEnabled

boolean isNotificationsEnabled()

Indicates if notifications should be fired when processing this message.

Returns:

true if notifications are enabled, false otherwise

getFlowCallStack

FlowCallStack getFlowCallStack()

Events have a stack of executed flows (same as a call stack), so that at any given instant an application developer can determine where this event came from.

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

Returns:

the flow stack associated to this event.

Since:

3.8.0

getSecurityContext

SecurityContext getSecurityContext()

The security context for this session. If not null outbound, inbound and/or method invocations will be authenticated using this context

Returns:

the context for this session or null if the request is not secure.

getLegacyCorrelationId

@Deprecated
String getLegacyCorrelationId()

Deprecated. TODO MULE-10706 Mule 4: remove this

Returns:

the correlation id to use for this event.

builder

static Event.Builder builder(EventContext context)

Create new Event.Builder.

Parameters:

context - the context to create event instance with.

Returns:

new builder instance.

builder

static Event.Builder builder(Event event)

Create new Event.Builder based on an existing Event instance. The existing EventContext is conserved.

Parameters:

event - existing event to use as a template to create builder instance

Returns:

new builder instance.

builder

static Event.Builder builder(EventContext context,
                             Event event)

Create new Event.Builder based on an existing Event instance and and EventContext. A new EventContext is used instead of the existing instance referenced by the existing Event. This builder should only be used in some specific scenarios like flow-ref where a new Flow executing the same Event needs a new context.

Parameters:

event - existing event to use as a template to create builder instance

context - the context to create event instance with.

Returns:

new builder instance.

getVariableValueOrNull

static <T> T getVariableValueOrNull(String key,
                                    Event event)

Helper method to get the value of a given variable in a null-safe manner such that null is returned for non-existent variables rather than a NoSuchElementException exception being thrown.

Type Parameters:

T - the variable type

Parameters:

key - the key of the variable to retrieve.

event - the event from which to retrieve a variable with the given key.

Returns:

the value of the variables if it exists otherwise null.

See Also:

getVariable(String)

getCurrentEvent

static Event getCurrentEvent()

Return the event associated with the currently executing thread.

Returns:

event for currently executing thread.

setCurrentEvent

static void setCurrentEvent(Event event)

Set the event to be associated with the currently executing thread.

Parameters:

event - event for currently executing thread.