org.apache.qpid.client.message

Class AbstractJMSMessage

java.lang.Object

org.apache.qpid.client.message.AbstractJMSMessage

All Implemented Interfaces:

javax.jms.Message

Direct Known Subclasses:

AbstractBytesTypedMessage, JMSMapMessage, JMSObjectMessage, JMSTextMessage

public abstract class AbstractJMSMessage
extends Object
implements Message

Field Summary

Fields inherited from interface org.apache.qpid.jms.Message

JMS_TYPE

Fields inherited from interface javax.jms.Message

DEFAULT_DELIVERY_MODE, DEFAULT_PRIORITY, DEFAULT_TIME_TO_LIVE

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractJMSMessage(AMQMessageDelegate delegate, boolean fromReceivedData)
protected	AbstractJMSMessage(AMQMessageDelegateFactory delegateFactory, boolean fromReceivedData)

Method Summary

Methods

Modifier and Type	Method and Description
void	acknowledge()
void	acknowledgeThis()
protected void	checkWritable()
void	clearBody()
void	clearProperties()
AMQSession	getAMQSession()
boolean	getBooleanProperty(String s)
byte	getByteProperty(String s)
String	getContentType()
abstract ByteBuffer	getData()
AMQMessageDelegate	getDelegate()
long	getDeliveryTag() Get the AMQ message number assigned to this message
double	getDoubleProperty(String s)
String	getEncoding()
float	getFloatProperty(String s)
int	getIntProperty(String s)
String	getJMSCorrelationID()
byte[]	getJMSCorrelationIDAsBytes()
int	getJMSDeliveryMode()
javax.jms.Destination	getJMSDestination()
long	getJMSExpiration()
String	getJMSMessageID()
int	getJMSPriority()
boolean	getJMSRedelivered()
javax.jms.Destination	getJMSReplyTo()
long	getJMSTimestamp()
String	getJMSType()
long	getLongProperty(String s)
protected abstract String	getMimeType()
Object	getObjectProperty(String s)
Enumeration	getPropertyNames()
String	getReplyToString()
short	getShortProperty(String s)
String	getStringProperty(String s)
void	prepareForSending() Invoked prior to sending the message.
boolean	propertyExists(String propertyName)
protected void	removeProperty(String propertyName)
void	setAMQSession(AMQSession s) The session is set when CLIENT_ACKNOWLEDGE mode is used so that the CHANNEL ACK can be sent when the user calls acknowledge()
void	setBooleanProperty(String s, boolean b)
void	setByteProperty(String s, byte b)
void	setContentType(String contentType)
void	setDoubleProperty(String s, double v)
void	setEncoding(String encoding)
void	setFloatProperty(String s, float v)
void	setIntProperty(String s, int i)
void	setJMSCorrelationID(String correlationId)
void	setJMSCorrelationIDAsBytes(byte[] bytes)
void	setJMSDeliveryMode(int i)
void	setJMSDestination(javax.jms.Destination destination)
void	setJMSExpiration(long l)
void	setJMSMessageID(String messageId)
void	setJMSMessageID(UUID messageId)
void	setJMSPriority(int i)
void	setJMSRedelivered(boolean b)
void	setJMSReplyTo(javax.jms.Destination destination)
void	setJMSTimestamp(long timestamp)
void	setJMSType(String string)
void	setLongProperty(String s, long l)
void	setObjectProperty(String s, Object o)
void	setReceivedFromServer()
void	setShortProperty(String s, short i)
void	setStringProperty(String s, String s1)
abstract String	toBodyString()
String	toHeaderString()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractJMSMessage

protected AbstractJMSMessage(AMQMessageDelegateFactory delegateFactory,
                  boolean fromReceivedData)

AbstractJMSMessage

protected AbstractJMSMessage(AMQMessageDelegate delegate,
                  boolean fromReceivedData)
                      throws QpidException

Throws:

QpidException

Method Detail

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 messageId)
                     throws javax.jms.JMSException

Specified by:

setJMSMessageID in interface javax.jms.Message

Throws:

javax.jms.JMSException

setJMSMessageID

public void setJMSMessageID(UUID messageId)
                     throws javax.jms.JMSException

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

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[] bytes)
                                throws javax.jms.JMSException

Specified by:

setJMSCorrelationIDAsBytes 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

getJMSCorrelationID

public String getJMSCorrelationID()
                           throws javax.jms.JMSException

Specified by:

getJMSCorrelationID 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)

Specified by:

setJMSDestination in interface javax.jms.Message

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 i)
                        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 b)
                       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 string)
                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 l)
                      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 i)
                    throws javax.jms.JMSException

Specified by:

setJMSPriority in interface javax.jms.Message

Throws:

javax.jms.JMSException

propertyExists

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

Specified by:

propertyExists in interface javax.jms.Message

Throws:

javax.jms.JMSException

getBooleanProperty

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

Specified by:

getBooleanProperty in interface javax.jms.Message

Throws:

javax.jms.JMSException

getByteProperty

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

Specified by:

getByteProperty in interface javax.jms.Message

Throws:

javax.jms.JMSException

getShortProperty

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

Specified by:

getShortProperty in interface javax.jms.Message

Throws:

javax.jms.JMSException

getIntProperty

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

Specified by:

getIntProperty in interface javax.jms.Message

Throws:

javax.jms.JMSException

getLongProperty

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

Specified by:

getLongProperty in interface javax.jms.Message

Throws:

javax.jms.JMSException

getFloatProperty

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

Specified by:

getFloatProperty in interface javax.jms.Message

Throws:

javax.jms.JMSException

getDoubleProperty

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

Specified by:

getDoubleProperty in interface javax.jms.Message

Throws:

javax.jms.JMSException

getStringProperty

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

Specified by:

getStringProperty in interface javax.jms.Message

Throws:

javax.jms.JMSException

getObjectProperty

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

Specified by:

getObjectProperty 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

setBooleanProperty

public void setBooleanProperty(String s,
                      boolean b)
                        throws javax.jms.JMSException

Specified by:

setBooleanProperty in interface javax.jms.Message

Throws:

javax.jms.JMSException

setByteProperty

public void setByteProperty(String s,
                   byte b)
                     throws javax.jms.JMSException

Specified by:

setByteProperty in interface javax.jms.Message

Throws:

javax.jms.JMSException

setShortProperty

public void setShortProperty(String s,
                    short i)
                      throws javax.jms.JMSException

Specified by:

setShortProperty in interface javax.jms.Message

Throws:

javax.jms.JMSException

setIntProperty

public void setIntProperty(String s,
                  int i)
                    throws javax.jms.JMSException

Specified by:

setIntProperty in interface javax.jms.Message

Throws:

javax.jms.JMSException

setLongProperty

public void setLongProperty(String s,
                   long l)
                     throws javax.jms.JMSException

Specified by:

setLongProperty in interface javax.jms.Message

Throws:

javax.jms.JMSException

setFloatProperty

public void setFloatProperty(String s,
                    float v)
                      throws javax.jms.JMSException

Specified by:

setFloatProperty in interface javax.jms.Message

Throws:

javax.jms.JMSException

setDoubleProperty

public void setDoubleProperty(String s,
                     double v)
                       throws javax.jms.JMSException

Specified by:

setDoubleProperty in interface javax.jms.Message

Throws:

javax.jms.JMSException

setStringProperty

public void setStringProperty(String s,
                     String s1)
                       throws javax.jms.JMSException

Specified by:

setStringProperty in interface javax.jms.Message

Throws:

javax.jms.JMSException

setObjectProperty

public void setObjectProperty(String s,
                     Object o)
                       throws javax.jms.JMSException

Specified by:

setObjectProperty 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

clearBody

public void clearBody()
               throws javax.jms.JMSException

Specified by:

clearBody in interface javax.jms.Message

Throws:

javax.jms.JMSException

acknowledgeThis

public void acknowledgeThis()
                     throws javax.jms.JMSException

Throws:

javax.jms.JMSException

acknowledge

public void acknowledge()
                 throws javax.jms.JMSException

Specified by:

acknowledge in interface javax.jms.Message

Throws:

javax.jms.JMSException

toBodyString

public abstract String toBodyString()
                             throws javax.jms.JMSException

Throws:

javax.jms.JMSException

getMimeType

protected abstract String getMimeType()

toHeaderString

public String toHeaderString()
                      throws javax.jms.JMSException

Throws:

javax.jms.JMSException

toString

public String toString()

Overrides:

toString in class Object

getDelegate

public AMQMessageDelegate getDelegate()

getData

public abstract ByteBuffer getData()
                            throws javax.jms.JMSException

Throws:

javax.jms.JMSException

checkWritable

protected void checkWritable()
                      throws javax.jms.MessageNotWriteableException

Throws:

javax.jms.MessageNotWriteableException

setReceivedFromServer

public void setReceivedFromServer()

setAMQSession

public void setAMQSession(AMQSession s)

The session is set when CLIENT_ACKNOWLEDGE mode is used so that the CHANNEL ACK can be sent when the user calls acknowledge()

Parameters:

s - the AMQ session that delivered this message

getAMQSession

public AMQSession getAMQSession()

getDeliveryTag

public long getDeliveryTag()

Get the AMQ message number assigned to this message

Returns:

the message number

prepareForSending

public void prepareForSending()
                       throws javax.jms.JMSException

Invoked prior to sending the message. Allows the message to be modified if necessary before sending.

Throws:

javax.jms.JMSException

setContentType

public void setContentType(String contentType)

getContentType

public String getContentType()

setEncoding

public void setEncoding(String encoding)

getEncoding

public String getEncoding()

getReplyToString

public String getReplyToString()

removeProperty

protected void removeProperty(String propertyName)
                       throws javax.jms.JMSException

Throws:

javax.jms.JMSException