com.solacesystems.jms.message

Class SolObjectMessage

java.lang.Object

com.solacesystems.jms.message.SolMessage

com.solacesystems.jms.message.SolObjectMessage

All Implemented Interfaces:

ObjectMessageIF, Serializable, Message, ObjectMessage

public class SolObjectMessage
extends SolMessage
implements ObjectMessageIF

See Also:

Serialized Form

Field Summary

Fields inherited from class com.solacesystems.jms.message.SolMessage

JMSMessageIDPrefix, PRORITY_MAX, PRORITY_UNDEFINED

Fields inherited from interface javax.jms.Message

DEFAULT_DELIVERY_MODE, DEFAULT_PRIORITY, DEFAULT_TIME_TO_LIVE

Constructor Summary

Constructors

Constructor and Description
SolObjectMessage()
SolObjectMessage(BytesXMLMessage message)

Method Summary

Modifier and Type	Method and Description
void	clearBody() Clears out the message body.
Serializable	getObject() Gets the serializable object containing this message's data.
byte[]	getSerializedObject()
void	setObject(Serializable newObject) Sets the serializable object containing this message's data.

Methods inherited from class com.solacesystems.jms.message.SolMessage

acknowledge, clearProperties, dump, getBooleanProperty, getByteProperty, getDoubleProperty, getFloatProperty, getHTTPContentEncoding, getHTTPContentType, getIntProperty, getJMSCorrelationID, getJMSCorrelationIDAsBytes, getJMSDeliveryMode, getJMSDestination, getJMSExpiration, getJMSMessageID, getJMSPriority, getJMSRedelivered, getJMSReplyTo, getJMSTimestamp, getJMSType, getJMSXDeliveryCount, getLongProperty, getMessage, getMessageSize, getObjectProperty, getProperties, getPropertyNames, getSenderID, getShortProperty, getStringProperty, isDMQEligible, isDTO, isElidingEligible, isReplyMsg, isXML, propertyExists, removeProperty, setAckHandler, setBooleanProperty, setByteProperty, setDiscardIndication, setDoubleProperty, setFloatProperty, setHTTPContentEncoding, setHTTPContentType, setIntProperty, setIsDMQEligible, setIsDTO, setIsElidingEligible, setIsReplyMsg, setIsXML, setJMSCorrelationID, setJMSCorrelationIDAsBytes, setJMSDeliveryMode, setJMSDestination, setJMSExpiration, setJMSMessageID, setJMSPriority, setJMSRedelivered, setJMSReplyTo, setJMSTimestamp, setJMSType, setJMSXDeliveryCount, setLongProperty, setObjectProperty, setObjectPropertyWithoutReadOnlyCheck, setSenderID, setShortProperty, setStringProperty, setTopicSequenceNumber, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, 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

Constructor Detail

SolObjectMessage

public SolObjectMessage()

SolObjectMessage

public SolObjectMessage(BytesXMLMessage message)

Method Detail

getSerializedObject

public byte[] getSerializedObject()

Specified by:

getSerializedObject in interface ObjectMessageIF

clearBody

public void clearBody()
               throws 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 Message

Overrides:

clearBody in class SolMessage

Throws:

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

setObject

public void setObject(Serializable newObject)
               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.

Specified by:

setObject in interface ObjectMessage

Parameters:

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

public Serializable getObject()
                       throws JMSException

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

Specified by:

getObject in interface ObjectMessage

Returns:

the serializable object containing this message's data

Throws:

JMSException - on error