Package org.apache.activemq.artemis.jms.client

Class ActiveMQObjectMessage

java.lang.Object

org.apache.activemq.artemis.jms.client.ActiveMQMessage

org.apache.activemq.artemis.jms.client.ActiveMQObjectMessage

All Implemented Interfaces:

Message, ObjectMessage

Direct Known Subclasses:

ActiveMQObjectCompatibleMessage

public class ActiveMQObjectMessage
extends ActiveMQMessage
implements ObjectMessage

ActiveMQ Artemis implementation of a JMS ObjectMessage.
Don't used ObjectMessage if you want good performance!

Serialization is slooooow!

Field Summary

Fields

Modifier and Type	Field	Description
static byte	TYPE

Fields inherited from class org.apache.activemq.artemis.jms.client.ActiveMQMessage

message, OLD_QUEUE_QUALIFIED_PREFIX, OLD_TEMP_QUEUE_QUALIFED_PREFIX, OLD_TEMP_TOPIC_QUALIFED_PREFIX, OLD_TOPIC_QUALIFIED_PREFIX, propertiesReadOnly, readOnly, replyTo

Fields inherited from interface jakarta.jms.Message

DEFAULT_DELIVERY_DELAY, DEFAULT_DELIVERY_MODE, DEFAULT_PRIORITY, DEFAULT_TIME_TO_LIVE

Constructor Summary

Constructors

Modifier	Constructor	Description
	ActiveMQObjectMessage(ObjectMessage foreign, ClientSession session, ConnectionFactoryOptions options)	A copy constructor for foreign JMS ObjectMessages.
protected	ActiveMQObjectMessage(ClientMessage message, ClientSession session, ConnectionFactoryOptions options)
protected	ActiveMQObjectMessage(ClientSession session, ConnectionFactoryOptions options)

Method Summary

Modifier and Type	Method	Description
void	clearBody()	Clears out the message body.
void	doBeforeReceive()
void	doBeforeSend()
protected <T> T	getBodyInternal(Class<T> c)
Serializable	getObject()	Gets the serializable object containing this message's data.
byte	getType()
boolean	isBodyAssignableTo(Class c)	Returns whether the message body is capable of being assigned to the specified type.
void	setObject(Serializable object)	Sets the serializable object containing this message's data.

Methods inherited from class org.apache.activemq.artemis.jms.client.ActiveMQMessage

acknowledge, checkBuffer, checkPrefix, checkPrefixStr, checkRead, checkWrite, clearProperties, coreCompositeTypeToJMSCompositeType, coreMaptoJMSMap, createMessage, createMessage, getBody, getBooleanProperty, getByteProperty, getCoreMessage, getDoubleProperty, getFloatProperty, getIntProperty, getJMSCorrelationID, getJMSCorrelationIDAsBytes, getJMSDeliveryMode, getJMSDeliveryTime, getJMSDestination, getJMSExpiration, getJMSMessageID, getJMSPriority, getJMSRedelivered, getJMSReplyTo, getJMSTimestamp, getJMSType, getLongProperty, getObjectProperty, getPropertyNames, getShortProperty, getStringProperty, hasNoBody, prefixOf, propertyExists, resetMessageID, saveToOutputStream, setBooleanProperty, setByteProperty, setClientAcknowledge, setDoubleProperty, setFloatProperty, setIndividualAcknowledge, setInputStream, setIntProperty, setJMSCorrelationID, setJMSCorrelationIDAsBytes, setJMSDeliveryMode, setJMSDeliveryTime, setJMSDestination, setJMSExpiration, setJMSMessageID, setJMSPriority, setJMSRedelivered, setJMSReplyTo, setJMSTimestamp, setJMSType, setLongProperty, setObjectProperty, setOutputStream, setShortProperty, setStringProperty, toString, waitCompletionOnStream

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface jakarta.jms.Message

acknowledge, clearProperties, getBody, getBooleanProperty, getByteProperty, getDoubleProperty, getFloatProperty, getIntProperty, getJMSCorrelationID, getJMSCorrelationIDAsBytes, getJMSDeliveryMode, getJMSDeliveryTime, getJMSDestination, getJMSExpiration, getJMSMessageID, getJMSPriority, getJMSRedelivered, getJMSReplyTo, getJMSTimestamp, getJMSType, getLongProperty, getObjectProperty, getPropertyNames, getShortProperty, getStringProperty, propertyExists, setBooleanProperty, setByteProperty, setDoubleProperty, setFloatProperty, setIntProperty, setJMSCorrelationID, setJMSCorrelationIDAsBytes, setJMSDeliveryMode, setJMSDeliveryTime, setJMSDestination, setJMSExpiration, setJMSMessageID, setJMSPriority, setJMSRedelivered, setJMSReplyTo, setJMSTimestamp, setJMSType, setLongProperty, setObjectProperty, setShortProperty, setStringProperty

Field Detail

TYPE

public static final byte TYPE

See Also:

Constant Field Values

Constructor Detail

ActiveMQObjectMessage

protected ActiveMQObjectMessage(ClientSession session,
                                ConnectionFactoryOptions options)

ActiveMQObjectMessage

protected ActiveMQObjectMessage(ClientMessage message,
                                ClientSession session,
                                ConnectionFactoryOptions options)

ActiveMQObjectMessage

public ActiveMQObjectMessage(ObjectMessage foreign,
                             ClientSession session,
                             ConnectionFactoryOptions options)
                      throws JMSException

A copy constructor for foreign JMS ObjectMessages.

Throws:

JMSException

Method Detail

getType

public byte getType()

Overrides:

getType in class ActiveMQMessage

doBeforeSend

public void doBeforeSend()
                  throws Exception

Overrides:

doBeforeSend in class ActiveMQMessage

Throws:

Exception

doBeforeReceive

public void doBeforeReceive()
                     throws ActiveMQException

Overrides:

doBeforeReceive in class ActiveMQMessage

Throws:

ActiveMQException

setObject

public void setObject(Serializable object)
               throws JMSException

Description copied from interface: ObjectMessage

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:

object - the message's data

Throws:

JMSException - if the Jakarta Messaging 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

Description copied from interface: ObjectMessage

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 - if the Jakarta Messaging provider fails to get the object due to some internal error.

MessageFormatException - if object deserialization fails.

clearBody

public void clearBody()
               throws JMSException

Description copied from interface: Message

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 ActiveMQMessage

Throws:

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

getBodyInternal

protected <T> T getBodyInternal(Class<T> c)
                         throws MessageFormatException

Overrides:

getBodyInternal in class ActiveMQMessage

Throws:

MessageFormatException

isBodyAssignableTo

public boolean isBodyAssignableTo(Class c)

Description copied from interface: Message

Returns whether the message body is capable of being assigned to the specified type. If this method returns true then a subsequent call to the method getBody on the same message with the same type argument would not throw a MessageFormatException.

If the message is a StreamMessage then false is always returned. If the message is a ObjectMessage and object deserialization fails then false is returned. If the message has no body then any type may be specified and true is returned.

Specified by:

isBodyAssignableTo in interface Message

Overrides:

isBodyAssignableTo in class ActiveMQMessage

Parameters:

c - The specified type
If the message is a TextMessage then this method will only return true if this parameter is set to String.class or another type to which a String is assignable.
If the message is a ObjectMessage then this method will only return true if this parameter is set to java.io.Serializable.class or another class to which the body is assignable.
If the message is a MapMessage then this method will only return true if this parameter is set to java.util.Map.class (or java.lang.Object.class).
If the message is a BytesMessage then this this method will only return true if this parameter is set to byte[].class (or java.lang.Object.class).
If the message is a TextMessage, ObjectMessage, MapMessage or BytesMessage and the message has no body, then the above does not apply and this method will return true irrespective of the value of this parameter.
If the message is a Message (but not one of its subtypes) then this method will return true irrespective of the value of this parameter.

Returns:

whether the message body is capable of being assigned to the specified type