org.mule.runtime.api.interception

Interface InterceptionEvent

All Superinterfaces:

Event

@NoImplement
public interface InterceptionEvent
extends Event

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.
BindingContext	asBindingContext() Creates a BindingContext for the target event to use with a MuleExpressionLanguage.
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.

Methods inherited from interface org.mule.runtime.api.event.Event

getAuthentication, getContext, getCorrelationId, getError, getItemSequenceInfo, getMessage, getVariables

Method Detail

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

asBindingContext

BindingContext asBindingContext()

Creates a BindingContext for the target event to use with a MuleExpressionLanguage.

Specified by:

asBindingContext in interface Event

Returns:

a BindingContext representing the data of the target event.