org.mule.runtime.api.event

Interface InputEvent

All Known Implementing Classes:

DefaultInputEvent

public interface InputEvent

Interface for defining the content of an event.

InputEvent can be used to trigger the execution of processor chains programmatically.

Since:

1.0

Method Summary

Modifier and Type	Method and Description
InputEvent	addParameter(String key, Object value) Add a parameter.
InputEvent	addParameter(String key, Object value, DataType dataType) Add a parameter.
InputEvent	addVariable(String key, Object value) Add a variable.
InputEvent	addVariable(String key, Object value, DataType dataType) Add a variable.
static InputEvent	create()
static InputEvent	create(Event event)
static InputEvent	create(InputEvent inputEvent)
InputEvent	error(Error error) Sets an error related to the produced 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.
Message	getMessage() Returns the message payload for this event
Map<String,TypedValue<?>>	getParameters() Returns the parameters in the event
Map<String,TypedValue<?>>	getProperties() Returns the properties in the event
Map<String,TypedValue<?>>	getVariables() Returns the variables in the event
InputEvent	message(Message message) Set the Message to construct Event with.
InputEvent	parameters(Map<String,Object> parameters) Set a map of parameters to be consumed within a XML connector operation
InputEvent	properties(Map<String,Object> properties) Set a map of properties to be consumed within a XML connector operation
InputEvent	variables(Map<String,?> variables) Set a map of variables.

Method Detail

create

static InputEvent create()

Returns:

a brand new InputEvent

create

static InputEvent create(Event event)

Parameters:

event - an Event to use as source of data

Returns:

a new InputEvent with the content of an existent Event

create

static InputEvent create(InputEvent inputEvent)

Parameters:

inputEvent - an InputEvent to use as source of data

Returns:

a new InputEvent with the content of an existent InputEvent

message

InputEvent message(Message message)

Set the Message to construct Event with.

Parameters:

message - the message instance.

Returns:

the builder instance

variables

InputEvent variables(Map<String,?> 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

InputEvent 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.

addVariable

InputEvent addVariable(String key,
                       Object value,
                       DataType dataType)

Add a variable.

Parameters:

key - the key of the variable to add.

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

dataType - additional metadata about the value type.

Returns:

the builder instance

properties

InputEvent properties(Map<String,Object> properties)

Set a map of properties to be consumed within a XML connector operation

For every module's being consumed in a Mule Application, when being macro expanded, these properties will be feed to it in a new and isolated Event, so that we can guarantee that for each invocation there's a real variable scoping for them.

Parameters:

properties - properties to be set.

Returns:

the builder instance

See Also:

parameters(Map)

parameters

InputEvent parameters(Map<String,Object> parameters)

Set a map of parameters to be consumed within a XML connector operation

For every module's being consumed in a Mule Application, when being macro expanded, these parameters will be feed to it in a new and isolated Event, so that we can guarantee that for each invocation there's a real variable scoping for them.

Parameters:

parameters - parameters to be set.

Returns:

the builder instance

See Also:

properties(Map)

addParameter

InputEvent addParameter(String key,
                        Object value)

Add a parameter.

Parameters:

key - the key of the parameter to add.

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

Returns:

the builder instance.

addParameter

InputEvent addParameter(String key,
                        Object value,
                        DataType dataType)

Add a parameter.

Parameters:

key - the key of the parameter to add.

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

dataType - additional metadata about the value type.

Returns:

the builder instance

error

InputEvent error(Error error)

Sets an error related to the produced event.

Parameters:

error - the error associated with the produced event

Returns:

the builder instance

getVariables

Map<String,TypedValue<?>> getVariables()

Returns the variables in the event

Returns:

a map of TypedValue containing the variable's names and values.

getProperties

Map<String,TypedValue<?>> getProperties()

Returns the properties in the event

Returns:

a map of TypedValue containing the properties's names and values.

getParameters

Map<String,TypedValue<?>> getParameters()

Returns the parameters in the event

Returns:

a map of TypedValue containing the parameter's names and values.

getMessage

Message getMessage()

Returns the message payload for this event

Returns:

the message payload for this event

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.