Package com.amazon.sqs.javamessaging.message

Class SQSObjectMessage

java.lang.Object

com.amazon.sqs.javamessaging.message.SQSMessage

com.amazon.sqs.javamessaging.message.SQSObjectMessage

All Implemented Interfaces:

jakarta.jms.Message, jakarta.jms.ObjectMessage

public class SQSObjectMessage
extends SQSMessage
implements jakarta.jms.ObjectMessage

An ObjectMessage object is used to send a message that contains a Java serializable object.

It inherits from the Message interface and adds a body containing a single reference to an object. Only Serializable Java objects can be used.

When a client receives an ObjectMessage, 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
SQSObjectMessage()	Create new empty ObjectMessage to send.
SQSObjectMessage(Acknowledger acknowledger, String queueUrl, software.amazon.awssdk.services.sqs.model.Message sqsMessage)	Convert received SQSMessage into ObjectMessage
SQSObjectMessage(Serializable payload)	Create new ObjectMessage with payload to send.

Method Summary

Modifier and Type	Method	Description
void	clearBody()	Sets the message body to write mode, and sets the object body to null
protected static Serializable	deserialize(String serialized)	Deserialize the String into Serializable object.
String	getMessageBody()
Serializable	getObject()	Gets the Serializable containing this message's body
protected static String	serialize(Serializable serializable)	Serialize the Serializable object to String.
void	setObject(Serializable payload)	Sets the Serializable 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

SQSObjectMessage

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

Convert received SQSMessage into ObjectMessage

Throws:

jakarta.jms.JMSException

SQSObjectMessage

public SQSObjectMessage()
                 throws jakarta.jms.JMSException

Create new empty ObjectMessage to send.

Throws:

jakarta.jms.JMSException

SQSObjectMessage

public SQSObjectMessage(Serializable payload)
                 throws jakarta.jms.JMSException

Create new ObjectMessage with payload to send.

Throws:

jakarta.jms.JMSException

Method Details

setObject

public void setObject(Serializable payload)
               throws jakarta.jms.JMSException

Sets the Serializable containing this message's body

Specified by:

setObject in interface jakarta.jms.ObjectMessage

Parameters:

payload - The Serializable containing the message's body

Throws:

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

jakarta.jms.MessageFormatException - If object serialization fails.

jakarta.jms.JMSException

getObject

public Serializable getObject()
                       throws jakarta.jms.JMSException

Gets the Serializable containing this message's body

Specified by:

getObject in interface jakarta.jms.ObjectMessage

Throws:

jakarta.jms.MessageFormatException - If object deserialization fails.

jakarta.jms.JMSException

clearBody

public void clearBody()
               throws jakarta.jms.JMSException

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

Specified by:

clearBody in interface jakarta.jms.Message

Overrides:

clearBody in class SQSMessage

Throws:

jakarta.jms.JMSException - If directly called

deserialize

protected static Serializable deserialize(String serialized)
                                   throws jakarta.jms.JMSException

Deserialize the String into Serializable object.

Throws:

jakarta.jms.JMSException

serialize

protected static String serialize(Serializable serializable)
                           throws jakarta.jms.JMSException

Serialize the Serializable object to String.

Throws:

jakarta.jms.JMSException

getMessageBody

public String getMessageBody()