Overview  Package   Class  Use  Deprecated  Index
Home >> All >> org >> activemq >> [ message overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---

org.activemq.message
Class ActiveMQMessage  

java.lang.Object
  org.activemq.message.AbstractPacket
      org.activemq.message.ActiveMQMessage

All Implemented Interfaces:

BodyPacket, java.lang.Comparable, org.activemq.io.util.MemoryManageable, javax.jms.Message, Packet

Direct Known Subclasses:

ActiveMQBytesMessage, ActiveMQMapMessage, ActiveMQObjectMessage, ActiveMQStreamMessage, ActiveMQTextMessage

---

public class ActiveMQMessage

extends AbstractPacket

implements javax.jms.Message, java.lang.Comparable, org.activemq.io.util.MemoryManageable, BodyPacket

The Message interface is the root interface of all JMS messages. It defines the message header and the acknowledge method used for all messages.

Most message-oriented middleware (MOM) products treat messages as lightweight entities that consist of a header and a payload. The header contains fields used for message routing and identification; the payload contains the application data being sent.

Within this general form, the definition of a message varies significantly across products. It would be quite difficult for the JMS API to support all of these message models.

With this in mind, the JMS message model has the following goals:

• Provide a single, unified message API
• Provide an API suitable for creating messages that match the format used by provider-native messaging applications
• Support the development of heterogeneous applications that span operating systems, machine architectures, and computer languages
• Support messages containing objects in the Java programming language ("Java objects")
• Support messages containing Extensible Markup Language (XML) pages

JMS messages are composed of the following parts:

• Header - All messages support the same set of header fields. Header fields contain values used by both clients and providers to identify and route messages.
• Properties - Each message contains a built-in facility for supporting application-defined property values. Properties provide an efficient mechanism for supporting application-defined message filtering.
• Body - The JMS API defines several types of message body, which cover the majority of messaging styles currently in use.

Message Bodies

The JMS API defines five types of message body:

• Stream - A StreamMessage object's message body contains a stream of primitive values in the Java programming language ("Java primitives"). It is filled and read sequentially.
• Map - A MapMessage object's message body contains a set of name-value pairs, where names are String objects, and values are Java primitives. The entries can be accessed sequentially or randomly by name. The order of the entries is undefined.
• Text - A TextMessage object's message body contains a java.lang.String object. This message type can be used to transport plain-text messages, and XML messages.
• Object - An ObjectMessage object's message body contains a Serializable Java object.
• Bytes - A BytesMessage object's message body contains a stream of uninterpreted bytes. This message type is for literally encoding a body to match an existing message format. In many cases, it is possible to use one of the other body types, which are easier to use. Although the JMS API allows the use of message properties with byte messages, they are typically not used, since the inclusion of properties may affect the format.

Message Headers

The JMSCorrelationID header field is used for linking one message with another. It typically links a reply message with its requesting message.

JMSCorrelationID can hold a provider-specific message ID, an application-specific String object, or a provider-native byte[] value.

Message Properties

A Message object contains a built-in facility for supporting application-defined property values. In effect, this provides a mechanism for adding application-specific header fields to a message.

Properties allow an application, via message selectors, to have a JMS provider select, or filter, messages on its behalf using application-specific criteria.

Property names must obey the rules for a message selector identifier. Property names must not be null, and must not be empty strings. If a property name is set and it is either null or an empty string, an IllegalArgumentException must be thrown.

Property values can be boolean, byte, short, int, long, float, double, and String.

Property values are set prior to sending a message. When a client receives a message, its properties are in read-only mode. If a client attempts to set properties at this point, a MessageNotWriteableException is thrown. If clearProperties is called, the properties can now be both read from and written to. Note that header fields are distinct from properties. Header fields are never in read-only mode.

A property value may duplicate a value in a message's body, or it may not. Although JMS does not define a policy for what should or should not be made a property, application developers should note that JMS providers will likely handle data in a message's body more efficiently than data in a message's properties. For best performance, applications should use message properties only when they need to customize a message's header. The primary reason for doing this is to support customized message selection.

Message properties support the following conversion table. The marked cases must be supported. The unmarked cases must throw a JMSException. The String-to-primitive conversions may throw a runtime exception if the primitive's valueOf method does not accept the String as a valid representation of the primitive.

A value written as the row type can be read as the column type.

 |        | boolean byte short int long float double String
 |----------------------------------------------------------
 |boolean |    X                                       X
 |byte    |          X     X    X   X                  X
 |short   |                X    X   X                  X
 |int     |                     X   X                  X
 |long    |                         X                  X
 |float   |                               X     X      X
 |double  |                                     X      X
 |String  |    X     X     X    X   X     X     X      X
 |----------------------------------------------------------
 

In addition to the type-specific set/get methods for properties, JMS provides the setObjectProperty and getObjectProperty methods. These support the same set of property types using the objectified primitive values. Their purpose is to allow the decision of property type to made at execution time rather than at compile time. They support the same property value conversions.

The setObjectProperty method accepts values of class Boolean, Byte, Short, Integer, Long, Float, Double, and String. An attempt to use any other class must throw a JMSException.

The getObjectProperty method only returns values of class Boolean, Byte, Short, Integer, Long, Float, Double, and String.

The order of property values is not defined. To iterate through a message's property values, use getPropertyNames to retrieve a property name enumeration and then use the various property get methods to retrieve their values.

A message's properties are deleted by the clearProperties method. This leaves the message with an empty set of properties.

Getting a property value for a name which has not been set returns a null value. Only the getStringProperty and getObjectProperty methods can return a null value. Attempting to read a null value as a primitive type must be treated as calling the primitive's corresponding valueOf(String) conversion method with a null value.

The JMS API reserves the JMSX property name prefix for JMS defined properties. The full set of these properties is defined in the Java Message Service specification. New JMS defined properties may be added in later versions of the JMS API. Support for these properties is optional. The String[] ConnectionMetaData.getJMSXPropertyNames method returns the names of the JMSX properties supported by a connection.

JMSX properties may be referenced in message selectors whether or not they are supported by a connection. If they are not present in a message, they are treated like any other absent property.

JMSX properties defined in the specification as "set by provider on send" are available to both the producer and the consumers of the message. JMSX properties defined in the specification as "set by provider on receive" are available only to the consumers.

JMSXGroupID and JMSXGroupSeq are standard properties that clients should use if they want to group messages. All providers must support them. Unless specifically noted, the values and semantics of the JMSX properties are undefined.

The JMS API reserves the JMS_vendor_name property name prefix for provider-specific properties. Each provider defines its own value for vendor_name. This is the mechanism a JMS provider uses to make its special per-message services available to a JMS client.

The purpose of provider-specific properties is to provide special features needed to integrate JMS clients with provider-native clients in a single JMS application. They should not be used for messaging between JMS clients.

Provider Implementations of JMS Message Interfaces

The JMS API provides a set of message interfaces that define the JMS message model. It does not provide implementations of these interfaces.

Each JMS provider supplies a set of message factories with its Session object for creating instances of messages. This allows a provider to use message implementations tailored to its specific needs.

A provider must be prepared to accept message implementations that are not its own. They may not be handled as efficiently as its own implementation; however, they must be handled.

Note the following exception case when a provider is handling a foreign message implementation. If the foreign message implementation contains a JMSReplyTo header field that is set to a foreign destination implementation, the provider is not required to handle or preserve the value of this header field.

Message Selectors

A JMS message selector allows a client to specify, by header field references and property references, the messages it is interested in. Only messages whose header and property values match the selector are delivered. What it means for a message not to be delivered depends on the MessageConsumer being used (see QueueReceiver and TopicSubscriber).

Message selectors cannot reference message body values.

A message selector matches a message if the selector evaluates to true when the message's header field values and property values are substituted for their corresponding identifiers in the selector.

A message selector is a String whose syntax is based on a subset of the SQL92 conditional expression syntax. If the value of a message selector is an empty string, the value is treated as a null and indicates that there is no message selector for the message consumer.

The order of evaluation of a message selector is from left to right within precedence level. Parentheses can be used to change this order.

Predefined selector literals and operator names are shown here in uppercase; however, they are case insensitive.

A selector can contain:

• Literals:
  • A string literal is enclosed in single quotes, with a single quote represented by doubled single quote; for example, 'literal' and 'literal''s'. Like string literals in the Java programming language, these use the Unicode character encoding.
  • An exact numeric literal is a numeric value without a decimal point, such as 57, -957, and +62; numbers in the range of long are supported. Exact numeric literals use the integer literal syntax of the Java programming language.
  • An approximate numeric literal is a numeric value in scientific notation, such as 7E3 and -57.9E2, or a numeric value with a decimal, such as 7., -95.7, and +6.2; numbers in the range of double are supported. Approximate literals use the floating-point literal syntax of the Java programming language.
  • The boolean literals TRUE and FALSE.
• Identifiers:
  • An identifier is an unlimited-length sequence of letters and digits, the first of which must be a letter. A letter is any character for which the method Character.isJavaLetter returns true. This includes '_' and '$'. A letter or digit is any character for which the method Character.isJavaLetterOrDigit returns true.
  • Identifiers cannot be the names NULL, TRUE, and FALSE.
  • Identifiers cannot be NOT, AND, OR, BETWEEN, LIKE, IN, IS, or ESCAPE.
  • Identifiers are either header field references or property references. The type of a property value in a message selector corresponds to the type used to set the property. If a property that does not exist in a message is referenced, its value is NULL.
  • The conversions that apply to the get methods for properties do not apply when a property is used in a message selector expression. For example, suppose you set a property as a string value, as in the following:

    myMessage.setStringProperty("NumberOfOrders", "2");

    The following expression in a message selector would evaluate to false, because a string cannot be used in an arithmetic expression:

    "NumberOfOrders > 1"

  • Identifiers are case-sensitive.
  • Message header field references are restricted to JMSDeliveryMode, JMSPriority, JMSMessageID, JMSTimestamp, JMSCorrelationID, and JMSType. JMSMessageID, JMSCorrelationID, and JMSType values may be null and if so are treated as a NULL value.
  • Any name beginning with 'JMSX' is a JMS defined property name.
  • Any name beginning with 'JMS_' is a provider-specific property name.
  • Any name that does not begin with 'JMS' is an application-specific property name.
• White space is the same as that defined for the Java programming language: space, horizontal tab, form feed, and line terminator.
• Expressions:
  • A selector is a conditional expression; a selector that evaluates to true matches; a selector that evaluates to false or unknown does not match.
  • Arithmetic expressions are composed of themselves, arithmetic operations, identifiers (whose value is treated as a numeric literal), and numeric literals.
  • Conditional expressions are composed of themselves, comparison operations, and logical operations.
• Standard bracketing () for ordering expression evaluation is supported.
• Logical operators in precedence order: NOT, AND, OR
• Comparison operators: =, >, >=, <, <=, <> (not equal)
  • Only like type values can be compared. One exception is that it is valid to compare exact numeric values and approximate numeric values; the type conversion required is defined by the rules of numeric promotion in the Java programming language. If the comparison of non-like type values is attempted, the value of the operation is false. If either of the type values evaluates to NULL, the value of the expression is unknown.
  • String and boolean comparison is restricted to = and <>. Two strings are equal if and only if they contain the same sequence of characters.
• Arithmetic operators in precedence order:
  • +, - (unary)
  • *, / (multiplication and division)
  • +, - (addition and subtraction)
  • Arithmetic operations must use numeric promotion in the Java programming language.
• arithmetic-expr1 [NOT] BETWEEN arithmetic-expr2 AND arithmetic-expr3 (comparison operator)
  • "age BETWEEN 15 AND 19" is equivalent to "age >= 15 AND age <= 19"
  • "age NOT BETWEEN 15 AND 19" is equivalent to "age < 15 OR age > 19"
• identifier [NOT] IN (string-literal1, string-literal2,...) (comparison operator where identifier has a String or NULL value)
  • "Country IN (' UK', 'US', 'France')" is true for 'UK' and false for 'Peru'; it is equivalent to the expression "(Country = ' UK') OR (Country = ' US') OR (Country = ' France')"
  • "Country NOT IN (' UK', 'US', 'France')" is false for 'UK' and true for 'Peru'; it is equivalent to the expression "NOT ((Country = ' UK') OR (Country = ' US') OR (Country = ' France'))"
  • If identifier of an IN or NOT IN operation is NULL, the value of the operation is unknown.
• identifier [NOT] LIKE pattern-value [ESCAPE escape-character] (comparison operator, where identifier has a String value; pattern-value is a string literal where '_' stands for any single character; '%' stands for any sequence of characters, including the empty sequence; and all other characters stand for themselves. The optional escape-character is a single-character string literal whose character is used to escape the special meaning of the '_' and '%' in pattern-value.)
  • "phone LIKE '12%3'" is true for '123' or '12993' and false for '1234'
  • "word LIKE 'l_se'" is true for 'lose' and false for 'loose'
  • "underscored LIKE '\_%' ESCAPE '\'" is true for '_foo' and false for 'bar'
  • "phone NOT LIKE '12%3'" is false for '123' or '12993' and true for '1234'
  • If identifier of a LIKE or NOT LIKE operation is NULL, the value of the operation is unknown.
• identifier IS NULL (comparison operator that tests for a null header field value or a missing property value)
  • "prop_name IS NULL"
• identifier IS NOT NULL (comparison operator that tests for the existence of a non-null header field value or a property value)
  • "prop_name IS NOT NULL"

  JMS providers are required to verify the syntactic correctness of a message selector at the time it is presented. A method that provides a syntactically incorrect selector must result in a JMSException. JMS providers may also optionally provide some semantic checking at the time the selector is presented. Not all semantic checking can be performed at the time a message selector is presented, because property types are not known.

  The following message selector selects messages with a message type of car and color of blue and weight greater than 2500 pounds:

  "JMSType = 'car' AND color = 'blue' AND weight > 2500"

  Null Values

  As noted above, property values may be NULL. The evaluation of selector expressions containing NULL values is defined by SQL92 NULL semantics. A brief description of these semantics is provided here.

  SQL treats a NULL value as unknown. Comparison or arithmetic with an unknown value always yields an unknown value.

  The IS NULL and IS NOT NULL operators convert an unknown value into the respective TRUE and FALSE values.

  The boolean operators use three-valued logic as defined by the following tables:

  The definition of the AND operator

   | AND  |   T   |   F   |   U
   +------+-------+-------+-------
   |  T   |   T   |   F   |   U
   |  F   |   F   |   F   |   F
   |  U   |   U   |   F   |   U
   +------+-------+-------+-------
   

  The definition of the OR operator

   | OR   |   T   |   F   |   U
   +------+-------+-------+--------
   |  T   |   T   |   T   |   T
   |  F   |   T   |   F   |   U
   |  U   |   T   |   U   |   U
   +------+-------+-------+-------
   

  The definition of the NOT operator

   | NOT
   +------+------
   |  T   |   F
   |  F   |   T
   |  U   |   U
   +------+-------
   

  Special Notes

  When used in a message selector, the JMSDeliveryMode header field is treated as having the values 'PERSISTENT' and 'NON_PERSISTENT'.

  Date and time values should use the standard long millisecond value. When a date or time literal is included in a message selector, it should be an integer literal for a millisecond value. The standard way to produce millisecond values is to use java.util.Calendar.

  Although SQL supports fixed decimal comparison and arithmetic, JMS message selectors do not. This is the reason for restricting exact numeric literals to those without a decimal (and the addition of numerics with a decimal as an alternate representation for approximate numeric values).

  SQL comments are not supported.

  Version:

  $Revision: 1.1.1.1 $

  ---

  Field Summary
  private  org.activemq.io.util.ByteArray	bodyAsBytes
  (package private) static byte	BOOLEAN
  static int	BROKER_NAME_INDEX
  (package private) static byte	BYTE
  (package private) static byte	BYTES
  static int	CACHED_DESTINATION_INDEX
  static int	CACHED_VALUES_INDEX
  (package private) static byte	CHAR
  static int	CID_INDEX
  static int	CLUSTER_NAME_INDEX
  private  java.lang.String	consumerIdentifier
  private  int[]	consumerNos
  static int	CORRELATION_INDEX           Message flag indexes (used for writing/reading to/from a Stream
  (package private) static int	DEFAULT_DELIVERY_MODE           The message producer's default delivery mode is PERSISTENT.
  (package private) static int	DEFAULT_PRIORITY           The message producer's default priority is 4.
  (package private) static long	DEFAULT_TIME_TO_LIVE           The message producer's default time to live is unlimited; the message never expires.
  private static java.lang.String	DELIVERY_COUNT_NAME
  private  int	deliveryCount
  static int	DISPATCHED_FROM_DLQ_INDEX
  private  boolean	dispatchedFromDLQ
  (package private) static byte	DOUBLE
  private  java.lang.String	entryBrokerName
  private  java.lang.String	entryClusterName
  (package private) static byte	EOF           message property types
  static int	EXPIRATION_INDEX
  static int	EXTERNAL_MESSAGE_ID_INDEX
  private  boolean	externalMessageId
  (package private) static byte	FLOAT
  (package private) static byte	INT
  private  java.lang.String	jmsClientID
  private  java.lang.String	jmsCorrelationID
  private  int	jmsDeliveryMode
  private  ActiveMQDestination	jmsDestination
  private  long	jmsExpiration
  private  java.lang.String	jmsMessageID
  private  org.activemq.service.MessageIdentity	jmsMessageIdentity
  private  int	jmsPriority
  private  boolean	jmsRedelivered
  private  ActiveMQDestination	jmsReplyTo
  private  long	jmsTimestamp
  private  java.lang.String	jmsType
  (package private) static byte	LONG
  static int	LONG_SEQUENCE_INDEX
  static int	MESSAGE_PART_INDEX
  private  MessageAcknowledge	messageAcknowledge
  private  boolean	messageConsumed
  private  boolean	messagePart
  private  short	messsageHandle
  (package private) static byte	NULL
  private  short	numberOfParts
  private  java.lang.String	parentMessageID
  private  short	partNumber
  static int	PAYLOAD_INDEX
  private  java.lang.String	producerKey
  private  java.util.Map	properties
  static int	PROPERTIES_INDEX
  protected  boolean	readOnlyMessage           readOnlyMessage denotes if the message is read only
  private  boolean	readOnlyProperties
  static int	REDELIVERED_INDEX
  static int	REPLY_TO_INDEX
  private  long	sequenceNumber
  (package private) static byte	SHORT
  (package private) static byte	STRING
  static int	TIMESTAMP_INDEX
  static int	TRANSACTION_ID_INDEX
  private  java.lang.Object	transactionId
  private  boolean	transientConsumed
  static int	TYPE_INDEX
  static int	XA_TRANS_INDEX
  private  boolean	xaTransacted

   

  Fields inherited from class org.activemq.message.AbstractPacket

  bitArray, BROKERS_VISITED_INDEX, cachedHashCode, RECEIPT_REQUIRED_INDEX

   

  Fields inherited from interface org.activemq.message.Packet

  ACTIVEMQ_BROKER_INFO, ACTIVEMQ_BYTES_MESSAGE, ACTIVEMQ_CONNECTION_INFO, ACTIVEMQ_MAP_MESSAGE, ACTIVEMQ_MESSAGE, ACTIVEMQ_MSG_ACK, ACTIVEMQ_OBJECT_MESSAGE, ACTIVEMQ_STREAM_MESSAGE, ACTIVEMQ_TEXT_MESSAGE, BROKER_ADMIN_COMMAND, CACHED_VALUE_COMMAND, CAPACITY_INFO, CAPACITY_INFO_REQUEST, CLEANUP_CONNECTION_INFO, CONSUMER_INFO, DURABLE_UNSUBSCRIBE, INT_RESPONSE_RECEIPT_INFO, KEEP_ALIVE, NOT_SET, PRODUCER_INFO, RECEIPT_INFO, RESPONSE_RECEIPT_INFO, SESSION_INFO, TRANSACTION_INFO, WIRE_FORMAT_INFO, XA_TRANSACTION_INFO

   

  Constructor Summary

  ActiveMQMessage()

   

  Method Summary
  void	acknowledge()           Acknowledges all consumed messages of the session of this consumed message.
  void	buildBodyFromBytes()           Builds the message body from data
  void	clearBody()           Clears out the message body.
  void	clearProperties()           Clears a message's properties.
  int	compareTo(ActiveMQMessage that)           Sorted by destination and then messageId
  int	compareTo(java.lang.Object o)           Compares this object with another, and returns a numerical result based on the comparison.
  void	convertBodyToBytes()           Convert the message body to data
  ActiveMQMessage	deepCopy()
  boolean	equals(java.lang.Object obj)           Returns true if this instance is equivalent to obj
  org.activemq.io.util.ByteArray	getBodyAsBytes()
  org.activemq.io.util.ByteArray	getBodyAsBytes(org.activemq.io.util.ByteArrayCompression compression)           return the data after applying compression
  boolean	getBooleanProperty(java.lang.String name)           Returns the value of the boolean property with the specified name.
  byte	getByteProperty(java.lang.String name)           Returns the value of the byte property with the specified name.
  java.lang.String	getConsumerIdentifer()
  int[]	getConsumerNos()
  java.lang.String	getConsumerNosAsString()
  int	getDeliveryCount()
  double	getDoubleProperty(java.lang.String name)           Returns the value of the double property with the specified name.
  java.lang.String	getEntryBrokerName()
  java.lang.String	getEntryClusterName()
  float	getFloatProperty(java.lang.String name)           Returns the value of the float property with the specified name.
  int	getIntProperty(java.lang.String name)           Returns the value of the int property with the specified name.
  ActiveMQDestination	getJMSActiveMQDestination()
  java.lang.String	getJMSClientID()
  java.lang.String	getJMSCorrelationID()           Gets the correlation ID for the message.
  byte[]	getJMSCorrelationIDAsBytes()           Gets the correlation ID as an array of bytes for the message.
  int	getJMSDeliveryMode()           Gets the DeliveryMode value specified for this message.
  javax.jms.Destination	getJMSDestination()           Gets the Destination object for this message.
  long	getJMSExpiration()           Gets the message's expiration value.
  java.lang.String	getJMSMessageID()           Gets the message ID.
  org.activemq.service.MessageIdentity	getJMSMessageIdentity()
  int	getJMSPriority()           Gets the message priority level.
  boolean	getJMSRedelivered()           Gets an indication of whether this message is being redelivered.
  javax.jms.Destination	getJMSReplyTo()           Gets the Destination object to which a reply to this message should be sent.
  long	getJMSTimestamp()           Gets the message timestamp.
  java.lang.String	getJMSType()           Gets the message type identifier supplied by the client when the message was sent.
  long	getLongProperty(java.lang.String name)           Returns the value of the long property with the specified name.
  java.lang.Object	getMemoryId()           Another way to get the Message id.
  MessageAcknowledge	getMessageAcknowledge()
  short	getMesssageHandle()
  short	getNumberOfParts()
  java.lang.Object	getObjectProperty(java.lang.String name)           Returns the value of the Java object property with the specified name.
  int	getPacketType()           Return the type of Packet
  java.lang.String	getParentMessageID()
  short	getPartNumber()
  int	getPriority()
  java.lang.String	getProducerKey()
  java.util.Map	getProperties()           Retrieve the message properties as a Map
  java.util.Enumeration	getPropertyNames()           Returns an Enumeration of all the property names.
  (package private)  java.lang.Object	getReservedProperty(java.lang.String name)
  long	getSequenceNumber()
  short	getShortProperty(java.lang.String name)           Returns the value of the short property with the specified name.
  java.lang.String	getStringProperty(java.lang.String name)           Returns the value of the String property with the specified name.
  java.lang.Object	getTransactionId()
  java.lang.String	getTransactionIDString()           A helper method for the OpenWire protocol
  (package private)  java.lang.Object	getVanillaProperty(java.util.Map table, java.lang.String name)
  int	hashCode()           Get a value that represents this Object, as uniquely as possible within the confines of an int.
  int	incrementDeliveryCount()           Increment the delivery count
  int	incrementRedeliveryCount()           Increment the redelivery count, which is the same as the delivery count except it does not consider the initial delivery upon message creation
  protected  void	initializeOther(ActiveMQMessage other)           Initializes another message with current values from this instance
  boolean	isAdvisory()
  boolean	isBodyConvertedToBytes()
  boolean	isConsumerTarget(int consumerNumber)           test to see if a particular Consumer at a Connection is meant to receive this Message
  boolean	isDispatchedFromDLQ()
  boolean	isEntryBroker(java.lang.String brokerName)           Determine if the message originated in the network from the named broker
  boolean	isEntryCluster(java.lang.String clusterName)           Determine if the message originated in the network from the named cluster
  boolean	isExpired()
  boolean	isExpired(long currentTime)           Indicates if the Message has expired
  boolean	isExternalMessageId()
  boolean	isJMSMessage()           Retrieve if a JMS Message type or not
  boolean	isLastMessagePart()
  boolean	isMessageConsumed()
  boolean	isMessagePart()
  boolean	isPartOfTransaction()
  boolean	isPersistent()
  boolean	isTemporary()
  boolean	isTransientConsumed()
  boolean	isXaTransacted()
  void	prepareMessageBody()           Prepare a message body for delivery
  private  void	prepareProperty(java.lang.String name)
  boolean	propertyExists(java.lang.String name)           Indicates whether a property value exists.
  void	readBody(java.io.DataInput dataIn)           Used to help build the body from an input stream
  java.util.Map	readMapProperties(java.io.DataInput dataIn)
  void	resetMessagePart()           reset message fragmentation infomation on this message
  void	setBodyAsBytes(byte[] data, int offset, int length)
  void	setBodyAsBytes(org.activemq.io.util.ByteArray ba)           set the body as bytes
  void	setBooleanProperty(java.lang.String name, boolean value)           Sets a boolean property value with the specified name into the message.
  void	setByteProperty(java.lang.String name, byte value)           Sets a byte property value with the specified name into the message.
  void	setConsumerIdentifer(java.lang.String consId)
  void	setConsumerNos(int[] newConsumerNos)
  void	setConsumerNosAsString(java.lang.String value)           Sets the consumer numbers using a String format
  void	setDeliveryCount(int deliveryCount)
  void	setDispatchedFromDLQ(boolean dispatchedFromDLQ)
  void	setDoubleProperty(java.lang.String name, double value)           Sets a double property value with the specified name into the message.
  void	setEntryBrokerName(java.lang.String newEntryBrokerName)
  void	setEntryClusterName(java.lang.String newEntryClusterName)
  void	setExternalMessageId(boolean externalMessageId)
  void	setFloatProperty(java.lang.String name, float value)           Sets a float property value with the specified name into the message.
  void	setIntProperty(java.lang.String name, int value)           Sets an int property value with the specified name into the message.
  void	setJMSClientID(java.lang.String newJmsClientID)
  void	setJMSCorrelationID(java.lang.String correlationID)           Sets the correlation ID for the message.
  void	setJMSCorrelationIDAsBytes(byte[] correlationID)           Sets the correlation ID as an array of bytes for the message.
  void	setJMSDeliveryMode(int deliveryMode)           Sets the DeliveryMode value for this message.
  void	setJMSDestination(javax.jms.Destination destination)           Sets the Destination object for this message.
  void	setJMSExpiration(long expiration)           Sets the message's expiration value.
  void	setJMSMessageID(java.lang.String id)           Sets the message ID.
  void	setJMSMessageIdentity(org.activemq.service.MessageIdentity messageIdentity)
  void	setJMSPriority(int priority)           Sets the priority level for this message.
  void	setJMSRedelivered(boolean redelivered)           Specifies whether this message is being redelivered.
  void	setJMSReplyTo(javax.jms.Destination replyTo)           Sets the Destination object to which a reply to this message should be sent.
  void	setJMSTimestamp(long timestamp)           Sets the message timestamp.
  void	setJMSType(java.lang.String type)           Sets the message type.
  void	setLongProperty(java.lang.String name, long value)           Sets a long property value with the specified name into the message.
  void	setMessageAcknowledge(MessageAcknowledge messageAcknowledge)
  void	setMessageConsumed(boolean messageConsumed)
  void	setMessagePart(boolean messagePart)
  void	setMesssageHandle(short messsageHandle)
  void	setNumberOfParts(short numberOfParts)
  void	setObjectProperty(java.lang.String name, java.lang.Object value)           Sets a Java object property value with the specified name into the message.
  void	setParentMessageID(java.lang.String parentMessageId)
  void	setPartNumber(short partNumber)
  void	setProducerKey(java.lang.String producerKey)
  void	setProperties(java.util.Map newProperties)           Set the Message's properties from an external source No checking on correct types is done by this method
  void	setReadOnly(boolean value)           set the message readOnly
  void	setSequenceNumber(long sequenceNumber)
  void	setShortProperty(java.lang.String name, short value)           Sets a short property value with the specified name into the message.
  void	setStringProperty(java.lang.String name, java.lang.String value)           Sets a String property value with the specified name into the message.
  void	setTransactionId(java.lang.Object newTransactionId)
  void	setTransactionIDString(java.lang.String text)           A helper method for the OpenWire protocol
  void	setTransientConsumed(boolean transientConsumed)
  ActiveMQMessage	shallowCopy()
  java.lang.String	toString()           Convert this Object to a human-readable String.
  protected  java.lang.String	toString(int[] consumerNos)
  (package private)  boolean	vanillaToBoolean(java.util.Map table, java.lang.String name)
  (package private)  byte	vanillaToByte(java.util.Map table, java.lang.String name)
  (package private)  double	vanillaToDouble(java.util.Map table, java.lang.String name)
  (package private)  float	vanillaToFloat(java.util.Map table, java.lang.String name)
  (package private)  int	vanillaToInt(java.util.Map table, java.lang.String name)
  (package private)  long	vanillaToLong(java.util.Map table, java.lang.String name)
  (package private)  short	vanillaToShort(java.util.Map table, java.lang.String name)
  (package private)  java.lang.String	vanillaToString(java.util.Map table, java.lang.String name)
  void	writeBody(java.io.DataOutput dataOut)           Used serialize the message body to an output stream
  void	writeMapProperties(java.util.Map table, java.io.DataOutput dataOut)           write map properties to an output stream

   

  Methods inherited from class org.activemq.message.AbstractPacket

  addBrokerVisited, clearBrokersVisited, decrementMemoryReferenceCount, equals, getBitArray, getBrokersVisited, getBrokersVisitedAsString, getId, getMemoryUsage, getMemoryUsageReferenceCount, getPacketTypeAsString, hasVisited, incrementMemoryReferenceCount, initializeBrokersVisited, initializeOther, isReceipt, isReceiptRequired, setBitArray, setBrokersVisitedAsString, setId, setMemoryUsage, setReceiptRequired

   

  Methods inherited from class java.lang.Object

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

   

  Methods inherited from interface org.activemq.io.util.MemoryManageable

  decrementMemoryReferenceCount, getMemoryUsage, getMemoryUsageReferenceCount, incrementMemoryReferenceCount

   

  Field Detail

  DEFAULT_DELIVERY_MODE

  static final int DEFAULT_DELIVERY_MODE

  The message producer's default delivery mode is PERSISTENT.

  See Also:

  DeliveryMode.PERSISTENT>DeliveryMode.PERSISTENT 55 , Constant Field Values

  ---

  DEFAULT_PRIORITY

  static final int DEFAULT_PRIORITY

  The message producer's default priority is 4.

  See Also:

  Constant Field Values

  ---

  DEFAULT_TIME_TO_LIVE

  static final long DEFAULT_TIME_TO_LIVE

  The message producer's default time to live is unlimited; the message never expires.

  See Also:

  Constant Field Values

  ---

  EOF

  static final byte EOF

  message property types

  See Also:

  Constant Field Values

  ---

  BYTES

  static final byte BYTES

  See Also:

  Constant Field Values

  ---

  STRING

  static final byte STRING

  See Also:

  Constant Field Values

  ---

  BOOLEAN

  static final byte BOOLEAN

  See Also:

  Constant Field Values

  ---

  CHAR

  static final byte CHAR

  See Also:

  Constant Field Values

  ---

  BYTE

  static final byte BYTE

  See Also:

  Constant Field Values

  ---

  SHORT

  static final byte SHORT

  See Also:

  Constant Field Values

  ---

  INT

  static final byte INT

  See Also:

  Constant Field Values

  ---

  LONG

  static final byte LONG

  See Also:

  Constant Field Values

  ---

  FLOAT

  static final byte FLOAT

  See Also:

  Constant Field Values

  ---

  DOUBLE

  static final byte DOUBLE

  See Also:

  Constant Field Values

  ---

  NULL

  static final byte NULL

  See Also:

  Constant Field Values

  ---

  CORRELATION_INDEX

  public static final int CORRELATION_INDEX

  Message flag indexes (used for writing/reading to/from a Stream

  See Also:

  Constant Field Values

  ---

  TYPE_INDEX

  public static final int TYPE_INDEX

  See Also:

  Constant Field Values

  ---

  BROKER_NAME_INDEX

  public static final int BROKER_NAME_INDEX

  See Also:

  Constant Field Values

  ---

  CLUSTER_NAME_INDEX

  public static final int CLUSTER_NAME_INDEX

  See Also:

  Constant Field Values

  ---

  TRANSACTION_ID_INDEX

  public static final int TRANSACTION_ID_INDEX

  See Also:

  Constant Field Values

  ---

  REPLY_TO_INDEX

  public static final int REPLY_TO_INDEX

  See Also:

  Constant Field Values

  ---

  TIMESTAMP_INDEX

  public static final int TIMESTAMP_INDEX

  See Also:

  Constant Field Values

  ---

  EXPIRATION_INDEX

  public static final int EXPIRATION_INDEX

  See Also:

  Constant Field Values

  ---

  REDELIVERED_INDEX

  public static final int REDELIVERED_INDEX

  See Also:

  Constant Field Values

  ---

  XA_TRANS_INDEX

  public static final int XA_TRANS_INDEX

  See Also:

  Constant Field Values

  ---

  CID_INDEX

  public static final int CID_INDEX

  See Also:

  Constant Field Values

  ---

  PROPERTIES_INDEX

  public static final int PROPERTIES_INDEX

  See Also:

  Constant Field Values

  ---

  DISPATCHED_FROM_DLQ_INDEX

  public static final int DISPATCHED_FROM_DLQ_INDEX

  See Also:

  Constant Field Values

  ---

  PAYLOAD_INDEX

  public static final int PAYLOAD_INDEX

  See Also:

  Constant Field Values

  ---

  EXTERNAL_MESSAGE_ID_INDEX

  public static final int EXTERNAL_MESSAGE_ID_INDEX

  See Also:

  Constant Field Values

  ---

  MESSAGE_PART_INDEX

  public static final int MESSAGE_PART_INDEX

  See Also:

  Constant Field Values

  ---

  CACHED_VALUES_INDEX

  public static final int CACHED_VALUES_INDEX

  See Also:

  Constant Field Values

  ---

  CACHED_DESTINATION_INDEX

  public static final int CACHED_DESTINATION_INDEX

  See Also:

  Constant Field Values

  ---

  LONG_SEQUENCE_INDEX

  public static final int LONG_SEQUENCE_INDEX

  See Also:

  Constant Field Values

  ---

  DELIVERY_COUNT_NAME

  private static final java.lang.String DELIVERY_COUNT_NAME

  See Also:

  Constant Field Values

  ---

  readOnlyMessage

  protected boolean readOnlyMessage

  readOnlyMessage denotes if the message is read only

  ---

  jmsMessageID

  private java.lang.String jmsMessageID

  ---

  jmsClientID

  private java.lang.String jmsClientID

  ---

  jmsCorrelationID

  private java.lang.String jmsCorrelationID

  ---

  producerKey

  private java.lang.String producerKey

  ---

  jmsDestination

  private ActiveMQDestination jmsDestination

  ---

  jmsReplyTo

  private ActiveMQDestination jmsReplyTo

  ---

  jmsDeliveryMode

  private int jmsDeliveryMode

  ---

  jmsRedelivered

  private boolean jmsRedelivered

  ---

  jmsType

  private java.lang.String jmsType

  ---

  jmsExpiration

  private long jmsExpiration

  ---

  jmsPriority

  private int jmsPriority

  ---

  jmsTimestamp

  private long jmsTimestamp

  ---

  properties

  private java.util.Map properties

  ---

  readOnlyProperties

  private boolean readOnlyProperties

  ---

  entryBrokerName

  private java.lang.String entryBrokerName

  ---

  entryClusterName

  private java.lang.String entryClusterName

  ---

  consumerNos

  private int[] consumerNos

  ---

  transactionId

  private java.lang.Object transactionId

  ---

  xaTransacted

  private boolean xaTransacted

  ---

  consumerIdentifier

  private java.lang.String consumerIdentifier

  ---

  messageConsumed

  private boolean messageConsumed

  ---

  transientConsumed

  private boolean transientConsumed

  ---

  sequenceNumber

  private long sequenceNumber

  ---

  deliveryCount

  private int deliveryCount

  ---

  dispatchedFromDLQ

  private boolean dispatchedFromDLQ

  ---

  messageAcknowledge

  private MessageAcknowledge messageAcknowledge

  ---

  bodyAsBytes

  private org.activemq.io.util.ByteArray bodyAsBytes

  ---

  jmsMessageIdentity

  private org.activemq.service.MessageIdentity jmsMessageIdentity

  ---

  messsageHandle

  private short messsageHandle

  ---

  externalMessageId

  private boolean externalMessageId

  ---

  messagePart

  private boolean messagePart

  ---

  numberOfParts

  private short numberOfParts

  ---

  partNumber

  private short partNumber

  ---

  parentMessageID

  private java.lang.String parentMessageID

  Constructor Detail

  ActiveMQMessage

  public ActiveMQMessage()

  Method Detail

  isJMSMessage

  public boolean isJMSMessage()

  Retrieve if a JMS Message type or not

  Specified by:

  isJMSMessage in interface Packet

  Overrides:

  isJMSMessage in class AbstractPacket

  ---

  toString

  public java.lang.String toString()

  Description copied from class: java.lang.Object

  Convert this Object to a human-readable String. There are no limits placed on how long this String should be or what it should contain. We suggest you make it as intuitive as possible to be able to place it into System.out.println() 55 and such.

  It is typical, but not required, to ensure that this method never completes abruptly with a java.lang.RuntimeException.

  This method will be called when performing string concatenation with this object. If the result is null, string concatenation will instead use "null".

  The default implementation returns getClass().getName() + "@" + Integer.toHexString(hashCode()).

  Overrides:

  toString in class AbstractPacket

  ---

  toString

  protected java.lang.String toString(int[] consumerNos)

  ---

  getMessageAcknowledge

  public MessageAcknowledge getMessageAcknowledge()

  ---

  setMessageAcknowledge

  public void setMessageAcknowledge(MessageAcknowledge messageAcknowledge)

  ---

  getPacketType

  public int getPacketType()

  Return the type of Packet

  Specified by:

  getPacketType in interface Packet

  ---

  setReadOnly

  public void setReadOnly(boolean value)

  set the message readOnly

  ---

  isConsumerTarget

  public boolean isConsumerTarget(int consumerNumber)

  test to see if a particular Consumer at a Connection is meant to receive this Message

  ---

  getConsumerNosAsString

  public java.lang.String getConsumerNosAsString()

  ---

  setConsumerNosAsString

  public void setConsumerNosAsString(java.lang.String value)

  Sets the consumer numbers using a String format

  ---

  isTemporary

  public boolean isTemporary()

  ---

  hashCode

  public int hashCode()

  Description copied from class: java.lang.Object

  Get a value that represents this Object, as uniquely as possible within the confines of an int.

  There are some requirements on this method which subclasses must follow:
  

  • Semantic equality implies identical hashcodes. In other words, if a.equals(b) is true, then a.hashCode() == b.hashCode() must be as well. However, the reverse is not necessarily true, and two objects may have the same hashcode without being equal.
  • It must be consistent. Whichever value o.hashCode() returns on the first invocation must be the value returned on all later invocations as long as the object exists. Notice, however, that the result of hashCode may change between separate executions of a Virtual Machine, because it is not invoked on the same object.

  Notice that since hashCode is used in java.util.Hashtable and other hashing classes, a poor implementation will degrade the performance of hashing (so don't blindly implement it as returning a constant!). Also, if calculating the hash is time-consuming, a class may consider caching the results.

  The default implementation returns System.identityHashCode(this)

  Overrides:

  hashCode in class AbstractPacket

  ---

  equals

  public boolean equals(java.lang.Object obj)

  Returns true if this instance is equivalent to obj

  Overrides:

  equals in class AbstractPacket

  ---

  compareTo

  public int compareTo(java.lang.Object o)

  Description copied from interface: java.lang.Comparable

  Compares this object with another, and returns a numerical result based on the comparison. If the result is negative, this object sorts less than the other; if 0, the two are equal, and if positive, this object sorts greater than the other. To translate this into boolean, simply perform o1.compareTo(o2) <op> 0, where op is one of <, <=, =, !=, >, or >=.

  You must make sure that the comparison is mutual, ie. sgn(x.compareTo(y)) == -sgn(y.compareTo(x)) (where sgn() is defined as -1, 0, or 1 based on the sign). This includes throwing an exception in either direction if the two are not comparable; hence, compareTo(null) should always throw an Exception.

  You should also ensure transitivity, in two forms: x.compareTo(y) > 0 && y.compareTo(z) > 0 implies x.compareTo(z) > 0; and x.compareTo(y) == 0 implies x.compareTo(z) == y.compareTo(z).

  Specified by:

  compareTo in interface java.lang.Comparable

  ---

  compareTo

  public int compareTo(ActiveMQMessage that)

  Sorted by destination and then messageId

  ---

  shallowCopy

  public ActiveMQMessage shallowCopy()
                              throws javax.jms.JMSException

  ---

  deepCopy

  public ActiveMQMessage deepCopy()
                           throws javax.jms.JMSException

  ---

  isExpired

  public boolean isExpired(long currentTime)

  Indicates if the Message has expired

  ---

  isExpired

  public boolean isExpired()

  ---

  isAdvisory

  public boolean isAdvisory()

  ---

  initializeOther

  protected void initializeOther(ActiveMQMessage other)

  Initializes another message with current values from this instance

  ---

  getJMSMessageID

  public java.lang.String getJMSMessageID()

  Gets the message ID.

  The JMSMessageID header field contains a value that uniquely identifies each message sent by a provider.

  When a message is sent, JMSMessageID can be ignored. When the send or publish method returns, it contains a provider-assigned value.

  A JMSMessageID is a String value that should function as a unique key for identifying messages in a historical repository. The exact scope of uniqueness is provider-defined. It should at least cover all messages for a specific installation of a provider, where an installation is some connected set of message routers.

  All JMSMessageID values must start with the prefix 'ID:'. Uniqueness of message ID values across different providers is not required.

  Since message IDs take some effort to create and increase a message's size, some JMS providers may be able to optimize message overhead if they are given a hint that the message ID is not used by an application. By calling the MessageProducer.setDisableMessageID method, a JMS client enables this potential optimization for all messages sent by that message producer. If the JMS provider accepts this hint, these messages must have the message ID set to null; if the provider ignores the hint, the message ID must be set to its normal unique value.

  Specified by:

  getJMSMessageID in interface javax.jms.Message

  ---

  setJMSMessageID

  public void setJMSMessageID(java.lang.String id)

  Sets the message ID.

  JMS providers set this field when a message is sent. This method can be used to change the value for a message that has been received.

  Specified by:

  setJMSMessageID in interface javax.jms.Message

  ---

  getMemoryId

  public java.lang.Object getMemoryId()

  Another way to get the Message id.

  Specified by:

  getMemoryId in interface org.activemq.io.util.MemoryManageable

  ---

  getJMSTimestamp

  public long getJMSTimestamp()

  Gets the message timestamp.

  The JMSTimestamp header field contains the time a message was handed off to a provider to be sent. It is not the time the message was actually transmitted, because the actual send may occur later due to transactions or other client-side queueing of messages.

  When a message is sent, JMSTimestamp is ignored. When the send or publish method returns, it contains a time value somewhere in the interval between the call and the return. The value is in the format of a normal millis time value in the Java programming language.

  Since timestamps take some effort to create and increase a message's size, some JMS providers may be able to optimize message overhead if they are given a hint that the timestamp is not used by an application. By calling the MessageProducer.setDisableMessageTimestamp method, a JMS client enables this potential optimization for all messages sent by that message producer. If the JMS provider accepts this hint, these messages must have the timestamp set to zero; if the provider ignores the hint, the timestamp must be set to its normal value.

  Specified by:

  getJMSTimestamp in interface javax.jms.Message

  ---

  setJMSTimestamp

  public void setJMSTimestamp(long timestamp)

  Sets the message timestamp.

  JMS providers set this field when a message is sent. This method can be used to change the value for a message that has been received.

  Specified by:

  setJMSTimestamp in interface javax.jms.Message

  ---

  getJMSCorrelationIDAsBytes

  public byte[] getJMSCorrelationIDAsBytes()

  Gets the correlation ID as an array of bytes for the message.

  The use of a byte[] value for JMSCorrelationID is non-portable.

  Specified by:

  getJMSCorrelationIDAsBytes in interface javax.jms.Message

  ---

  setJMSCorrelationIDAsBytes

  public void setJMSCorrelationIDAsBytes(byte[] correlationID)

  Sets the correlation ID as an array of bytes for the message.

  The array is copied before the method returns, so future modifications to the array will not alter this message header.

  If a provider supports the native concept of correlation ID, a JMS client may need to assign specific JMSCorrelationID values to match those expected by native messaging clients. JMS providers without native correlation ID values are not required to support this method and its corresponding get method; their implementation may throw a java.lang.UnsupportedOperationException.

  The use of a byte[] value for JMSCorrelationID is non-portable.

  Specified by:

  setJMSCorrelationIDAsBytes in interface javax.jms.Message

  ---

  setJMSCorrelationID

  public void setJMSCorrelationID(java.lang.String correlationID)

  Sets the correlation ID for the message.

  A client can use the JMSCorrelationID header field to link one message with another. A typical use is to link a response message with its request message.

  JMSCorrelationID can hold one of the following:

  • A provider-specific message ID
  • An application-specific String
  • A provider-native byte[] value

  Since each message sent by a JMS provider is assigned a message ID value, it is convenient to link messages via message ID. All message ID values must start with the 'ID:' prefix.

  In some cases, an application (made up of several clients) needs to use an application-specific value for linking messages. For instance, an application may use JMSCorrelationID to hold a value referencing some external information. Application-specified values must not start with the 'ID:' prefix; this is reserved for provider-generated message ID values.

  If a provider supports the native concept of correlation ID, a JMS client may need to assign specific JMSCorrelationID values to match those expected by clients that do not use the JMS API. A byte[] value is used for this purpose. JMS providers without native correlation ID values are not required to support byte[] values. The use of a byte[] value for JMSCorrelationID is non-portable.

  Specified by:

  setJMSCorrelationID in interface javax.jms.Message

  ---

  getJMSCorrelationID

  public java.lang.String getJMSCorrelationID()

  Gets the correlation ID for the message.

  This method is used to return correlation ID values that are either provider-specific message IDs or application-specific String values.

  Specified by:

  getJMSCorrelationID in interface javax.jms.Message

  ---

  getJMSReplyTo

  public javax.jms.Destination getJMSReplyTo()

  Gets the Destination object to which a reply to this message should be sent.

  Specified by:

  getJMSReplyTo in interface javax.jms.Message

  ---

  setJMSReplyTo

  public void setJMSReplyTo(javax.jms.Destination replyTo)

  Sets the Destination object to which a reply to this message should be sent.

  The JMSReplyTo header field contains the destination where a reply to the current message should be sent. If it is null, no reply is expected. The destination may be either a Queue object or a Topic object.

  Messages sent with a null JMSReplyTo value may be a notification of some event, or they may just be some data the sender thinks is of interest.

  Messages with a JMSReplyTo value typically expect a response. A response is optional; it is up to the client to decide. These messages are called requests. A message sent in response to a request is called a reply.

  In some cases a client may wish to match a request it sent earlier with a reply it has just received. The client can use the JMSCorrelationID header field for this purpose.

  Specified by:

  setJMSReplyTo in interface javax.jms.Message

  ---

  getJMSDestination

  public javax.jms.Destination getJMSDestination()

  Gets the Destination object for this message.

  The JMSDestination header field contains the destination to which the message is being sent.

  When a message is sent, this field is ignored. After completion of the send or publish method, the field holds the destination specified by the method.

  When a message is received, its JMSDestination value must be equivalent to the value assigned when it was sent.

  Specified by:

  getJMSDestination in interface javax.jms.Message

  ---

  setJMSDestination

  public void setJMSDestination(javax.jms.Destination destination)

  Sets the Destination object for this message.

  JMS providers set this field when a message is sent. This method can be used to change the value for a message that has been received.

  Specified by:

  setJMSDestination in interface javax.jms.Message

  ---

  getJMSDeliveryMode

  public int getJMSDeliveryMode()

  Gets the DeliveryMode value specified for this message.

  Specified by:

  getJMSDeliveryMode in interface javax.jms.Message

  ---

  setJMSDeliveryMode

  public void setJMSDeliveryMode(int deliveryMode)

  Sets the DeliveryMode value for this message.

  JMS providers set this field when a message is sent. This method can be used to change the value for a message that has been received.

  Specified by:

  setJMSDeliveryMode in interface javax.jms.Message

  ---

  getJMSRedelivered

  public boolean getJMSRedelivered()

  Gets an indication of whether this message is being redelivered.

  If a client receives a message with the JMSRedelivered field set, it is likely, but not guaranteed, that this message was delivered earlier but that its receipt was not acknowledged at that time.

  Specified by:

  getJMSRedelivered in interface javax.jms.Message

  ---

  setJMSRedelivered

  public void setJMSRedelivered(boolean redelivered)

  Specifies whether this message is being redelivered.

  This field is set at the time the message is delivered. This method can be used to change the value for a message that has been received.

  Specified by:

  setJMSRedelivered in interface javax.jms.Message

  ---

  getJMSType

  public java.lang.String getJMSType()

  Gets the message type identifier supplied by the client when the message was sent.

  Specified by:

  getJMSType in interface javax.jms.Message

  ---

  setJMSType

  public void setJMSType(java.lang.String type)

  Sets the message type.

  Some JMS providers use a message repository that contains the definitions of messages sent by applications. The JMSType header field may reference a message's definition in the provider's repository.

  The JMS API does not define a standard message definition repository, nor does it define a naming policy for the definitions it contains.

  Some messaging systems require that a message type definition for each application message be created and that each message specify its type. In order to work with such JMS providers, JMS clients should assign a value to JMSType, whether the application makes use of it or not. This ensures that the field is properly set for those providers that require it.

  To ensure portability, JMS clients should use symbolic values for JMSType that can be configured at installation time to the values defined in the current provider's message repository. If string literals are used, they may not be valid type names for some JMS providers.

  Specified by:

  setJMSType in interface javax.jms.Message

  ---

  getJMSExpiration

  public long getJMSExpiration()

  Gets the message's expiration value.

  When a message is sent, the JMSExpiration header field is left unassigned. After completion of the send or publish method, it holds the expiration time of the message. This is the sum of the time-to-live value specified by the client and the GMT at the time of the send or publish.

  If the time-to-live is specified as zero, JMSExpiration is set to zero to indicate that the message does not expire.

  When a message's expiration time is reached, a provider should discard it. The JMS API does not define any form of notification of message expiration.

  Clients should not receive messages that have expired; however, the JMS API does not guarantee that this will not happen.

  Specified by:

  getJMSExpiration in interface javax.jms.Message

  ---

  setJMSExpiration

  public void setJMSExpiration(long expiration)

  Sets the message's expiration value.

  JMS providers set this field when a message is sent. This method can be used to change the value for a message that has been received.

  Specified by:

  setJMSExpiration in interface javax.jms.Message

  ---

  getJMSPriority

  public int getJMSPriority()

  Gets the message priority level.

  The JMS API defines ten levels of priority value, with 0 as the lowest priority and 9 as the highest. In addition, clients should consider priorities 0-4 as gradations of normal priority and priorities 5-9 as gradations of expedited priority.

  The JMS API does not require that a provider strictly implement priority ordering of messages; however, it should do its best to deliver expedited messages ahead of normal messages.

  Specified by:

  getJMSPriority in interface javax.jms.Message

  ---

  setJMSPriority

  public void setJMSPriority(int priority)

  Sets the priority level for this message.

  JMS providers set this field when a message is sent. This method can be used to change the value for a message that has been received.

  Specified by:

  setJMSPriority in interface javax.jms.Message

  ---

  clearProperties

  public void clearProperties()

  Clears a message's properties.

  The message's header fields and body are not cleared.

  Specified by:

  clearProperties in interface javax.jms.Message

  ---

  propertyExists

  public boolean propertyExists(java.lang.String name)

  Indicates whether a property value exists.

  Specified by:

  propertyExists in interface javax.jms.Message

  ---

  getBooleanProperty

  public boolean getBooleanProperty(java.lang.String name)
                             throws javax.jms.JMSException

  Returns the value of the boolean property with the specified name.

  Specified by:

  getBooleanProperty in interface javax.jms.Message

  ---

  getByteProperty

  public byte getByteProperty(java.lang.String name)
                       throws javax.jms.JMSException

  Returns the value of the byte property with the specified name.

  Specified by:

  getByteProperty in interface javax.jms.Message

  ---

  getShortProperty

  public short getShortProperty(java.lang.String name)
                         throws javax.jms.JMSException

  Returns the value of the short property with the specified name.

  Specified by:

  getShortProperty in interface javax.jms.Message

  ---

  getIntProperty

  public int getIntProperty(java.lang.String name)
                     throws javax.jms.JMSException

  Returns the value of the int property with the specified name.

  Specified by:

  getIntProperty in interface javax.jms.Message

  ---

  getLongProperty

  public long getLongProperty(java.lang.String name)
                       throws javax.jms.JMSException

  Returns the value of the long property with the specified name.

  Specified by:

  getLongProperty in interface javax.jms.Message

  ---

  getFloatProperty

  public float getFloatProperty(java.lang.String name)
                         throws javax.jms.JMSException

  Returns the value of the float property with the specified name.

  Specified by:

  getFloatProperty in interface javax.jms.Message

  ---

  getDoubleProperty

  public double getDoubleProperty(java.lang.String name)
                           throws javax.jms.JMSException

  Returns the value of the double property with the specified name.

  Specified by:

  getDoubleProperty in interface javax.jms.Message

  ---

  getStringProperty

  public java.lang.String getStringProperty(java.lang.String name)
                                     throws javax.jms.JMSException

  Returns the value of the String property with the specified name.

  Specified by:

  getStringProperty in interface javax.jms.Message

  ---

  getObjectProperty

  public java.lang.Object getObjectProperty(java.lang.String name)

  Returns the value of the Java object property with the specified name.

  This method can be used to return, in objectified format, an object that has been stored as a property in the message with the equivalent setObjectProperty method call, or its equivalent primitive settypeProperty method.

  Specified by:

  getObjectProperty in interface javax.jms.Message

  ---

  getPropertyNames

  public java.util.Enumeration getPropertyNames()

  Returns an Enumeration of all the property names.

  Note that JMS standard header fields are not considered properties and are not returned in this enumeration.

  Specified by:

  getPropertyNames in interface javax.jms.Message

  ---

  getProperties

  public java.util.Map getProperties()

  Retrieve the message properties as a Map

  ---

  setProperties

  public void setProperties(java.util.Map newProperties)

  Set the Message's properties from an external source No checking on correct types is done by this method

  ---

  setBooleanProperty

  public void setBooleanProperty(java.lang.String name,
                                 boolean value)
                          throws javax.jms.JMSException

  Sets a boolean property value with the specified name into the message.

  Specified by:

  setBooleanProperty in interface javax.jms.Message

  ---

  setByteProperty

  public void setByteProperty(java.lang.String name,
                              byte value)
                       throws javax.jms.JMSException

  Sets a byte property value with the specified name into the message.

  Specified by:

  setByteProperty in interface javax.jms.Message

  ---

  setShortProperty

  public void setShortProperty(java.lang.String name,
                               short value)
                        throws javax.jms.JMSException

  Sets a short property value with the specified name into the message.

  Specified by:

  setShortProperty in interface javax.jms.Message

  ---

  setIntProperty

  public void setIntProperty(java.lang.String name,
                             int value)
                      throws javax.jms.JMSException

  Sets an int property value with the specified name into the message.

  Specified by:

  setIntProperty in interface javax.jms.Message

  ---

  setLongProperty

  public void setLongProperty(java.lang.String name,
                              long value)
                       throws javax.jms.JMSException

  Sets a long property value with the specified name into the message.

  Specified by:

  setLongProperty in interface javax.jms.Message

  ---

  setFloatProperty

  public void setFloatProperty(java.lang.String name,
                               float value)
                        throws javax.jms.JMSException

  Sets a float property value with the specified name into the message.

  Specified by:

  setFloatProperty in interface javax.jms.Message

  ---

  setDoubleProperty

  public void setDoubleProperty(java.lang.String name,
                                double value)
                         throws javax.jms.JMSException

  Sets a double property value with the specified name into the message.

  Specified by:

  setDoubleProperty in interface javax.jms.Message

  ---

  setStringProperty

  public void setStringProperty(java.lang.String name,
                                java.lang.String value)
                         throws javax.jms.JMSException

  Sets a String property value with the specified name into the message.

  Specified by:

  setStringProperty in interface javax.jms.Message

  ---

  setObjectProperty

  public void setObjectProperty(java.lang.String name,
                                java.lang.Object value)
                         throws javax.jms.JMSException

  Sets a Java object property value with the specified name into the message.

  Note that this method works only for the objectified primitive object types (Integer, Double, Long ...) and String objects.

  Specified by:

  setObjectProperty in interface javax.jms.Message

  ---

  acknowledge

  public void acknowledge()
                   throws javax.jms.JMSException

  Acknowledges all consumed messages of the session of this consumed message.

  All consumed JMS messages support the acknowledge method for use when a client has specified that its JMS session's consumed messages are to be explicitly acknowledged. By invoking acknowledge on a consumed message, a client acknowledges all messages consumed by the session that the message was delivered to.

  Calls to acknowledge are ignored for both transacted sessions and sessions specified to use implicit acknowledgement modes.

  A client may individually acknowledge each message as it is consumed, or it may choose to acknowledge messages as an application-defined group (which is done by calling acknowledge on the last received message of the group, thereby acknowledging all messages consumed by the session.)

  Messages that have been received but not acknowledged may be redelivered.

  Specified by:

  acknowledge in interface javax.jms.Message

  ---

  clearBody

  public void clearBody()
                 throws javax.jms.JMSException

  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 javax.jms.Message

  ---

  vanillaToBoolean

  boolean vanillaToBoolean(java.util.Map table,
                           java.lang.String name)
                     throws javax.jms.JMSException

  ---

  vanillaToByte

  byte vanillaToByte(java.util.Map table,
                     java.lang.String name)
               throws javax.jms.JMSException

  ---

  vanillaToShort

  short vanillaToShort(java.util.Map table,
                       java.lang.String name)
                 throws javax.jms.JMSException

  ---

  vanillaToInt

  int vanillaToInt(java.util.Map table,
                   java.lang.String name)
             throws javax.jms.JMSException

  ---

  vanillaToLong

  long vanillaToLong(java.util.Map table,
                     java.lang.String name)
               throws javax.jms.JMSException

  ---

  vanillaToFloat

  float vanillaToFloat(java.util.Map table,
                       java.lang.String name)
                 throws javax.jms.JMSException

  ---

  vanillaToDouble

  double vanillaToDouble(java.util.Map table,
                         java.lang.String name)
                   throws javax.jms.JMSException

  ---

  getVanillaProperty

  java.lang.Object getVanillaProperty(java.util.Map table,
                                      java.lang.String name)

  ---

  getReservedProperty

  java.lang.Object getReservedProperty(java.lang.String name)

  ---

  vanillaToString

  java.lang.String vanillaToString(java.util.Map table,
                                   java.lang.String name)
                             throws javax.jms.JMSException

  ---

  prepareProperty

  private void prepareProperty(java.lang.String name)
                        throws javax.jms.JMSException

  ---

  getEntryBrokerName

  public java.lang.String getEntryBrokerName()

  ---

  setEntryBrokerName

  public void setEntryBrokerName(java.lang.String newEntryBrokerName)

  ---

  getEntryClusterName

  public java.lang.String getEntryClusterName()

  ---

  setEntryClusterName

  public void setEntryClusterName(java.lang.String newEntryClusterName)

  ---

  getConsumerNos

  public int[] getConsumerNos()

  ---

  setConsumerNos

  public void setConsumerNos(int[] newConsumerNos)

  ---

  getJMSClientID

  public java.lang.String getJMSClientID()

  ---

  setJMSClientID

  public void setJMSClientID(java.lang.String newJmsClientID)

  ---

  isPartOfTransaction

  public boolean isPartOfTransaction()

  ---

  getTransactionId

  public java.lang.Object getTransactionId()

  ---

  setTransactionId

  public void setTransactionId(java.lang.Object newTransactionId)

  ---

  getConsumerIdentifer

  public java.lang.String getConsumerIdentifer()

  ---

  setConsumerIdentifer

  public void setConsumerIdentifer(java.lang.String consId)

  ---

  isMessageConsumed

  public boolean isMessageConsumed()

  ---

  setMessageConsumed

  public void setMessageConsumed(boolean messageConsumed)

  ---

  prepareMessageBody

  public void prepareMessageBody()
                          throws javax.jms.JMSException

  Prepare a message body for delivery

  ---

  convertBodyToBytes

  public final void convertBodyToBytes()
                                throws java.io.IOException

  Convert the message body to data

  ---

  buildBodyFromBytes

  public final void buildBodyFromBytes()
                                throws java.io.IOException

  Builds the message body from data

  ---

  writeBody

  public void writeBody(java.io.DataOutput dataOut)
                 throws java.io.IOException

  Used serialize the message body to an output stream

  Specified by:

  writeBody in interface BodyPacket

  ---

  readBody

  public void readBody(java.io.DataInput dataIn)
                throws java.io.IOException

  Used to help build the body from an input stream

  Specified by:

  readBody in interface BodyPacket

  ---

  getBodyAsBytes

  public org.activemq.io.util.ByteArray getBodyAsBytes()
                                                throws java.io.IOException

  ---

  getBodyAsBytes

  public org.activemq.io.util.ByteArray getBodyAsBytes(org.activemq.io.util.ByteArrayCompression compression)
                                                throws java.io.IOException

  return the data after applying compression

  ---

  isBodyConvertedToBytes

  public boolean isBodyConvertedToBytes()

  ---

  setBodyAsBytes

  public void setBodyAsBytes(byte[] data,
                             int offset,
                             int length)

  ---

  setBodyAsBytes

  public void setBodyAsBytes(org.activemq.io.util.ByteArray ba)

  set the body as bytes

  ---

  writeMapProperties

  public void writeMapProperties(java.util.Map table,
                                 java.io.DataOutput dataOut)
                          throws java.io.IOException

  write map properties to an output stream

  ---

  readMapProperties

  public java.util.Map readMapProperties(java.io.DataInput dataIn)
                                  throws java.io.IOException

  ---

  isXaTransacted

  public boolean isXaTransacted()

  ---

  getJMSActiveMQDestination

  public ActiveMQDestination getJMSActiveMQDestination()

  ---

  getJMSMessageIdentity

  public org.activemq.service.MessageIdentity getJMSMessageIdentity()

  ---

  setJMSMessageIdentity

  public void setJMSMessageIdentity(org.activemq.service.MessageIdentity messageIdentity)

  ---

  isEntryBroker

  public boolean isEntryBroker(java.lang.String brokerName)

  Determine if the message originated in the network from the named broker

  ---

  isEntryCluster

  public boolean isEntryCluster(java.lang.String clusterName)

  Determine if the message originated in the network from the named cluster

  ---

  isTransientConsumed

  public boolean isTransientConsumed()

  ---

  setTransientConsumed

  public void setTransientConsumed(boolean transientConsumed)

  ---

  getSequenceNumber

  public long getSequenceNumber()

  ---

  setSequenceNumber

  public void setSequenceNumber(long sequenceNumber)

  ---

  getDeliveryCount

  public int getDeliveryCount()

  ---

  setDeliveryCount

  public void setDeliveryCount(int deliveryCount)

  ---

  incrementDeliveryCount

  public int incrementDeliveryCount()

  Increment the delivery count

  ---

  incrementRedeliveryCount

  public int incrementRedeliveryCount()

  Increment the redelivery count, which is the same as the delivery count except it does not consider the initial delivery upon message creation

  ---

  isPersistent

  public boolean isPersistent()

  ---

  isDispatchedFromDLQ

  public boolean isDispatchedFromDLQ()

  ---

  setDispatchedFromDLQ

  public void setDispatchedFromDLQ(boolean dispatchedFromDLQ)

  ---

  getMesssageHandle

  public short getMesssageHandle()

  ---

  setMesssageHandle

  public void setMesssageHandle(short messsageHandle)

  ---

  isExternalMessageId

  public boolean isExternalMessageId()

  ---

  setExternalMessageId

  public void setExternalMessageId(boolean externalMessageId)

  ---

  getProducerKey

  public java.lang.String getProducerKey()

  ---

  setProducerKey

  public void setProducerKey(java.lang.String producerKey)

  ---

  resetMessagePart

  public void resetMessagePart()

  reset message fragmentation infomation on this message

  ---

  isMessagePart

  public boolean isMessagePart()

  ---

  isLastMessagePart

  public boolean isLastMessagePart()

  ---

  setMessagePart

  public void setMessagePart(boolean messagePart)

  ---

  getNumberOfParts

  public short getNumberOfParts()

  ---

  setNumberOfParts

  public void setNumberOfParts(short numberOfParts)

  ---

  getPartNumber

  public short getPartNumber()

  ---

  setPartNumber

  public void setPartNumber(short partNumber)

  ---

  getParentMessageID

  public java.lang.String getParentMessageID()

  ---

  setParentMessageID

  public void setParentMessageID(java.lang.String parentMessageId)

  ---

  getPriority

  public int getPriority()

  Specified by:

  getPriority in interface org.activemq.io.util.MemoryManageable

  ---

  getTransactionIDString

  public java.lang.String getTransactionIDString()
                                          throws java.io.IOException

  A helper method for the OpenWire protocol

  ---

  setTransactionIDString

  public void setTransactionIDString(java.lang.String text)
                              throws java.io.IOException

  A helper method for the OpenWire protocol

  ---

  Overview  Package   Class  Use  Deprecated  Index
  Home >> All >> org >> activemq >> [ message overview ]	PREV CLASS  NEXT CLASS
  SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

  ---