MessageSupport (Camel :: Core 2.22.2 API)

java.lang.Object
- org.apache.camel.impl.MessageSupport

All Implemented Interfaces:

CamelContextAware, Message, DataTypeAware

Direct Known Subclasses:

DefaultMessage
```
public abstract class MessageSupport
extends Object
implements Message, CamelContextAware, 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

Version:

Constructor Summary

Constructors
Constructor and Description

MessageSupport()

Constructors
Constructor and Description
`MessageSupport()`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`Message`	`copy()` Creates a copy of this message so that it can be used and possibly modified further in another exchange
`void`	`copyAttachments(Message that)` Copies the attachments of the other message into this message
`void`	`copyFrom(Message that)` Copies the contents of the other message into this message If you need to do a copy and then set a new body, then use `Message.copyFromWithNewBody(Message, Object)` method instead.
`void`	`copyFromWithNewBody(Message that, Object newBody)` Copies the contents (except the body) of the other message into this message and uses the provided new body instead
`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()` Returns the body of the message as a POJO The body can be `null` if no body is set.
`<T> T`	`getBody(Class<T> type)` Returns the body as the specified type Notice if the message body is stream based then calling this method multiple times may lead to the stream not being able to be re-read again.
`protected <T> T`	`getBody(Class<T> type, Object body)`
`CamelContext`	`getCamelContext()` Get the `CamelContext`
`DataType`	`getDataType()` Get the data type of the message.
`Exchange`	`getExchange()` Returns the exchange this message is related to
`Object`	`getMandatoryBody()` Returns the body of the message as a POJO Notice if the message body is stream based then calling this method multiple times may lead to the stream not being able to be re-read again.
`<T> T`	`getMandatoryBody(Class<T> type)` Returns the mandatory body as the specified type Notice if the message body is stream based then calling this method multiple times may lead to the stream not being able to be re-read again.
`String`	`getMessageId()` Returns the id of the message
`boolean`	`hasDataType()` Whether any data type has been configured
`abstract Message`	`newInstance()` Returns a new instance
`void`	`setBody(Object body)` Sets the body of the message
`<T> void`	`setBody(Object value, Class<T> type)` Sets the body of the message as a specific type
`void`	`setBody(Object body, DataType type)` Set the message body with data type.
`void`	`setCamelContext(CamelContext camelContext)` Injects the `CamelContext`
`void`	`setDataType(DataType type)` Set the data type of the message.
`void`	`setExchange(Exchange exchange)`
`void`	`setMessageId(String messageId)` Sets the id of the message
`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
addAttachment, addAttachmentObject, createExchangeId, getAttachment, getAttachmentNames, getAttachmentObject, getAttachmentObjects, getAttachments, getHeader, getHeader, getHeader, getHeader, getHeader, getHeader, getHeaders, hasAttachments, hasHeaders, isFault, removeAttachment, removeHeader, removeHeaders, removeHeaders, setAttachmentObjects, setAttachments, setFault, setHeader, setHeaders

- Constructor Detail
  - MessageSupport
```
public MessageSupport()
```
- Method Detail
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getBody
```
public Object getBody()
```
    Description copied from interface: Message
    
    Returns the body of the message as a POJO
    The body can be null if no body is set.
    Notice if the message body is stream based then calling this method multiple times may lead to the stream not being able to be re-read again. You can enable stream caching and call the StreamCache.reset() method to reset the stream to be able to re-read again (if possible). See more details about stream caching.
    
    Specified by:
    
    getBody in interface Message
    
    Returns:
    
    the body, can be null
  - getBody
```
public <T> T getBody(Class<T> type)
```
    Description copied from interface: Message
    
    Returns the body as the specified type
    Notice if the message body is stream based then calling this method multiple times may lead to the stream not being able to be re-read again. You can enable stream caching and call the StreamCache.reset() method to reset the stream to be able to re-read again (if possible). See more details about stream caching.
    
    Specified by:
    
    getBody in interface Message
    
    Parameters:
    
    type - the type that the body
    
    Returns:
    
    the body of the message as the specified type, or null if no body exists
  - getMandatoryBody
```
public Object getMandatoryBody()
                        throws InvalidPayloadException
```
    Description copied from interface: Message
    
    Returns the body of the message as a POJO
    Notice if the message body is stream based then calling this method multiple times may lead to the stream not being able to be re-read again. See more details about stream caching.
    
    Specified by:
    
    getMandatoryBody in interface Message
    
    Returns:
    
    the body, is never null
    
    Throws:
    
    InvalidPayloadException - Is thrown if the body being null or wrong class type
  - getBody
```
protected <T> T getBody(Class<T> type,
                        Object body)
```
  - getMandatoryBody
```
public <T> T getMandatoryBody(Class<T> type)
                       throws InvalidPayloadException
```
    Description copied from interface: Message
    
    Returns the mandatory body as the specified type
    Notice if the message body is stream based then calling this method multiple times may lead to the stream not being able to be re-read again. You can enable stream caching and call the StreamCache.reset() method to reset the stream to be able to re-read again (if possible). See more details about stream caching.
    
    Specified by:
    
    getMandatoryBody in interface Message
    
    Parameters:
    
    type - the type that the body
    
    Returns:
    
    the body of the message as the specified type, is never null.
    
    Throws:
    
    InvalidPayloadException - Is thrown if the body being null or wrong class type
  - setBody
```
public void setBody(Object body)
```
    Description copied from interface: Message
    
    Sets the body of the message
    
    Specified by:
    
    setBody in interface Message
    
    Parameters:
    
    body - the body
  - setBody
```
public <T> void setBody(Object value,
                        Class<T> type)
```
    Description copied from interface: Message
    
    Sets the body of the message as a specific type
    
    Specified by:
    
    setBody in interface Message
    
    Parameters:
    
    value - the body
    
    type - the type of the body
  - setBody
```
public void setBody(Object body,
                    DataType type)
```
    Description copied from interface: DataTypeAware
    
    Set the message body with data type.
    
    Specified by:
    
    setBody in interface DataTypeAware
    
    Parameters:
    
    body - message body
    
    type - data type
  - getDataType
```
public DataType getDataType()
```
    Description copied from interface: DataTypeAware
    
    Get the data type of the message.
    
    Specified by:
    
    getDataType in interface DataTypeAware
    
    Returns:
    
    data type
  - setDataType
```
public void setDataType(DataType type)
```
    Description copied from interface: DataTypeAware
    
    Set the data type of the message.
    
    Specified by:
    
    setDataType in interface DataTypeAware
    
    Parameters:
    
    type - data type
  - hasDataType
```
public boolean hasDataType()
```
    Description copied from interface: DataTypeAware
    
    Whether any data type has been configured
    
    Specified by:
    
    hasDataType in interface DataTypeAware
  - copy
```
public Message copy()
```
    Description copied from interface: Message
    
    Creates a copy of this message so that it can be used and possibly modified further in another exchange
    
    Specified by:
    
    copy in interface Message
    
    Returns:
    
    a new message instance copied from this message
  - copyFrom
```
public void copyFrom(Message that)
```
    Description copied from interface: Message
    
    Copies the contents of the other message into this message
    If you need to do a copy and then set a new body, then use Message.copyFromWithNewBody(Message, Object) method instead.
    
    Specified by:
    
    copyFrom in interface Message
    
    Parameters:
    
    that - the other message
    
    See Also:
    
    Message.copyFromWithNewBody(Message, Object)
  - copyFromWithNewBody
```
public void copyFromWithNewBody(Message that,
                                Object newBody)
```
    Description copied from interface: Message
    
    Copies the contents (except the body) of the other message into this message and uses the provided new body instead
    
    Specified by:
    
    copyFromWithNewBody in interface Message
    
    Parameters:
    
    that - the other message
    
    newBody - the new body to use
  - getExchange
```
public Exchange getExchange()
```
    Description copied from interface: Message
    
    Returns the exchange this message is related to
    
    Specified by:
    
    getExchange in interface Message
    
    Returns:
    
    the exchange
  - setExchange
```
public void setExchange(Exchange exchange)
```
  - getCamelContext
```
public CamelContext getCamelContext()
```
    Description copied from interface: CamelContextAware
    
    Get the CamelContext
    
    Specified by:
    
    getCamelContext in interface CamelContextAware
    
    Returns:
    
    camelContext the Camel context
  - setCamelContext
```
public void setCamelContext(CamelContext camelContext)
```
    Description copied from interface: CamelContextAware
    
    Injects the CamelContext
    
    Specified by:
    
    setCamelContext in interface CamelContextAware
    
    Parameters:
    
    camelContext - the Camel context
  - copyAttachments
```
public void copyAttachments(Message that)
```
    Description copied from interface: Message
    
    Copies the attachments of the other message into this message
    
    Specified by:
    
    copyAttachments in interface Message
    
    Parameters:
    
    that - the other message
  - newInstance
```
public abstract 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()
```
    Description copied from interface: Message
    
    Returns the id of the message
    
    Specified by:
    
    getMessageId in interface Message
    
    Returns:
    
    the message id
  - setMessageId
```
public void setMessageId(String messageId)
```
    Description copied from interface: Message
    
    Sets the id of the message
    
    Specified by:
    
    setMessageId in interface Message
    
    Parameters:
    
    messageId - id of the message
  - createMessageId
```
protected String createMessageId()
```
    Allow implementations to auto-create a messageId

Class MessageSupport

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface org.apache.camel.Message

Constructor Detail

MessageSupport

Method Detail

toString

getBody

getBody

getMandatoryBody

getBody

getMandatoryBody

setBody

setBody

setBody

getDataType

setDataType

hasDataType

copy

copyFrom

copyFromWithNewBody

getExchange

setExchange

getCamelContext

setCamelContext

copyAttachments

newInstance

createBody

getMessageId

setMessageId

createMessageId