Package org.apache.camel.component.jms

Class JmsMessage

java.lang.Object

org.apache.camel.support.MessageSupport

org.apache.camel.support.DefaultMessage

org.apache.camel.component.jms.JmsMessage

All Implemented Interfaces:

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

public class JmsMessage
extends org.apache.camel.support.DefaultMessage

Represents a Message for working with JMS

Field Summary

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

camelContext, typeConverter

Constructor Summary

Constructors

Constructor	Description
JmsMessage(org.apache.camel.Exchange exchange, jakarta.jms.Message jmsMessage, jakarta.jms.Session jmsSession, JmsBinding binding)

Method Summary

Modifier and Type	Method	Description
void	copyFrom(org.apache.camel.Message that)
protected Object	createBody()
protected String	createMessageId()
protected void	ensureInitialHeaders()	Ensure that the headers have been populated from the underlying JMS message before we start mutating the headers
JmsBinding	getBinding()
Object	getHeader(String name)
Map<String,Object>	getHeaders()
jakarta.jms.Message	getJmsMessage()	Returns the underlying JMS message
jakarta.jms.Session	getJmsSession()	Returns the underlying JMS session.
void	init(org.apache.camel.Exchange exchange, jakarta.jms.Message jmsMessage, jakarta.jms.Session jmsSession, JmsBinding binding)
JmsMessage	newInstance()
protected void	populateInitialHeaders(Map<String,Object> map)
Object	removeHeader(String name)
void	reset()
void	setBinding(JmsBinding binding)
void	setBody(Object body)
void	setHeader(String name, Object value)
void	setHeaders(Map<String,Object> headers)
void	setJmsMessage(jakarta.jms.Message jmsMessage)
void	setJmsSession(jakarta.jms.Session jmsSession)
boolean	shouldCreateNewMessage()	Returns true if a new JMS message instance should be created to send to the next component
String	toString()

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

createHeaders, getHeader, getHeader, getHeader, getHeader, getHeader, hasHeaders, hasPopulatedHeaders, removeHeaders, removeHeaders

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

copy, copyFromWithNewBody, getBody, getBody, getBody, getCamelContext, getDataType, getExchange, getMandatoryBody, getMandatoryBody, getMessageId, getMessageTimestamp, getPayloadForTrait, hasDataType, hasMessageId, hasTrait, removeTrait, setBody, setBody, setCamelContext, setDataType, setExchange, setMessageId, setPayloadForTrait

Methods inherited from class java.lang.Object

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

Constructor Details

JmsMessage

public JmsMessage(org.apache.camel.Exchange exchange,
 jakarta.jms.Message jmsMessage,
 jakarta.jms.Session jmsSession,
 JmsBinding binding)

Method Details

init

public void init(org.apache.camel.Exchange exchange,
 jakarta.jms.Message jmsMessage,
 jakarta.jms.Session jmsSession,
 JmsBinding binding)

reset

public void reset()

Specified by:

reset in interface org.apache.camel.Message

Overrides:

reset in class org.apache.camel.support.DefaultMessage

toString

public String toString()

Overrides:

toString in class org.apache.camel.support.MessageSupport

copyFrom

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

Specified by:

copyFrom in interface org.apache.camel.Message

Overrides:

copyFrom in class org.apache.camel.support.MessageSupport

getBinding

public JmsBinding getBinding()

setBinding

public void setBinding(JmsBinding binding)

getJmsMessage

public jakarta.jms.Message getJmsMessage()

Returns the underlying JMS message

setJmsMessage

public void setJmsMessage(jakarta.jms.Message jmsMessage)

getJmsSession

public jakarta.jms.Session getJmsSession()

Returns the underlying JMS session.

This may be null if using JmsPollingConsumer, or the broker component from Apache ActiveMQ 5.11.x or older.

setJmsSession

public void setJmsSession(jakarta.jms.Session jmsSession)

setBody

public void setBody(Object body)

Specified by:

setBody in interface org.apache.camel.Message

Overrides:

setBody in class org.apache.camel.support.MessageSupport

getHeader

public Object getHeader(String name)

Specified by:

getHeader in interface org.apache.camel.Message

Overrides:

getHeader in class org.apache.camel.support.DefaultMessage

getHeaders

public Map<String,Object> getHeaders()

Specified by:

getHeaders in interface org.apache.camel.Message

Overrides:

getHeaders in class org.apache.camel.support.DefaultMessage

removeHeader

public Object removeHeader(String name)

Specified by:

removeHeader in interface org.apache.camel.Message

Overrides:

removeHeader in class org.apache.camel.support.DefaultMessage

setHeaders

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

Specified by:

setHeaders in interface org.apache.camel.Message

Overrides:

setHeaders in class org.apache.camel.support.DefaultMessage

setHeader

public void setHeader(String name,
 Object value)

Specified by:

setHeader in interface org.apache.camel.Message

Overrides:

setHeader in class org.apache.camel.support.DefaultMessage

newInstance

public JmsMessage newInstance()

Specified by:

newInstance in interface org.apache.camel.Message

Overrides:

newInstance in class org.apache.camel.support.DefaultMessage

shouldCreateNewMessage

public boolean shouldCreateNewMessage()

Returns true if a new JMS message instance should be created to send to the next component

ensureInitialHeaders

protected void ensureInitialHeaders()

Ensure that the headers have been populated from the underlying JMS message before we start mutating the headers

createBody

protected Object createBody()

Overrides:

createBody in class org.apache.camel.support.MessageSupport

populateInitialHeaders

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

Overrides:

populateInitialHeaders in class org.apache.camel.support.DefaultMessage

createMessageId

protected String createMessageId()

Overrides:

createMessageId in class org.apache.camel.support.MessageSupport