CoreMessage (Red Hat JBoss Enterprise Application Platform 7.4.0.GA public API)

java.lang.Object
- org.apache.activemq.artemis.api.core.RefCountMessage
- - org.apache.activemq.artemis.core.message.impl.CoreMessage

All Implemented Interfaces:

ICoreMessage, Message

Direct Known Subclasses:

ClientMessageImpl, LargeServerMessageImpl
```
public class CoreMessage
extends RefCountMessage
implements ICoreMessage
```
Note: you shouldn't change properties using multi-threads. Change your properties before you can send it to multiple consumers

Field Summary

Fields
Modifier and Type	Field and Description
`protected SimpleString`	`address`
`static int`	`BODY_OFFSET`
`protected io.netty.buffer.ByteBuf`	`buffer` That is the readInto for the whole message, including properties..
`static int`	`BUFFER_HEADER_SPACE`
`protected boolean`	`durable`
`protected int`	`endOfBodyPosition`
`protected long`	`messageID`
`protected int`	`messageIDPosition`
`protected byte`	`priority`
`protected TypedProperties`	`properties`
`protected long`	`timestamp`
`protected byte`	`type`
`protected ResetLimitWrappedActiveMQBuffer`	`writableBuffer`

Fields inherited from interface org.apache.activemq.artemis.api.core.Message
BYTES_TYPE, DEFAULT_TYPE, EMBEDDED_TYPE, HDR_ACTUAL_EXPIRY_TIME, HDR_BRIDGE_DUPLICATE_ID, HDR_CONTENT_TYPE, HDR_DUPLICATE_DETECTION_ID, HDR_GROUP_ID, HDR_GROUP_SEQUENCE, HDR_LARGE_BODY_SIZE, HDR_LARGE_COMPRESSED, HDR_LAST_VALUE_NAME, HDR_ORIG_MESSAGE_ID, HDR_ORIGINAL_ADDRESS, HDR_ORIGINAL_QUEUE, HDR_PREFIX, HDR_ROUTE_TO_ACK_IDS, HDR_ROUTE_TO_IDS, HDR_ROUTING_TYPE, HDR_SCALEDOWN_TO_IDS, HDR_SCHEDULED_DELIVERY_TIME, HDR_VALIDATED_USER, INTERNAL_PROPERTY_NAMES_PREDICATE, LARGE_EMBEDDED_TYPE, MAP_TYPE, memoryOffset, OBJECT_TYPE, STREAM_TYPE, TEXT_TYPE

Constructor Summary

Constructors
Modifier	Constructor and Description
	`CoreMessage()`
`protected`	`CoreMessage(CoreMessage other)`
	`CoreMessage(CoreMessageObjectPools coreMessageObjectPools)`
`protected`	`CoreMessage(CoreMessage other, TypedProperties copyProperties)`
	`CoreMessage(long id, int bufferSize)`
	`CoreMessage(long id, int bufferSize, CoreMessageObjectPools coreMessageObjectPools)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`checkEncode()`
`void`	`clearInternalProperties()`
`boolean`	`containsProperty(SimpleString key)`
`boolean`	`containsProperty(String key)`
`Message`	`copy()` It will generate a new instance of the message encode, being a deep copy, new properties, new everything
`Message`	`copy(long newID)` It will generate a new instance of the message encode, being a deep copy, new properties, new everything
`void`	`decodeHeadersAndProperties(io.netty.buffer.ByteBuf buffer)`
`CoreMessage`	`encode()`
`void`	`encodeHeadersAndProperties(io.netty.buffer.ByteBuf buffer)`
`String`	`getAddress()`
`SimpleString`	`getAddressSimpleString()`
`Object`	`getAnnotation(SimpleString key)` On core there's no delivery annotation
`ActiveMQBuffer`	`getBodyBuffer()` The body used for this message.
`int`	`getBodyBufferSize()` Returns the length in bytes of the body buffer.
`InputStream`	`getBodyInputStream()`
`Boolean`	`getBooleanProperty(SimpleString key)`
`Boolean`	`getBooleanProperty(String key)`
`io.netty.buffer.ByteBuf`	`getBuffer()`
`Byte`	`getByteProperty(SimpleString key)`
`Byte`	`getByteProperty(String key)`
`byte[]`	`getBytesProperty(SimpleString key)`
`byte[]`	`getBytesProperty(String key)`
`Object`	`getCorrelationID()`
`ActiveMQBuffer`	`getDataBuffer()` This will return the proper buffer to represent the data of the Message.
`Double`	`getDoubleProperty(SimpleString key)`
`Double`	`getDoubleProperty(String key)`
`Object`	`getDuplicateProperty()`
`int`	`getEncodeSize()` Returns the size of the encoded message.
`int`	`getEndOfBodyPosition()`
`long`	`getExpiration()` Returns the expiration time of this message.
`Float`	`getFloatProperty(SimpleString key)`
`Float`	`getFloatProperty(String key)`
`SimpleString`	`getGroupID()`
`int`	`getGroupSequence()`
`int`	`getHeadersAndPropertiesEncodeSize()`
`Integer`	`getIntProperty(SimpleString key)`
`Integer`	`getIntProperty(String key)`
`LargeBodyReader`	`getLargeBodyReader()`
`SimpleString`	`getLastValueProperty()`
`Long`	`getLongProperty(SimpleString key)`
`Long`	`getLongProperty(String key)`
`int`	`getMemoryEstimate()`
`long`	`getMessageID()` Returns the messageID.
`Object`	`getObjectProperty(SimpleString key)`
`Object`	`getObjectProperty(String key)`
`long`	`getPersistentSize()` This is the size of the message when persisted on disk which is used for metrics tracking Note that even if the message itself is not persisted on disk (ie non-durable) this value is still used for metrics tracking If a normal message it will be the encoded message size If a large message it will be encoded message size + large message body size
`Persister<Message>`	`getPersister()`
`int`	`getPersistSize()`
`byte`	`getPriority()` Returns the message priority.
`TypedProperties`	`getProperties()` I am keeping this synchronized as the decode of the Properties is lazy
`Set<SimpleString>`	`getPropertyNames()` Returns all the names of the properties for this message.
`ActiveMQBuffer`	`getReadOnlyBodyBuffer()` Returns a new Buffer slicing the current Body.
`SimpleString`	`getReplyTo()`
`RoutingType`	`getRoutingType()`
`Long`	`getScheduledDeliveryTime()` Used to calculate what is the delivery time.
`Short`	`getShortProperty(SimpleString key)`
`Short`	`getShortProperty(String key)`
`SimpleString`	`getSimpleStringProperty(SimpleString key)`
`SimpleString`	`getSimpleStringProperty(String key)`
`String`	`getStringProperty(SimpleString key)`
`String`	`getStringProperty(String key)`
`long`	`getTimestamp()`
`byte`	`getType()` Return the type of the message
`UUID`	`getUserID()` This represents historically the JMSMessageID.
`String`	`getValidatedUserID()`
`boolean`	`hasScheduledDeliveryTime()` Search for the existence of the property: an implementor can save the message to be decoded, if possible.
`CoreMessage`	`initBuffer(int initialMessageBufferSize)`
`protected void`	`internalSetMessageID(long messageID)` This method serves as a purpose of extension.
`boolean`	`isDurable()` Returns whether this message is durable or not.
`boolean`	`isLargeMessage()`
`boolean`	`isServerMessage()` We are really interested if this is a LargeServerMessage.
`void`	`messageChanged()` WARNING: Calling this method on a AMQPMessage will allow the non mutable part of the message to be modified.
`void`	`moveHeadersAndProperties(Message msg)` Used on large messages treatment.
`void`	`persist(ActiveMQBuffer targetRecord)`
`CoreMessage`	`putBooleanProperty(SimpleString key, boolean value)`
`CoreMessage`	`putBooleanProperty(String key, boolean value)`
`CoreMessage`	`putByteProperty(SimpleString key, byte value)`
`CoreMessage`	`putByteProperty(String key, byte value)`
`CoreMessage`	`putBytesProperty(SimpleString key, byte[] value)`
`CoreMessage`	`putBytesProperty(String key, byte[] value)`
`CoreMessage`	`putCharProperty(SimpleString key, char value)`
`CoreMessage`	`putCharProperty(String key, char value)`
`CoreMessage`	`putDoubleProperty(SimpleString key, double value)`
`CoreMessage`	`putDoubleProperty(String key, double value)`
`CoreMessage`	`putFloatProperty(SimpleString key, float value)`
`CoreMessage`	`putFloatProperty(String key, float value)`
`CoreMessage`	`putIntProperty(SimpleString key, int value)`
`CoreMessage`	`putIntProperty(String key, int value)`
`CoreMessage`	`putLongProperty(SimpleString key, long value)`
`CoreMessage`	`putLongProperty(String key, long value)`
`CoreMessage`	`putObjectProperty(SimpleString key, Object value)`
`CoreMessage`	`putObjectProperty(String key, Object value)`
`CoreMessage`	`putShortProperty(SimpleString key, short value)`
`CoreMessage`	`putShortProperty(String key, short value)`
`CoreMessage`	`putStringProperty(SimpleString key, SimpleString value)`
`CoreMessage`	`putStringProperty(SimpleString key, String value)`
`CoreMessage`	`putStringProperty(String key, String value)` Puts a String property in this message.
`void`	`receiveBuffer_1X(io.netty.buffer.ByteBuf buffer)` This will fix the incoming body of 1.x messages
`void`	`receiveBuffer(io.netty.buffer.ByteBuf buffer)` Used to receive this message from an encoded medium buffer
`void`	`reloadPersistence(ActiveMQBuffer record, CoreMessageObjectPools pools)`
`Object`	`removeAnnotation(SimpleString key)` On core there's no delivery annotation
`Object`	`removeProperty(SimpleString key)`
`Object`	`removeProperty(String key)`
`boolean`	`searchProperty(SimpleString key)` Differently from `containsProperty(SimpleString)`, this method can save decoding the message, performing a search of the `key` property and falling back to `containsProperty(SimpleString)` if not possible or if already decoded.
`void`	`sendBuffer_1X(io.netty.buffer.ByteBuf sendBuffer)` Recast the message as an 1.4 message
`void`	`sendBuffer(io.netty.buffer.ByteBuf sendBuffer, int deliveryCount)` Used to send this message to an encoded medium buffer.
`CoreMessage`	`setAddress(SimpleString address)` This will set the address on CoreMessage.
`CoreMessage`	`setAddress(String address)` Look at `Message.setAddress(SimpleString)` for the doc.
`CoreMessage`	`setBuffer(io.netty.buffer.ByteBuf buffer)` The buffer will belong to this message, until release is called.
`Message`	`setCorrelationID(Object correlationID)`
`CoreMessage`	`setDurable(boolean durable)` Sets whether this message is durable or not.
`CoreMessage`	`setExpiration(long expiration)` Sets the expiration of this message.
`CoreMessage`	`setGroupID(SimpleString groupId)`
`CoreMessage`	`setGroupID(String groupId)`
`CoreMessage`	`setGroupSequence(int sequence)`
`Message`	`setLastValueProperty(SimpleString lastValueName)`
`CoreMessage`	`setMessageID(long messageID)`
`CoreMessage`	`setPriority(byte priority)` Sets the message priority.
`CoreMessage`	`setReplyTo(SimpleString address)`
`Message`	`setRoutingType(RoutingType routingType)`
`CoreMessage`	`setScheduledDeliveryTime(Long time)`
`CoreMessage`	`setTimestamp(long timestamp)`
`CoreMessage`	`setType(byte type)` the type of the message
`CoreMessage`	`setUserID(Object uuid)`
`CoreMessage`	`setUserID(UUID userID)`
`CoreMessage`	`setValidatedUserID(String validatedUserID)`
`CoreMessage`	`toCore()` This should make you convert your message into Core format.
`CoreMessage`	`toCore(CoreMessageObjectPools coreMessageObjectPools)` This should make you convert your message into Core format.
`String`	`toString()`

Methods inherited from class org.apache.activemq.artemis.api.core.RefCountMessage
debugRefs, debugString, durableDown, durableUp, getDurableCount, getParentRef, getRefCount, getUsage, refDown, refUp, releaseComplete, setParentRef, usageDown, usageUp

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

Methods inherited from interface org.apache.activemq.artemis.api.core.ICoreMessage
toMap

Methods inherited from interface org.apache.activemq.artemis.api.core.Message
acceptsConsumer, copy, durableDown, durableUp, getAnnotationString, getBrokerProperty, getConnectionID, getDuplicateIDBytes, getDurableCount, getExtraBytesProperty, getObjectPropertyForFilter, getRefCount, getUsage, getWholeMessageSize, isExpired, putExtraBytesProperty, reencode, refDown, referenceOriginalMessage, refUp, rejectConsumer, releaseBuffer, removeExtraBytesProperty, setAnnotation, setBrokerProperty, setConnectionID, toPropertyMap, usageDown, usageUp

- Field Detail
  - 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
  - buffer
```
protected io.netty.buffer.ByteBuf buffer
```
    That is the readInto for the whole message, including properties.. it does not include the buffer for the Packet send and receive header on core protocol
  - writableBuffer
```
protected volatile ResetLimitWrappedActiveMQBuffer writableBuffer
```
  - endOfBodyPosition
```
protected int endOfBodyPosition
```
  - messageIDPosition
```
protected int messageIDPosition
```
  - messageID
```
protected long messageID
```
  - address
```
protected SimpleString address
```
  - type
```
protected byte type
```
  - durable
```
protected boolean durable
```
  - timestamp
```
protected long timestamp
```
  - priority
```
protected byte priority
```
  - properties
```
protected volatile TypedProperties properties
```
- Constructor Detail
  - CoreMessage
```
public CoreMessage(CoreMessageObjectPools coreMessageObjectPools)
```
  - CoreMessage
```
public CoreMessage()
```
  - CoreMessage
```
protected CoreMessage(CoreMessage other)
```
  - CoreMessage
```
public CoreMessage(long id,
                   int bufferSize)
```
  - CoreMessage
```
public CoreMessage(long id,
                   int bufferSize,
                   CoreMessageObjectPools coreMessageObjectPools)
```
  - CoreMessage
```
protected CoreMessage(CoreMessage other,
                      TypedProperties copyProperties)
```
- Method Detail
  - getAnnotation
```
public Object getAnnotation(SimpleString key)
```
    On core there's no delivery annotation
    
    Specified by:
    
    getAnnotation in interface Message
  - removeAnnotation
```
public Object removeAnnotation(SimpleString key)
```
    On core there's no delivery annotation
    
    Specified by:
    
    removeAnnotation in interface Message
  - clearInternalProperties
```
public void clearInternalProperties()
```
    Specified by:
    
    clearInternalProperties in interface Message
  - getPersister
```
public Persister<Message> getPersister()
```
    Specified by:
    
    getPersister in interface Message
  - initBuffer
```
public CoreMessage initBuffer(int initialMessageBufferSize)
```
  - getReplyTo
```
public SimpleString getReplyTo()
```
    Specified by:
    
    getReplyTo in interface Message
  - getRoutingType
```
public RoutingType getRoutingType()
```
    Specified by:
    
    getRoutingType in interface Message
  - setRoutingType
```
public Message setRoutingType(RoutingType routingType)
```
    Specified by:
    
    setRoutingType in interface Message
  - setReplyTo
```
public CoreMessage setReplyTo(SimpleString address)
```
    Specified by:
    
    setReplyTo in interface Message
  - receiveBuffer
```
public void receiveBuffer(io.netty.buffer.ByteBuf buffer)
```
    Description copied from interface: Message
    
    Used to receive this message from an encoded medium buffer
    
    Specified by:
    
    receiveBuffer in interface Message
  - receiveBuffer_1X
```
public void receiveBuffer_1X(io.netty.buffer.ByteBuf buffer)
```
    This will fix the incoming body of 1.x messages
    
    Specified by:
    
    receiveBuffer_1X in interface ICoreMessage
  - getReadOnlyBodyBuffer
```
public ActiveMQBuffer getReadOnlyBodyBuffer()
```
    Description copied from interface: ICoreMessage
    
    Returns a new Buffer slicing the current Body.
    
    Specified by:
    
    getReadOnlyBodyBuffer in interface ICoreMessage
  - getBodyBufferSize
```
public int getBodyBufferSize()
```
    Description copied from interface: ICoreMessage
    
    Returns the length in bytes of the body buffer.
    
    Specified by:
    
    getBodyBufferSize in interface ICoreMessage
  - getDataBuffer
```
public ActiveMQBuffer getDataBuffer()
```
    This will return the proper buffer to represent the data of the Message. If compressed it will decompress. If large, it will read from the file or streaming.
    
    Specified by:
    
    getDataBuffer in interface ICoreMessage
    
    Returns:
  - getGroupID
```
public SimpleString getGroupID()
```
    Specified by:
    
    getGroupID in interface Message
  - setGroupID
```
public CoreMessage setGroupID(SimpleString groupId)
```
    Specified by:
    
    setGroupID in interface Message
  - setGroupID
```
public CoreMessage setGroupID(String groupId)
```
    Specified by:
    
    setGroupID in interface Message
  - getGroupSequence
```
public int getGroupSequence()
```
    Specified by:
    
    getGroupSequence in interface Message
  - setGroupSequence
```
public CoreMessage setGroupSequence(int sequence)
```
    Specified by:
    
    setGroupSequence in interface Message
  - getCorrelationID
```
public Object getCorrelationID()
```
    Specified by:
    
    getCorrelationID in interface Message
  - setCorrelationID
```
public Message setCorrelationID(Object correlationID)
```
    Specified by:
    
    setCorrelationID in interface Message
  - sendBuffer
```
public void sendBuffer(io.netty.buffer.ByteBuf sendBuffer,
                       int deliveryCount)
```
    Description copied from interface: Message
    
    Used to send this message to an encoded medium buffer.
    
    Specified by:
    
    sendBuffer in interface Message
    
    Parameters:
    
    sendBuffer -
    
    deliveryCount - Some protocols (AMQP) will have this as part of the message. ignored on core
  - sendBuffer_1X
```
public void sendBuffer_1X(io.netty.buffer.ByteBuf sendBuffer)
```
    Recast the message as an 1.4 message
    
    Specified by:
    
    sendBuffer_1X in interface ICoreMessage
  - checkEncode
```
protected void checkEncode()
```
  - getScheduledDeliveryTime
```
public Long getScheduledDeliveryTime()
```
    Description copied from interface: Message
    
    Used to calculate what is the delivery time. Return null if not scheduled.
    
    Specified by:
    
    getScheduledDeliveryTime in interface Message
  - setScheduledDeliveryTime
```
public CoreMessage setScheduledDeliveryTime(Long time)
```
    Specified by:
    
    setScheduledDeliveryTime in interface Message
  - getBodyInputStream
```
public InputStream getBodyInputStream()
```
    Specified by:
    
    getBodyInputStream in interface ICoreMessage
    
    Specified by:
    
    getBodyInputStream in interface Message
  - getBodyBuffer
```
public ActiveMQBuffer getBodyBuffer()
```
    The body used for this message.
    
    Specified by:
    
    getBodyBuffer in interface ICoreMessage
    
    Specified by:
    
    getBodyBuffer in interface Message
  - getEndOfBodyPosition
```
public int getEndOfBodyPosition()
```
    Specified by:
    
    getEndOfBodyPosition in interface ICoreMessage
  - messageChanged
```
public void messageChanged()
```
    Description copied from interface: Message
    
    WARNING: Calling this method on a AMQPMessage will allow the non mutable part of the message to be modified.
    
    Specified by:
    
    messageChanged in interface Message
  - internalSetMessageID
```
protected void internalSetMessageID(long messageID)
```
    This method serves as a purpose of extension. Large Message on a Core Message will have to set the messageID on the attached NewLargeMessage
  - moveHeadersAndProperties
```
public void moveHeadersAndProperties(Message msg)
```
    Description copied from interface: ICoreMessage
    
    Used on large messages treatment. this method is used to transfer properties from a temporary CoreMessage to a definitive one. This is used when before a Message was defined as a LargeMessages, its properties are then moved from the Temporary message to its final LargeMessage object. Be careful as this will not perform a copy of the Properties. For real copy, use the copy methods or copy constructors.
    
    Specified by:
    
    moveHeadersAndProperties in interface ICoreMessage
  - copy
```
public Message copy()
```
    Description copied from interface: Message
    
    It will generate a new instance of the message encode, being a deep copy, new properties, new everything
    
    Specified by:
    
    copy in interface Message
  - copy
```
public Message copy(long newID)
```
    Description copied from interface: Message
    
    It will generate a new instance of the message encode, being a deep copy, new properties, new everything
    
    Specified by:
    
    copy in interface Message
  - getExpiration
```
public long getExpiration()
```
    Description copied from interface: Message
    
    Returns the expiration time of this message.
    
    Specified by:
    
    getExpiration in interface Message
  - getTimestamp
```
public long getTimestamp()
```
    Specified by:
    
    getTimestamp in interface Message
  - setTimestamp
```
public CoreMessage setTimestamp(long timestamp)
```
    Specified by:
    
    setTimestamp 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
  - 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
  - getUserID
```
public UUID getUserID()
```
    Description copied from interface: Message
    
    This represents historically the JMSMessageID. We had in the past used this for the MessageID that was sent on core messages... later on when we added AMQP this name clashed with AMQPMessage.getUserID();
    
    Specified by:
    
    getUserID in interface Message
    
    Returns:
    
    the user id
  - setUserID
```
public CoreMessage setUserID(Object uuid)
```
    Specified by:
    
    setUserID in interface Message
  - getValidatedUserID
```
public String getValidatedUserID()
```
    Specified by:
    
    getValidatedUserID in interface Message
  - setValidatedUserID
```
public CoreMessage setValidatedUserID(String validatedUserID)
```
    Specified by:
    
    setValidatedUserID in interface Message
  - setMessageID
```
public CoreMessage setMessageID(long messageID)
```
    Specified by:
    
    setMessageID in interface Message
  - setAddress
```
public CoreMessage setAddress(SimpleString address)
```
    Description copied from interface: Message
    
    This will set the address on CoreMessage. Note for AMQPMessages: in AMQPMessages this will not really change the address on the message. Instead it will add a property on extraProperties which only transverse internally at the broker. Whatever you change here it won't affect anything towards the received message. If you wish to change AMQPMessages address you will have to do it directly at the AMQP Message, however beware that AMQPMessages are not supposed to be changed at the broker, so only do it if you know what you are doing.
    
    Specified by:
    
    setAddress in interface Message
    
    Returns:
  - getAddressSimpleString
```
public SimpleString getAddressSimpleString()
```
    Specified by:
    
    getAddressSimpleString in interface Message
  - setExpiration
```
public CoreMessage setExpiration(long expiration)
```
    Description copied from interface: Message
    
    Sets the expiration of this message.
    
    Specified by:
    
    setExpiration in interface Message
    
    Parameters:
    
    expiration - expiration time
  - setPriority
```
public CoreMessage 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
  - setUserID
```
public CoreMessage setUserID(UUID userID)
```
  - getProperties
```
public final TypedProperties getProperties()
```
    I am keeping this synchronized as the decode of the Properties is lazy
  - getMemoryEstimate
```
public int getMemoryEstimate()
```
    Specified by:
    
    getMemoryEstimate in interface Message
  - isServerMessage
```
public boolean isServerMessage()
```
    Description copied from interface: ICoreMessage
    
    We are really interested if this is a LargeServerMessage.
    
    Specified by:
    
    isServerMessage in interface ICoreMessage
    
    Returns:
  - getType
```
public byte getType()
```
    Description copied from interface: ICoreMessage
    
    Return the type of the message
    
    Specified by:
    
    getType in interface ICoreMessage
    
    Specified by:
    
    getType in interface Message
  - setType
```
public CoreMessage setType(byte type)
```
    Description copied from interface: ICoreMessage
    
    the type of the message
    
    Specified by:
    
    setType in interface ICoreMessage
    
    Specified by:
    
    setType in interface Message
  - decodeHeadersAndProperties
```
public void decodeHeadersAndProperties(io.netty.buffer.ByteBuf buffer)
```
  - encode
```
public CoreMessage encode()
```
  - encodeHeadersAndProperties
```
public void encodeHeadersAndProperties(io.netty.buffer.ByteBuf buffer)
```
  - getHeadersAndPropertiesEncodeSize
```
public int getHeadersAndPropertiesEncodeSize()
```
    Specified by:
    
    getHeadersAndPropertiesEncodeSize in interface ICoreMessage
  - getDuplicateProperty
```
public Object getDuplicateProperty()
```
    Specified by:
    
    getDuplicateProperty in interface Message
  - getLastValueProperty
```
public SimpleString getLastValueProperty()
```
    Specified by:
    
    getLastValueProperty in interface Message
  - setLastValueProperty
```
public Message setLastValueProperty(SimpleString lastValueName)
```
    Specified by:
    
    setLastValueProperty in interface Message
  - getEncodeSize
```
public int getEncodeSize()
```
    Description copied from interface: Message
    
    Returns the size of the encoded message.
    
    Specified by:
    
    getEncodeSize in interface Message
  - isLargeMessage
```
public boolean isLargeMessage()
```
    Specified by:
    
    isLargeMessage in interface Message
  - getAddress
```
public String getAddress()
```
    Specified by:
    
    getAddress in interface Message
  - setAddress
```
public CoreMessage setAddress(String address)
```
    Description copied from interface: Message
    
    Look at Message.setAddress(SimpleString) for the doc.
    
    Specified by:
    
    setAddress in interface Message
    
    Returns:
  - setBuffer
```
public CoreMessage setBuffer(io.netty.buffer.ByteBuf buffer)
```
    Description copied from interface: Message
    
    The buffer will belong to this message, until release is called.
    
    Specified by:
    
    setBuffer in interface Message
  - getBuffer
```
public io.netty.buffer.ByteBuf getBuffer()
```
    Specified by:
    
    getBuffer in interface Message
  - 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 CoreMessage 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
  - putBooleanProperty
```
public CoreMessage putBooleanProperty(String key,
                                      boolean value)
```
    Specified by:
    
    putBooleanProperty in interface Message
  - putBooleanProperty
```
public CoreMessage putBooleanProperty(SimpleString key,
                                      boolean value)
```
    Specified by:
    
    putBooleanProperty in interface Message
  - getBooleanProperty
```
public Boolean getBooleanProperty(SimpleString key)
                           throws ActiveMQPropertyConversionException
```
    Specified by:
    
    getBooleanProperty in interface Message
    
    Throws:
    
    ActiveMQPropertyConversionException
  - getBooleanProperty
```
public Boolean getBooleanProperty(String key)
                           throws ActiveMQPropertyConversionException
```
    Specified by:
    
    getBooleanProperty in interface Message
    
    Throws:
    
    ActiveMQPropertyConversionException
  - putByteProperty
```
public CoreMessage putByteProperty(SimpleString key,
                                   byte value)
```
    Specified by:
    
    putByteProperty in interface Message
  - putByteProperty
```
public CoreMessage putByteProperty(String key,
                                   byte value)
```
    Specified by:
    
    putByteProperty in interface Message
  - getByteProperty
```
public Byte getByteProperty(SimpleString key)
                     throws ActiveMQPropertyConversionException
```
    Specified by:
    
    getByteProperty in interface Message
    
    Throws:
    
    ActiveMQPropertyConversionException
  - getByteProperty
```
public Byte getByteProperty(String key)
                     throws ActiveMQPropertyConversionException
```
    Specified by:
    
    getByteProperty in interface Message
    
    Throws:
    
    ActiveMQPropertyConversionException
  - putBytesProperty
```
public CoreMessage putBytesProperty(SimpleString key,
                                    byte[] value)
```
    Specified by:
    
    putBytesProperty in interface Message
  - putBytesProperty
```
public CoreMessage putBytesProperty(String key,
                                    byte[] value)
```
    Specified by:
    
    putBytesProperty in interface Message
  - getBytesProperty
```
public byte[] getBytesProperty(SimpleString key)
                        throws ActiveMQPropertyConversionException
```
    Specified by:
    
    getBytesProperty in interface Message
    
    Throws:
    
    ActiveMQPropertyConversionException
  - getBytesProperty
```
public byte[] getBytesProperty(String key)
                        throws ActiveMQPropertyConversionException
```
    Specified by:
    
    getBytesProperty in interface Message
    
    Throws:
    
    ActiveMQPropertyConversionException
  - putCharProperty
```
public CoreMessage putCharProperty(SimpleString key,
                                   char value)
```
    Specified by:
    
    putCharProperty in interface Message
  - putCharProperty
```
public CoreMessage putCharProperty(String key,
                                   char value)
```
    Specified by:
    
    putCharProperty in interface Message
  - putShortProperty
```
public CoreMessage putShortProperty(SimpleString key,
                                    short value)
```
    Specified by:
    
    putShortProperty in interface Message
  - putShortProperty
```
public CoreMessage putShortProperty(String key,
                                    short value)
```
    Specified by:
    
    putShortProperty in interface Message
  - putIntProperty
```
public CoreMessage putIntProperty(SimpleString key,
                                  int value)
```
    Specified by:
    
    putIntProperty in interface Message
  - putIntProperty
```
public CoreMessage putIntProperty(String key,
                                  int value)
```
    Specified by:
    
    putIntProperty in interface Message
  - getIntProperty
```
public Integer getIntProperty(SimpleString key)
                       throws ActiveMQPropertyConversionException
```
    Specified by:
    
    getIntProperty in interface Message
    
    Throws:
    
    ActiveMQPropertyConversionException
  - getIntProperty
```
public Integer getIntProperty(String key)
                       throws ActiveMQPropertyConversionException
```
    Specified by:
    
    getIntProperty in interface Message
    
    Throws:
    
    ActiveMQPropertyConversionException
  - putLongProperty
```
public CoreMessage putLongProperty(SimpleString key,
                                   long value)
```
    Specified by:
    
    putLongProperty in interface Message
  - putLongProperty
```
public CoreMessage putLongProperty(String key,
                                   long value)
```
    Specified by:
    
    putLongProperty in interface Message
  - getLongProperty
```
public Long getLongProperty(SimpleString key)
                     throws ActiveMQPropertyConversionException
```
    Specified by:
    
    getLongProperty in interface Message
    
    Throws:
    
    ActiveMQPropertyConversionException
  - getLongProperty
```
public Long getLongProperty(String key)
                     throws ActiveMQPropertyConversionException
```
    Specified by:
    
    getLongProperty in interface Message
    
    Throws:
    
    ActiveMQPropertyConversionException
  - putFloatProperty
```
public CoreMessage putFloatProperty(SimpleString key,
                                    float value)
```
    Specified by:
    
    putFloatProperty in interface Message
  - putFloatProperty
```
public CoreMessage putFloatProperty(String key,
                                    float value)
```
    Specified by:
    
    putFloatProperty in interface Message
  - putDoubleProperty
```
public CoreMessage putDoubleProperty(SimpleString key,
                                     double value)
```
    Specified by:
    
    putDoubleProperty in interface Message
  - putDoubleProperty
```
public CoreMessage putDoubleProperty(String key,
                                     double value)
```
    Specified by:
    
    putDoubleProperty in interface Message
  - getDoubleProperty
```
public Double getDoubleProperty(SimpleString key)
                         throws ActiveMQPropertyConversionException
```
    Specified by:
    
    getDoubleProperty in interface Message
    
    Throws:
    
    ActiveMQPropertyConversionException
  - getDoubleProperty
```
public Double getDoubleProperty(String key)
                         throws ActiveMQPropertyConversionException
```
    Specified by:
    
    getDoubleProperty in interface Message
    
    Throws:
    
    ActiveMQPropertyConversionException
  - putStringProperty
```
public CoreMessage putStringProperty(SimpleString key,
                                     SimpleString value)
```
    Specified by:
    
    putStringProperty in interface Message
  - putStringProperty
```
public CoreMessage putStringProperty(SimpleString key,
                                     String value)
```
    Specified by:
    
    putStringProperty in interface Message
  - putStringProperty
```
public CoreMessage 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
  - putObjectProperty
```
public CoreMessage putObjectProperty(SimpleString key,
                                     Object value)
                              throws ActiveMQPropertyConversionException
```
    Specified by:
    
    putObjectProperty in interface Message
    
    Throws:
    
    ActiveMQPropertyConversionException
  - getObjectProperty
```
public Object getObjectProperty(String key)
```
    Specified by:
    
    getObjectProperty in interface Message
  - getObjectProperty
```
public Object getObjectProperty(SimpleString key)
```
    Specified by:
    
    getObjectProperty in interface Message
  - putObjectProperty
```
public CoreMessage putObjectProperty(String key,
                                     Object value)
                              throws ActiveMQPropertyConversionException
```
    Specified by:
    
    putObjectProperty in interface Message
    
    Throws:
    
    ActiveMQPropertyConversionException
  - getShortProperty
```
public Short getShortProperty(SimpleString key)
                       throws ActiveMQPropertyConversionException
```
    Specified by:
    
    getShortProperty in interface Message
    
    Throws:
    
    ActiveMQPropertyConversionException
  - getShortProperty
```
public Short getShortProperty(String key)
                       throws ActiveMQPropertyConversionException
```
    Specified by:
    
    getShortProperty in interface Message
    
    Throws:
    
    ActiveMQPropertyConversionException
  - getFloatProperty
```
public Float getFloatProperty(SimpleString key)
                       throws ActiveMQPropertyConversionException
```
    Specified by:
    
    getFloatProperty in interface Message
    
    Throws:
    
    ActiveMQPropertyConversionException
  - getFloatProperty
```
public Float getFloatProperty(String key)
                       throws ActiveMQPropertyConversionException
```
    Specified by:
    
    getFloatProperty in interface Message
    
    Throws:
    
    ActiveMQPropertyConversionException
  - getStringProperty
```
public String getStringProperty(SimpleString key)
                         throws ActiveMQPropertyConversionException
```
    Specified by:
    
    getStringProperty in interface Message
    
    Throws:
    
    ActiveMQPropertyConversionException
  - getStringProperty
```
public String getStringProperty(String key)
                         throws ActiveMQPropertyConversionException
```
    Specified by:
    
    getStringProperty in interface Message
    
    Throws:
    
    ActiveMQPropertyConversionException
  - getSimpleStringProperty
```
public SimpleString getSimpleStringProperty(SimpleString key)
                                     throws ActiveMQPropertyConversionException
```
    Specified by:
    
    getSimpleStringProperty in interface Message
    
    Throws:
    
    ActiveMQPropertyConversionException
  - getSimpleStringProperty
```
public SimpleString getSimpleStringProperty(String key)
                                     throws ActiveMQPropertyConversionException
```
    Specified by:
    
    getSimpleStringProperty in interface Message
    
    Throws:
    
    ActiveMQPropertyConversionException
  - removeProperty
```
public Object removeProperty(SimpleString key)
```
    Specified by:
    
    removeProperty in interface Message
  - removeProperty
```
public Object removeProperty(String key)
```
    Specified by:
    
    removeProperty in interface Message
  - hasScheduledDeliveryTime
```
public boolean hasScheduledDeliveryTime()
```
    Description copied from interface: Message
    
    Search for the existence of the property: an implementor can save the message to be decoded, if possible.
    
    Specified by:
    
    hasScheduledDeliveryTime in interface Message
  - searchProperty
```
public boolean searchProperty(SimpleString key)
```
    Differently from containsProperty(SimpleString), this method can save decoding the message, performing a search of the key property and falling back to containsProperty(SimpleString) if not possible or if already decoded.
  - containsProperty
```
public boolean containsProperty(SimpleString key)
```
    Specified by:
    
    containsProperty in interface Message
  - containsProperty
```
public boolean containsProperty(String key)
```
    Specified by:
    
    containsProperty in interface Message
  - 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
  - getLargeBodyReader
```
public LargeBodyReader getLargeBodyReader()
                                   throws ActiveMQException
```
    Specified by:
    
    getLargeBodyReader in interface ICoreMessage
    
    Throws:
    
    ActiveMQException
  - getPersistSize
```
public int getPersistSize()
```
    Specified by:
    
    getPersistSize in interface Message
  - persist
```
public void persist(ActiveMQBuffer targetRecord)
```
    Specified by:
    
    persist in interface Message
  - reloadPersistence
```
public void reloadPersistence(ActiveMQBuffer record,
                              CoreMessageObjectPools pools)
```
    Specified by:
    
    reloadPersistence in interface Message
  - toCore
```
public CoreMessage toCore()
```
    Description copied from interface: Message
    
    This should make you convert your message into Core format.
    
    Specified by:
    
    toCore in interface Message
  - toCore
```
public CoreMessage toCore(CoreMessageObjectPools coreMessageObjectPools)
```
    Description copied from interface: Message
    
    This should make you convert your message into Core format.
    
    Specified by:
    
    toCore in interface Message
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getPersistentSize
```
public long getPersistentSize()
                       throws ActiveMQException
```
    Description copied from interface: Message
    
    This is the size of the message when persisted on disk which is used for metrics tracking Note that even if the message itself is not persisted on disk (ie non-durable) this value is still used for metrics tracking If a normal message it will be the encoded message size If a large message it will be encoded message size + large message body size
    
    Specified by:
    
    getPersistentSize in interface Message
    
    Returns:
    
    Throws:
    
    ActiveMQException

Class CoreMessage

Field Summary

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

Constructor Summary

Method Summary

Methods inherited from class org.apache.activemq.artemis.api.core.RefCountMessage

Methods inherited from class java.lang.Object

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

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

Field Detail

BUFFER_HEADER_SPACE

BODY_OFFSET

buffer

writableBuffer

endOfBodyPosition

messageIDPosition

messageID

address

type

durable

timestamp

priority

properties

Constructor Detail

CoreMessage

CoreMessage

CoreMessage

CoreMessage

CoreMessage

CoreMessage

Method Detail

getAnnotation

removeAnnotation

clearInternalProperties

getPersister

initBuffer

getReplyTo

getRoutingType

setRoutingType

setReplyTo

receiveBuffer

receiveBuffer_1X

getReadOnlyBodyBuffer

getBodyBufferSize

getDataBuffer

getGroupID

setGroupID

setGroupID

getGroupSequence

setGroupSequence

getCorrelationID

setCorrelationID

sendBuffer

sendBuffer_1X

checkEncode

getScheduledDeliveryTime

setScheduledDeliveryTime

getBodyInputStream

getBodyBuffer

getEndOfBodyPosition

messageChanged

internalSetMessageID

moveHeadersAndProperties

copy

copy

getExpiration

getTimestamp

setTimestamp

getMessageID

getPriority

getUserID

setUserID

getValidatedUserID

setValidatedUserID

setMessageID

setAddress

getAddressSimpleString

setExpiration

setPriority

setUserID