Package org.apache.camel.support

Class MessageSupport

java.lang.Object

org.apache.camel.support.MessageSupport

All Implemented Interfaces:

org.apache.camel.CamelContextAware, org.apache.camel.Message, org.apache.camel.spi.DataTypeAware

Direct Known Subclasses:

DefaultMessage

public abstract class MessageSupport
extends Object
implements org.apache.camel.Message, org.apache.camel.CamelContextAware, org.apache.camel.spi.DataTypeAware

A base class for implementation inheritance providing the core Message body handling features but letting the derived class deal with headers. Unless a specific provider wishes to do something particularly clever with headers you probably want to just derive from DefaultMessage

Constructor Summary

Constructors

Constructor	Description
MessageSupport()

Method Summary

Modifier and Type	Method	Description
org.apache.camel.Message	copy()
void	copyFrom(org.apache.camel.Message that)
void	copyFromWithNewBody(org.apache.camel.Message that, Object newBody)
protected Object	createBody()	A factory method to allow a provider to lazily create the message body for inbound messages from other sources
protected String	createMessageId()	Allow implementations to auto-create a messageId
Object	getBody()
<T> T	getBody(Class<T> type)
protected <T> T	getBody(Class<T> type, Object body)
org.apache.camel.CamelContext	getCamelContext()
org.apache.camel.spi.DataType	getDataType()
org.apache.camel.Exchange	getExchange()
Object	getMandatoryBody()
<T> T	getMandatoryBody(Class<T> type)
String	getMessageId()
long	getMessageTimestamp()
boolean	hasDataType()
boolean	hasMessageId()
abstract org.apache.camel.Message	newInstance()	Returns a new instance
void	reset()
void	setBody(Object body)
<T> void	setBody(Object value, Class<T> type)
void	setBody(Object body, org.apache.camel.spi.DataType type)
void	setCamelContext(org.apache.camel.CamelContext camelContext)
void	setDataType(org.apache.camel.spi.DataType type)
void	setExchange(org.apache.camel.Exchange exchange)
void	setMessageId(String messageId)
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.camel.Message

getHeader, getHeader, getHeader, getHeader, getHeader, getHeader, getHeaders, hasHeaders, removeHeader, removeHeaders, removeHeaders, setHeader, setHeaders

Constructor Detail

MessageSupport

public MessageSupport()

Method Detail

reset

public void reset()

Specified by:

reset in interface org.apache.camel.Message

toString

public String toString()

Overrides:

toString in class Object

getBody

public Object getBody()

Specified by:

getBody in interface org.apache.camel.Message

getBody

public <T> T getBody(Class<T> type)

Specified by:

getBody in interface org.apache.camel.Message

getMandatoryBody

public Object getMandatoryBody()
                        throws org.apache.camel.InvalidPayloadException

Specified by:

getMandatoryBody in interface org.apache.camel.Message

Throws:

org.apache.camel.InvalidPayloadException

getBody

protected <T> T getBody(Class<T> type,
                        Object body)

getMandatoryBody

public <T> T getMandatoryBody(Class<T> type)
                       throws org.apache.camel.InvalidPayloadException

Specified by:

getMandatoryBody in interface org.apache.camel.Message

Throws:

org.apache.camel.InvalidPayloadException

setBody

public void setBody(Object body)

Specified by:

setBody in interface org.apache.camel.Message

setBody

public <T> void setBody(Object value,
                        Class<T> type)

Specified by:

setBody in interface org.apache.camel.Message

setBody

public void setBody(Object body,
                    org.apache.camel.spi.DataType type)

Specified by:

setBody in interface org.apache.camel.spi.DataTypeAware

getDataType

public org.apache.camel.spi.DataType getDataType()

Specified by:

getDataType in interface org.apache.camel.spi.DataTypeAware

setDataType

public void setDataType(org.apache.camel.spi.DataType type)

Specified by:

setDataType in interface org.apache.camel.spi.DataTypeAware

hasDataType

public boolean hasDataType()

Specified by:

hasDataType in interface org.apache.camel.spi.DataTypeAware

copy

public org.apache.camel.Message copy()

Specified by:

copy in interface org.apache.camel.Message

copyFrom

public void copyFrom(org.apache.camel.Message that)

Specified by:

copyFrom in interface org.apache.camel.Message

copyFromWithNewBody

public void copyFromWithNewBody(org.apache.camel.Message that,
                                Object newBody)

Specified by:

copyFromWithNewBody in interface org.apache.camel.Message

getExchange

public org.apache.camel.Exchange getExchange()

Specified by:

getExchange in interface org.apache.camel.Message

setExchange

public void setExchange(org.apache.camel.Exchange exchange)

getCamelContext

public org.apache.camel.CamelContext getCamelContext()

Specified by:

getCamelContext in interface org.apache.camel.CamelContextAware

setCamelContext

public void setCamelContext(org.apache.camel.CamelContext camelContext)

Specified by:

setCamelContext in interface org.apache.camel.CamelContextAware

newInstance

public abstract org.apache.camel.Message newInstance()

Returns a new instance

createBody

protected Object createBody()

A factory method to allow a provider to lazily create the message body for inbound messages from other sources

Returns:

the value of the message body or null if there is no value available

getMessageId

public String getMessageId()

Specified by:

getMessageId in interface org.apache.camel.Message

getMessageTimestamp

public long getMessageTimestamp()

Specified by:

getMessageTimestamp in interface org.apache.camel.Message

setMessageId

public void setMessageId(String messageId)

Specified by:

setMessageId in interface org.apache.camel.Message

hasMessageId

public boolean hasMessageId()

Specified by:

hasMessageId in interface org.apache.camel.Message

createMessageId

protected String createMessageId()

Allow implementations to auto-create a messageId