org.fusesource.stompjms.message
Class StompJmsObjectMessage

java.lang.Object
  org.fusesource.stompjms.message.StompJmsMessage
      org.fusesource.stompjms.message.StompJmsObjectMessage

All Implemented Interfaces:

javax.jms.Message, javax.jms.ObjectMessage

public class StompJmsObjectMessage
extends StompJmsMessage
implements javax.jms.ObjectMessage

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.

See Also:

Session.createObjectMessage(), Session.createObjectMessage(Serializable), BytesMessage, MapMessage, Message, StreamMessage, TextMessage

Nested Class Summary

Nested classes/interfaces inherited from class org.fusesource.stompjms.message.StompJmsMessage

StompJmsMessage.JmsMsgType

Field Summary

protected java.io.Serializable

object

Fields inherited from class org.fusesource.stompjms.message.StompJmsMessage

acknowledgeCallback, frame, properties, readOnlyBody, readOnlyProperties, redeliveryCounter, transactionId

Fields inherited from interface javax.jms.Message

DEFAULT_DELIVERY_MODE, DEFAULT_PRIORITY, DEFAULT_TIME_TO_LIVE

Constructor Summary

StompJmsObjectMessage()

Method Summary

void	clearBody() Clears out the message body.
StompJmsMessage	copy()
StompJmsMessage.JmsMsgType	getMsgType()
java.io.Serializable	getObject() Gets the serializable object containing this message's data.
void	setObject(java.io.Serializable newObject) Sets the serializable object containing this message's data.
void	storeContent() serialize the payload
java.lang.String	toString()

Methods inherited from class org.fusesource.stompjms.message.StompJmsMessage

acknowledge, checkReadOnlyBody, checkValidObject, clearProperties, copy, decodeString, encodeString, equals, getAcknowledgeCallback, getAllPropertyNames, getBooleanProperty, getByteProperty, getConsumerId, getContent, getDoubleProperty, getFloatProperty, getFrame, getIntProperty, getJMSCorrelationID, getJMSCorrelationIDAsBytes, getJMSDeliveryMode, getJMSDestination, getJMSExpiration, getJMSMessageID, getJMSPriority, getJMSRedelivered, getJMSReplyTo, getJMSTimestamp, getJMSType, getLongProperty, getMessageID, getObjectProperty, getProperties, getPropertyNames, getRedeliveryCounter, getShortProperty, getStompJmsDestination, getStompJmsReplyTo, getStringProperty, getTransactionId, hashCode, incrementRedeliveryCounter, isPersistent, isRedelivered, lazyCreateProperties, onSend, propertyExists, removeProperty, setAcknowledgeCallback, setBooleanProperty, setBooleanProperty, setByteProperty, setContent, setDoubleProperty, setFloatProperty, setFrame, setIntProperty, setJMSCorrelationID, setJMSCorrelationIDAsBytes, setJMSDeliveryMode, setJMSDestination, setJMSDestination, setJMSExpiration, setJMSMessageID, setJMSPriority, setJMSRedelivered, setJMSReplyTo, setJMSReplyTo, setJMSTimestamp, setJMSType, setLongProperty, setMessageID, setObjectProperty, setObjectProperty, setPersistent, setProperties, setProperty, setReadOnlyBody, setReadOnlyProperties, setRedelivered, setRedeliveryCounter, setShortProperty, setStringProperty, setTransactionId

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface javax.jms.Message

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

Field Detail

object

protected transient java.io.Serializable object

Constructor Detail

StompJmsObjectMessage

public StompJmsObjectMessage()

Method Detail

getMsgType

public StompJmsMessage.JmsMsgType getMsgType()

Overrides:

getMsgType in class StompJmsMessage

copy

public StompJmsMessage copy()
                     throws javax.jms.JMSException

Overrides:

copy in class StompJmsMessage

Throws:

javax.jms.JMSException

storeContent

public void storeContent()
                  throws javax.jms.JMSException

Description copied from class: StompJmsMessage

serialize the payload

Overrides:

storeContent in class StompJmsMessage

Throws:

javax.jms.JMSException

clearBody

public void clearBody()
               throws javax.jms.JMSException

Clears out the message body. Clearing a message's body does not clear its header values or property entries.

If this message body was read-only, calling this method leaves the message body in the same state as an empty body in a newly created message.

Specified by:

clearBody in interface javax.jms.Message

Overrides:

clearBody in class StompJmsMessage

Throws:

javax.jms.JMSException - if the JMS provider fails to clear the message body due to some internal error.

setObject

public void setObject(java.io.Serializable newObject)
               throws javax.jms.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.

Specified by:

setObject in interface javax.jms.ObjectMessage

Parameters:

newObject - the message's data

Throws:

javax.jms.JMSException - if the JMS provider fails to set the object due to some internal error.

javax.jms.MessageFormatException - if object serialization fails.

javax.jms.MessageNotWriteableException - if the message is in read-only mode.

getObject

public java.io.Serializable getObject()
                               throws javax.jms.JMSException

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

Specified by:

getObject in interface javax.jms.ObjectMessage

Returns:

the serializable object containing this message's data

Throws:

javax.jms.JMSException

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object