Package com.amazon.sqs.javamessaging.message

Class SQSTextMessage

java.lang.Object

com.amazon.sqs.javamessaging.message.SQSMessage

com.amazon.sqs.javamessaging.message.SQSTextMessage

All Implemented Interfaces:

jakarta.jms.Message, jakarta.jms.TextMessage

public class SQSTextMessage
extends SQSMessage
implements jakarta.jms.TextMessage

A TextMessage object is used to send a message body containing a java.lang.String. It inherits from the Message interface and adds a text message body. SQS does not accept empty or null message body

When a client receives a TextMessage, it is in read-only mode. If a client attempts to write to the message at this point, a MessageNotWriteableException is thrown. If clearBody is called, the message can now be both read from and written to.

Nested Class Summary

Nested classes/interfaces inherited from class com.amazon.sqs.javamessaging.message.SQSMessage

SQSMessage.JMSMessagePropertyValue, SQSMessage.TypeConversionSupport

Field Summary

Fields inherited from class com.amazon.sqs.javamessaging.message.SQSMessage

BYTE_MESSAGE_TYPE, JMS_SQS_CORRELATION_ID, JMS_SQS_MESSAGE_TYPE, JMS_SQS_REPLY_TO_QUEUE_NAME, JMS_SQS_REPLY_TO_QUEUE_URL, OBJECT_MESSAGE_TYPE, TEXT_MESSAGE_TYPE

Fields inherited from interface jakarta.jms.Message

DEFAULT_DELIVERY_DELAY, DEFAULT_DELIVERY_MODE, DEFAULT_PRIORITY, DEFAULT_TIME_TO_LIVE

Constructor Summary

Constructors

Constructor	Description
SQSTextMessage()	Create new empty TextMessage to send.
SQSTextMessage(Acknowledger acknowledger, String queueUrl, software.amazon.awssdk.services.sqs.model.Message sqsMessage)	Convert received SQSMessage into TextMessage.
SQSTextMessage(String payload)	Create new TextMessage with payload to send.

Method Summary

Modifier and Type	Method	Description
void	clearBody()	Sets the message body to write mode, and sets the text to null
String	getText()	Gets the text containing this message's body.
void	setText(String string)	Sets the text containing this message's body.

Methods inherited from class com.amazon.sqs.javamessaging.message.SQSMessage

acknowledge, checkBodyWritePermissions, checkPropertyWritePermissions, clearProperties, convertExceptionToJMSException, convertExceptionToMessageFormatException, getBody, getBooleanProperty, getByteProperty, getDoubleProperty, getFloatProperty, getIntProperty, getJMSCorrelationID, getJMSCorrelationIDAsBytes, getJMSDeliveryMode, getJMSDeliveryTime, getJMSDestination, getJMSExpiration, getJMSMessageID, getJMSMessagePropertyValue, getJMSPriority, getJMSRedelivered, getJMSReplyTo, getJMSTimestamp, getJMSType, getLongProperty, getObjectProperty, getPropertyNames, getQueueUrl, getReceiptHandle, getShortProperty, getSQSMessageDeduplicationId, getSQSMessageGroupId, getSQSMessageId, getSQSMessageSequenceNumber, getStringProperty, isBodyAssignableTo, propertyExists, setBodyWritePermissions, setBooleanProperty, setByteProperty, setDoubleProperty, setFloatProperty, setIntProperty, setJMSCorrelationID, setJMSCorrelationIDAsBytes, setJMSDeliveryMode, setJMSDeliveryTime, setJMSDestination, setJMSExpiration, setJMSMessageID, setJMSPriority, setJMSRedelivered, setJMSReplyTo, setJMSTimestamp, setJMSType, setLongProperty, setObjectProperty, setSequenceNumber, setShortProperty, setSQSMessageId, setStringProperty

Methods inherited from class java.lang.Object

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

Methods inherited from interface jakarta.jms.Message

acknowledge, clearProperties, getBody, getBooleanProperty, getByteProperty, getDoubleProperty, getFloatProperty, getIntProperty, getJMSCorrelationID, getJMSCorrelationIDAsBytes, getJMSDeliveryMode, getJMSDeliveryTime, getJMSDestination, getJMSExpiration, getJMSMessageID, getJMSPriority, getJMSRedelivered, getJMSReplyTo, getJMSTimestamp, getJMSType, getLongProperty, getObjectProperty, getPropertyNames, getShortProperty, getStringProperty, isBodyAssignableTo, propertyExists, setBooleanProperty, setByteProperty, setDoubleProperty, setFloatProperty, setIntProperty, setJMSCorrelationID, setJMSCorrelationIDAsBytes, setJMSDeliveryMode, setJMSDeliveryTime, setJMSDestination, setJMSExpiration, setJMSMessageID, setJMSPriority, setJMSRedelivered, setJMSReplyTo, setJMSTimestamp, setJMSType, setLongProperty, setObjectProperty, setShortProperty, setStringProperty

Constructor Details

SQSTextMessage

public SQSTextMessage(Acknowledger acknowledger,
 String queueUrl,
 software.amazon.awssdk.services.sqs.model.Message sqsMessage)
               throws jakarta.jms.JMSException

Convert received SQSMessage into TextMessage.

Throws:

jakarta.jms.JMSException

SQSTextMessage

public SQSTextMessage()
               throws jakarta.jms.JMSException

Create new empty TextMessage to send.

Throws:

jakarta.jms.JMSException

SQSTextMessage

public SQSTextMessage(String payload)
               throws jakarta.jms.JMSException

Create new TextMessage with payload to send.

Throws:

jakarta.jms.JMSException

Method Details

setText

public void setText(String string)
             throws jakarta.jms.JMSException

Sets the text containing this message's body.

Specified by:

setText in interface jakarta.jms.TextMessage

Parameters:

string - The String containing the message's body

Throws:

jakarta.jms.MessageNotWriteableException - If the message is in read-only mode.

jakarta.jms.JMSException

getText

public String getText()
               throws jakarta.jms.JMSException

Gets the text containing this message's body.

Specified by:

getText in interface jakarta.jms.TextMessage

Returns:

The String containing the message's body

Throws:

jakarta.jms.JMSException

clearBody

public void clearBody()
               throws jakarta.jms.JMSException

Sets the message body to write mode, and sets the text to null

Specified by:

clearBody in interface jakarta.jms.Message

Overrides:

clearBody in class SQSMessage

Throws:

jakarta.jms.JMSException - If directly called