Package org.apache.activemq.command

Class ActiveMQMessage

java.lang.Object

org.apache.activemq.command.BaseCommand

org.apache.activemq.command.Message

org.apache.activemq.command.ActiveMQMessage

All Implemented Interfaces:

jakarta.jms.Message, MessageReference, Command, DataStructure, MarshallAware, Message, ScheduledMessage

Direct Known Subclasses:

ActiveMQBlobMessage, ActiveMQBytesMessage, ActiveMQMapMessage, ActiveMQObjectMessage, ActiveMQStreamMessage, ActiveMQTextMessage

public class ActiveMQMessage
extends Message
implements Message, ScheduledMessage

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.activemq.command.Message

Message.MessageDestination

Field Summary

Fields

Modifier and Type	Field	Description
protected Callback	acknowledgeCallback
static final String	BROKER_PATH_PROPERTY
static final byte	DATA_STRUCTURE_TYPE
static final String	DLQ_DELIVERY_FAILURE_CAUSE_PROPERTY

Fields inherited from class org.apache.activemq.command.Message

arrival, brokerInTime, brokerOutTime, compressed, content, correlationId, dataStructure, DEFAULT_MINIMUM_MESSAGE_SIZE, deliveryTime, destination, droppable, expiration, groupID, groupSequence, jmsXGroupFirstForConsumer, marshalledProperties, messageId, ORIGINAL_EXPIRATION, originalDestination, originalTransactionId, persistent, priority, producerId, properties, readOnlyBody, readOnlyProperties, recievedByDFBridge, redeliveryCounter, replyTo, size, targetConsumerId, timestamp, transactionId, type, userID

Fields inherited from class org.apache.activemq.command.BaseCommand

commandId, responseRequired

Fields inherited from interface jakarta.jms.Message

DEFAULT_DELIVERY_DELAY, DEFAULT_DELIVERY_MODE, DEFAULT_PRIORITY, DEFAULT_TIME_TO_LIVE

Fields inherited from interface org.apache.activemq.ScheduledMessage

AMQ_SCHEDULED_CRON, AMQ_SCHEDULED_DELAY, AMQ_SCHEDULED_ID, AMQ_SCHEDULED_PERIOD, AMQ_SCHEDULED_REPEAT, AMQ_SCHEDULER_ACTION, AMQ_SCHEDULER_ACTION_BROWSE, AMQ_SCHEDULER_ACTION_END_TIME, AMQ_SCHEDULER_ACTION_REMOVE, AMQ_SCHEDULER_ACTION_REMOVEALL, AMQ_SCHEDULER_ACTION_START_TIME, AMQ_SCHEDULER_MANAGEMENT_DESTINATION

Constructor Summary

Constructors

Constructor	Description
ActiveMQMessage()

Method Summary

Modifier and Type	Method	Description
void	acknowledge()
protected void	checkReadOnlyBody()
protected void	checkReadOnlyProperties()
protected void	checkValidObject(Object value)
void	clearBody()
void	clearProperties()
protected Object	convertScheduled(String name, Object value)
Message	copy()
protected void	copy(ActiveMQMessage copy)
protected static String	decodeString(byte[] data)
protected <T> T	doGetBody(Class<T> asType)
protected static byte[]	encodeString(String data)
boolean	equals(Object o)
Callback	getAcknowledgeCallback()
Enumeration	getAllPropertyNames()	return all property names, including standard JMS properties and JMSX properties
final <T> T	getBody(Class<T> asType)
boolean	getBooleanProperty(String name)
byte	getByteProperty(String name)
byte	getDataStructureType()
double	getDoubleProperty(String name)
float	getFloatProperty(String name)
int	getIntProperty(String name)
String	getJMSCorrelationID()
byte[]	getJMSCorrelationIDAsBytes()
int	getJMSDeliveryMode()
long	getJMSDeliveryTime()
jakarta.jms.Destination	getJMSDestination()
long	getJMSExpiration()
String	getJMSMessageID()
int	getJMSPriority()
boolean	getJMSRedelivered()
jakarta.jms.Destination	getJMSReplyTo()
long	getJMSTimestamp()
String	getJMSType()
String	getJMSXMimeType()	Returns the MIME type of this mesage.
long	getLongProperty(String name)
Object	getObjectProperty(String name)
Enumeration	getPropertyNames()
short	getShortProperty(String name)
String	getStringProperty(String name)
int	hashCode()
boolean	isBodyAssignableTo(Class c)
protected boolean	isContentMarshalled()
void	onSend()	Send operation event listener.
boolean	propertyExists(String name)
void	setAcknowledgeCallback(Callback acknowledgeCallback)
void	setBooleanProperty(String name, boolean value)
void	setBooleanProperty(String name, boolean value, boolean checkReadOnly)
void	setByteProperty(String name, byte value)
void	setDoubleProperty(String name, double value)
void	setFloatProperty(String name, float value)
void	setIntProperty(String name, int value)
void	setJMSCorrelationID(String correlationId)
void	setJMSCorrelationIDAsBytes(byte[] correlationId)
void	setJMSDeliveryMode(int mode)
void	setJMSDeliveryTime(long deliveryTime)
void	setJMSDestination(jakarta.jms.Destination destination)
void	setJMSExpiration(long expiration)
void	setJMSMessageID(String value)	Seems to be invalid because the parameter doesn't initialize MessageId instance variables ProducerId and ProducerSequenceId
void	setJMSMessageID(ProducerId producerId, long producerSequenceId)	This will create an object of MessageId.
void	setJMSPriority(int priority)
void	setJMSRedelivered(boolean redelivered)
void	setJMSReplyTo(jakarta.jms.Destination destination)
void	setJMSTimestamp(long timestamp)
void	setJMSType(String type)
void	setLongProperty(String name, long value)
void	setObjectProperty(String name, Object value)
void	setObjectProperty(String name, Object value, boolean checkReadOnly)
void	setProperties(Map<String,?> properties)
void	setShortProperty(String name, short value)
void	setStringProperty(String name, String value)
void	storeContent()
void	storeContentAndClear()
Response	visit(CommandVisitor visitor)

Methods inherited from class org.apache.activemq.command.Message

afterMarshall, afterUnmarshall, beforeMarshall, beforeUnmarshall, canProcessAsExpired, clearUnMarshalledState, compress, copy, decrementReferenceCount, doCompress, getArrival, getBrokerInTime, getBrokerOutTime, getBrokerPath, getCluster, getConnection, getContent, getCorrelationId, getDataStructure, getDestination, getExpiration, getGroupID, getGroupSequence, getMarshalledProperties, getMemoryUsage, getMessage, getMessageHardRef, getMessageId, getMinimumMessageSize, getOriginalDestination, getOriginalTransactionId, getPriority, getProducerId, getProperties, getProperty, getRedeliveryCounter, getReferenceCount, getRegionDestination, getReplyTo, getSize, getTargetConsumerId, getTimestamp, getTransactionId, getType, getUserID, incrementRedeliveryCounter, incrementReferenceCount, isAdvisory, isCompressed, isDroppable, isDropped, isExpired, isInTransaction, isJMSXGroupFirstForConsumer, isMarshallAware, isMarshalled, isMessage, isPersistent, isPropertiesMarshalled, isReadOnlyBody, isReadOnlyProperties, isRecievedByDFBridge, isRedelivered, lazyCreateProperties, onMessageRolledBack, readResolve, removeProperty, setArrival, setBrokerInTime, setBrokerOutTime, setBrokerPath, setCluster, setCompressed, setConnection, setContent, setCorrelationId, setDataStructure, setDestination, setDroppable, setExpiration, setGroupID, setGroupSequence, setJMSXGroupFirstForConsumer, setMarshalledProperties, setMemoryUsage, setMessageId, setOriginalDestination, setOriginalTransactionId, setPersistent, setPriority, setProducerId, setProperty, setReadOnlyBody, setReadOnlyProperties, setRecievedByDFBridge, setRedelivered, setRedeliveryCounter, setRegionDestination, setReplyTo, setTargetConsumerId, setTimestamp, setTransactionId, setType, setUserID, toString, toString

Methods inherited from class org.apache.activemq.command.BaseCommand

copy, getCommandId, getFrom, getTo, isBrokerInfo, isConnectionControl, isConsumerControl, isMessageAck, isMessageDispatch, isMessageDispatchNotification, isResponse, isResponseRequired, isShutdownInfo, isWireFormatInfo, setCommandId, setFrom, setResponseRequired, setTo

Methods inherited from class java.lang.Object

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

Field Details

DATA_STRUCTURE_TYPE

public static final byte DATA_STRUCTURE_TYPE

See Also:

• Constant Field Values

DLQ_DELIVERY_FAILURE_CAUSE_PROPERTY

public static final String DLQ_DELIVERY_FAILURE_CAUSE_PROPERTY

See Also:

• Constant Field Values

BROKER_PATH_PROPERTY

public static final String BROKER_PATH_PROPERTY

See Also:

• Constant Field Values

acknowledgeCallback

protected transient Callback acknowledgeCallback

Constructor Details

ActiveMQMessage

public ActiveMQMessage()

Method Details

getDataStructureType

public byte getDataStructureType()

Specified by:

getDataStructureType in interface DataStructure

Returns:

The type of the data structure

copy

public Message copy()

Specified by:

copy in class Message

copy

protected void copy(ActiveMQMessage copy)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

acknowledge

public void acknowledge()
                 throws jakarta.jms.JMSException

Specified by:

acknowledge in interface jakarta.jms.Message

Throws:

jakarta.jms.JMSException

clearBody

public void clearBody()
               throws jakarta.jms.JMSException

Specified by:

clearBody in interface jakarta.jms.Message

Specified by:

clearBody in class Message

Throws:

jakarta.jms.JMSException

getJMSMessageID

public String getJMSMessageID()

Specified by:

getJMSMessageID in interface jakarta.jms.Message

setJMSMessageID

public void setJMSMessageID(String value)
                     throws jakarta.jms.JMSException

Seems to be invalid because the parameter doesn't initialize MessageId instance variables ProducerId and ProducerSequenceId

Specified by:

setJMSMessageID in interface jakarta.jms.Message

Parameters:

value -

Throws:

jakarta.jms.JMSException

setJMSMessageID

public void setJMSMessageID(ProducerId producerId,
 long producerSequenceId)
                     throws jakarta.jms.JMSException

This will create an object of MessageId. For it to be valid, the instance variable ProducerId and producerSequenceId must be initialized.

Parameters:

producerId -

producerSequenceId -

Throws:

jakarta.jms.JMSException

getJMSTimestamp

public long getJMSTimestamp()

Specified by:

getJMSTimestamp in interface jakarta.jms.Message

setJMSTimestamp

public void setJMSTimestamp(long timestamp)

Specified by:

setJMSTimestamp in interface jakarta.jms.Message

getJMSCorrelationID

public String getJMSCorrelationID()

Specified by:

getJMSCorrelationID in interface jakarta.jms.Message

setJMSCorrelationID

public void setJMSCorrelationID(String correlationId)

Specified by:

setJMSCorrelationID in interface jakarta.jms.Message

getJMSCorrelationIDAsBytes

public byte[] getJMSCorrelationIDAsBytes()
                                  throws jakarta.jms.JMSException

Specified by:

getJMSCorrelationIDAsBytes in interface jakarta.jms.Message

Throws:

jakarta.jms.JMSException

setJMSCorrelationIDAsBytes

public void setJMSCorrelationIDAsBytes(byte[] correlationId)
                                throws jakarta.jms.JMSException

Specified by:

setJMSCorrelationIDAsBytes in interface jakarta.jms.Message

Throws:

jakarta.jms.JMSException

getJMSXMimeType

public String getJMSXMimeType()

Description copied from interface: Message

Returns the MIME type of this mesage. This can be used in selectors to filter on the MIME types of the different JMS messages, or in the case of BlobMessage it allows you to create a selector on the MIME type of the BLOB body

Specified by:

getJMSXMimeType in interface Message

decodeString

protected static String decodeString(byte[] data)
                              throws jakarta.jms.JMSException

Throws:

jakarta.jms.JMSException

encodeString

protected static byte[] encodeString(String data)
                              throws jakarta.jms.JMSException

Throws:

jakarta.jms.JMSException

getJMSReplyTo

public jakarta.jms.Destination getJMSReplyTo()

Specified by:

getJMSReplyTo in interface jakarta.jms.Message

setJMSReplyTo

public void setJMSReplyTo(jakarta.jms.Destination destination)
                   throws jakarta.jms.JMSException

Specified by:

setJMSReplyTo in interface jakarta.jms.Message

Throws:

jakarta.jms.JMSException

getJMSDestination

public jakarta.jms.Destination getJMSDestination()

Specified by:

getJMSDestination in interface jakarta.jms.Message

setJMSDestination

public void setJMSDestination(jakarta.jms.Destination destination)
                       throws jakarta.jms.JMSException

Specified by:

setJMSDestination in interface jakarta.jms.Message

Throws:

jakarta.jms.JMSException

getJMSDeliveryMode

public int getJMSDeliveryMode()

Specified by:

getJMSDeliveryMode in interface jakarta.jms.Message

setJMSDeliveryMode

public void setJMSDeliveryMode(int mode)

Specified by:

setJMSDeliveryMode in interface jakarta.jms.Message

getJMSRedelivered

public boolean getJMSRedelivered()

Specified by:

getJMSRedelivered in interface jakarta.jms.Message

setJMSRedelivered

public void setJMSRedelivered(boolean redelivered)

Specified by:

setJMSRedelivered in interface jakarta.jms.Message

getJMSType

public String getJMSType()

Specified by:

getJMSType in interface jakarta.jms.Message

setJMSType

public void setJMSType(String type)

Specified by:

setJMSType in interface jakarta.jms.Message

getJMSExpiration

public long getJMSExpiration()

Specified by:

getJMSExpiration in interface jakarta.jms.Message

setJMSExpiration

public void setJMSExpiration(long expiration)

Specified by:

setJMSExpiration in interface jakarta.jms.Message

getJMSPriority

public int getJMSPriority()

Specified by:

getJMSPriority in interface jakarta.jms.Message

setJMSPriority

public void setJMSPriority(int priority)

Specified by:

setJMSPriority in interface jakarta.jms.Message

clearProperties

public void clearProperties()

Specified by:

clearProperties in interface jakarta.jms.Message

Overrides:

clearProperties in class Message

propertyExists

public boolean propertyExists(String name)
                       throws jakarta.jms.JMSException

Specified by:

propertyExists in interface jakarta.jms.Message

Throws:

jakarta.jms.JMSException

getPropertyNames

public Enumeration getPropertyNames()
                             throws jakarta.jms.JMSException

Specified by:

getPropertyNames in interface jakarta.jms.Message

Throws:

jakarta.jms.JMSException

getAllPropertyNames

public Enumeration getAllPropertyNames()
                                throws jakarta.jms.JMSException

return all property names, including standard JMS properties and JMSX properties

Returns:

Enumeration of all property names on this message

Throws:

jakarta.jms.JMSException

setObjectProperty

public void setObjectProperty(String name,
 Object value)
                       throws jakarta.jms.JMSException

Specified by:

setObjectProperty in interface jakarta.jms.Message

Throws:

jakarta.jms.JMSException

setObjectProperty

public void setObjectProperty(String name,
 Object value,
 boolean checkReadOnly)
                       throws jakarta.jms.JMSException

Throws:

jakarta.jms.JMSException

setProperties

public void setProperties(Map<String,?> properties)
                   throws jakarta.jms.JMSException

Throws:

jakarta.jms.JMSException

checkValidObject

protected void checkValidObject(Object value)
                         throws jakarta.jms.MessageFormatException

Throws:

jakarta.jms.MessageFormatException

convertScheduled

protected Object convertScheduled(String name,
 Object value)
                           throws jakarta.jms.MessageFormatException

Throws:

jakarta.jms.MessageFormatException

getObjectProperty

public Object getObjectProperty(String name)
                         throws jakarta.jms.JMSException

Specified by:

getObjectProperty in interface jakarta.jms.Message

Throws:

jakarta.jms.JMSException

getBooleanProperty

public boolean getBooleanProperty(String name)
                           throws jakarta.jms.JMSException

Specified by:

getBooleanProperty in interface jakarta.jms.Message

Throws:

jakarta.jms.JMSException

getByteProperty

public byte getByteProperty(String name)
                     throws jakarta.jms.JMSException

Specified by:

getByteProperty in interface jakarta.jms.Message

Throws:

jakarta.jms.JMSException

getShortProperty

public short getShortProperty(String name)
                       throws jakarta.jms.JMSException

Specified by:

getShortProperty in interface jakarta.jms.Message

Throws:

jakarta.jms.JMSException

getIntProperty

public int getIntProperty(String name)
                   throws jakarta.jms.JMSException

Specified by:

getIntProperty in interface jakarta.jms.Message

Throws:

jakarta.jms.JMSException

getLongProperty

public long getLongProperty(String name)
                     throws jakarta.jms.JMSException

Specified by:

getLongProperty in interface jakarta.jms.Message

Throws:

jakarta.jms.JMSException

getFloatProperty

public float getFloatProperty(String name)
                       throws jakarta.jms.JMSException

Specified by:

getFloatProperty in interface jakarta.jms.Message

Throws:

jakarta.jms.JMSException

getDoubleProperty

public double getDoubleProperty(String name)
                         throws jakarta.jms.JMSException

Specified by:

getDoubleProperty in interface jakarta.jms.Message

Throws:

jakarta.jms.JMSException

getStringProperty

public String getStringProperty(String name)
                         throws jakarta.jms.JMSException

Specified by:

getStringProperty in interface jakarta.jms.Message

Throws:

jakarta.jms.JMSException

setBooleanProperty

public void setBooleanProperty(String name,
 boolean value)
                        throws jakarta.jms.JMSException

Specified by:

setBooleanProperty in interface jakarta.jms.Message

Throws:

jakarta.jms.JMSException

setBooleanProperty

public void setBooleanProperty(String name,
 boolean value,
 boolean checkReadOnly)
                        throws jakarta.jms.JMSException

Throws:

jakarta.jms.JMSException

setByteProperty

public void setByteProperty(String name,
 byte value)
                     throws jakarta.jms.JMSException

Specified by:

setByteProperty in interface jakarta.jms.Message

Throws:

jakarta.jms.JMSException

setShortProperty

public void setShortProperty(String name,
 short value)
                      throws jakarta.jms.JMSException

Specified by:

setShortProperty in interface jakarta.jms.Message

Throws:

jakarta.jms.JMSException

setIntProperty

public void setIntProperty(String name,
 int value)
                    throws jakarta.jms.JMSException

Specified by:

setIntProperty in interface jakarta.jms.Message

Throws:

jakarta.jms.JMSException

setLongProperty

public void setLongProperty(String name,
 long value)
                     throws jakarta.jms.JMSException

Specified by:

setLongProperty in interface jakarta.jms.Message

Throws:

jakarta.jms.JMSException

setFloatProperty

public void setFloatProperty(String name,
 float value)
                      throws jakarta.jms.JMSException

Specified by:

setFloatProperty in interface jakarta.jms.Message

Throws:

jakarta.jms.JMSException

setDoubleProperty

public void setDoubleProperty(String name,
 double value)
                       throws jakarta.jms.JMSException

Specified by:

setDoubleProperty in interface jakarta.jms.Message

Throws:

jakarta.jms.JMSException

setStringProperty

public void setStringProperty(String name,
 String value)
                       throws jakarta.jms.JMSException

Specified by:

setStringProperty in interface jakarta.jms.Message

Throws:

jakarta.jms.JMSException

checkReadOnlyProperties

protected void checkReadOnlyProperties()
                                throws jakarta.jms.MessageNotWriteableException

Throws:

jakarta.jms.MessageNotWriteableException

checkReadOnlyBody

protected void checkReadOnlyBody()
                          throws jakarta.jms.MessageNotWriteableException

Throws:

jakarta.jms.MessageNotWriteableException

getAcknowledgeCallback

public Callback getAcknowledgeCallback()

setAcknowledgeCallback

public void setAcknowledgeCallback(Callback acknowledgeCallback)

onSend

public void onSend()
            throws jakarta.jms.JMSException

Send operation event listener. Used to get the message ready to be sent.

Throws:

jakarta.jms.JMSException

visit

public Response visit(CommandVisitor visitor)
               throws Exception

Specified by:

visit in interface Command

Throws:

Exception

storeContent

public void storeContent()

Specified by:

storeContent in class Message

storeContentAndClear

public void storeContentAndClear()

Specified by:

storeContentAndClear in class Message

isContentMarshalled

protected boolean isContentMarshalled()

Overrides:

isContentMarshalled in class Message

getJMSDeliveryTime

public long getJMSDeliveryTime()
                        throws jakarta.jms.JMSException

Specified by:

getJMSDeliveryTime in interface jakarta.jms.Message

Throws:

jakarta.jms.JMSException

setJMSDeliveryTime

public void setJMSDeliveryTime(long deliveryTime)
                        throws jakarta.jms.JMSException

Specified by:

setJMSDeliveryTime in interface jakarta.jms.Message

Throws:

jakarta.jms.JMSException

getBody

public final <T> T getBody(Class<T> asType)
                    throws jakarta.jms.JMSException

Specified by:

getBody in interface jakarta.jms.Message

Throws:

jakarta.jms.JMSException

isBodyAssignableTo

public boolean isBodyAssignableTo(Class c)
                           throws jakarta.jms.JMSException

Specified by:

isBodyAssignableTo in interface jakarta.jms.Message

Throws:

jakarta.jms.JMSException

doGetBody

protected <T> T doGetBody(Class<T> asType)
                   throws jakarta.jms.JMSException

Throws:

jakarta.jms.JMSException