Package org.apache.qpid.jms.message

Class JmsMessage

java.lang.Object

org.apache.qpid.jms.message.JmsMessage

All Implemented Interfaces:

jakarta.jms.Message

Direct Known Subclasses:

JmsBytesMessage, JmsMapMessage, JmsObjectMessage, JmsStreamMessage, JmsTextMessage

public class JmsMessage
extends java.lang.Object
implements jakarta.jms.Message

Field Summary

Fields

Modifier and Type	Field	Description
protected JmsAcknowledgeCallback	acknowledgeCallback
protected JmsConnection	connection
protected JmsMessageFacade	facade
protected boolean	readOnly
protected boolean	readOnlyBody
protected boolean	readOnlyProperties
protected boolean	validatePropertyNames

Fields inherited from interface jakarta.jms.Message

DEFAULT_DELIVERY_DELAY, DEFAULT_DELIVERY_MODE, DEFAULT_PRIORITY, DEFAULT_TIME_TO_LIVE

Constructor Summary

Constructors

Constructor	Description
JmsMessage(JmsMessageFacade facade)

Method Summary

Modifier and Type	Method	Description
void	acknowledge()
protected void	checkReadOnly()
protected void	checkReadOnlyBody()
protected void	checkReadOnlyProperties()
protected void	checkWriteOnlyBody()
void	clearBody()
void	clearProperties()
JmsMessage	copy()
protected void	copy(JmsMessage other)
protected <T> T	doGetBody(java.lang.Class<T> asType)
boolean	equals(java.lang.Object o)
JmsAcknowledgeCallback	getAcknowledgeCallback()
java.util.Enumeration<?>	getAllPropertyNames()	return all property names, including standard JMS properties and JMSX properties
<T> T	getBody(java.lang.Class<T> asType)
boolean	getBooleanProperty(java.lang.String name)
byte	getByteProperty(java.lang.String name)
JmsConnection	getConnection()
double	getDoubleProperty(java.lang.String name)
JmsMessageFacade	getFacade()
float	getFloatProperty(java.lang.String name)
int	getIntProperty(java.lang.String name)
java.lang.String	getJMSCorrelationID()
byte[]	getJMSCorrelationIDAsBytes()
int	getJMSDeliveryMode()
long	getJMSDeliveryTime()
jakarta.jms.Destination	getJMSDestination()
long	getJMSExpiration()
java.lang.String	getJMSMessageID()
int	getJMSPriority()
boolean	getJMSRedelivered()
jakarta.jms.Destination	getJMSReplyTo()
long	getJMSTimestamp()
java.lang.String	getJMSType()
long	getLongProperty(java.lang.String name)
java.lang.Object	getObjectProperty(java.lang.String name)
java.util.Enumeration<?>	getPropertyNames()
short	getShortProperty(java.lang.String name)
java.lang.String	getStringProperty(java.lang.String name)
int	hashCode()
boolean	isBodyAssignableTo(java.lang.Class target)
boolean	isExpired()
boolean	isReadOnly()
boolean	isReadOnlyBody()
boolean	isReadOnlyProperties()
boolean	isValidatePropertyNames()
void	onDispatch()	Used to trigger processing required before dispatch of a message to its intended consumer.
void	onSend(long producerTtl)	Used to trigger processing required to place the message in a state where it is ready to be written to the wire.
void	onSendComplete()	Used to trigger processing required to place the message into a writable state once again following completion of the send operation.
boolean	propertyExists(java.lang.String name)
void	setAcknowledgeCallback(JmsAcknowledgeCallback jmsAcknowledgeCallback)
void	setBooleanProperty(java.lang.String name, boolean value)
void	setByteProperty(java.lang.String name, byte value)
void	setConnection(JmsConnection connection)
void	setDoubleProperty(java.lang.String name, double value)
void	setFloatProperty(java.lang.String name, float value)
void	setIntProperty(java.lang.String name, int value)
void	setJMSCorrelationID(java.lang.String correlationId)
void	setJMSCorrelationIDAsBytes(byte[] correlationId)
void	setJMSDeliveryMode(int mode)
void	setJMSDeliveryTime(long deliveryTime)
void	setJMSDestination(jakarta.jms.Destination destination)
void	setJMSExpiration(long expiration)
void	setJMSMessageID(java.lang.String value)
void	setJMSPriority(int priority)
void	setJMSRedelivered(boolean redelivered)
void	setJMSReplyTo(jakarta.jms.Destination destination)
void	setJMSTimestamp(long timestamp)
void	setJMSType(java.lang.String type)
void	setLongProperty(java.lang.String name, long value)
void	setObjectProperty(java.lang.String name, java.lang.Object value)
void	setReadOnly(boolean readOnly)
void	setReadOnlyBody(boolean readOnlyBody)
void	setReadOnlyProperties(boolean readOnlyProperties)
void	setShortProperty(java.lang.String name, short value)
void	setStringProperty(java.lang.String name, java.lang.String value)
void	setValidatePropertyNames(boolean validatePropertyNames)
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

acknowledgeCallback

protected transient JmsAcknowledgeCallback acknowledgeCallback

connection

protected transient JmsConnection connection

facade

protected final JmsMessageFacade facade

readOnly

protected boolean readOnly

readOnlyBody

protected boolean readOnlyBody

readOnlyProperties

protected boolean readOnlyProperties

validatePropertyNames

protected boolean validatePropertyNames

Constructor Detail

JmsMessage

public JmsMessage(JmsMessageFacade facade)

Method Detail

copy

public JmsMessage copy()
                throws jakarta.jms.JMSException

Throws:

jakarta.jms.JMSException

copy

protected void copy(JmsMessage other)

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

acknowledge

public void acknowledge()
                 throws jakarta.jms.JMSException

Specified by:

acknowledge in interface jakarta.jms.Message

Throws:

jakarta.jms.JMSException

isBodyAssignableTo

public boolean isBodyAssignableTo(java.lang.Class target)
                           throws jakarta.jms.JMSException

Specified by:

isBodyAssignableTo in interface jakarta.jms.Message

Throws:

jakarta.jms.JMSException

getBody

public final <T> T getBody(java.lang.Class<T> asType)
                    throws jakarta.jms.JMSException

Specified by:

getBody in interface jakarta.jms.Message

Throws:

jakarta.jms.JMSException

doGetBody

protected <T> T doGetBody(java.lang.Class<T> asType)
                   throws jakarta.jms.JMSException

Throws:

jakarta.jms.JMSException

clearBody

public void clearBody()
               throws jakarta.jms.JMSException

Specified by:

clearBody in interface jakarta.jms.Message

Throws:

jakarta.jms.JMSException

isValidatePropertyNames

public boolean isValidatePropertyNames()

setValidatePropertyNames

public void setValidatePropertyNames(boolean validatePropertyNames)

isReadOnly

public boolean isReadOnly()

setReadOnly

public void setReadOnly(boolean readOnly)

isReadOnlyBody

public boolean isReadOnlyBody()

setReadOnlyBody

public void setReadOnlyBody(boolean readOnlyBody)

isReadOnlyProperties

public boolean isReadOnlyProperties()

setReadOnlyProperties

public void setReadOnlyProperties(boolean readOnlyProperties)

getJMSMessageID

public java.lang.String getJMSMessageID()
                                 throws jakarta.jms.JMSException

Specified by:

getJMSMessageID in interface jakarta.jms.Message

Throws:

jakarta.jms.JMSException

setJMSMessageID

public void setJMSMessageID(java.lang.String value)
                     throws jakarta.jms.JMSException

Specified by:

setJMSMessageID in interface jakarta.jms.Message

Throws:

jakarta.jms.JMSException

getJMSTimestamp

public long getJMSTimestamp()
                     throws jakarta.jms.JMSException

Specified by:

getJMSTimestamp in interface jakarta.jms.Message

Throws:

jakarta.jms.JMSException

setJMSTimestamp

public void setJMSTimestamp(long timestamp)
                     throws jakarta.jms.JMSException

Specified by:

setJMSTimestamp in interface jakarta.jms.Message

Throws:

jakarta.jms.JMSException

getJMSCorrelationID

public java.lang.String getJMSCorrelationID()
                                     throws jakarta.jms.JMSException

Specified by:

getJMSCorrelationID in interface jakarta.jms.Message

Throws:

jakarta.jms.JMSException

setJMSCorrelationID

public void setJMSCorrelationID(java.lang.String correlationId)
                         throws jakarta.jms.JMSException

Specified by:

setJMSCorrelationID in interface jakarta.jms.Message

Throws:

jakarta.jms.JMSException

getJMSCorrelationIDAsBytes

public byte[] getJMSCorrelationIDAsBytes()
                                  throws jakarta.jms.JMSException

Specified by:

getJMSCorrelationIDAsBytes in interface jakarta.jms.Message

Throws:

jakarta.jms.JMSException

setJMSCorrelationIDAsBytes

public void setJMSCorrelationIDAsBytes(byte[] correlationId)
                                throws jakarta.jms.JMSException

Specified by:

setJMSCorrelationIDAsBytes in interface jakarta.jms.Message

Throws:

jakarta.jms.JMSException

getJMSReplyTo

public jakarta.jms.Destination getJMSReplyTo()
                                      throws jakarta.jms.JMSException

Specified by:

getJMSReplyTo in interface jakarta.jms.Message

Throws:

jakarta.jms.JMSException

setJMSReplyTo

public void setJMSReplyTo(jakarta.jms.Destination destination)
                   throws jakarta.jms.JMSException

Specified by:

setJMSReplyTo in interface jakarta.jms.Message

Throws:

jakarta.jms.JMSException

getJMSDestination

public jakarta.jms.Destination getJMSDestination()
                                          throws jakarta.jms.JMSException

Specified by:

getJMSDestination in interface jakarta.jms.Message

Throws:

jakarta.jms.JMSException

setJMSDestination

public void setJMSDestination(jakarta.jms.Destination destination)
                       throws jakarta.jms.JMSException

Specified by:

setJMSDestination in interface jakarta.jms.Message

Throws:

jakarta.jms.JMSException

getJMSDeliveryMode

public int getJMSDeliveryMode()
                       throws jakarta.jms.JMSException

Specified by:

getJMSDeliveryMode in interface jakarta.jms.Message

Throws:

jakarta.jms.JMSException

setJMSDeliveryMode

public void setJMSDeliveryMode(int mode)
                        throws jakarta.jms.JMSException

Specified by:

setJMSDeliveryMode in interface jakarta.jms.Message

Throws:

jakarta.jms.JMSException

getJMSRedelivered

public boolean getJMSRedelivered()
                          throws jakarta.jms.JMSException

Specified by:

getJMSRedelivered in interface jakarta.jms.Message

Throws:

jakarta.jms.JMSException

setJMSRedelivered

public void setJMSRedelivered(boolean redelivered)
                       throws jakarta.jms.JMSException

Specified by:

setJMSRedelivered in interface jakarta.jms.Message

Throws:

jakarta.jms.JMSException

getJMSType

public java.lang.String getJMSType()
                            throws jakarta.jms.JMSException

Specified by:

getJMSType in interface jakarta.jms.Message

Throws:

jakarta.jms.JMSException

setJMSType

public void setJMSType(java.lang.String type)
                throws jakarta.jms.JMSException

Specified by:

setJMSType in interface jakarta.jms.Message

Throws:

jakarta.jms.JMSException

getJMSExpiration

public long getJMSExpiration()
                      throws jakarta.jms.JMSException

Specified by:

getJMSExpiration in interface jakarta.jms.Message

Throws:

jakarta.jms.JMSException

setJMSExpiration

public void setJMSExpiration(long expiration)
                      throws jakarta.jms.JMSException

Specified by:

setJMSExpiration in interface jakarta.jms.Message

Throws:

jakarta.jms.JMSException

getJMSPriority

public int getJMSPriority()
                   throws jakarta.jms.JMSException

Specified by:

getJMSPriority in interface jakarta.jms.Message

Throws:

jakarta.jms.JMSException

setJMSPriority

public void setJMSPriority(int priority)
                    throws jakarta.jms.JMSException

Specified by:

setJMSPriority in interface jakarta.jms.Message

Throws:

jakarta.jms.JMSException

getJMSDeliveryTime

public long getJMSDeliveryTime()
                        throws jakarta.jms.JMSException

Specified by:

getJMSDeliveryTime in interface jakarta.jms.Message

Throws:

jakarta.jms.JMSException

setJMSDeliveryTime

public void setJMSDeliveryTime(long deliveryTime)
                        throws jakarta.jms.JMSException

Specified by:

setJMSDeliveryTime in interface jakarta.jms.Message

Throws:

jakarta.jms.JMSException

clearProperties

public void clearProperties()
                     throws jakarta.jms.JMSException

Specified by:

clearProperties in interface jakarta.jms.Message

Throws:

jakarta.jms.JMSException

propertyExists

public boolean propertyExists(java.lang.String name)
                       throws jakarta.jms.JMSException

Specified by:

propertyExists in interface jakarta.jms.Message

Throws:

jakarta.jms.JMSException

getPropertyNames

public java.util.Enumeration<?> getPropertyNames()
                                          throws jakarta.jms.JMSException

Specified by:

getPropertyNames in interface jakarta.jms.Message

Throws:

jakarta.jms.JMSException

getAllPropertyNames

public java.util.Enumeration<?> getAllPropertyNames()
                                             throws jakarta.jms.JMSException

return all property names, including standard JMS properties and JMSX properties

Returns:

Enumeration of all property names on this message

Throws:

jakarta.jms.JMSException - if an error occurs while reading the properties from the Message.

setObjectProperty

public void setObjectProperty(java.lang.String name,
                              java.lang.Object value)
                       throws jakarta.jms.JMSException

Specified by:

setObjectProperty in interface jakarta.jms.Message

Throws:

jakarta.jms.JMSException

getObjectProperty

public java.lang.Object getObjectProperty(java.lang.String name)
                                   throws jakarta.jms.JMSException

Specified by:

getObjectProperty in interface jakarta.jms.Message

Throws:

jakarta.jms.JMSException

getBooleanProperty

public boolean getBooleanProperty(java.lang.String name)
                           throws jakarta.jms.JMSException

Specified by:

getBooleanProperty in interface jakarta.jms.Message

Throws:

jakarta.jms.JMSException

getByteProperty

public byte getByteProperty(java.lang.String name)
                     throws jakarta.jms.JMSException

Specified by:

getByteProperty in interface jakarta.jms.Message

Throws:

jakarta.jms.JMSException

getShortProperty

public short getShortProperty(java.lang.String name)
                       throws jakarta.jms.JMSException

Specified by:

getShortProperty in interface jakarta.jms.Message

Throws:

jakarta.jms.JMSException

getIntProperty

public int getIntProperty(java.lang.String name)
                   throws jakarta.jms.JMSException

Specified by:

getIntProperty in interface jakarta.jms.Message

Throws:

jakarta.jms.JMSException

getLongProperty

public long getLongProperty(java.lang.String name)
                     throws jakarta.jms.JMSException

Specified by:

getLongProperty in interface jakarta.jms.Message

Throws:

jakarta.jms.JMSException

getFloatProperty

public float getFloatProperty(java.lang.String name)
                       throws jakarta.jms.JMSException

Specified by:

getFloatProperty in interface jakarta.jms.Message

Throws:

jakarta.jms.JMSException

getDoubleProperty

public double getDoubleProperty(java.lang.String name)
                         throws jakarta.jms.JMSException

Specified by:

getDoubleProperty in interface jakarta.jms.Message

Throws:

jakarta.jms.JMSException

getStringProperty

public java.lang.String getStringProperty(java.lang.String name)
                                   throws jakarta.jms.JMSException

Specified by:

getStringProperty in interface jakarta.jms.Message

Throws:

jakarta.jms.JMSException

setBooleanProperty

public void setBooleanProperty(java.lang.String name,
                               boolean value)
                        throws jakarta.jms.JMSException

Specified by:

setBooleanProperty in interface jakarta.jms.Message

Throws:

jakarta.jms.JMSException

setByteProperty

public void setByteProperty(java.lang.String name,
                            byte value)
                     throws jakarta.jms.JMSException

Specified by:

setByteProperty in interface jakarta.jms.Message

Throws:

jakarta.jms.JMSException

setShortProperty

public void setShortProperty(java.lang.String name,
                             short value)
                      throws jakarta.jms.JMSException

Specified by:

setShortProperty in interface jakarta.jms.Message

Throws:

jakarta.jms.JMSException

setIntProperty

public void setIntProperty(java.lang.String name,
                           int value)
                    throws jakarta.jms.JMSException

Specified by:

setIntProperty in interface jakarta.jms.Message

Throws:

jakarta.jms.JMSException

setLongProperty

public void setLongProperty(java.lang.String name,
                            long value)
                     throws jakarta.jms.JMSException

Specified by:

setLongProperty in interface jakarta.jms.Message

Throws:

jakarta.jms.JMSException

setFloatProperty

public void setFloatProperty(java.lang.String name,
                             float value)
                      throws jakarta.jms.JMSException

Specified by:

setFloatProperty in interface jakarta.jms.Message

Throws:

jakarta.jms.JMSException

setDoubleProperty

public void setDoubleProperty(java.lang.String name,
                              double value)
                       throws jakarta.jms.JMSException

Specified by:

setDoubleProperty in interface jakarta.jms.Message

Throws:

jakarta.jms.JMSException

setStringProperty

public void setStringProperty(java.lang.String name,
                              java.lang.String value)
                       throws jakarta.jms.JMSException

Specified by:

setStringProperty in interface jakarta.jms.Message

Throws:

jakarta.jms.JMSException

getAcknowledgeCallback

public JmsAcknowledgeCallback getAcknowledgeCallback()

setAcknowledgeCallback

public void setAcknowledgeCallback(JmsAcknowledgeCallback jmsAcknowledgeCallback)

onSend

public void onSend(long producerTtl)
            throws jakarta.jms.JMSException

Used to trigger processing required to place the message in a state where it is ready to be written to the wire. This processing can include such tasks as ensuring that the proper message headers are set or compressing message bodies etc. During this call the message is placed in a read-only mode and will not be returned to a writable state until send completion is triggered.

Parameters:

producerTtl - the time to live value that the producer was configured with at send time.

Throws:

jakarta.jms.JMSException - if an error occurs while preparing the message for send.

onSendComplete

public void onSendComplete()

Used to trigger processing required to place the message into a writable state once again following completion of the send operation.

onDispatch

public void onDispatch()
                throws jakarta.jms.JMSException

Used to trigger processing required before dispatch of a message to its intended consumer. This method should perform any needed decoding or message property processing prior to the message arriving at a consumer.

Throws:

jakarta.jms.JMSException - if an error occurs while preparing the message for dispatch.

getConnection

public JmsConnection getConnection()

setConnection

public void setConnection(JmsConnection connection)

getFacade

public JmsMessageFacade getFacade()

isExpired

public boolean isExpired()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

checkReadOnly

protected void checkReadOnly()
                      throws jakarta.jms.MessageNotWriteableException

Throws:

jakarta.jms.MessageNotWriteableException

checkReadOnlyProperties

protected void checkReadOnlyProperties()
                                throws jakarta.jms.MessageNotWriteableException

Throws:

jakarta.jms.MessageNotWriteableException

checkReadOnlyBody

protected void checkReadOnlyBody()
                          throws jakarta.jms.MessageNotWriteableException

Throws:

jakarta.jms.MessageNotWriteableException

checkWriteOnlyBody

protected void checkWriteOnlyBody()
                           throws jakarta.jms.MessageNotReadableException

Throws:

jakarta.jms.MessageNotReadableException