public interface ObjectMessage extends Message
ObjectMessage
object is used to send a message that contains
a serializable object in the Java programming language ("Java 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.
If a collection of Java objects must be sent, one of the
Collection
classes provided since JDK 1.2 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.
Session.createObjectMessage()
,
Session.createObjectMessage(Serializable)
,
BytesMessage
,
MapMessage
,
Message
,
StreamMessage
,
TextMessage
DEFAULT_DELIVERY_MODE, DEFAULT_PRIORITY, DEFAULT_TIME_TO_LIVE
Modifier and Type | Method and Description |
---|---|
Serializable |
getObject()
Gets the serializable object containing this message's data.
|
void |
setObject(Serializable object)
Sets the serializable object containing this message's data.
|
acknowledge, clearBody, clearProperties, getBooleanProperty, getByteProperty, getDoubleProperty, getFloatProperty, getIntProperty, getJMSCorrelationID, getJMSCorrelationIDAsBytes, getJMSDeliveryMode, getJMSDestination, getJMSExpiration, getJMSMessageID, getJMSPriority, getJMSRedelivered, getJMSReplyTo, getJMSTimestamp, getJMSType, getLongProperty, getObjectProperty, getPropertyNames, getShortProperty, getStringProperty, propertyExists, setBooleanProperty, setByteProperty, setDoubleProperty, setFloatProperty, setIntProperty, setJMSCorrelationID, setJMSCorrelationIDAsBytes, setJMSDeliveryMode, setJMSDestination, setJMSExpiration, setJMSMessageID, setJMSPriority, setJMSRedelivered, setJMSReplyTo, setJMSTimestamp, setJMSType, setLongProperty, setObjectProperty, setShortProperty, setStringProperty
void setObject(Serializable object) throws JMSException
ObjectMessage
contains a snapshot of the object at the time setObject()
is called; subsequent modifications of the object will have no
effect on the ObjectMessage
body.object
- the message's dataJMSException
- if the JMS provider fails to set the object
due to some internal error.MessageFormatException
- if object serialization fails.MessageNotWriteableException
- if the message is in read-only
mode.Serializable getObject() throws JMSException
JMSException
- if the JMS provider fails to get the object
due to some internal error.MessageFormatException
- if object deserialization fails.Copyright 2004-2024 Solace Corporation. All rights reserved.