Package org.apache.qpid.jms.message.facade

Interface JmsObjectMessageFacade

All Superinterfaces:

JmsMessageFacade, TraceableMessage

All Known Implementing Classes:

AmqpJmsObjectMessageFacade

public interface JmsObjectMessageFacade
extends JmsMessageFacade

Interface for a message Facade that wraps an ObjectMessage based provider message.

Method Summary

Modifier and Type	Method	Description
JmsObjectMessageFacade	copy()	Create a new instance and perform a deep copy of this object's contents.
Serializable	getObject()	Gets the Object value that is contained in the provider message.
void	setObject(Serializable value)	Stores the given object into the provider Message.

Methods inherited from interface org.apache.qpid.jms.message.facade.JmsMessageFacade

clearBody, clearProperties, encodeMessage, getCorrelationId, getCorrelationIdBytes, getDeliveryCount, getDeliveryTime, getDestination, getExpiration, getGroupId, getGroupSequence, getMessageId, getPriority, getProperty, getPropertyNames, getProviderMessageIdObject, getRedeliveryCount, getReplyTo, getTimestamp, getType, getUserId, getUserIdBytes, hasBody, isDeliveryTimeTransmitted, isPersistent, isRedelivered, onDispatch, onSend, propertyExists, setCorrelationId, setCorrelationIdBytes, setDeliveryCount, setDeliveryTime, setDestination, setExpiration, setGroupId, setGroupSequence, setMessageId, setPersistent, setPriority, setProperty, setProviderMessageIdObject, setRedelivered, setRedeliveryCount, setReplyTo, setTimestamp, setType, setUserId, setUserIdBytes

Methods inherited from interface org.apache.qpid.jms.tracing.TraceableMessage

filterTracingAnnotations, getTracingAnnotation, getTracingContext, removeTracingAnnotation, removeTracingContext, setTracingAnnotation, setTracingContext

Method Details

copy

JmsObjectMessageFacade copy()
                     throws jakarta.jms.JMSException

Description copied from interface: JmsMessageFacade

Create a new instance and perform a deep copy of this object's contents.

Specified by:

copy in interface JmsMessageFacade

Returns:

a deep copy of this Message Facade including a complete copy of the byte contents of the wrapped message.

Throws:

jakarta.jms.JMSException - if an error occurs while copying this message.

getObject

Serializable getObject()
                throws IOException,
ClassNotFoundException

Gets the Object value that is contained in the provider message. If the Object is stored in some serialized form then the Provider must de-serialize the object prior to returning it.

Returns:

the de-serialized version of the contained object.

Throws:

IOException - if the provider fails to get the object due to some internal error.

ClassNotFoundException - if object de-serialization fails because the ClassLoader cannot find the Class locally.

setObject

void setObject(Serializable value)
        throws IOException

Stores the given object into the provider Message. In order for the provider to be fully JMS compliant the set Object should be immediately serialized and stored so that future modifications to the object are not reflected in the stored version of the object.

Parameters:

value - the new value to write to the provider message.

Throws:

IOException - if the provider fails to store the object due to some internal error.