MessageImpl (Red Hat JBoss Enterprise Application Platform 7.2.0.Beta public API)

java.lang.Object
- org.apache.activemq.artemis.core.message.impl.MessageImpl

All Implemented Interfaces:

Message, MessageInternal

Direct Known Subclasses:

ClientMessageImpl, ServerMessageImpl
```
public abstract class MessageImpl
extends Object
implements MessageInternal
```
A concrete implementation of a message
All messages handled by ActiveMQ Artemis core are of this type

Field Summary

Fields
Modifier and Type	Field and Description
`protected SimpleString`	`address`
`static int`	`BODY_OFFSET`
`protected ResetLimitWrappedActiveMQBuffer`	`bodyBuffer`
`protected ActiveMQBuffer`	`buffer`
`static int`	`BUFFER_HEADER_SPACE`
`protected boolean`	`bufferValid`
`protected boolean`	`durable`
`static SimpleString`	`HDR_BRIDGE_DUPLICATE_ID`
`static SimpleString`	`HDR_ROUTE_TO_ACK_IDS`
`static SimpleString`	`HDR_ROUTE_TO_IDS`
`static SimpleString`	`HDR_SCALEDOWN_TO_IDS`
`protected long`	`messageID`
`protected byte`	`priority`
`protected TypedProperties`	`properties`
`protected long`	`timestamp`
`protected byte`	`type`

Fields inherited from interface org.apache.activemq.artemis.api.core.Message
BYTES_TYPE, DEFAULT_TYPE, HDR_ACTUAL_EXPIRY_TIME, HDR_CONTENT_TYPE, HDR_DUPLICATE_DETECTION_ID, HDR_GROUP_ID, HDR_LARGE_BODY_SIZE, HDR_LARGE_COMPRESSED, HDR_LAST_VALUE_NAME, HDR_ORIG_MESSAGE_ID, HDR_ORIGINAL_ADDRESS, HDR_ORIGINAL_QUEUE, HDR_ROUTING_TYPE, HDR_SCHEDULED_DELIVERY_TIME, HDR_VALIDATED_USER, MAP_TYPE, OBJECT_TYPE, STREAM_TYPE, TEXT_TYPE

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`MessageImpl()`
`protected`	`MessageImpl(byte type, boolean durable, long expiration, long timestamp, byte priority, int initialMessageBufferSize)` overridden by the client message, we need access to the connection so we can create the appropriate ActiveMQBuffer.
`protected`	`MessageImpl(int initialMessageBufferSize)`
`protected`	`MessageImpl(MessageImpl other)`
`protected`	`MessageImpl(MessageImpl other, TypedProperties properties)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`bodyChanged()`
`String`	`bodyToString()` Debug Helper!!!! I'm leaving this message here without any callers for a reason: During debugs it's important eventually to identify what's on the bodies, and this method will give you a good idea about them.
`void`	`checkCompletion()`
`boolean`	`containsProperty(SimpleString key)` Returns `true` if this message contains a property with the given key, `false` else.
`boolean`	`containsProperty(String key)`
`void`	`copyHeadersAndProperties(MessageInternal msg)`
`void`	`createBody(int initialMessageBufferSize)`
`void`	`decode(ActiveMQBuffer buff)`
`void`	`decodeFromBuffer(ActiveMQBuffer buffer)`
`void`	`decodeHeadersAndProperties(ActiveMQBuffer buffer)`
`void`	`encode(ActiveMQBuffer buff)`
`void`	`encodeHeadersAndProperties(ActiveMQBuffer buffer)`
`boolean`	`equals(Object other)`
`SimpleString`	`getAddress()` this doesn't need to be synchronized as setAddress is protecting the buffer, not the address
`ActiveMQBuffer`	`getBodyBuffer()` Returns the message body as an ActiveMQBuffer
`ActiveMQBuffer`	`getBodyBufferDuplicate()` Returns a copy of the message body as an ActiveMQBuffer.
`BodyEncoder`	`getBodyEncoder()`
`Boolean`	`getBooleanProperty(SimpleString key)` Returns the property corresponding to the specified key as a Boolean.
`Boolean`	`getBooleanProperty(String key)`
`Byte`	`getByteProperty(SimpleString key)` Returns the property corresponding to the specified key as a Byte.
`Byte`	`getByteProperty(String key)`
`byte[]`	`getBytesProperty(SimpleString key)` Returns the property corresponding to the specified key as a byte[].
`byte[]`	`getBytesProperty(String key)`
`Double`	`getDoubleProperty(SimpleString key)` Returns the property corresponding to the specified key as a Double.
`Double`	`getDoubleProperty(String key)`
`ActiveMQBuffer`	`getEncodedBuffer()`
`int`	`getEncodeSize()` Returns the size of the encoded message.
`int`	`getEndOfBodyPosition()`
`int`	`getEndOfMessagePosition()`
`long`	`getExpiration()` Returns the expiration time of this message.
`Float`	`getFloatProperty(SimpleString key)` Returns the property corresponding to the specified key as a Float.
`Float`	`getFloatProperty(String key)`
`int`	`getHeadersAndPropertiesEncodeSize()`
`Integer`	`getIntProperty(SimpleString key)` Returns the property corresponding to the specified key as an Integer.
`Integer`	`getIntProperty(String key)`
`Long`	`getLongProperty(SimpleString key)` Returns the property corresponding to the specified key as a Long.
`Long`	`getLongProperty(String key)`
`long`	`getMessageID()` Returns the messageID.
`Object`	`getObjectProperty(SimpleString key)` Returns the property corresponding to the specified key
`Object`	`getObjectProperty(String key)`
`byte`	`getPriority()` Returns the message priority.
`TypedProperties`	`getProperties()`
`Set<SimpleString>`	`getPropertyNames()` Returns all the names of the properties for this message.
`Short`	`getShortProperty(SimpleString key)` Returns the property corresponding to the specified key as a Short.
`Short`	`getShortProperty(String key)`
`SimpleString`	`getSimpleStringProperty(SimpleString key)` Returns the property corresponding to the specified key as a SimpleString.
`SimpleString`	`getSimpleStringProperty(String key)`
`String`	`getStringProperty(SimpleString key)` Returns the property corresponding to the specified key as a String.
`String`	`getStringProperty(String key)`
`long`	`getTimestamp()` Returns the message timestamp.
`byte`	`getType()` Returns this message type.
`TypedProperties`	`getTypedProperties()`
`UUID`	`getUserID()` Returns the userID - this is an optional user specified UUID that can be set to identify the message and will be passed around with the message
`ActiveMQBuffer`	`getWholeBuffer()`
`int`	`hashCode()`
`boolean`	`isDurable()` Returns whether this message is durable or not.
`boolean`	`isExpired()` Returns whether this message is expired or not.
`Message`	`putBooleanProperty(SimpleString key, boolean value)` Puts a boolean property in this message.
`Message`	`putBooleanProperty(String key, boolean value)`
`Message`	`putByteProperty(SimpleString key, byte value)` Puts a byte property in this message.
`Message`	`putByteProperty(String key, byte value)`
`Message`	`putBytesProperty(SimpleString key, byte[] value)` Puts a byte[] property in this message.
`Message`	`putBytesProperty(String key, byte[] value)`
`Message`	`putCharProperty(SimpleString key, char value)` Puts a char property in this message.
`Message`	`putCharProperty(String key, char value)`
`Message`	`putDoubleProperty(SimpleString key, double value)` Puts a double property in this message.
`Message`	`putDoubleProperty(String key, double value)`
`Message`	`putFloatProperty(SimpleString key, float value)` Puts a float property in this message.
`Message`	`putFloatProperty(String key, float value)`
`Message`	`putIntProperty(SimpleString key, int value)` Puts an int property in this message.
`Message`	`putIntProperty(String key, int value)`
`Message`	`putLongProperty(SimpleString key, long value)` Puts a long property in this message.
`Message`	`putLongProperty(String key, long value)`
`Message`	`putObjectProperty(SimpleString key, Object value)` Puts an Object property in this message.
`Message`	`putObjectProperty(String key, Object value)`
`Message`	`putShortProperty(SimpleString key, short value)` Puts a short property in this message.
`Message`	`putShortProperty(String key, short value)`
`Message`	`putStringProperty(SimpleString key, SimpleString value)` Puts a SimpleString property in this message.
`Message`	`putStringProperty(String key, String value)` Puts a String property in this message.
`Message`	`putTypedProperties(TypedProperties otherProps)`
`Object`	`removeProperty(SimpleString key)` Removes the property corresponding to the specified key.
`Object`	`removeProperty(String key)`
`Message`	`setAddress(SimpleString address)` The only reason this is synchronized is because of encoding a message versus invalidating the buffer.
`void`	`setAddressTransient(SimpleString address)`
`MessageImpl`	`setDurable(boolean durable)` Sets whether this message is durable or not.
`MessageImpl`	`setExpiration(long expiration)` Sets the expiration of this message.
`MessageImpl`	`setPriority(byte priority)` Sets the message priority.
`MessageImpl`	`setTimestamp(long timestamp)` Sets the message timestamp.
`void`	`setType(byte type)`
`MessageImpl`	`setUserID(UUID userID)` Sets the user ID
`Map<String,Object>`	`toMap()`
`Map<String,Object>`	`toPropertyMap()`
`Message`	`writeBodyBufferBytes(byte[] bytes)` Writes the input byte array to the message body ActiveMQBuffer
`Message`	`writeBodyBufferString(String string)` Writes the input String to the message body ActiveMQBuffer

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.activemq.artemis.core.message.impl.MessageInternal
getBodyInputStream, isServerMessage

Methods inherited from interface org.apache.activemq.artemis.api.core.Message
isLargeMessage

- Field Detail
  - HDR_ROUTE_TO_IDS
```
public static final SimpleString HDR_ROUTE_TO_IDS
```
  - HDR_SCALEDOWN_TO_IDS
```
public static final SimpleString HDR_SCALEDOWN_TO_IDS
```
  - HDR_ROUTE_TO_ACK_IDS
```
public static final SimpleString HDR_ROUTE_TO_ACK_IDS
```
  - HDR_BRIDGE_DUPLICATE_ID
```
public static final SimpleString HDR_BRIDGE_DUPLICATE_ID
```
  - BUFFER_HEADER_SPACE
```
public static final int BUFFER_HEADER_SPACE
```
    See Also:
    
    Constant Field Values
  - BODY_OFFSET
```
public static final int BODY_OFFSET
```
    See Also:
    
    Constant Field Values
  - messageID
```
protected long messageID
```
  - address
```
protected SimpleString address
```
  - type
```
protected byte type
```
  - durable
```
protected boolean durable
```
  - timestamp
```
protected long timestamp
```
  - properties
```
protected TypedProperties properties
```
  - priority
```
protected byte priority
```
  - buffer
```
protected volatile ActiveMQBuffer buffer
```
  - bodyBuffer
```
protected volatile ResetLimitWrappedActiveMQBuffer bodyBuffer
```
  - bufferValid
```
protected volatile boolean bufferValid
```
- Constructor Detail
  - MessageImpl
```
protected MessageImpl()
```
  - MessageImpl
```
protected MessageImpl(byte type,
                      boolean durable,
                      long expiration,
                      long timestamp,
                      byte priority,
                      int initialMessageBufferSize)
```
    overridden by the client message, we need access to the connection so we can create the appropriate ActiveMQBuffer.
    
    Parameters:
    
    type -
    
    durable -
    
    expiration -
    
    timestamp -
    
    priority -
    
    initialMessageBufferSize -
  - MessageImpl
```
protected MessageImpl(int initialMessageBufferSize)
```
  - MessageImpl
```
protected MessageImpl(MessageImpl other)
```
  - MessageImpl
```
protected MessageImpl(MessageImpl other,
                      TypedProperties properties)
```
- Method Detail
  - getEncodeSize
```
public int getEncodeSize()
```
    Description copied from interface: Message
    
    Returns the size of the encoded message.
    
    Specified by:
    
    getEncodeSize in interface Message
  - getHeadersAndPropertiesEncodeSize
```
public int getHeadersAndPropertiesEncodeSize()
```
    Specified by:
    
    getHeadersAndPropertiesEncodeSize in interface MessageInternal
  - encodeHeadersAndProperties
```
public void encodeHeadersAndProperties(ActiveMQBuffer buffer)
```
    Specified by:
    
    encodeHeadersAndProperties in interface MessageInternal
  - decodeHeadersAndProperties
```
public void decodeHeadersAndProperties(ActiveMQBuffer buffer)
```
    Specified by:
    
    decodeHeadersAndProperties in interface MessageInternal
  - copyHeadersAndProperties
```
public void copyHeadersAndProperties(MessageInternal msg)
```
  - getBodyBuffer
```
public ActiveMQBuffer getBodyBuffer()
```
    Description copied from interface: Message
    
    Returns the message body as an ActiveMQBuffer
    
    Specified by:
    
    getBodyBuffer in interface Message
  - writeBodyBufferBytes
```
public Message writeBodyBufferBytes(byte[] bytes)
```
    Description copied from interface: Message
    
    Writes the input byte array to the message body ActiveMQBuffer
    
    Specified by:
    
    writeBodyBufferBytes in interface Message
  - writeBodyBufferString
```
public Message writeBodyBufferString(String string)
```
    Description copied from interface: Message
    
    Writes the input String to the message body ActiveMQBuffer
    
    Specified by:
    
    writeBodyBufferString in interface Message
  - checkCompletion
```
public void checkCompletion()
                     throws ActiveMQException
```
    Throws:
    
    ActiveMQException
  - getBodyBufferDuplicate
```
public ActiveMQBuffer getBodyBufferDuplicate()
```
    Description copied from interface: Message
    
    Returns a copy of the message body as an ActiveMQBuffer. Any modification of this buffer should not impact the underlying buffer.
    
    Specified by:
    
    getBodyBufferDuplicate in interface Message
  - getMessageID
```
public long getMessageID()
```
    Description copied from interface: Message
    
    Returns the messageID.
    The messageID is set when the message is handled by the server.
    
    Specified by:
    
    getMessageID in interface Message
  - getUserID
```
public UUID getUserID()
```
    Description copied from interface: Message
    
    Returns the userID - this is an optional user specified UUID that can be set to identify the message and will be passed around with the message
    
    Specified by:
    
    getUserID in interface Message
    
    Returns:
    
    the user id
  - setUserID
```
public MessageImpl setUserID(UUID userID)
```
    Description copied from interface: Message
    
    Sets the user ID
    
    Specified by:
    
    setUserID in interface Message
  - getAddress
```
public SimpleString getAddress()
```
    this doesn't need to be synchronized as setAddress is protecting the buffer, not the address
    
    Specified by:
    
    getAddress in interface Message
  - setAddress
```
public Message setAddress(SimpleString address)
```
    The only reason this is synchronized is because of encoding a message versus invalidating the buffer. This synchronization can probably be removed since setAddress is always called from a single thread. However I will keep it as it's harmless and it's been well tested
    
    Specified by:
    
    setAddress in interface Message
    
    Parameters:
    
    address - address to send the message to
  - getType
```
public byte getType()
```
    Description copied from interface: Message
    
    Returns this message type.
    See fields *_TYPE for possible values.
    
    Specified by:
    
    getType in interface Message
  - setType
```
public void setType(byte type)
```
  - isDurable
```
public boolean isDurable()
```
    Description copied from interface: Message
    
    Returns whether this message is durable or not.
    
    Specified by:
    
    isDurable in interface Message
  - setDurable
```
public MessageImpl setDurable(boolean durable)
```
    Description copied from interface: Message
    
    Sets whether this message is durable or not.
    
    Specified by:
    
    setDurable in interface Message
    
    Parameters:
    
    durable - true to flag this message as durable, false else
  - getExpiration
```
public long getExpiration()
```
    Description copied from interface: Message
    
    Returns the expiration time of this message.
    
    Specified by:
    
    getExpiration in interface Message
  - setExpiration
```
public MessageImpl setExpiration(long expiration)
```
    Description copied from interface: Message
    
    Sets the expiration of this message.
    
    Specified by:
    
    setExpiration in interface Message
    
    Parameters:
    
    expiration - expiration time
  - getTimestamp
```
public long getTimestamp()
```
    Description copied from interface: Message
    
    Returns the message timestamp.
    The timestamp corresponds to the time this message was handled by an ActiveMQ Artemis server.
    
    Specified by:
    
    getTimestamp in interface Message
  - setTimestamp
```
public MessageImpl setTimestamp(long timestamp)
```
    Description copied from interface: Message
    
    Sets the message timestamp.
    
    Specified by:
    
    setTimestamp in interface Message
    
    Parameters:
    
    timestamp - timestamp
  - getPriority
```
public byte getPriority()
```
    Description copied from interface: Message
    
    Returns the message priority.
    Values range from 0 (less priority) to 9 (more priority) inclusive.
    
    Specified by:
    
    getPriority in interface Message
  - setPriority
```
public MessageImpl setPriority(byte priority)
```
    Description copied from interface: Message
    
    Sets the message priority.
    Value must be between 0 and 9 inclusive.
    
    Specified by:
    
    setPriority in interface Message
    
    Parameters:
    
    priority - the new message priority
  - isExpired
```
public boolean isExpired()
```
    Description copied from interface: Message
    
    Returns whether this message is expired or not.
    
    Specified by:
    
    isExpired in interface Message
  - toMap
```
public Map<String,Object> toMap()
```
    Specified by:
    
    toMap in interface Message
    
    Returns:
    
    Returns the message in Map form, useful when encoding to JSON
  - toPropertyMap
```
public Map<String,Object> toPropertyMap()
```
    Specified by:
    
    toPropertyMap in interface Message
    
    Returns:
    
    Returns the message properties in Map form, useful when encoding to JSON
  - decodeFromBuffer
```
public void decodeFromBuffer(ActiveMQBuffer buffer)
```
    Specified by:
    
    decodeFromBuffer in interface MessageInternal
  - bodyChanged
```
public void bodyChanged()
```
    Specified by:
    
    bodyChanged in interface MessageInternal
  - getEndOfMessagePosition
```
public int getEndOfMessagePosition()
```
    Specified by:
    
    getEndOfMessagePosition in interface MessageInternal
  - getEndOfBodyPosition
```
public int getEndOfBodyPosition()
```
    Specified by:
    
    getEndOfBodyPosition in interface MessageInternal
  - encode
```
public void encode(ActiveMQBuffer buff)
```
  - decode
```
public void decode(ActiveMQBuffer buff)
```
  - getEncodedBuffer
```
public ActiveMQBuffer getEncodedBuffer()
```
    Specified by:
    
    getEncodedBuffer in interface MessageInternal
  - setAddressTransient
```
public void setAddressTransient(SimpleString address)
```
    Specified by:
    
    setAddressTransient in interface MessageInternal
  - putBooleanProperty
```
public Message putBooleanProperty(SimpleString key,
                                  boolean value)
```
    Description copied from interface: Message
    
    Puts a boolean property in this message.
    
    Specified by:
    
    putBooleanProperty in interface Message
    
    Parameters:
    
    key - property name
    
    value - property value
  - putByteProperty
```
public Message putByteProperty(SimpleString key,
                               byte value)
```
    Description copied from interface: Message
    
    Puts a byte property in this message.
    
    Specified by:
    
    putByteProperty in interface Message
    
    Parameters:
    
    key - property name
    
    value - property value
  - putBytesProperty
```
public Message putBytesProperty(SimpleString key,
                                byte[] value)
```
    Description copied from interface: Message
    
    Puts a byte[] property in this message.
    
    Specified by:
    
    putBytesProperty in interface Message
    
    Parameters:
    
    key - property name
    
    value - property value
  - putCharProperty
```
public Message putCharProperty(SimpleString key,
                               char value)
```
    Description copied from interface: Message
    
    Puts a char property in this message.
    
    Specified by:
    
    putCharProperty in interface Message
    
    Parameters:
    
    key - property name
    
    value - property value
  - putCharProperty
```
public Message putCharProperty(String key,
                               char value)
```
    Specified by:
    
    putCharProperty in interface Message
    
    See Also:
    
    Message.putCharProperty(SimpleString, char)
  - putShortProperty
```
public Message putShortProperty(SimpleString key,
                                short value)
```
    Description copied from interface: Message
    
    Puts a short property in this message.
    
    Specified by:
    
    putShortProperty in interface Message
    
    Parameters:
    
    key - property name
    
    value - property value
  - putIntProperty
```
public Message putIntProperty(SimpleString key,
                              int value)
```
    Description copied from interface: Message
    
    Puts an int property in this message.
    
    Specified by:
    
    putIntProperty in interface Message
    
    Parameters:
    
    key - property name
    
    value - property value
  - putLongProperty
```
public Message putLongProperty(SimpleString key,
                               long value)
```
    Description copied from interface: Message
    
    Puts a long property in this message.
    
    Specified by:
    
    putLongProperty in interface Message
    
    Parameters:
    
    key - property name
    
    value - property value
  - putFloatProperty
```
public Message putFloatProperty(SimpleString key,
                                float value)
```
    Description copied from interface: Message
    
    Puts a float property in this message.
    
    Specified by:
    
    putFloatProperty in interface Message
    
    Parameters:
    
    key - property name
    
    value - property value
  - putDoubleProperty
```
public Message putDoubleProperty(SimpleString key,
                                 double value)
```
    Description copied from interface: Message
    
    Puts a double property in this message.
    
    Specified by:
    
    putDoubleProperty in interface Message
    
    Parameters:
    
    key - property name
    
    value - property value
  - putStringProperty
```
public Message putStringProperty(SimpleString key,
                                 SimpleString value)
```
    Description copied from interface: Message
    
    Puts a SimpleString property in this message.
    
    Specified by:
    
    putStringProperty in interface Message
    
    Parameters:
    
    key - property name
    
    value - property value
  - putObjectProperty
```
public Message putObjectProperty(SimpleString key,
                                 Object value)
                          throws ActiveMQPropertyConversionException
```
    Description copied from interface: Message
    Puts an Object property in this message.
    Accepted types are:
    - Boolean
    - Byte
    - Short
    - Character
    - Integer
    - Long
    - Float
    - Double
    - String
    - SimpleString
    Using any other type will throw a PropertyConversionException.
    Specified by:
    
    putObjectProperty in interface Message
    
    Parameters:
    
    key - property name
    
    value - property value
    
    Throws:
    
    ActiveMQPropertyConversionException - if the value is not one of the accepted property types.
  - putObjectProperty
```
public Message putObjectProperty(String key,
                                 Object value)
                          throws ActiveMQPropertyConversionException
```
    Specified by:
    
    putObjectProperty in interface Message
    
    Throws:
    
    ActiveMQPropertyConversionException
    
    See Also:
    
    Message.putObjectProperty(SimpleString, Object)
  - putBooleanProperty
```
public Message putBooleanProperty(String key,
                                  boolean value)
```
    Specified by:
    
    putBooleanProperty in interface Message
    
    See Also:
    
    Message.putBooleanProperty(SimpleString, boolean)
  - putByteProperty
```
public Message putByteProperty(String key,
                               byte value)
```
    Specified by:
    
    putByteProperty in interface Message
    
    See Also:
    
    Message.putByteProperty(SimpleString, byte)
  - putBytesProperty
```
public Message putBytesProperty(String key,
                                byte[] value)
```
    Specified by:
    
    putBytesProperty in interface Message
    
    See Also:
    
    Message.putBytesProperty(SimpleString, byte[])
  - putShortProperty
```
public Message putShortProperty(String key,
                                short value)
```
    Specified by:
    
    putShortProperty in interface Message
    
    See Also:
    
    Message.putShortProperty(SimpleString, short)
  - putIntProperty
```
public Message putIntProperty(String key,
                              int value)
```
    Specified by:
    
    putIntProperty in interface Message
    
    See Also:
    
    Message.putIntProperty(SimpleString, int)
  - putLongProperty
```
public Message putLongProperty(String key,
                               long value)
```
    Specified by:
    
    putLongProperty in interface Message
    
    See Also:
    
    Message.putLongProperty(SimpleString, long)
  - putFloatProperty
```
public Message putFloatProperty(String key,
                                float value)
```
    Specified by:
    
    putFloatProperty in interface Message
    
    See Also:
    
    Message.putFloatProperty(SimpleString, float)
  - putDoubleProperty
```
public Message putDoubleProperty(String key,
                                 double value)
```
    Specified by:
    
    putDoubleProperty in interface Message
    
    See Also:
    
    Message.putDoubleProperty(SimpleString, double)
  - putStringProperty
```
public Message putStringProperty(String key,
                                 String value)
```
    Description copied from interface: Message
    
    Puts a String property in this message.
    
    Specified by:
    
    putStringProperty in interface Message
    
    Parameters:
    
    key - property name
    
    value - property value
  - putTypedProperties
```
public Message putTypedProperties(TypedProperties otherProps)
```
  - getObjectProperty
```
public Object getObjectProperty(SimpleString key)
```
    Description copied from interface: Message
    
    Returns the property corresponding to the specified key
    
    Specified by:
    
    getObjectProperty in interface Message
  - getBooleanProperty
```
public Boolean getBooleanProperty(SimpleString key)
                           throws ActiveMQPropertyConversionException
```
    Description copied from interface: Message
    
    Returns the property corresponding to the specified key as a Boolean.
    
    Specified by:
    
    getBooleanProperty in interface Message
    
    Throws:
    
    ActiveMQPropertyConversionException - if the value can not be converted to a Boolean
  - getBooleanProperty
```
public Boolean getBooleanProperty(String key)
                           throws ActiveMQPropertyConversionException
```
    Specified by:
    
    getBooleanProperty in interface Message
    
    Throws:
    
    ActiveMQPropertyConversionException
    
    See Also:
    
    Message.getBooleanProperty(SimpleString)
  - getByteProperty
```
public Byte getByteProperty(SimpleString key)
                     throws ActiveMQPropertyConversionException
```
    Description copied from interface: Message
    
    Returns the property corresponding to the specified key as a Byte.
    
    Specified by:
    
    getByteProperty in interface Message
    
    Throws:
    
    ActiveMQPropertyConversionException - if the value can not be converted to a Byte
  - getByteProperty
```
public Byte getByteProperty(String key)
                     throws ActiveMQPropertyConversionException
```
    Specified by:
    
    getByteProperty in interface Message
    
    Throws:
    
    ActiveMQPropertyConversionException
    
    See Also:
    
    Message.getByteProperty(SimpleString)
  - getBytesProperty
```
public byte[] getBytesProperty(SimpleString key)
                        throws ActiveMQPropertyConversionException
```
    Description copied from interface: Message
    
    Returns the property corresponding to the specified key as a byte[].
    
    Specified by:
    
    getBytesProperty in interface Message
    
    Throws:
    
    ActiveMQPropertyConversionException - if the value can not be converted to a byte[]
  - getBytesProperty
```
public byte[] getBytesProperty(String key)
                        throws ActiveMQPropertyConversionException
```
    Specified by:
    
    getBytesProperty in interface Message
    
    Throws:
    
    ActiveMQPropertyConversionException
    
    See Also:
    
    Message.getBytesProperty(SimpleString)
  - getDoubleProperty
```
public Double getDoubleProperty(SimpleString key)
                         throws ActiveMQPropertyConversionException
```
    Description copied from interface: Message
    
    Returns the property corresponding to the specified key as a Double.
    
    Specified by:
    
    getDoubleProperty in interface Message
    
    Throws:
    
    ActiveMQPropertyConversionException - if the value can not be converted to a Double
  - getDoubleProperty
```
public Double getDoubleProperty(String key)
                         throws ActiveMQPropertyConversionException
```
    Specified by:
    
    getDoubleProperty in interface Message
    
    Throws:
    
    ActiveMQPropertyConversionException
    
    See Also:
    
    Message.getDoubleProperty(SimpleString)
  - getIntProperty
```
public Integer getIntProperty(SimpleString key)
                       throws ActiveMQPropertyConversionException
```
    Description copied from interface: Message
    
    Returns the property corresponding to the specified key as an Integer.
    
    Specified by:
    
    getIntProperty in interface Message
    
    Throws:
    
    ActiveMQPropertyConversionException - if the value can not be converted to an Integer
  - getIntProperty
```
public Integer getIntProperty(String key)
                       throws ActiveMQPropertyConversionException
```
    Specified by:
    
    getIntProperty in interface Message
    
    Throws:
    
    ActiveMQPropertyConversionException
    
    See Also:
    
    Message.getIntProperty(SimpleString)
  - getLongProperty
```
public Long getLongProperty(SimpleString key)
                     throws ActiveMQPropertyConversionException
```
    Description copied from interface: Message
    
    Returns the property corresponding to the specified key as a Long.
    
    Specified by:
    
    getLongProperty in interface Message
    
    Throws:
    
    ActiveMQPropertyConversionException - if the value can not be converted to a Long
  - getLongProperty
```
public Long getLongProperty(String key)
                     throws ActiveMQPropertyConversionException
```
    Specified by:
    
    getLongProperty in interface Message
    
    Throws:
    
    ActiveMQPropertyConversionException
    
    See Also:
    
    Message.getLongProperty(SimpleString)
  - getShortProperty
```
public Short getShortProperty(SimpleString key)
                       throws ActiveMQPropertyConversionException
```
    Description copied from interface: Message
    
    Returns the property corresponding to the specified key as a Short.
    
    Specified by:
    
    getShortProperty in interface Message
    
    Throws:
    
    ActiveMQPropertyConversionException - if the value can not be converted to a Short
  - getShortProperty
```
public Short getShortProperty(String key)
                       throws ActiveMQPropertyConversionException
```
    Specified by:
    
    getShortProperty in interface Message
    
    Throws:
    
    ActiveMQPropertyConversionException
    
    See Also:
    
    Message.getShortProperty(SimpleString)
  - getFloatProperty
```
public Float getFloatProperty(SimpleString key)
                       throws ActiveMQPropertyConversionException
```
    Description copied from interface: Message
    
    Returns the property corresponding to the specified key as a Float.
    
    Specified by:
    
    getFloatProperty in interface Message
    
    Throws:
    
    ActiveMQPropertyConversionException - if the value can not be converted to a Float
  - getFloatProperty
```
public Float getFloatProperty(String key)
                       throws ActiveMQPropertyConversionException
```
    Specified by:
    
    getFloatProperty in interface Message
    
    Throws:
    
    ActiveMQPropertyConversionException
    
    See Also:
    
    Message.getFloatProperty(SimpleString)
  - getStringProperty
```
public String getStringProperty(SimpleString key)
                         throws ActiveMQPropertyConversionException
```
    Description copied from interface: Message
    
    Returns the property corresponding to the specified key as a String.
    
    Specified by:
    
    getStringProperty in interface Message
    
    Throws:
    
    ActiveMQPropertyConversionException - if the value can not be converted to a String
  - getStringProperty
```
public String getStringProperty(String key)
                         throws ActiveMQPropertyConversionException
```
    Specified by:
    
    getStringProperty in interface Message
    
    Throws:
    
    ActiveMQPropertyConversionException
    
    See Also:
    
    Message.getStringProperty(SimpleString)
  - getSimpleStringProperty
```
public SimpleString getSimpleStringProperty(SimpleString key)
                                     throws ActiveMQPropertyConversionException
```
    Description copied from interface: Message
    
    Returns the property corresponding to the specified key as a SimpleString.
    
    Specified by:
    
    getSimpleStringProperty in interface Message
    
    Throws:
    
    ActiveMQPropertyConversionException - if the value can not be converted to a SimpleString
  - getSimpleStringProperty
```
public SimpleString getSimpleStringProperty(String key)
                                     throws ActiveMQPropertyConversionException
```
    Specified by:
    
    getSimpleStringProperty in interface Message
    
    Throws:
    
    ActiveMQPropertyConversionException
    
    See Also:
    
    Message.getSimpleStringProperty(SimpleString)
  - getObjectProperty
```
public Object getObjectProperty(String key)
```
    Specified by:
    
    getObjectProperty in interface Message
    
    See Also:
    
    Message.getBooleanProperty(SimpleString)
  - removeProperty
```
public Object removeProperty(SimpleString key)
```
    Description copied from interface: Message
    
    Removes the property corresponding to the specified key.
    
    Specified by:
    
    removeProperty in interface Message
    
    Parameters:
    
    key - property name
    
    Returns:
    
    the value corresponding to the specified key or @{code null}
  - removeProperty
```
public Object removeProperty(String key)
```
    Specified by:
    
    removeProperty in interface Message
    
    See Also:
    
    Message.removeProperty(SimpleString)
  - containsProperty
```
public boolean containsProperty(SimpleString key)
```
    Description copied from interface: Message
    
    Returns true if this message contains a property with the given key, false else.
    
    Specified by:
    
    containsProperty in interface Message
    
    Parameters:
    
    key - property name
  - containsProperty
```
public boolean containsProperty(String key)
```
    Specified by:
    
    containsProperty in interface Message
    
    See Also:
    
    Message.containsProperty(SimpleString)
  - getPropertyNames
```
public Set<SimpleString> getPropertyNames()
```
    Description copied from interface: Message
    
    Returns all the names of the properties for this message.
    
    Specified by:
    
    getPropertyNames in interface Message
  - getWholeBuffer
```
public ActiveMQBuffer getWholeBuffer()
```
    Specified by:
    
    getWholeBuffer in interface MessageInternal
  - getBodyEncoder
```
public BodyEncoder getBodyEncoder()
                           throws ActiveMQException
```
    Specified by:
    
    getBodyEncoder in interface MessageInternal
    
    Throws:
    
    ActiveMQException
  - getTypedProperties
```
public TypedProperties getTypedProperties()
```
    Specified by:
    
    getTypedProperties in interface MessageInternal
  - equals
```
public boolean equals(Object other)
```
    Overrides:
    
    equals in class Object
  - bodyToString
```
public String bodyToString()
```
    Debug Helper!!!! I'm leaving this message here without any callers for a reason: During debugs it's important eventually to identify what's on the bodies, and this method will give you a good idea about them. Add the message.bodyToString() to the Watch variables on the debugger view and this will show up like a charm!!!
    
    Returns:
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - getProperties
```
public TypedProperties getProperties()
```
  - createBody
```
public void createBody(int initialMessageBufferSize)
```

Class MessageImpl

Field Summary

Fields inherited from interface org.apache.activemq.artemis.api.core.Message

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface org.apache.activemq.artemis.core.message.impl.MessageInternal

Methods inherited from interface org.apache.activemq.artemis.api.core.Message

Field Detail

HDR_ROUTE_TO_IDS

HDR_SCALEDOWN_TO_IDS

HDR_ROUTE_TO_ACK_IDS

HDR_BRIDGE_DUPLICATE_ID

BUFFER_HEADER_SPACE

BODY_OFFSET

messageID

address

type

durable

timestamp

properties

priority

buffer

bodyBuffer

bufferValid

Constructor Detail

MessageImpl

MessageImpl

MessageImpl

MessageImpl

MessageImpl

Method Detail

getEncodeSize

getHeadersAndPropertiesEncodeSize

encodeHeadersAndProperties

decodeHeadersAndProperties

copyHeadersAndProperties

getBodyBuffer

writeBodyBufferBytes

writeBodyBufferString

checkCompletion

getBodyBufferDuplicate

getMessageID

getUserID

setUserID

getAddress

setAddress

getType

setType

isDurable

setDurable

getExpiration

setExpiration

getTimestamp

setTimestamp

getPriority

setPriority

isExpired

toMap

toPropertyMap

decodeFromBuffer

bodyChanged

getEndOfMessagePosition

getEndOfBodyPosition

encode

decode

getEncodedBuffer

setAddressTransient

putBooleanProperty

putByteProperty

putBytesProperty

putCharProperty

putCharProperty

putShortProperty

putIntProperty

putLongProperty

putFloatProperty

putDoubleProperty

putStringProperty

putObjectProperty