org.mule.runtime.api.interception

Interface InterceptionEvent

public interface InterceptionEvent

Provides access to the attributes of the input event of a component and allows to mutate them.

Since:

1.0

Method Summary

Modifier and Type	Method and Description
InterceptionEvent	addVariable(String key, Object value) Add a variable.
InterceptionEvent	addVariable(String key, Object value, DataType mediaType) Add a variable.
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 payload 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.
InterceptionEvent	message(Message message) Set the Message to construct the target Event with.
InterceptionEvent	removeVariable(String key) Remove a variable.
InterceptionEvent	variables(Map<String,Object> variables) Set a map of variables.

Method Detail

getMessage

Message getMessage()

Returns the message payload for this event

Returns:

the message payload for this event

getVariableNames

Set<String> getVariableNames()

Returns an immutable Set of variable names.

Returns:

the set of names

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.

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.

message

InterceptionEvent message(Message message)

Set the Message to construct the target Event with.

Parameters:

message - the message instance.

Returns:

the builder instance

variables

InterceptionEvent variables(Map<String,Object> variables)

Set a map of variables. Any existing variables added to the builder will be removed.

Parameters:

variables - variables to be set.

Returns:

the builder instance

addVariable

InterceptionEvent addVariable(String key,
                              Object value,
                              DataType mediaType)

Add a variable.

Parameters:

key - the key of the variable to add.

value - the value of the variable to add. null values are supported.

mediaType - additional metadata about the value type.

Returns:

the builder instance.

addVariable

InterceptionEvent addVariable(String key,
                              Object value)

Add a variable.

Parameters:

key - the key of the variable to add.

value - the value of the variable to add. null values are supported.

Returns:

the builder instance

removeVariable

InterceptionEvent removeVariable(String key)

Remove a variable.

Parameters:

key - the variable key.

Returns:

the builder instance