org.mule.runtime.api.message

Interface MuleMessage

All Superinterfaces:

Serializable

public interface MuleMessage
extends Serializable

Represents a message payload. The Message is comprised of the payload itself and properties associated with the payload.

Since:

1.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	MuleMessage.Builder
static interface	MuleMessage.CollectionBuilder
static interface	MuleMessage.PayloadBuilder

Method Summary

Modifier and Type	Method and Description
static MuleMessage.PayloadBuilder	builder() Provides a builder to create MuleMessage objects.
static MuleMessage.Builder	builder(MuleMessage message) Provides a builder to create MuleMessage objects based on an existing MuleMessage instance.
Attributes	getAttributes() Gets the attributes associated with the MuleMessage.
DataType	getDataType() Returns the data type (if any) associated with the message's payload.
Object	getPayload()
static MuleMessage	of(Object payload) Create a new instance with the given payload.

Method Detail

builder

static MuleMessage.PayloadBuilder builder()

Provides a builder to create MuleMessage objects.

Returns:

a new MuleMessage.Builder.

builder

static MuleMessage.Builder builder(MuleMessage message)

Provides a builder to create MuleMessage objects based on an existing MuleMessage instance.

Parameters:

message - existing MuleMessage to use as a template to create a new MuleMessage.Builder instance.

Returns:

a new MuleMessage.Builder based on the template message provided.

Throws:

NullPointerException - if the message is null

of

static MuleMessage of(Object payload)

Create a new instance with the given payload.

Parameters:

payload - the message payload

Returns:

new message instance

Throws:

NullPointerException - if the payload is null

getPayload

Object getPayload()

Returns:

the current message payload

getAttributes

Attributes getAttributes()

Gets the attributes associated with the MuleMessage. The Attributes attributes object is specifc to the connector that was the source of the current message and is used for obtaining message properties or headers if applicable plus additional information that provides context for the current message such as file size, file name and last modified date for FILE, and origin ip address, query parameters etc. for HTTP.

If there are no attributes associated with the current message, for example if the source of the message was not a connector, then the attributes with be null.

Returns:

attributes associated with the message, or null if none exist.

getDataType

DataType getDataType()

Returns the data type (if any) associated with the message's payload.