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:
- javax.jms.Message, MessageReference, Command, DataStructure, MarshallAware
- Direct Known Subclasses:
- ActiveMQBytesMessage, ActiveMQMapMessage, ActiveMQObjectMessage, ActiveMQStreamMessage, ActiveMQTextMessage
public class ActiveMQMessage
- extends Message
- implements javax.jms.Message
- Version:
- $Revision:$
Fields inherited from class org.apache.activemq.command.Message |
arrival, AVERAGE_MESSAGE_SIZE_OVERHEAD, compressed, content, correlationId, dataStructure, destination, droppable, expiration, groupID, groupSequence, marshalledProperties, messageId, originalDestination, originalTransactionId, persistent, priority, producerId, properties, readOnlyBody, readOnlyProperties, recievedByDFBridge, redeliveryCounter, replyTo, size, targetConsumerId, timestamp, transactionId, type, userID |
Fields inherited from interface javax.jms.Message |
DEFAULT_DELIVERY_MODE, DEFAULT_PRIORITY, DEFAULT_TIME_TO_LIVE |
Method Summary |
void |
acknowledge()
|
protected void |
checkReadOnlyBody()
|
protected void |
checkValidObject(java.lang.Object value)
|
void |
clearBody()
|
void |
clearProperties()
|
Message |
copy()
|
protected void |
copy(ActiveMQMessage copy)
|
protected static java.lang.String |
decodeString(byte[] data)
|
protected static byte[] |
encodeString(java.lang.String data)
|
boolean |
equals(java.lang.Object o)
|
Callback |
getAcknowledgeCallback()
|
boolean |
getBooleanProperty(java.lang.String name)
|
byte |
getByteProperty(java.lang.String name)
|
byte |
getDataStructureType()
|
double |
getDoubleProperty(java.lang.String name)
|
float |
getFloatProperty(java.lang.String name)
|
int |
getIntProperty(java.lang.String name)
|
java.lang.String |
getJMSCorrelationID()
|
byte[] |
getJMSCorrelationIDAsBytes()
|
int |
getJMSDeliveryMode()
|
javax.jms.Destination |
getJMSDestination()
|
long |
getJMSExpiration()
|
java.lang.String |
getJMSMessageID()
|
int |
getJMSPriority()
|
boolean |
getJMSRedelivered()
|
javax.jms.Destination |
getJMSReplyTo()
|
long |
getJMSTimestamp()
|
java.lang.String |
getJMSType()
|
long |
getLongProperty(java.lang.String name)
|
java.lang.Object |
getObjectProperty(java.lang.String name)
|
java.util.Enumeration |
getPropertyNames()
|
short |
getShortProperty(java.lang.String name)
|
java.lang.String |
getStringProperty(java.lang.String name)
|
int |
hashCode()
|
boolean |
isExpired()
Returns true if this message is expired |
void |
onSend()
Send operation event listener. |
boolean |
propertyExists(java.lang.String name)
|
void |
setAcknowledgeCallback(Callback acknowledgeCallback)
|
void |
setBooleanProperty(java.lang.String name,
boolean value)
|
void |
setByteProperty(java.lang.String name,
byte value)
|
void |
setDoubleProperty(java.lang.String name,
double value)
|
void |
setFloatProperty(java.lang.String name,
float value)
|
void |
setIntProperty(java.lang.String name,
int value)
|
void |
setJMSCorrelationID(java.lang.String correlationId)
|
void |
setJMSCorrelationIDAsBytes(byte[] correlationId)
|
void |
setJMSDeliveryMode(int mode)
|
void |
setJMSDestination(javax.jms.Destination destination)
|
void |
setJMSExpiration(long expiration)
|
void |
setJMSMessageID(ProducerId producerId,
long producerSequenceId)
This will create an object of MessageId. |
void |
setJMSMessageID(java.lang.String value)
Seems to be invalid because the parameter doesn't initialize MessageId instance variables ProducerId and
ProducerSequenceId |
void |
setJMSPriority(int priority)
|
void |
setJMSRedelivered(boolean redelivered)
|
void |
setJMSReplyTo(javax.jms.Destination destination)
|
void |
setJMSTimestamp(long timestamp)
|
void |
setJMSType(java.lang.String type)
|
void |
setLongProperty(java.lang.String name,
long value)
|
void |
setObjectProperty(java.lang.String name,
java.lang.Object value)
|
void |
setProperties(java.util.Map properties)
|
void |
setShortProperty(java.lang.String name,
short value)
|
void |
setStringProperty(java.lang.String name,
java.lang.String value)
|
Response |
visit(CommandVisitor visitor)
|
Methods inherited from class org.apache.activemq.command.Message |
afterMarshall, afterUnmarshall, beforeMarshall, beforeUnmarshall, copy, decrementReferenceCount, evictMarshlledForm, getArrival, getBrokerPath, getCachedMarshalledForm, getConnection, getContent, getCorrelationId, getDataStructure, getDestination, getExpiration, getGroupID, getGroupSequence, getMarshalledProperties, getMessage, getMessageHardRef, getMessageId, getOriginalDestination, getOriginalTransactionId, getPriority, getProducerId, getProperties, getProperty, getRedeliveryCounter, getReferenceCount, getRegionDestination, getReplyTo, getSize, getTargetConsumerId, getTimestamp, getTransactionId, getType, getUserID, incrementRedeliveryCounter, incrementReferenceCount, isAdvisory, isCompressed, isDroppable, isInTransaction, isMarshallAware, isPersistent, isReadOnlyBody, isReadOnlyProperties, isRecievedByDFBridge, isRedelivered, lazyCreateProperties, onMessageRolledBack, setArrival, setBrokerPath, setCachedMarshalledForm, setCompressed, setConnection, setContent, setCorrelationId, setDataStructure, setDestination, setDroppable, setExpiration, setGroupID, setGroupSequence, setMarshalledProperties, setMessageId, setOriginalDestination, setOriginalTransactionId, setPersistent, setPriority, setProducerId, setProperty, setReadOnlyBody, setReadOnlyProperties, setRecievedByDFBridge, setRedelivered, setRedeliveryCounter, setRegionDestination, setReplyTo, setTargetConsumerId, setTimestamp, setTransactionId, setType, setUserID |
Methods inherited from class org.apache.activemq.command.BaseCommand |
copy, getCommandId, getFrom, getTo, isBrokerInfo, isMessage, isMessageAck, isMessageDispatch, isMessageDispatchNotification, isResponse, isResponseRequired, isShutdownInfo, isWireFormatInfo, setCommandId, setFrom, setResponseRequired, setTo, toString |
Methods inherited from class java.lang.Object |
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
DATA_STRUCTURE_TYPE
public static final byte DATA_STRUCTURE_TYPE
- See Also:
- Constant Field Values
acknowledgeCallback
protected transient Callback acknowledgeCallback
ActiveMQMessage
public ActiveMQMessage()
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 java.lang.Object
equals
public boolean equals(java.lang.Object o)
- Overrides:
equals
in class java.lang.Object
acknowledge
public void acknowledge()
throws javax.jms.JMSException
- Specified by:
acknowledge
in interface javax.jms.Message
- Throws:
javax.jms.JMSException
clearBody
public void clearBody()
throws javax.jms.JMSException
- Specified by:
clearBody
in interface javax.jms.Message
- Throws:
javax.jms.JMSException
getJMSMessageID
public java.lang.String getJMSMessageID()
- Specified by:
getJMSMessageID
in interface javax.jms.Message
setJMSMessageID
public void setJMSMessageID(java.lang.String value)
throws javax.jms.JMSException
- Seems to be invalid because the parameter doesn't initialize MessageId instance variables ProducerId and
ProducerSequenceId
- Specified by:
setJMSMessageID
in interface javax.jms.Message
- Parameters:
value
-
- Throws:
javax.jms.JMSException
setJMSMessageID
public void setJMSMessageID(ProducerId producerId,
long producerSequenceId)
throws javax.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:
javax.jms.JMSException
getJMSTimestamp
public long getJMSTimestamp()
- Specified by:
getJMSTimestamp
in interface javax.jms.Message
setJMSTimestamp
public void setJMSTimestamp(long timestamp)
- Specified by:
setJMSTimestamp
in interface javax.jms.Message
getJMSCorrelationID
public java.lang.String getJMSCorrelationID()
- Specified by:
getJMSCorrelationID
in interface javax.jms.Message
setJMSCorrelationID
public void setJMSCorrelationID(java.lang.String correlationId)
- Specified by:
setJMSCorrelationID
in interface javax.jms.Message
getJMSCorrelationIDAsBytes
public byte[] getJMSCorrelationIDAsBytes()
throws javax.jms.JMSException
- Specified by:
getJMSCorrelationIDAsBytes
in interface javax.jms.Message
- Throws:
javax.jms.JMSException
setJMSCorrelationIDAsBytes
public void setJMSCorrelationIDAsBytes(byte[] correlationId)
throws javax.jms.JMSException
- Specified by:
setJMSCorrelationIDAsBytes
in interface javax.jms.Message
- Throws:
javax.jms.JMSException
decodeString
protected static java.lang.String decodeString(byte[] data)
throws javax.jms.JMSException
- Throws:
javax.jms.JMSException
encodeString
protected static byte[] encodeString(java.lang.String data)
throws javax.jms.JMSException
- Throws:
javax.jms.JMSException
getJMSReplyTo
public javax.jms.Destination getJMSReplyTo()
- Specified by:
getJMSReplyTo
in interface javax.jms.Message
setJMSReplyTo
public void setJMSReplyTo(javax.jms.Destination destination)
throws javax.jms.JMSException
- Specified by:
setJMSReplyTo
in interface javax.jms.Message
- Throws:
javax.jms.JMSException
getJMSDestination
public javax.jms.Destination getJMSDestination()
- Specified by:
getJMSDestination
in interface javax.jms.Message
setJMSDestination
public void setJMSDestination(javax.jms.Destination destination)
throws javax.jms.JMSException
- Specified by:
setJMSDestination
in interface javax.jms.Message
- Throws:
javax.jms.JMSException
getJMSDeliveryMode
public int getJMSDeliveryMode()
- Specified by:
getJMSDeliveryMode
in interface javax.jms.Message
setJMSDeliveryMode
public void setJMSDeliveryMode(int mode)
- Specified by:
setJMSDeliveryMode
in interface javax.jms.Message
getJMSRedelivered
public boolean getJMSRedelivered()
- Specified by:
getJMSRedelivered
in interface javax.jms.Message
setJMSRedelivered
public void setJMSRedelivered(boolean redelivered)
- Specified by:
setJMSRedelivered
in interface javax.jms.Message
getJMSType
public java.lang.String getJMSType()
- Specified by:
getJMSType
in interface javax.jms.Message
setJMSType
public void setJMSType(java.lang.String type)
- Specified by:
setJMSType
in interface javax.jms.Message
getJMSExpiration
public long getJMSExpiration()
- Specified by:
getJMSExpiration
in interface javax.jms.Message
setJMSExpiration
public void setJMSExpiration(long expiration)
- Specified by:
setJMSExpiration
in interface javax.jms.Message
getJMSPriority
public int getJMSPriority()
- Specified by:
getJMSPriority
in interface javax.jms.Message
setJMSPriority
public void setJMSPriority(int priority)
- Specified by:
setJMSPriority
in interface javax.jms.Message
clearProperties
public void clearProperties()
- Specified by:
clearProperties
in interface javax.jms.Message
- Overrides:
clearProperties
in class Message
propertyExists
public boolean propertyExists(java.lang.String name)
throws javax.jms.JMSException
- Specified by:
propertyExists
in interface javax.jms.Message
- Throws:
javax.jms.JMSException
getPropertyNames
public java.util.Enumeration getPropertyNames()
throws javax.jms.JMSException
- Specified by:
getPropertyNames
in interface javax.jms.Message
- Throws:
javax.jms.JMSException
setObjectProperty
public void setObjectProperty(java.lang.String name,
java.lang.Object value)
throws javax.jms.JMSException
- Specified by:
setObjectProperty
in interface javax.jms.Message
- Throws:
javax.jms.JMSException
setProperties
public void setProperties(java.util.Map properties)
throws javax.jms.JMSException
- Throws:
javax.jms.JMSException
checkValidObject
protected void checkValidObject(java.lang.Object value)
throws javax.jms.MessageFormatException
- Throws:
javax.jms.MessageFormatException
getObjectProperty
public java.lang.Object getObjectProperty(java.lang.String name)
throws javax.jms.JMSException
- Specified by:
getObjectProperty
in interface javax.jms.Message
- Throws:
javax.jms.JMSException
getBooleanProperty
public boolean getBooleanProperty(java.lang.String name)
throws javax.jms.JMSException
- Specified by:
getBooleanProperty
in interface javax.jms.Message
- Throws:
javax.jms.JMSException
getByteProperty
public byte getByteProperty(java.lang.String name)
throws javax.jms.JMSException
- Specified by:
getByteProperty
in interface javax.jms.Message
- Throws:
javax.jms.JMSException
getShortProperty
public short getShortProperty(java.lang.String name)
throws javax.jms.JMSException
- Specified by:
getShortProperty
in interface javax.jms.Message
- Throws:
javax.jms.JMSException
getIntProperty
public int getIntProperty(java.lang.String name)
throws javax.jms.JMSException
- Specified by:
getIntProperty
in interface javax.jms.Message
- Throws:
javax.jms.JMSException
getLongProperty
public long getLongProperty(java.lang.String name)
throws javax.jms.JMSException
- Specified by:
getLongProperty
in interface javax.jms.Message
- Throws:
javax.jms.JMSException
getFloatProperty
public float getFloatProperty(java.lang.String name)
throws javax.jms.JMSException
- Specified by:
getFloatProperty
in interface javax.jms.Message
- Throws:
javax.jms.JMSException
getDoubleProperty
public double getDoubleProperty(java.lang.String name)
throws javax.jms.JMSException
- Specified by:
getDoubleProperty
in interface javax.jms.Message
- Throws:
javax.jms.JMSException
getStringProperty
public java.lang.String getStringProperty(java.lang.String name)
throws javax.jms.JMSException
- Specified by:
getStringProperty
in interface javax.jms.Message
- Throws:
javax.jms.JMSException
setBooleanProperty
public void setBooleanProperty(java.lang.String name,
boolean value)
throws javax.jms.JMSException
- Specified by:
setBooleanProperty
in interface javax.jms.Message
- Throws:
javax.jms.JMSException
setByteProperty
public void setByteProperty(java.lang.String name,
byte value)
throws javax.jms.JMSException
- Specified by:
setByteProperty
in interface javax.jms.Message
- Throws:
javax.jms.JMSException
setShortProperty
public void setShortProperty(java.lang.String name,
short value)
throws javax.jms.JMSException
- Specified by:
setShortProperty
in interface javax.jms.Message
- Throws:
javax.jms.JMSException
setIntProperty
public void setIntProperty(java.lang.String name,
int value)
throws javax.jms.JMSException
- Specified by:
setIntProperty
in interface javax.jms.Message
- Throws:
javax.jms.JMSException
setLongProperty
public void setLongProperty(java.lang.String name,
long value)
throws javax.jms.JMSException
- Specified by:
setLongProperty
in interface javax.jms.Message
- Throws:
javax.jms.JMSException
setFloatProperty
public void setFloatProperty(java.lang.String name,
float value)
throws javax.jms.JMSException
- Specified by:
setFloatProperty
in interface javax.jms.Message
- Throws:
javax.jms.JMSException
setDoubleProperty
public void setDoubleProperty(java.lang.String name,
double value)
throws javax.jms.JMSException
- Specified by:
setDoubleProperty
in interface javax.jms.Message
- Throws:
javax.jms.JMSException
setStringProperty
public void setStringProperty(java.lang.String name,
java.lang.String value)
throws javax.jms.JMSException
- Specified by:
setStringProperty
in interface javax.jms.Message
- Throws:
javax.jms.JMSException
checkReadOnlyBody
protected void checkReadOnlyBody()
throws javax.jms.MessageNotWriteableException
- Throws:
javax.jms.MessageNotWriteableException
isExpired
public boolean isExpired()
- Description copied from interface:
MessageReference
- Returns true if this message is expired
- Specified by:
isExpired
in interface MessageReference
- Overrides:
isExpired
in class Message
getAcknowledgeCallback
public Callback getAcknowledgeCallback()
setAcknowledgeCallback
public void setAcknowledgeCallback(Callback acknowledgeCallback)
onSend
public void onSend()
- Send operation event listener. Used to get the message ready to be sent.
visit
public Response visit(CommandVisitor visitor)
throws java.lang.Exception
- Specified by:
visit
in interface Command
- Throws:
java.lang.Exception
Copyright © 2009 Apache Software Foundation. All Rights Reserved.