org.mule.api
Interface MuleEvent

All Known Implementing Classes:

DefaultMuleEvent

public interface MuleEvent

MuleEvent represents any data event occuring in the Mule environment. All data sent or received within the mule environment will be passed between components as an MuleEvent.

The MuleEvent holds a MuleMessage payload 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 properties that can be set and retrieved by Mule components.

See Also:

MuleMessage

Field Summary

static int	TIMEOUT_DO_NOT_WAIT
static int	TIMEOUT_NOT_SET_VALUE
static int	TIMEOUT_WAIT_FOREVER

Method Summary

Credentials	getCredentials()
String	getEncoding() Gets the encoding for this message.
ImmutableEndpoint	getEndpoint() Gets the endpoint associated with this event
String	getId() Every event in the system is assigned a universally unique id (UUID).
MuleMessage	getMessage() Returns the message payload for this event
byte[]	getMessageAsBytes() Reterns the conents of the message as a byte array.
String	getMessageAsString() Returns the message contents as a string If necessary this will use the encoding set on the event
String	getMessageAsString(String encoding) Returns the message contents as a string
MuleContext	getMuleContext() Returns the muleContext for the Mule node that this event was received in
OutputStream	getOutputStream() An outputstream the can optionally be used write response data to an incoming message.
Object	getProperty(String name) Gets a property associated with the current event.
Object	getProperty(String name, Object defaultValue) Gets a property associated with the current event.
Service	getService() Retrieves the service for the current event
MuleSession	getSession() Retrieves the service session for the current event
int	getTimeout() The number of milliseconds to wait for a return event when running synchronously.
boolean	isStopFurtherProcessing() Determines whether the default processing for this event will be executed.
boolean	isSynchronous() Determines whether the was sent synchrounously or not
void	setStopFurtherProcessing(boolean stopFurtherProcessing) Determines whether the default processing for this event will be executed.
void	setSynchronous(boolean value) Determines whether the was sent synchrounously or not
void	setTimeout(int timeout) The number of milliseconds to wait for a return event when running synchronously.
Object	transformMessage() Transforms the message into it's recognised or expected format.
Object	transformMessage(Class outputType) Transforms the message into the requested format.
byte[]	transformMessageToBytes() Transforms the message into it's recognised or expected format and then into an array of bytes.
String	transformMessageToString() Returns the message transformed into it's recognised or expected format and then into a String.

Field Detail

TIMEOUT_WAIT_FOREVER

static final int TIMEOUT_WAIT_FOREVER

See Also:

Constant Field Values

TIMEOUT_DO_NOT_WAIT

static final int TIMEOUT_DO_NOT_WAIT

See Also:

Constant Field Values

TIMEOUT_NOT_SET_VALUE

static final int TIMEOUT_NOT_SET_VALUE

See Also:

Constant Field Values

Method Detail

getMessage

MuleMessage getMessage()

Returns the message payload for this event

Returns:

the message payload for this event

getCredentials

Credentials getCredentials()

getMessageAsBytes

byte[] getMessageAsBytes()
                         throws MuleException

Reterns the conents of the message as a byte array.

Returns:

the conents of the message as a byte array

Throws:

MuleException - if the message cannot be converted into an array of bytes

transformMessage

Object transformMessage()
                        throws TransformerException

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

Returns:

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

Throws:

TransformerException - if a failure occurs in the transformer

See Also:

Transformer

transformMessage

Object transformMessage(Class outputType)
                        throws TransformerException

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

Parameters:

outputType - The requested output type.

Returns:

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

Throws:

TransformerException - if a failure occurs in the transformer

See Also:

Transformer

transformMessageToBytes

byte[] transformMessageToBytes()
                               throws TransformerException

Transforms the message into it's recognised or expected format and then into an array of bytes. The transformer used is the one configured on the endpoint through which this event was received.

Returns:

the message transformed into it's recognised or expected format as an array of bytes.

Throws:

TransformerException - if a failure occurs in the transformer

See Also:

Transformer

transformMessageToString

String transformMessageToString()
                                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. If necessary this will use the encoding set on the event

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()
                          throws MuleException

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

Returns:

the message contents as a string

Throws:

MuleException - if the message cannot be converted into a string

getMessageAsString

String getMessageAsString(String encoding)
                          throws MuleException

Returns the message contents as a string

Parameters:

encoding - the encoding to use when converting the message to string

Returns:

the message contents as a string

Throws:

MuleException - if the message cannot be converted into a string

getId

String getId()

Every event in the system is assigned a universally unique id (UUID).

Returns:

the unique identifier for the event

getProperty

Object getProperty(String name)

Gets a property associated with the current event. This method will check all property scopes on the currnet message and the current session

Parameters:

name - the property name

Returns:

the property value or null if the property does not exist

getProperty

Object getProperty(String name,
                   Object defaultValue)

Gets a property associated with the current event. This method will check all property scopes on the currnet message and the current session

Parameters:

name - the property name

defaultValue - a default value if the property doesn't exist in the event

Returns:

the property value or the defaultValue if the property does not exist

getEndpoint

ImmutableEndpoint getEndpoint()

Gets the endpoint associated with this event

Returns:

the endpoint associated with this event

getSession

MuleSession getSession()

Retrieves the service session for the current event

Returns:

the service session for the event

getService

Service getService()

Retrieves the service for the current event

Returns:

the service for the event

isStopFurtherProcessing

boolean isStopFurtherProcessing()

Determines whether the default processing for this event will be executed. By default, the Mule server will route events according to a components configuration. The user can override this behaviour by obtaining a reference to the MuleEvent context, either by implementing org.mule.api.lifecycle.Callable or calling RequestContext.getEventContext to obtain the MuleEventContext for the current thread. The user can programmatically control how events are dispached.

Returns:

Returns true is the user has set stopFurtherProcessing.

See Also:

MuleContext, MuleEventContext, Callable

setStopFurtherProcessing

void setStopFurtherProcessing(boolean stopFurtherProcessing)

Determines whether the default processing for this event will be executed. By default, the Mule server will route events according to a components configuration. The user can override this behaviour by obtaining a reference to the MuleEvent context, either by implementing org.mule.api.lifecycle.Callable or calling RequestContext.getEventContext to obtain the MuleEventContext for the current thread. The user can programmatically control how events are dispached.

Parameters:

stopFurtherProcessing - the value to set.

isSynchronous

boolean isSynchronous()

Determines whether the was sent synchrounously or not

Returns:

true if the event is synchronous

setSynchronous

void setSynchronous(boolean value)

Determines whether the was sent synchrounously or not

Parameters:

value - true if the event is synchronous

getTimeout

int getTimeout()

The number of milliseconds to wait for a return event when running synchronously. 0 wait forever -1 try and receive, but do not wait or a positive millisecond value

Returns:

the event timeout in milliseconds

setTimeout

void setTimeout(int timeout)

The number of milliseconds to wait for a return event when running synchronously. 0 wait forever -1 try and receive, but do not wait or a positive millisecod value

Parameters:

timeout - the event timeout in milliseconds

getOutputStream

OutputStream getOutputStream()

An outputstream the can optionally be used write response data to an incoming message.

Returns:

an output strem if one has been made available by the message receiver that received the message

getEncoding

String getEncoding()

Gets the encoding for this message.

Returns:

the encoding for the event. This must never return null.

getMuleContext

MuleContext getMuleContext()

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

Returns:

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