org.mule.runtime.api.message

Interface Message

All Superinterfaces:

Serializable

public interface Message
extends Serializable

Represents a message. The Message is comprised of the payload, (a value and its DataType) and getAttributes() associated with the content.

Since:

1.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	Message.Builder Handles the Message's MediaType as well as its attributes creation, either from a provided TypedValue or constructing it internally from a given value and MediaType.
static interface	Message.CollectionBuilder
static interface	Message.PayloadBuilder Handles the Message's payload creation, either from a provided TypedValue or constructing it internally from a given value and MediaType.

Method Summary

Modifier and Type	Method and Description
static Message.PayloadBuilder	builder() Provides a builder to create Message objects.
static Message.Builder	builder(Message message) Provides a builder to create Message objects based on an existing Message instance.
<T> TypedValue<T>	getAttributes() Gets the attributes associated with the Message.
<T> TypedValue<T>	getPayload() Gets a TypedValue with the payload of this message.
static Message	of(Object payload) Create a new instance with the given payload.

Method Detail

builder

static Message.PayloadBuilder builder()

Provides a builder to create Message objects.

Returns:

a new Message.Builder.

builder

static Message.Builder builder(Message message)

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

Parameters:

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

Returns:

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

getPayload

<T> TypedValue<T> getPayload()

Gets a TypedValue with the payload of this message.

Type Parameters:

T - the type of the payload.

Returns:

the message payload.

getAttributes

<T> TypedValue<T> getAttributes()

Gets the attributes associated with the Message. The Attributes attributes object is specific 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.

of

static Message of(Object payload)

Create a new instance with the given payload.

Parameters:

payload - the message payload

Returns:

new message instance