javax.jms

Interface ObjectMessage

Contents
  • All Superinterfaces:
    Message

    public interface ObjectMessage
extends 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.

    Since:
    JMS 1.0
    Version:
    JMS 2.0
    See Also:
    Session.createObjectMessage(), Session.createObjectMessage(Serializable), BytesMessage, MapMessage, Message, StreamMessage, TextMessage

    • Method Detail

      • setObject

        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 - 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

        Serializable getObject()
                throws JMSException
        Gets 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.

Document created the 11/06/2005, last modified the 18/08/2025
Source of the printed document:https://www.gaudry.be/en/java-api-javaee-rf-javax/jms/ObjectMessage.html

The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.

References

  1. View the html document Language of the document:fr Manuel PHP : https://docs.oracle.com, ObjectMessage (Java(TM) EE 7 Specification APIs)

These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author of this site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.