com.amazon.sqs.javamessaging.message

Class SQSMessage

java.lang.Object

com.amazon.sqs.javamessaging.message.SQSMessage

Direct Known Subclasses:

SQSBytesMessage, SQSObjectMessage, SQSTextMessage

public class SQSMessage
extends java.lang.Object

The SQSMessage is the root class of all SQS JMS messages and implements JMS Message interface.

Not all message headers are supported at this time:

• JMSMessageID is always assigned as SQS provided message id.
• JMSRedelivered is set to true if SQS delivers the message more than once. This not necessarily mean that the user received message more than once, but rather SQS attempted to deliver it more than once. Due to prefetching used in SQSMessageConsumerPrefetch, this can be set to true although user never received the message. This is set based on SQS ApproximateReceiveCount attribute
• JMSDestination
is the destination object which message is sent to and received from.

JMSXDeliveryCount reserved property is supported and set based on the approximate receive count observed on the SQS side.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SQSMessage.JMSMessagePropertyValue This class is used fulfill object value, corresponding SQS message attribute type and message attribute string value.
static class	SQSMessage.TypeConversionSupport Copied from org.apache.activemq.util.TypeConversionSupport to provide the same property support provided by activemq without creating a dependency on activemq.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	BYTE_MESSAGE_TYPE
static java.lang.String	JMS_SQS_MESSAGE_TYPE
static java.lang.String	JMS_SQS_REPLY_TO_QUEUE_NAME
static java.lang.String	JMS_SQS_REPLY_TO_QUEUE_URL
static java.lang.String	OBJECT_MESSAGE_TYPE
static java.lang.String	TEXT_MESSAGE_TYPE

Method Summary

Methods

Modifier and Type	Method and Description
void	acknowledge() Acknowledges message(s).
protected void	checkBodyWritePermissions()
protected void	checkPropertyWritePermissions()
void	clearBody() Clears out the message body.
void	clearProperties() Clears a message's properties and set the write permissions for properties.
protected static JMSException	convertExceptionToJMSException(java.lang.Exception e)
protected static MessageFormatException	convertExceptionToMessageFormatException(java.lang.Exception e)
boolean	getBooleanProperty(java.lang.String name) Returns the value of the boolean property with the specified name.
byte	getByteProperty(java.lang.String name) Returns the value of the byte property with the specified name.
double	getDoubleProperty(java.lang.String name) Returns the value of the double property with the specified name.
float	getFloatProperty(java.lang.String name) Returns the value of the float property with the specified name.
int	getIntProperty(java.lang.String name) Returns the value of the int property with the specified name.
java.lang.String	getJMSCorrelationID()
byte[]	getJMSCorrelationIDAsBytes()
int	getJMSDeliveryMode()
Destination	getJMSDestination() Gets the Destination object for this message.
long	getJMSExpiration()
java.lang.String	getJMSMessageID() Gets the message ID.
SQSMessage.JMSMessagePropertyValue	getJMSMessagePropertyValue(java.lang.String name) Returns the property value with message attribute to object property conversions took place.
int	getJMSPriority()
boolean	getJMSRedelivered()
Destination	getJMSReplyTo()
long	getJMSTimestamp()
java.lang.String	getJMSType()
long	getLongProperty(java.lang.String name) Returns the value of the long property with the specified name.
java.lang.Object	getObjectProperty(java.lang.String name) Returns the value of the Java object property with the specified name.
java.util.Enumeration<java.lang.String>	getPropertyNames() Returns an Enumeration of all the property names.
java.lang.String	getQueueUrl() Get queueUrl the message came from.
java.lang.String	getReceiptHandle() Get SQS Message receiptHandle.
short	getShortProperty(java.lang.String name) Returns the value of the short property with the specified name.
java.lang.String	getSQSMessageDeduplicationId() Get SQS Message Deduplication Id (applicable for FIFO queues, available also as JMS property 'JMS_SQS_DeduplicationId')
java.lang.String	getSQSMessageGroupId() Get SQS Message Group Id (applicable for FIFO queues, available also as JMS property 'JMSXGroupId')
java.lang.String	getSQSMessageId() Get SQS Message Id.
java.lang.String	getSQSMessageSequenceNumber() Get SQS Message Sequence Number (applicable for FIFO queues, available also as JMS property 'JMS_SQS_SequenceNumber')
java.lang.String	getStringProperty(java.lang.String name) Returns the value of the String property with the specified name.
boolean	propertyExists(java.lang.String name) Indicates whether a property value exists for the given property name.
protected void	setBodyWritePermissions(boolean enable)
void	setBooleanProperty(java.lang.String name, boolean value) Sets a boolean property value with the specified name into the message.
void	setByteProperty(java.lang.String name, byte value) Sets a byte property value with the specified name into the message.
void	setDoubleProperty(java.lang.String name, double value) Sets a double property value with the specified name into the message.
void	setFloatProperty(java.lang.String name, float value) Sets a float property value with the specified name into the message.
void	setIntProperty(java.lang.String name, int value) Sets a int property value with the specified name into the message.
void	setJMSCorrelationID(java.lang.String correlationID)
void	setJMSCorrelationIDAsBytes(byte[] correlationID)
void	setJMSDeliveryMode(int deliveryMode)
void	setJMSDestination(Destination destination) Sets the Destination object for this message.
void	setJMSExpiration(long expiration)
void	setJMSMessageID(java.lang.String id) Sets the message ID.
void	setJMSPriority(int priority)
void	setJMSRedelivered(boolean redelivered)
void	setJMSReplyTo(Destination replyTo)
void	setJMSTimestamp(long timestamp)
void	setJMSType(java.lang.String type)
void	setLongProperty(java.lang.String name, long value) Sets a long property value with the specified name into the message.
void	setObjectProperty(java.lang.String name, java.lang.Object value) Sets a Java object property value with the specified name into the message.
void	setSequenceNumber(java.lang.String sequenceNumber) This method sets the JMS_SQS_SEQUENCE_NUMBER property on the message.
void	setShortProperty(java.lang.String name, short value) Sets a short property value with the specified name into the message.
void	setSQSMessageId(java.lang.String sqsMessageID) Set SQS Message Id, used on send.
void	setStringProperty(java.lang.String name, java.lang.String value) Sets a String property value with the specified name into the message.

Methods inherited from class java.lang.Object

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

Field Detail

BYTE_MESSAGE_TYPE

public static final java.lang.String BYTE_MESSAGE_TYPE

See Also:

Constant Field Values

OBJECT_MESSAGE_TYPE

public static final java.lang.String OBJECT_MESSAGE_TYPE

See Also:

Constant Field Values

TEXT_MESSAGE_TYPE

public static final java.lang.String TEXT_MESSAGE_TYPE

See Also:

Constant Field Values

JMS_SQS_MESSAGE_TYPE

public static final java.lang.String JMS_SQS_MESSAGE_TYPE

See Also:

Constant Field Values

JMS_SQS_REPLY_TO_QUEUE_NAME

public static final java.lang.String JMS_SQS_REPLY_TO_QUEUE_NAME

See Also:

Constant Field Values

JMS_SQS_REPLY_TO_QUEUE_URL

public static final java.lang.String JMS_SQS_REPLY_TO_QUEUE_URL

See Also:

Constant Field Values

Method Detail

checkPropertyWritePermissions

protected void checkPropertyWritePermissions()
                                      throws JMSException

Throws:

JMSException

checkBodyWritePermissions

protected void checkBodyWritePermissions()
                                  throws JMSException

Throws:

JMSException

convertExceptionToJMSException

protected static JMSException convertExceptionToJMSException(java.lang.Exception e)

convertExceptionToMessageFormatException

protected static MessageFormatException convertExceptionToMessageFormatException(java.lang.Exception e)

setBodyWritePermissions

protected void setBodyWritePermissions(boolean enable)

getSQSMessageGroupId

public java.lang.String getSQSMessageGroupId()
                                      throws JMSException

Get SQS Message Group Id (applicable for FIFO queues, available also as JMS property 'JMSXGroupId')

Throws:

JMSException

getSQSMessageDeduplicationId

public java.lang.String getSQSMessageDeduplicationId()
                                              throws JMSException

Get SQS Message Deduplication Id (applicable for FIFO queues, available also as JMS property 'JMS_SQS_DeduplicationId')

Throws:

JMSException

getSQSMessageSequenceNumber

public java.lang.String getSQSMessageSequenceNumber()
                                             throws JMSException

Get SQS Message Sequence Number (applicable for FIFO queues, available also as JMS property 'JMS_SQS_SequenceNumber')

Throws:

JMSException

getSQSMessageId

public java.lang.String getSQSMessageId()

Get SQS Message Id.

Returns:

SQS Message Id.

setSQSMessageId

public void setSQSMessageId(java.lang.String sqsMessageID)
                     throws JMSException

Set SQS Message Id, used on send.

Parameters:

sqsMessageID - messageId assigned by SQS during send.

Throws:

JMSException

getReceiptHandle

public java.lang.String getReceiptHandle()

Get SQS Message receiptHandle.

Returns:

SQS Message receiptHandle.

getQueueUrl

public java.lang.String getQueueUrl()

Get queueUrl the message came from.

Returns:

queueUrl.

getJMSMessageID

public java.lang.String getJMSMessageID()
                                 throws JMSException

Gets the message ID.

The JMSMessageID header field contains a value that uniquely identifies each message sent by a provider. It is set to SQS messageId with the prefix 'ID:'.

Returns:

the ID of the message.

Throws:

JMSException

setJMSMessageID

public void setJMSMessageID(java.lang.String id)
                     throws JMSException

Sets the message ID. It should have prefix 'ID:'.

Set when a message is sent. This method can be used to change the value for a message that has been received.

Parameters:

id - The ID of the message.

Throws:

JMSException

getJMSTimestamp

public long getJMSTimestamp()
                     throws JMSException

Throws:

JMSException

setJMSTimestamp

public void setJMSTimestamp(long timestamp)
                     throws JMSException

Throws:

JMSException

getJMSCorrelationIDAsBytes

public byte[] getJMSCorrelationIDAsBytes()
                                  throws JMSException

Throws:

JMSException

setJMSCorrelationIDAsBytes

public void setJMSCorrelationIDAsBytes(byte[] correlationID)
                                throws JMSException

Throws:

JMSException

setJMSCorrelationID

public void setJMSCorrelationID(java.lang.String correlationID)
                         throws JMSException

Throws:

JMSException

getJMSCorrelationID

public java.lang.String getJMSCorrelationID()
                                     throws JMSException

Throws:

JMSException

getJMSReplyTo

public Destination getJMSReplyTo()
                          throws JMSException

Throws:

JMSException

setJMSReplyTo

public void setJMSReplyTo(Destination replyTo)
                   throws JMSException

Throws:

JMSException

getJMSDestination

public Destination getJMSDestination()
                              throws JMSException

Gets the Destination object for this message.

The JMSDestination header field contains the destination to which the message is being sent.

When a message is sent, this field is ignored. After completion of the send or publish method, the field holds the destination specified by the method.

When a message is received, its JMSDestination value must be equivalent to the value assigned when it was sent.

Returns:

The destination of this message.

Throws:

JMSException

setJMSDestination

public void setJMSDestination(Destination destination)
                       throws JMSException

Sets the Destination object for this message.

Set when a message is sent. This method can be used to change the value for a message that has been received.

Parameters:

destination - The destination for this message.

Throws:

JMSException

getJMSDeliveryMode

public int getJMSDeliveryMode()
                       throws JMSException

Throws:

JMSException

setJMSDeliveryMode

public void setJMSDeliveryMode(int deliveryMode)
                        throws JMSException

Throws:

JMSException

getJMSRedelivered

public boolean getJMSRedelivered()
                          throws JMSException

Throws:

JMSException

setJMSRedelivered

public void setJMSRedelivered(boolean redelivered)
                       throws JMSException

Throws:

JMSException

getJMSType

public java.lang.String getJMSType()
                            throws JMSException

Throws:

JMSException

setJMSType

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

Throws:

JMSException

getJMSExpiration

public long getJMSExpiration()
                      throws JMSException

Throws:

JMSException

setJMSExpiration

public void setJMSExpiration(long expiration)
                      throws JMSException

Throws:

JMSException

getJMSPriority

public int getJMSPriority()
                   throws JMSException

Throws:

JMSException

setJMSPriority

public void setJMSPriority(int priority)
                    throws JMSException

Throws:

JMSException

clearProperties

public void clearProperties()
                     throws JMSException

Clears a message's properties and set the write permissions for properties. The message's header fields and body are not cleared.

Throws:

JMSException

propertyExists

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

Indicates whether a property value exists for the given property name.

Parameters:

name - The name of the property.

Returns:

true if the property exists.

Throws:

JMSException

getBooleanProperty

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

Returns the value of the boolean property with the specified name.

Parameters:

name - The name of the property to get.

Returns:

the boolean property value for the specified name.

Throws:

JMSException - On internal error.

MessageFormatException - If the property cannot be converted to the specified type.

java.lang.NullPointerException - When property name is null.

getByteProperty

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

Returns the value of the byte property with the specified name.

Parameters:

name - The name of the property to get.

Returns:

the byte property value for the specified name.

Throws:

JMSException - On internal error.

MessageFormatException - If the property cannot be converted to the specified type.

java.lang.NullPointerException - When property name is null.

java.lang.NumberFormatException - When property value is null.

getShortProperty

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

Returns the value of the short property with the specified name.

Parameters:

name - The name of the property to get.

Returns:

the short property value for the specified name.

Throws:

JMSException - On internal error.

MessageFormatException - If the property cannot be converted to the specified type.

java.lang.NullPointerException - When property name is null.

java.lang.NumberFormatException - When property value is null.

getIntProperty

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

Returns the value of the int property with the specified name.

Parameters:

name - The name of the property to get.

Returns:

the int property value for the specified name.

Throws:

JMSException - On internal error.

MessageFormatException - If the property cannot be converted to the specified type.

java.lang.NullPointerException - When property name is null.

java.lang.NumberFormatException - When property value is null.

getLongProperty

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

Returns the value of the long property with the specified name.

Parameters:

name - The name of the property to get.

Returns:

the long property value for the specified name.

Throws:

JMSException - On internal error.

MessageFormatException - If the property cannot be converted to the specified type.

java.lang.NullPointerException - When property name is null.

java.lang.NumberFormatException - When property value is null.

getFloatProperty

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

Returns the value of the float property with the specified name.

Parameters:

name - The name of the property to get.

Returns:

the float property value for the specified name.

Throws:

JMSException - Wn internal error.

MessageFormatException - If the property cannot be converted to the specified type.

java.lang.NullPointerException - When property name or value is null.

getDoubleProperty

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

Returns the value of the double property with the specified name.

Parameters:

name - The name of the property to get.

Returns:

the double property value for the specified name.

Throws:

JMSException - On internal error.

MessageFormatException - If the property cannot be converted to the specified type.

java.lang.NullPointerException - When property name or value is null.

getStringProperty

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

Returns the value of the String property with the specified name.

Parameters:

name - The name of the property to get.

Returns:

the String property value for the specified name.

Throws:

JMSException - On internal error.

MessageFormatException - If the property cannot be converted to the specified type.

java.lang.NullPointerException - When property name is null.

getObjectProperty

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

Returns the value of the Java object property with the specified name.

This method can be used to return, in boxed format, an object that has been stored as a property in the message with the equivalent setObjectProperty method call, or its equivalent primitive setter method.

Parameters:

name - The name of the property to get.

Returns:

the Java object property value with the specified name, in boxed format (for example, if the property was set as an int, an Integer is returned); if there is no property by this name, a null value is returned.

Throws:

JMSException - On internal error.

getJMSMessagePropertyValue

public SQSMessage.JMSMessagePropertyValue getJMSMessagePropertyValue(java.lang.String name)
                                                              throws JMSException

Returns the property value with message attribute to object property conversions took place.

Parameters:

name - The name of the property to get.

Returns:

JMSMessagePropertyValue with object value and corresponding SQS message attribute type and message attribute string value.

Throws:

JMSException - On internal error.

getPropertyNames

public java.util.Enumeration<java.lang.String> getPropertyNames()
                                                         throws JMSException

Returns an Enumeration of all the property names.

Note that JMS standard header fields are not considered properties and are not returned in this enumeration.

Returns:

an enumeration of all the names of property values.

Throws:

JMSException - On internal error.

setBooleanProperty

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

Sets a boolean property value with the specified name into the message.

Parameters:

name - The name of the property to set.

value - The boolean value of the property to set.

Throws:

JMSException - On internal error.

java.lang.IllegalArgumentException - If the name or value is null or empty string.

MessageNotWriteableException - If properties are read-only.

setByteProperty

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

Sets a byte property value with the specified name into the message.

Parameters:

name - The name of the property to set.

value - The byte value of the property to set.

Throws:

JMSException - On internal error.

java.lang.IllegalArgumentException - If the name or value is null or empty string.

MessageNotWriteableException - If properties are read-only.

setShortProperty

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

Sets a short property value with the specified name into the message.

Parameters:

name - The name of the property to set.

value - The short value of the property to set.

Throws:

JMSException - On internal error.

java.lang.IllegalArgumentException - If the name or value is null or empty string.

MessageNotWriteableException - If properties are read-only.

setIntProperty

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

Sets a int property value with the specified name into the message.

Parameters:

name - The name of the property to set.

value - The int value of the property to set.

Throws:

JMSException - On internal error.

java.lang.IllegalArgumentException - If the name or value is null or empty string.

MessageNotWriteableException - If properties are read-only.

setLongProperty

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

Sets a long property value with the specified name into the message.

Parameters:

name - The name of the property to set.

value - The long value of the property to set.

Throws:

JMSException - On internal error.

java.lang.IllegalArgumentException - If the name or value is null or empty string.

MessageNotWriteableException - If properties are read-only.

setFloatProperty

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

Sets a float property value with the specified name into the message.

Parameters:

name - The name of the property to set.

value - The float value of the property to set.

Throws:

JMSException - On internal error.

java.lang.IllegalArgumentException - If the name or value is null or empty string.

MessageNotWriteableException - If properties are read-only.

setDoubleProperty

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

Sets a double property value with the specified name into the message.

Parameters:

name - The name of the property to set.

value - The double value of the property to set.

Throws:

JMSException - On internal error.

java.lang.IllegalArgumentException - If the name or value is null or empty string.

MessageNotWriteableException - If properties are read-only.

setStringProperty

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

Sets a String property value with the specified name into the message.

Parameters:

name - The name of the property to set.

value - The String value of the property to set.

Throws:

JMSException - On internal error.

java.lang.IllegalArgumentException - If the name or value is null or empty string.

MessageNotWriteableException - If properties are read-only.

setObjectProperty

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

Sets a Java object property value with the specified name into the message.

Note that this method works only for the boxed primitive object types (Integer, Double, Long ...) and String objects.

Parameters:

name - The name of the property to set.

value - The object value of the property to set.

Throws:

JMSException - On internal error.

java.lang.IllegalArgumentException - If the name or value is null or empty string.

MessageFormatException - If the object is invalid type.

MessageNotWriteableException - If properties are read-only.

acknowledge

public void acknowledge()
                 throws JMSException

Acknowledges message(s).

A client may individually acknowledge each message as it is consumed, or it may choose to acknowledge multiple messages based on acknowledge mode, which in turn might might acknowledge all messages consumed by the session.

Messages that have been received but not acknowledged may be redelivered.

If the session is closed, messages cannot be acknowledged.

If only the consumer is closed, messages can still be acknowledged.

Throws:

JMSException - On Internal error

java.lang.IllegalStateException - If this method is called on a closed session.

See Also:

AcknowledgeMode

clearBody

public void clearBody()
               throws JMSException

Clears out the message body. Clearing a message's body does not clear its header values or property entries.

This method cannot be called directly instead the implementation on the subclasses should be used.

Throws:

JMSException - If directly called

setSequenceNumber

public void setSequenceNumber(java.lang.String sequenceNumber)
                       throws JMSException

This method sets the JMS_SQS_SEQUENCE_NUMBER property on the message. It is exposed explicitly here, so that it can be invoked even on read-only message object obtained through receing a message. This support the use case of send a received message by using the same JMSMessage object.

Parameters:

sequenceNumber - Sequence number to set. If null or empty, the stored sequence number will be removed.

Throws:

JMSException