org.mule.runtime.core.api

Interface MuleEventContext

All Known Implementing Classes:

DefaultMuleEventContext

public interface MuleEventContext

MuleEventContext is the context object for the current request. Using the context, developers can send/dispatch/receive events programmatically as well as manage transactions.

Method Summary

Modifier and Type	Method and Description
Transaction	getCurrentTransaction() Returns the current transaction (if any) for the session
Event	getEvent() Returns the event
FlowConstruct	getFlowConstruct()
org.mule.runtime.api.message.Message	getMessage() Returns the message payload for this event
String	getMessageAsString(Charset encoding, MuleContext muleContext) Returns the message contents as a string
String	getMessageAsString(MuleContext muleContext) Returns the message contents as a string This method will use the encoding set on the event
MuleSession	getSession()
Transaction	getTransaction() Returns the transaction for the current event or null if there is no transaction in progress
void	setEvent(Event event) Sets the event for this context.
Object	transformMessage(Class expectedType, MuleContext muleContext) Returns the message transformed into it's recognised or expected format.
Object	transformMessage(org.mule.runtime.api.metadata.DataType dataType, MuleContext muleContext) Returns the message transformed into its recognised or expected format.
String	transformMessageToString(MuleContext muleContext) Returns the message transformed into it's recognised or expected format and then into a String.

Method Detail

getMessage

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

Returns the message payload for this event

Returns:

the message payload for this event

getEvent

Event getEvent()

Returns the event

Returns:

the event

setEvent

void setEvent(Event event)

Sets the event for this context.

Parameters:

event -

transformMessage

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

Returns the message transformed into its recognised or expected format. The transformer used is the one configured on the endpoint through which this event was received.

Parameters:

dataType - The dataType required for the return object. This param just provides a convienient way to manage type casting of transformed objects

muleContext - the Mule node.

Returns:

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

Throws:

TransformerException - if a failure occurs or if the return type is not the same as the expected type in the transformer

See Also:

Transformer

transformMessage

Object transformMessage(Class expectedType,
                        MuleContext muleContext)
                 throws TransformerException

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

Parameters:

expectedType - The class type required for the return object. This param just provides a convienient way to manage type casting of transformed objects

muleContext - the Mule node.

Returns:

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

Throws:

TransformerException - if a failure occurs or if the return type is not the same as the expected type in the transformer

See Also:

Transformer

transformMessageToString

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. This method will use the encoding set on the 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

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

Returns the message contents as a string This method will use the encoding set on the 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

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

Returns the message contents as a string

Parameters:

encoding - The encoding to use when transforming the message

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

getCurrentTransaction

Transaction getCurrentTransaction()

Returns the current transaction (if any) for the session

Returns:

the current transaction for the session or null if there is no transaction in progress

getFlowConstruct

FlowConstruct getFlowConstruct()

getTransaction

Transaction getTransaction()

Returns the transaction for the current event or null if there is no transaction in progress

Returns:

the transaction for the current event or null if there is no transaction in progress

getSession

MuleSession getSession()