Top Description Fields Methods
jakarta.jms

public Interface ObjectMessage

extends Message
Imports
java.io.Serializable
An 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.

Since
JMS 1.0
Version
Jakarta Messaging 2.0
See Also
jakarta.jms.Session#createObjectMessage(), jakarta.jms.Session#createObjectMessage(Serializable), jakarta.jms.BytesMessage, jakarta.jms.MapMessage, jakarta.jms.Message, jakarta.jms.StreamMessage, jakarta.jms.TextMessage

Field Summary

Inherited from jakarta.jms.Message:
DEFAULT_DELIVERY_DELAYDEFAULT_DELIVERY_MODEDEFAULT_PRIORITYDEFAULT_TIME_TO_LIVE

Method Summary

Modifier and TypeMethod and Description
public Serializable

Returns:

the serializable object containing this message's data
getObject()

Gets the serializable object containing this message's data.

public void
setObject(Serializable
the message's data
object)

Sets the serializable object containing this message's data.

Inherited from jakarta.jms.Message:
acknowledgeclearBodyclearPropertiesgetBodygetBooleanPropertygetBytePropertygetDoublePropertygetFloatPropertygetIntPropertygetJMSCorrelationIDgetJMSCorrelationIDAsBytesgetJMSDeliveryModegetJMSDeliveryTimegetJMSDestinationgetJMSExpirationgetJMSMessageIDgetJMSPrioritygetJMSRedeliveredgetJMSReplyTogetJMSTimestampgetJMSTypegetLongPropertygetObjectPropertygetPropertyNamesgetShortPropertygetStringPropertyisBodyAssignableTopropertyExistssetBooleanPropertysetBytePropertysetDoublePropertysetFloatPropertysetIntPropertysetJMSCorrelationIDsetJMSCorrelationIDAsBytessetJMSDeliveryModesetJMSDeliveryTimesetJMSDestinationsetJMSExpirationsetJMSMessageIDsetJMSPrioritysetJMSRedeliveredsetJMSReplyTosetJMSTimestampsetJMSTypesetLongPropertysetObjectPropertysetShortPropertysetStringProperty

Method Detail

getObjectback to summary
public Serializable getObject() throws JMSException

Gets the serializable object containing this message's data. The default value is null.

Returns:Serializable

the serializable object containing this message's data

Exceptions
JMSException:
if the Jakarta Messaging provider fails to get the object due to some internal error.
MessageFormatException:
if object deserialization fails.
setObjectback to summary
public void setObject(Serializable object) throws JMSException

Sets the serializable object containing this message's data. It is important to note that an 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.

Parameters
object:Serializable

the message's data

Exceptions
JMSException:
if the Jakarta Messaging 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.