File Doc Category Size Date Package
ObjectMessage.java API Doc Glassfish v2 API 4562 Fri May 04 22:36:16 BST 2007 javax.jms

ObjectMessage

public interface ObjectMessage implements Message

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.

version: 1.0 - 6 August 1998
author: Mark Hapner
author: Rich Burridge
see: javax.jms.Session#createObjectMessage()
see: javax.jms.Session#createObjectMessage(Serializable)
see: javax.jms.BytesMessage
see: javax.jms.MapMessage
see: javax.jms.Message
see: javax.jms.StreamMessage
see: javax.jms.TextMessage

Fields Summary
Constructors Summary
Methods Summary
public java.io.Serializable getObject()
Gets the serializable object containing this message's data. The default value is null.
return
the serializable object containing this message's data
exception
JMSException if the JMS provider fails to get the object due to some internal error.
exception
MessageFormatException if object deserialization fails.
public void setObject(java.io.Serializable object)
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.
param
object the message's data
exception
JMSException if the JMS provider fails to set the object due to some internal error.
exception
MessageFormatException if object serialization fails.
exception
MessageNotWriteableException if the message is in read-only mode.