Package org.apache.qpid.jms.message

Class JmsMessage

java.lang.Object

org.apache.qpid.jms.message.JmsMessage

All Implemented Interfaces:

javax.jms.Message

Direct Known Subclasses:

JmsBytesMessage, JmsMapMessage, JmsObjectMessage, JmsStreamMessage, JmsTextMessage

public class JmsMessage
extends Object
implements javax.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 javax.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(Class<T> asType)
boolean	equals(Object o)
JmsAcknowledgeCallback	getAcknowledgeCallback()
Enumeration<?>	getAllPropertyNames()	return all property names, including standard JMS properties and JMSX properties
<T> T	getBody(Class<T> asType)
boolean	getBooleanProperty(String name)
byte	getByteProperty(String name)
JmsConnection	getConnection()
double	getDoubleProperty(String name)
JmsMessageFacade	getFacade()
float	getFloatProperty(String name)
int	getIntProperty(String name)
String	getJMSCorrelationID()
byte[]	getJMSCorrelationIDAsBytes()
int	getJMSDeliveryMode()
long	getJMSDeliveryTime()
javax.jms.Destination	getJMSDestination()
long	getJMSExpiration()
String	getJMSMessageID()
int	getJMSPriority()
boolean	getJMSRedelivered()
javax.jms.Destination	getJMSReplyTo()
long	getJMSTimestamp()
String	getJMSType()
long	getLongProperty(String name)
Object	getObjectProperty(String name)
Enumeration<?>	getPropertyNames()
short	getShortProperty(String name)
String	getStringProperty(String name)
int	hashCode()
boolean	isBodyAssignableTo(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(String name)
void	setAcknowledgeCallback(JmsAcknowledgeCallback jmsAcknowledgeCallback)
void	setBooleanProperty(String name, boolean value)
void	setByteProperty(String name, byte value)
void	setConnection(JmsConnection connection)
void	setDoubleProperty(String name, double value)
void	setFloatProperty(String name, float value)
void	setIntProperty(String name, int value)
void	setJMSCorrelationID(String correlationId)
void	setJMSCorrelationIDAsBytes(byte[] correlationId)
void	setJMSDeliveryMode(int mode)
void	setJMSDeliveryTime(long deliveryTime)
void	setJMSDestination(javax.jms.Destination destination)
void	setJMSExpiration(long expiration)
void	setJMSMessageID(String value)
void	setJMSPriority(int priority)
void	setJMSRedelivered(boolean redelivered)
void	setJMSReplyTo(javax.jms.Destination destination)
void	setJMSTimestamp(long timestamp)
void	setJMSType(String type)
void	setLongProperty(String name, long value)
void	setObjectProperty(String name, Object value)
void	setReadOnly(boolean readOnly)
void	setReadOnlyBody(boolean readOnlyBody)
void	setReadOnlyProperties(boolean readOnlyProperties)
void	setShortProperty(String name, short value)
void	setStringProperty(String name, String value)
void	setValidatePropertyNames(boolean validatePropertyNames)
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 javax.jms.JMSException

Throws:

javax.jms.JMSException

copy

protected void copy(JmsMessage other)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

acknowledge

public void acknowledge()
                 throws javax.jms.JMSException

Specified by:

acknowledge in interface javax.jms.Message

Throws:

javax.jms.JMSException

isBodyAssignableTo

public boolean isBodyAssignableTo(Class target)
                           throws javax.jms.JMSException

Specified by:

isBodyAssignableTo in interface javax.jms.Message

Throws:

javax.jms.JMSException

getBody

public final <T> T getBody(Class<T> asType)
                    throws javax.jms.JMSException

Specified by:

getBody in interface javax.jms.Message

Throws:

javax.jms.JMSException

doGetBody

protected <T> T doGetBody(Class<T> asType)
                   throws javax.jms.JMSException

Throws:

javax.jms.JMSException

clearBody

public void clearBody()
               throws javax.jms.JMSException

Specified by:

clearBody in interface javax.jms.Message

Throws:

javax.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 String getJMSMessageID()
                       throws javax.jms.JMSException

Specified by:

getJMSMessageID in interface javax.jms.Message

Throws:

javax.jms.JMSException

setJMSMessageID

public void setJMSMessageID(String value)
                     throws javax.jms.JMSException

Specified by:

setJMSMessageID in interface javax.jms.Message

Throws:

javax.jms.JMSException

getJMSTimestamp

public long getJMSTimestamp()
                     throws javax.jms.JMSException

Specified by:

getJMSTimestamp in interface javax.jms.Message

Throws:

javax.jms.JMSException

setJMSTimestamp

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

Specified by:

setJMSTimestamp in interface javax.jms.Message

Throws:

javax.jms.JMSException

getJMSCorrelationID

public String getJMSCorrelationID()
                           throws javax.jms.JMSException

Specified by:

getJMSCorrelationID in interface javax.jms.Message

Throws:

javax.jms.JMSException

setJMSCorrelationID

public void setJMSCorrelationID(String correlationId)
                         throws javax.jms.JMSException

Specified by:

setJMSCorrelationID in interface javax.jms.Message

Throws:

javax.jms.JMSException

getJMSCorrelationIDAsBytes

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

Specified by:

getJMSCorrelationIDAsBytes in interface javax.jms.Message

Throws:

javax.jms.JMSException

setJMSCorrelationIDAsBytes

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

Specified by:

setJMSCorrelationIDAsBytes in interface javax.jms.Message

Throws:

javax.jms.JMSException

getJMSReplyTo

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

Specified by:

getJMSReplyTo in interface javax.jms.Message

Throws:

javax.jms.JMSException

setJMSReplyTo

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

Specified by:

setJMSReplyTo in interface javax.jms.Message

Throws:

javax.jms.JMSException

getJMSDestination

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

Specified by:

getJMSDestination in interface javax.jms.Message

Throws:

javax.jms.JMSException

setJMSDestination

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

Specified by:

setJMSDestination in interface javax.jms.Message

Throws:

javax.jms.JMSException

getJMSDeliveryMode

public int getJMSDeliveryMode()
                       throws javax.jms.JMSException

Specified by:

getJMSDeliveryMode in interface javax.jms.Message

Throws:

javax.jms.JMSException

setJMSDeliveryMode

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

Specified by:

setJMSDeliveryMode in interface javax.jms.Message

Throws:

javax.jms.JMSException

getJMSRedelivered

public boolean getJMSRedelivered()
                          throws javax.jms.JMSException

Specified by:

getJMSRedelivered in interface javax.jms.Message

Throws:

javax.jms.JMSException

setJMSRedelivered

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

Specified by:

setJMSRedelivered in interface javax.jms.Message

Throws:

javax.jms.JMSException

getJMSType

public String getJMSType()
                  throws javax.jms.JMSException

Specified by:

getJMSType in interface javax.jms.Message

Throws:

javax.jms.JMSException

setJMSType

public void setJMSType(String type)
                throws javax.jms.JMSException

Specified by:

setJMSType in interface javax.jms.Message

Throws:

javax.jms.JMSException

getJMSExpiration

public long getJMSExpiration()
                      throws javax.jms.JMSException

Specified by:

getJMSExpiration in interface javax.jms.Message

Throws:

javax.jms.JMSException

setJMSExpiration

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

Specified by:

setJMSExpiration in interface javax.jms.Message

Throws:

javax.jms.JMSException

getJMSPriority

public int getJMSPriority()
                   throws javax.jms.JMSException

Specified by:

getJMSPriority in interface javax.jms.Message

Throws:

javax.jms.JMSException

setJMSPriority

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

Specified by:

setJMSPriority in interface javax.jms.Message

Throws:

javax.jms.JMSException

getJMSDeliveryTime

public long getJMSDeliveryTime()
                        throws javax.jms.JMSException

Specified by:

getJMSDeliveryTime in interface javax.jms.Message

Throws:

javax.jms.JMSException

setJMSDeliveryTime

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

Specified by:

setJMSDeliveryTime in interface javax.jms.Message

Throws:

javax.jms.JMSException

clearProperties

public void clearProperties()
                     throws javax.jms.JMSException

Specified by:

clearProperties in interface javax.jms.Message

Throws:

javax.jms.JMSException

propertyExists

public boolean propertyExists(String name)
                       throws javax.jms.JMSException

Specified by:

propertyExists in interface javax.jms.Message

Throws:

javax.jms.JMSException

getPropertyNames

public Enumeration<?> getPropertyNames()
                                throws javax.jms.JMSException

Specified by:

getPropertyNames in interface javax.jms.Message

Throws:

javax.jms.JMSException

getAllPropertyNames

public Enumeration<?> getAllPropertyNames()
                                   throws javax.jms.JMSException

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

Returns:

Enumeration of all property names on this message

Throws:

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

setObjectProperty

public void setObjectProperty(String name,
                              Object value)
                       throws javax.jms.JMSException

Specified by:

setObjectProperty in interface javax.jms.Message

Throws:

javax.jms.JMSException

getObjectProperty

public Object getObjectProperty(String name)
                         throws javax.jms.JMSException

Specified by:

getObjectProperty in interface javax.jms.Message

Throws:

javax.jms.JMSException

getBooleanProperty

public boolean getBooleanProperty(String name)
                           throws javax.jms.JMSException

Specified by:

getBooleanProperty in interface javax.jms.Message

Throws:

javax.jms.JMSException

getByteProperty

public byte getByteProperty(String name)
                     throws javax.jms.JMSException

Specified by:

getByteProperty in interface javax.jms.Message

Throws:

javax.jms.JMSException

getShortProperty

public short getShortProperty(String name)
                       throws javax.jms.JMSException

Specified by:

getShortProperty in interface javax.jms.Message

Throws:

javax.jms.JMSException

getIntProperty

public int getIntProperty(String name)
                   throws javax.jms.JMSException

Specified by:

getIntProperty in interface javax.jms.Message

Throws:

javax.jms.JMSException

getLongProperty

public long getLongProperty(String name)
                     throws javax.jms.JMSException

Specified by:

getLongProperty in interface javax.jms.Message

Throws:

javax.jms.JMSException

getFloatProperty

public float getFloatProperty(String name)
                       throws javax.jms.JMSException

Specified by:

getFloatProperty in interface javax.jms.Message

Throws:

javax.jms.JMSException

getDoubleProperty

public double getDoubleProperty(String name)
                         throws javax.jms.JMSException

Specified by:

getDoubleProperty in interface javax.jms.Message

Throws:

javax.jms.JMSException

getStringProperty

public String getStringProperty(String name)
                         throws javax.jms.JMSException

Specified by:

getStringProperty in interface javax.jms.Message

Throws:

javax.jms.JMSException

setBooleanProperty

public void setBooleanProperty(String name,
                               boolean value)
                        throws javax.jms.JMSException

Specified by:

setBooleanProperty in interface javax.jms.Message

Throws:

javax.jms.JMSException

setByteProperty

public void setByteProperty(String name,
                            byte value)
                     throws javax.jms.JMSException

Specified by:

setByteProperty in interface javax.jms.Message

Throws:

javax.jms.JMSException

setShortProperty

public void setShortProperty(String name,
                             short value)
                      throws javax.jms.JMSException

Specified by:

setShortProperty in interface javax.jms.Message

Throws:

javax.jms.JMSException

setIntProperty

public void setIntProperty(String name,
                           int value)
                    throws javax.jms.JMSException

Specified by:

setIntProperty in interface javax.jms.Message

Throws:

javax.jms.JMSException

setLongProperty

public void setLongProperty(String name,
                            long value)
                     throws javax.jms.JMSException

Specified by:

setLongProperty in interface javax.jms.Message

Throws:

javax.jms.JMSException

setFloatProperty

public void setFloatProperty(String name,
                             float value)
                      throws javax.jms.JMSException

Specified by:

setFloatProperty in interface javax.jms.Message

Throws:

javax.jms.JMSException

setDoubleProperty

public void setDoubleProperty(String name,
                              double value)
                       throws javax.jms.JMSException

Specified by:

setDoubleProperty in interface javax.jms.Message

Throws:

javax.jms.JMSException

setStringProperty

public void setStringProperty(String name,
                              String value)
                       throws javax.jms.JMSException

Specified by:

setStringProperty in interface javax.jms.Message

Throws:

javax.jms.JMSException

getAcknowledgeCallback

public JmsAcknowledgeCallback getAcknowledgeCallback()

setAcknowledgeCallback

public void setAcknowledgeCallback(JmsAcknowledgeCallback jmsAcknowledgeCallback)

onSend

public void onSend(long producerTtl)
            throws javax.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:

javax.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 javax.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:

javax.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 String toString()

Overrides:

toString in class Object

checkReadOnly

protected void checkReadOnly()
                      throws javax.jms.MessageNotWriteableException

Throws:

javax.jms.MessageNotWriteableException

checkReadOnlyProperties

protected void checkReadOnlyProperties()
                                throws javax.jms.MessageNotWriteableException

Throws:

javax.jms.MessageNotWriteableException

checkReadOnlyBody

protected void checkReadOnlyBody()
                          throws javax.jms.MessageNotWriteableException

Throws:

javax.jms.MessageNotWriteableException

checkWriteOnlyBody

protected void checkWriteOnlyBody()
                           throws javax.jms.MessageNotReadableException

Throws:

javax.jms.MessageNotReadableException