Package javax.jms
Interface ObjectMessage
-
- All Superinterfaces:
Message
public interface ObjectMessage extends Message
AnObjectMessageobject is used to send a message that contains a serializable object in the Java programming language ("Java object"). It inherits from theMessageinterface and adds a body containing a single reference to an object. OnlySerializableJava objects can be used.If a collection of Java objects must be sent, one of the
Collectionclasses 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, aMessageNotWriteableExceptionis thrown. IfclearBodyis called, the message can now be both read from and written to.
-
-
Field Summary
-
Fields inherited from interface javax.jms.Message
DEFAULT_DELIVERY_MODE, DEFAULT_PRIORITY, DEFAULT_TIME_TO_LIVE
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.io.SerializablegetObject()Gets the serializable object containing this message's data.voidsetObject(java.io.Serializable object)Sets the serializable object containing this message's data.-
Methods inherited from interface javax.jms.Message
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
-
-
-
-
Method Detail
-
setObject
void setObject(java.io.Serializable object) throws JMSExceptionSets the serializable object containing this message's data. It is important to note that anObjectMessagecontains a snapshot of the object at the timesetObject()is called; subsequent modifications of the object will have no effect on theObjectMessagebody.- Parameters:
object- the message's data- Throws:
JMSException- 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.
-
getObject
java.io.Serializable getObject() throws JMSExceptionGets the serializable object containing this message's data. The default value is null.- Returns:
- the serializable object containing this message's data
- Throws:
JMSException- if the JMS provider fails to get the object due to some internal error.MessageFormatException- if object deserialization fails.
-
-