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
-
Nested Class Summary
Nested classes/interfaces inherited from class org.apache.activemq.command.Message
Message.MessageDestination
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected Callback
static final String
static final byte
static final String
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 -
Method Summary
Modifier and TypeMethodDescriptionvoid
protected void
protected void
protected void
checkValidObject
(Object value) void
void
protected Object
convertScheduled
(String name, Object value) copy()
protected void
copy
(ActiveMQMessage copy) protected static String
decodeString
(byte[] data) protected <T> T
protected static byte[]
encodeString
(String data) boolean
return all property names, including standard JMS properties and JMSX propertiesfinal <T> T
boolean
getBooleanProperty
(String name) byte
getByteProperty
(String name) byte
double
getDoubleProperty
(String name) float
getFloatProperty
(String name) int
getIntProperty
(String name) byte[]
int
long
jakarta.jms.Destination
long
int
boolean
jakarta.jms.Destination
long
Returns the MIME type of this mesage.long
getLongProperty
(String name) getObjectProperty
(String name) short
getShortProperty
(String name) getStringProperty
(String name) int
hashCode()
boolean
protected boolean
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 ProducerSequenceIdvoid
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
void
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
-
Field Details
-
DATA_STRUCTURE_TYPE
public static final byte DATA_STRUCTURE_TYPE- See Also:
-
DLQ_DELIVERY_FAILURE_CAUSE_PROPERTY
- See Also:
-
BROKER_PATH_PROPERTY
- See Also:
-
acknowledgeCallback
-
-
Constructor Details
-
ActiveMQMessage
public ActiveMQMessage()
-
-
Method Details
-
getDataStructureType
public byte getDataStructureType()- Specified by:
getDataStructureType
in interfaceDataStructure
- Returns:
- The type of the data structure
-
copy
-
copy
-
hashCode
public int hashCode() -
equals
-
acknowledge
public void acknowledge() throws jakarta.jms.JMSException- Specified by:
acknowledge
in interfacejakarta.jms.Message
- Throws:
jakarta.jms.JMSException
-
clearBody
public void clearBody() throws jakarta.jms.JMSException -
getJMSMessageID
- Specified by:
getJMSMessageID
in interfacejakarta.jms.Message
-
setJMSMessageID
Seems to be invalid because the parameter doesn't initialize MessageId instance variables ProducerId and ProducerSequenceId- Specified by:
setJMSMessageID
in interfacejakarta.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 interfacejakarta.jms.Message
-
setJMSTimestamp
public void setJMSTimestamp(long timestamp) - Specified by:
setJMSTimestamp
in interfacejakarta.jms.Message
-
getJMSCorrelationID
- Specified by:
getJMSCorrelationID
in interfacejakarta.jms.Message
-
setJMSCorrelationID
- Specified by:
setJMSCorrelationID
in interfacejakarta.jms.Message
-
getJMSCorrelationIDAsBytes
public byte[] getJMSCorrelationIDAsBytes() throws jakarta.jms.JMSException- Specified by:
getJMSCorrelationIDAsBytes
in interfacejakarta.jms.Message
- Throws:
jakarta.jms.JMSException
-
setJMSCorrelationIDAsBytes
public void setJMSCorrelationIDAsBytes(byte[] correlationId) throws jakarta.jms.JMSException - Specified by:
setJMSCorrelationIDAsBytes
in interfacejakarta.jms.Message
- Throws:
jakarta.jms.JMSException
-
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 ofBlobMessage
it allows you to create a selector on the MIME type of the BLOB body- Specified by:
getJMSXMimeType
in interfaceMessage
-
decodeString
- Throws:
jakarta.jms.JMSException
-
encodeString
- Throws:
jakarta.jms.JMSException
-
getJMSReplyTo
public jakarta.jms.Destination getJMSReplyTo()- Specified by:
getJMSReplyTo
in interfacejakarta.jms.Message
-
setJMSReplyTo
public void setJMSReplyTo(jakarta.jms.Destination destination) throws jakarta.jms.JMSException - Specified by:
setJMSReplyTo
in interfacejakarta.jms.Message
- Throws:
jakarta.jms.JMSException
-
getJMSDestination
public jakarta.jms.Destination getJMSDestination()- Specified by:
getJMSDestination
in interfacejakarta.jms.Message
-
setJMSDestination
public void setJMSDestination(jakarta.jms.Destination destination) throws jakarta.jms.JMSException - Specified by:
setJMSDestination
in interfacejakarta.jms.Message
- Throws:
jakarta.jms.JMSException
-
getJMSDeliveryMode
public int getJMSDeliveryMode()- Specified by:
getJMSDeliveryMode
in interfacejakarta.jms.Message
-
setJMSDeliveryMode
public void setJMSDeliveryMode(int mode) - Specified by:
setJMSDeliveryMode
in interfacejakarta.jms.Message
-
getJMSRedelivered
public boolean getJMSRedelivered()- Specified by:
getJMSRedelivered
in interfacejakarta.jms.Message
-
setJMSRedelivered
public void setJMSRedelivered(boolean redelivered) - Specified by:
setJMSRedelivered
in interfacejakarta.jms.Message
-
getJMSType
- Specified by:
getJMSType
in interfacejakarta.jms.Message
-
setJMSType
- Specified by:
setJMSType
in interfacejakarta.jms.Message
-
getJMSExpiration
public long getJMSExpiration()- Specified by:
getJMSExpiration
in interfacejakarta.jms.Message
-
setJMSExpiration
public void setJMSExpiration(long expiration) - Specified by:
setJMSExpiration
in interfacejakarta.jms.Message
-
getJMSPriority
public int getJMSPriority()- Specified by:
getJMSPriority
in interfacejakarta.jms.Message
-
setJMSPriority
public void setJMSPriority(int priority) - Specified by:
setJMSPriority
in interfacejakarta.jms.Message
-
clearProperties
public void clearProperties()- Specified by:
clearProperties
in interfacejakarta.jms.Message
- Overrides:
clearProperties
in classMessage
-
propertyExists
- Specified by:
propertyExists
in interfacejakarta.jms.Message
- Throws:
jakarta.jms.JMSException
-
getPropertyNames
- Specified by:
getPropertyNames
in interfacejakarta.jms.Message
- Throws:
jakarta.jms.JMSException
-
getAllPropertyNames
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
- Specified by:
setObjectProperty
in interfacejakarta.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
- Throws:
jakarta.jms.JMSException
-
checkValidObject
- Throws:
jakarta.jms.MessageFormatException
-
convertScheduled
protected Object convertScheduled(String name, Object value) throws jakarta.jms.MessageFormatException - Throws:
jakarta.jms.MessageFormatException
-
getObjectProperty
- Specified by:
getObjectProperty
in interfacejakarta.jms.Message
- Throws:
jakarta.jms.JMSException
-
getBooleanProperty
- Specified by:
getBooleanProperty
in interfacejakarta.jms.Message
- Throws:
jakarta.jms.JMSException
-
getByteProperty
- Specified by:
getByteProperty
in interfacejakarta.jms.Message
- Throws:
jakarta.jms.JMSException
-
getShortProperty
- Specified by:
getShortProperty
in interfacejakarta.jms.Message
- Throws:
jakarta.jms.JMSException
-
getIntProperty
- Specified by:
getIntProperty
in interfacejakarta.jms.Message
- Throws:
jakarta.jms.JMSException
-
getLongProperty
- Specified by:
getLongProperty
in interfacejakarta.jms.Message
- Throws:
jakarta.jms.JMSException
-
getFloatProperty
- Specified by:
getFloatProperty
in interfacejakarta.jms.Message
- Throws:
jakarta.jms.JMSException
-
getDoubleProperty
- Specified by:
getDoubleProperty
in interfacejakarta.jms.Message
- Throws:
jakarta.jms.JMSException
-
getStringProperty
- Specified by:
getStringProperty
in interfacejakarta.jms.Message
- Throws:
jakarta.jms.JMSException
-
setBooleanProperty
- Specified by:
setBooleanProperty
in interfacejakarta.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
- Specified by:
setByteProperty
in interfacejakarta.jms.Message
- Throws:
jakarta.jms.JMSException
-
setShortProperty
- Specified by:
setShortProperty
in interfacejakarta.jms.Message
- Throws:
jakarta.jms.JMSException
-
setIntProperty
- Specified by:
setIntProperty
in interfacejakarta.jms.Message
- Throws:
jakarta.jms.JMSException
-
setLongProperty
- Specified by:
setLongProperty
in interfacejakarta.jms.Message
- Throws:
jakarta.jms.JMSException
-
setFloatProperty
- Specified by:
setFloatProperty
in interfacejakarta.jms.Message
- Throws:
jakarta.jms.JMSException
-
setDoubleProperty
- Specified by:
setDoubleProperty
in interfacejakarta.jms.Message
- Throws:
jakarta.jms.JMSException
-
setStringProperty
- Specified by:
setStringProperty
in interfacejakarta.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
-
setAcknowledgeCallback
-
onSend
public void onSend() throws jakarta.jms.JMSExceptionSend operation event listener. Used to get the message ready to be sent.- Throws:
jakarta.jms.JMSException
-
visit
-
storeContent
public void storeContent()- Specified by:
storeContent
in classMessage
-
storeContentAndClear
public void storeContentAndClear()- Specified by:
storeContentAndClear
in classMessage
-
isContentMarshalled
protected boolean isContentMarshalled()- Overrides:
isContentMarshalled
in classMessage
-
getJMSDeliveryTime
public long getJMSDeliveryTime() throws jakarta.jms.JMSException- Specified by:
getJMSDeliveryTime
in interfacejakarta.jms.Message
- Throws:
jakarta.jms.JMSException
-
setJMSDeliveryTime
public void setJMSDeliveryTime(long deliveryTime) throws jakarta.jms.JMSException - Specified by:
setJMSDeliveryTime
in interfacejakarta.jms.Message
- Throws:
jakarta.jms.JMSException
-
getBody
- Specified by:
getBody
in interfacejakarta.jms.Message
- Throws:
jakarta.jms.JMSException
-
isBodyAssignableTo
- Specified by:
isBodyAssignableTo
in interfacejakarta.jms.Message
- Throws:
jakarta.jms.JMSException
-
doGetBody
- Throws:
jakarta.jms.JMSException
-