org.mule.runtime.api.message

Interface MuleEvent

All Superinterfaces:

Serializable

public interface MuleEvent
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 MuleEvent.

Since:

1.0 TODO MULE-10487 Remove MuleEvent from mule-api module

See Also:

Message

Method Summary

Modifier and Type	Method and Description
Optional<Error>	getError() When a mule component throws an error then an Error object gets generated with all the data associated to the error.
Message	getMessage() Returns the message for this event
<T> TypedValue<T>	getVariable(String key) Returns the variable registered under the given key
Set<String>	getVariableNames() Returns an immutable Set of variable names.

Method Detail

getVariable

<T> 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

getMessage

Message getMessage()

Returns the message for this event

Returns:

the event's Message

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.