org.mule.runtime.core.api

Interface Event.Builder

All Known Implementing Classes:

DefaultEventBuilder

Enclosing interface:

Event

public static interface Event.Builder

Method Summary

Modifier and Type	Method and Description
Event.Builder	addVariable(String key, Object value) Add a variable.
Event.Builder	addVariable(String key, Object value, org.mule.runtime.api.metadata.DataType mediaType) Add a variable.
Event	build() Build a new Event based on the state configured in the Event.Builder.
Event.Builder	correlationId(String correlationId) Deprecated. Transport infrastructure is deprecated.
Event.Builder	disableNotifications() Deprecated. Transport infrastructure is deprecated.
Event.Builder	error(org.mule.runtime.api.message.Error error) Sets an error related to the produced event.
Event.Builder	flow(FlowConstruct flow) Deprecated. TODO MULE-10013 remove this
Event.Builder	groupCorrelation(GroupCorrelation groupCorrelation) Sets the group correlation information to the produced event.
Event.Builder	message(org.mule.runtime.api.message.Message message) Set the Message to construct Event with.
Event.Builder	parameters(Map<String,Object> parameters) Set a map of parameters to be consumed within a ModuleOperationMessageProcessorChainBuilder.ModuleOperationProcessorChain.
Event.Builder	properties(Map<String,Object> properties) Set a map of properties to be consumed within a ModuleOperationMessageProcessorChainBuilder.ModuleOperationProcessorChain.
Event.Builder	removeParameter(String key) Remove a parameter.
Event.Builder	removeVariable(String key) Remove a variable.
Event.Builder	replyToDestination(Object replyToDestination) Deprecated. TODO MULE-10739 Move ReplyToHandler to compatibility module.
Event.Builder	replyToHandler(ReplyToHandler replyToHandler) Deprecated. TODO MULE-10739 Move ReplyToHandler to compatibility module.
Event.Builder	session(MuleSession session) Deprecated. Transport infrastructure is deprecated.
Event.Builder	variables(Map<String,Object> variables) Set a map of variables.

Method Detail

message

Event.Builder message(org.mule.runtime.api.message.Message message)

Set the Message to construct Event with.

Parameters:

message - the message instance.

Returns:

the builder instance

variables

Event.Builder 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

Event.Builder 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

Event.Builder addVariable(String key,
                          Object value,
                          org.mule.runtime.api.metadata.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

removeVariable

Event.Builder removeVariable(String key)

Remove a variable.

Parameters:

key - the variable key.

Returns:

the builder instance

properties

Event.Builder properties(Map<String,Object> properties)

Set a map of properties to be consumed within a ModuleOperationMessageProcessorChainBuilder.ModuleOperationProcessorChain.

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

Event.Builder parameters(Map<String,Object> parameters)

Set a map of parameters to be consumed within a ModuleOperationMessageProcessorChainBuilder.ModuleOperationProcessorChain.

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)

removeParameter

Event.Builder removeParameter(String key)

Remove a parameter.

Parameters:

key - the parameter key.

Returns:

the builder instance

See Also:

parameters(Map)

correlationId

@Deprecated
Event.Builder correlationId(String correlationId)

Deprecated. Transport infrastructure is deprecated.

Set correlationId overriding the correlationId from EventContext.getCorrelationId() that came from the source system or that was configured in the connector source. This is only used to support transports and should not be used otherwise.

Parameters:

correlationId - to override existing correlationId

Returns:

the builder instance

groupCorrelation

Event.Builder groupCorrelation(GroupCorrelation groupCorrelation)

Sets the group correlation information to the produced event.

Parameters:

groupCorrelation - the object containing the group correlation information to set on the produced event

Returns:

the builder instance

error

Event.Builder error(org.mule.runtime.api.message.Error error)

Sets an error related to the produced event.

Parameters:

error - the error associated with the produced event

Returns:

the builder instance

replyToHandler

@Deprecated
Event.Builder replyToHandler(ReplyToHandler replyToHandler)

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

Parameters:

replyToHandler -

Returns:

the builder instance

replyToDestination

@Deprecated
Event.Builder replyToDestination(Object replyToDestination)

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

Parameters:

replyToDestination -

Returns:

the builder instance

flow

@Deprecated
Event.Builder flow(FlowConstruct flow)

Deprecated. TODO MULE-10013 remove this

Parameters:

flow -

Returns:

the builder instance

disableNotifications

@Deprecated
Event.Builder disableNotifications()

Deprecated. Transport infrastructure is deprecated.

Disables the firing of notifications when processing the produced event.

session

@Deprecated
Event.Builder session(MuleSession session)

Deprecated. Transport infrastructure is deprecated.

Parameters:

session -

Returns:

the builder instance

build

Event build()

Build a new Event based on the state configured in the Event.Builder.

Returns:

new Event instance.