org.apache.camel.support

Class DefaultMessage

java.lang.Object

org.apache.camel.support.MessageSupport

org.apache.camel.support.DefaultMessage

All Implemented Interfaces:

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

public class DefaultMessage
extends MessageSupport

The default implementation of Message

This implementation uses a CaseInsensitiveMap storing the headers. This allows us to be able to lookup headers using case insensitive keys, making it easier for end users as they do not have to be worried about using exact keys. See more details at CaseInsensitiveMap. The implementation of the map can be configured by the HeadersMapFactory which can be set on the CamelContext. The default implementation uses the CaseInsensitiveMap.

Constructor Summary

Constructors

Constructor and Description
DefaultMessage(org.apache.camel.CamelContext camelContext)
DefaultMessage(org.apache.camel.Exchange exchange)

Method Summary

Modifier and Type	Method and Description
void	addAttachment(String id, DataHandler content)
void	addAttachmentObject(String id, org.apache.camel.Attachment content)
protected Map<String,org.apache.camel.Attachment>	createAttachments() A factory method to lazily create the attachmentObjects to make it easy to create efficient Message implementations which only construct and populate the Map on demand
protected Map<String,Object>	createHeaders() A factory method to lazily create the headers to make it easy to create efficient Message implementations which only construct and populate the Map on demand
DataHandler	getAttachment(String id)
Set<String>	getAttachmentNames()
org.apache.camel.Attachment	getAttachmentObject(String id)
Map<String,org.apache.camel.Attachment>	getAttachmentObjects()
Map<String,DataHandler>	getAttachments()
Object	getHeader(String name)
<T> T	getHeader(String name, Class<T> type)
Object	getHeader(String name, Object defaultValue)
<T> T	getHeader(String name, Object defaultValue, Class<T> type)
Object	getHeader(String name, Supplier<Object> defaultValueSupplier)
<T> T	getHeader(String name, Supplier<Object> defaultValueSupplier, Class<T> type)
Map<String,Object>	getHeaders()
boolean	hasAttachments()
boolean	hasHeaders()
protected boolean	hasPopulatedHeaders() Returns true if the headers have been mutated in some way
boolean	isFault()
protected Boolean	isTransactedRedelivered() A strategy for component specific messages to determine whether the message is redelivered or not.
DefaultMessage	newInstance() Returns a new instance
protected void	populateInitialAttachments(Map<String,org.apache.camel.Attachment> map) A strategy method populate the initial set of attachmentObjects on an inbound message from an underlying binding
protected void	populateInitialHeaders(Map<String,Object> map) A strategy method populate the initial set of headers on an inbound message from an underlying binding
void	removeAttachment(String id)
Object	removeHeader(String name)
boolean	removeHeaders(String pattern)
boolean	removeHeaders(String pattern, String... excludePatterns)
void	setAttachmentObjects(Map<String,org.apache.camel.Attachment> attachments)
void	setAttachments(Map<String,DataHandler> attachments)
void	setFault(boolean fault)
void	setHeader(String name, Object value)
void	setHeaders(Map<String,Object> headers)

Methods inherited from class org.apache.camel.support.MessageSupport

copy, copyAttachments, copyFrom, copyFromWithNewBody, createBody, createMessageId, getBody, getBody, getBody, getCamelContext, getDataType, getExchange, getMandatoryBody, getMandatoryBody, getMessageId, hasDataType, setBody, setBody, setBody, setCamelContext, setDataType, setExchange, setMessageId, 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.CamelContextAware

trySetCamelContext

Constructor Detail

DefaultMessage

public DefaultMessage(org.apache.camel.Exchange exchange)

DefaultMessage

public DefaultMessage(org.apache.camel.CamelContext camelContext)

Method Detail

isFault

public boolean isFault()

setFault

public void setFault(boolean fault)

getHeader

public Object getHeader(String name)

getHeader

public Object getHeader(String name,
                        Object defaultValue)

getHeader

public Object getHeader(String name,
                        Supplier<Object> defaultValueSupplier)

getHeader

public <T> T getHeader(String name,
                       Class<T> type)

getHeader

public <T> T getHeader(String name,
                       Object defaultValue,
                       Class<T> type)

getHeader

public <T> T getHeader(String name,
                       Supplier<Object> defaultValueSupplier,
                       Class<T> type)

setHeader

public void setHeader(String name,
                      Object value)

removeHeader

public Object removeHeader(String name)

removeHeaders

public boolean removeHeaders(String pattern)

removeHeaders

public boolean removeHeaders(String pattern,
                             String... excludePatterns)

getHeaders

public Map<String,Object> getHeaders()

setHeaders

public void setHeaders(Map<String,Object> headers)

hasHeaders

public boolean hasHeaders()

newInstance

public DefaultMessage newInstance()

Description copied from class: MessageSupport

Returns a new instance

Specified by:

newInstance in class MessageSupport

createHeaders

protected Map<String,Object> createHeaders()

A factory method to lazily create the headers to make it easy to create efficient Message implementations which only construct and populate the Map on demand

Returns:

return a newly constructed Map possibly containing headers from the underlying inbound transport

createAttachments

protected Map<String,org.apache.camel.Attachment> createAttachments()

A factory method to lazily create the attachmentObjects to make it easy to create efficient Message implementations which only construct and populate the Map on demand

Returns:

return a newly constructed Map

populateInitialHeaders

protected void populateInitialHeaders(Map<String,Object> map)

A strategy method populate the initial set of headers on an inbound message from an underlying binding

Parameters:

map - is the empty header map to populate

populateInitialAttachments

protected void populateInitialAttachments(Map<String,org.apache.camel.Attachment> map)

A strategy method populate the initial set of attachmentObjects on an inbound message from an underlying binding

Parameters:

map - is the empty attachment map to populate

isTransactedRedelivered

protected Boolean isTransactedRedelivered()

A strategy for component specific messages to determine whether the message is redelivered or not.

Important: It is not always possible to determine if the transacted is a redelivery or not, and therefore null is returned. Such an example would be a JDBC message. However JMS brokers provides details if a transacted message is redelivered.

Returns:

true if redelivered, false if not, null if not able to determine

addAttachment

public void addAttachment(String id,
                          DataHandler content)

addAttachmentObject

public void addAttachmentObject(String id,
                                org.apache.camel.Attachment content)

getAttachment

public DataHandler getAttachment(String id)

getAttachmentObject

public org.apache.camel.Attachment getAttachmentObject(String id)

getAttachmentNames

public Set<String> getAttachmentNames()

removeAttachment

public void removeAttachment(String id)

getAttachments

public Map<String,DataHandler> getAttachments()

getAttachmentObjects

public Map<String,org.apache.camel.Attachment> getAttachmentObjects()

setAttachments

public void setAttachments(Map<String,DataHandler> attachments)

setAttachmentObjects

public void setAttachmentObjects(Map<String,org.apache.camel.Attachment> attachments)

hasAttachments

public boolean hasAttachments()

hasPopulatedHeaders

protected boolean hasPopulatedHeaders()

Returns true if the headers have been mutated in some way