org.mule.runtime.core.message

Class DefaultEventBuilder.EventImplementation

java.lang.Object

org.mule.runtime.core.message.DefaultEventBuilder.EventImplementation

All Implemented Interfaces:

Serializable, Event, DeserializationPostInitialisable

Enclosing class:

DefaultEventBuilder

public static class DefaultEventBuilder.EventImplementation
extends Object
implements Event, DeserializationPostInitialisable

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

The Event holds some data and provides helper methods for obtaining the data in a format that the receiving Mule component understands. The event can also maintain any number of flowVariables that can be set and retrieved by Mule components.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface org.mule.runtime.core.api.Event

Event.Builder, Event.CurrentEventHolder

Nested classes/interfaces inherited from interface org.mule.runtime.core.util.store.DeserializationPostInitialisable

DeserializationPostInitialisable.Implementation

Method Summary

Modifier and Type	Method and Description
EventContext	getContext()
String	getCorrelationId() The returned value will depend on the MessageSource that created this event, and the flow that is executing the event.
Optional<org.mule.runtime.api.message.Error>	getError() When a mule component throws an error then an Error object gets generated with all the data associated to the error.
FlowCallStack	getFlowCallStack() Events have a stack of executed flows (same as a call stack), so that at any given instant an application developer can determine where this event came from.
FlowConstruct	getFlowConstruct() Retrieves the service for the current event
GroupCorrelation	getGroupCorrelation() Returns the correlation metadata of this message.
String	getLegacyCorrelationId() Deprecated. Transport infrastructure is deprecated.
org.mule.runtime.api.message.Message	getMessage() Returns the message payload for this event
byte[]	getMessageAsBytes(MuleContext muleContext) Returns the contents of the message as a byte array.
String	getMessageAsString(Charset encoding, MuleContext muleContext) Returns the message contents for logging
String	getMessageAsString(MuleContext muleContext) Returns the message contents as a string If necessary this will use the encoding set on the event
MuleContext	getMuleContext() Returns the muleContext for the Mule node that this event was received in
Map<String,org.mule.runtime.api.metadata.TypedValue<Object>>	getParameters() Returns the complete set of parameters in the current event
Map<String,org.mule.runtime.api.metadata.TypedValue<Object>>	getProperties() Returns the complete set of properties in the current event
Object	getReplyToDestination() Return the destination (if any) that will be passed to the reply-to handler.
ReplyToHandler	getReplyToHandler() Return the replyToHandler (if any) that will be used to perform async reply
SecurityContext	getSecurityContext() The security context for this session.
MuleSession	getSession() Retrieves the service session for the current event
<T> org.mule.runtime.api.metadata.TypedValue<T>	getVariable(String key) Returns the variable registered under the given key
Set<String>	getVariableNames() Returns an immutable Set of variable names.
boolean	isNotificationsEnabled() Indicates if notifications should be fired when processing this message.
String	toString()
<T> T	transformMessage(Class<T> outputType, MuleContext muleContext) Transforms the message into the requested format.
Object	transformMessage(org.mule.runtime.api.metadata.DataType outputType, MuleContext muleContext) Transforms the message into the requested format.
String	transformMessageToString(MuleContext muleContext) Returns the message transformed into it's recognised or expected format and then into a String.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

builder, builder, builder, getCurrentEvent, getVariableValueOrNull, setCurrentEvent

Method Detail

getContext

public EventContext getContext()

Specified by:

getContext in interface Event

Returns:

the context applicable to all events created from the same root Event from a MessageSource.

getMessage

public org.mule.runtime.api.message.Message getMessage()

Description copied from interface: Event

Returns the message payload for this event

Specified by:

getMessage in interface Event

Returns:

the message payload for this event

getError

public Optional<org.mule.runtime.api.message.Error> getError()

Description copied from interface: Event

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.

Specified by:

getError in interface Event

Returns:

an optional of the error associated with the event. Will be empty if there's no error associated with the event.

getMessageAsBytes

public byte[] getMessageAsBytes(MuleContext muleContext)
                         throws DefaultMuleException

Description copied from interface: Event

Returns the contents of the message as a byte array.

Specified by:

getMessageAsBytes in interface Event

Parameters:

muleContext - the Mule node.

Returns:

the contents of the message as a byte array

Throws:

DefaultMuleException

transformMessage

public <T> T transformMessage(Class<T> outputType,
                              MuleContext muleContext)
                       throws TransformerException

Description copied from interface: Event

Transforms the message into the requested format. The transformer used is the one configured on the endpoint through which this event was received.

Specified by:

transformMessage in interface Event

Parameters:

outputType - The requested output type.

muleContext - the Mule node.

Returns:

the message transformed into it's recognized or expected format.

Throws:

TransformerException - if a failure occurs in the transformer

See Also:

if the transform fails or the outputtype is null

transformMessage

public Object transformMessage(org.mule.runtime.api.metadata.DataType outputType,
                               MuleContext muleContext)
                        throws TransformerException

Description copied from interface: Event

Transforms the message into the requested format. The transformer used is the one configured on the endpoint through which this event was received.

Specified by:

transformMessage in interface Event

Parameters:

outputType - The requested output type.

muleContext - the Mule node.

Returns:

the message transformed into it's recognized or expected format.

Throws:

TransformerException - if a failure occurs in the transformer

See Also:

if the transform fails or the outputtype is null

transformMessageToString

public String transformMessageToString(MuleContext muleContext)
                                throws TransformerException

Returns the message transformed into it's recognised or expected format and then into a String. The transformer used is the one configured on the endpoint through which this event was received.

Specified by:

transformMessageToString in interface Event

Parameters:

muleContext - the Mule node.

Returns:

the message transformed into it's recognised or expected format as a Strings.

Throws:

TransformerException - if a failure occurs in the transformer

See Also:

Transformer

getMessageAsString

public String getMessageAsString(MuleContext muleContext)
                          throws org.mule.runtime.api.exception.MuleException

Description copied from interface: Event

Returns the message contents as a string If necessary this will use the encoding set on the event

Specified by:

getMessageAsString in interface Event

Parameters:

muleContext - the Mule node.

Returns:

the message contents as a string

Throws:

org.mule.runtime.api.exception.MuleException - if the message cannot be converted into a string

getMessageAsString

public String getMessageAsString(Charset encoding,
                                 MuleContext muleContext)
                          throws org.mule.runtime.api.exception.MuleException

Returns the message contents for logging

Specified by:

getMessageAsString in interface Event

Parameters:

encoding - the encoding to use when converting bytes to a string, if necessary

muleContext - the Mule node.

Returns:

the message contents as a string

Throws:

org.mule.runtime.api.exception.MuleException - if the message cannot be converted into a string

toString

public String toString()

Overrides:

toString in class Object

getSession

public MuleSession getSession()

Description copied from interface: Event

Retrieves the service session for the current event

Specified by:

getSession in interface Event

Returns:

the service session for the event

getFlowConstruct

public FlowConstruct getFlowConstruct()

Description copied from interface: Event

Retrieves the service for the current event

Specified by:

getFlowConstruct in interface Event

Returns:

the service for the event

getMuleContext

public MuleContext getMuleContext()

Description copied from interface: Event

Returns the muleContext for the Mule node that this event was received in

Specified by:

getMuleContext in interface Event

Returns:

the muleContext for the Mule node that this event was received in

getReplyToHandler

public ReplyToHandler getReplyToHandler()

Description copied from interface: Event

Return the replyToHandler (if any) that will be used to perform async reply

Specified by:

getReplyToHandler in interface Event

getReplyToDestination

public Object getReplyToDestination()

Description copied from interface: Event

Return the destination (if any) that will be passed to the reply-to handler.

Specified by:

getReplyToDestination in interface Event

getVariableNames

public Set<String> getVariableNames()

Description copied from interface: Event

Returns an immutable Set of variable names.

Specified by:

getVariableNames in interface Event

Returns:

the set of names

getVariable

public <T> org.mule.runtime.api.metadata.TypedValue<T> getVariable(String key)

Description copied from interface: Event

Returns the variable registered under the given key

Specified by:

getVariable in interface Event

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

getProperties

public Map<String,org.mule.runtime.api.metadata.TypedValue<Object>> getProperties()

Description copied from interface: Event

Returns the complete set of properties in the current event

Specified by:

getProperties in interface Event

Returns:

a Map containing the properties' name as key and the TypedValue as value

getParameters

public Map<String,org.mule.runtime.api.metadata.TypedValue<Object>> getParameters()

Description copied from interface: Event

Returns the complete set of parameters in the current event

Specified by:

getParameters in interface Event

Returns:

a Map containing the parameters' name as key and the TypedValue as value

isNotificationsEnabled

public boolean isNotificationsEnabled()

Description copied from interface: Event

Indicates if notifications should be fired when processing this message.

Specified by:

isNotificationsEnabled in interface Event

Returns:

true if notifications are enabled, false otherwise

getFlowCallStack

public FlowCallStack getFlowCallStack()

Description copied from interface: Event

Events have a stack of executed flows (same as a call stack), so that at any given instant an application developer can determine where this event came from.

This will only be enabled if DefaultMuleConfiguration.isFlowTrace() is true. If false, the stack will always be empty.

Specified by:

getFlowCallStack in interface Event

Returns:

the flow stack associated to this event.

getSecurityContext

public SecurityContext getSecurityContext()

Description copied from interface: Event

The security context for this session. If not null outbound, inbound and/or method invocations will be authenticated using this context

Specified by:

getSecurityContext in interface Event

Returns:

the context for this session or null if the request is not secure.

getGroupCorrelation

public GroupCorrelation getGroupCorrelation()

Description copied from interface: Event

Returns the correlation metadata of this message. See GroupCorrelation.

Specified by:

getGroupCorrelation in interface Event

Returns:

the correlation metadata of this message.

getCorrelationId

public String getCorrelationId()

Description copied from interface: Event

The returned value will depend on the MessageSource that created this event, and the flow that is executing the event.

Specified by:

getCorrelationId in interface Event

Returns:

the correlation id to use for this event.

getLegacyCorrelationId

@Deprecated
public String getLegacyCorrelationId()

Deprecated. Transport infrastructure is deprecated.

Obtain the correlationId set during flow execution if any. This is only used to support transports and should not be used otherwise. Customization of the correlationId, if needed, should instead be done as part of the source connector configuration.

Specified by:

getLegacyCorrelationId in interface Event

Returns:

legacy correlationId if set, otherwise null.