java.lang.Object
- org.apache.activemq.artemis.api.core.RefCountMessage
- - org.apache.activemq.artemis.protocol.amqp.broker.AMQPMessage

All Implemented Interfaces:: Message

Direct Known Subclasses:: AMQPLargeMessage, AMQPStandardMessage

public abstract class AMQPMessage
extends RefCountMessage
implements Message

See AMQP v1.0 message format


                                                      Bare Message
                                                            |
                                      .---------------------+--------------------.
                                      |                                          |
 +--------+-------------+-------------+------------+--------------+--------------+--------+
 | header | delivery-   | message-    | properties | application- | application- | footer |
 |        | annotations | annotations |            | properties   | data         |        |
 +--------+-------------+-------------+------------+--------------+--------------+--------+
 |                                                                                        |
 '-------------------------------------------+--------------------------------------------'
                                             |
                                      Annotated Message

Zero or one header sections.
Zero or one delivery-annotation sections.
Zero or one message-annotation sections.
Zero or one properties sections.
Zero or one application-properties sections.
The body consists of one of the following three choices:
- one or more data sections
- one or more amqp-sequence sections
- or a single amqp-value section.
Zero or one footer sections.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static class`	`AMQPMessage.MessageDataScanningStatus`	This has been made public just for testing purposes: it's not stable and developers shouldn't rely on this for developing purposes.

Field Summary

Fields
Modifier and Type	Field	Description
`protected SimpleString`	`address`
`static SimpleString`	`ADDRESS_PROPERTY`
`protected org.apache.qpid.proton.amqp.messaging.ApplicationProperties`	`applicationProperties`
`protected int`	`applicationPropertiesPosition`
`protected String`	`connectionID`
`protected org.apache.activemq.artemis.core.persistence.CoreMessageObjectPools`	`coreMessageObjectPools`
`static int`	`DEFAULT_MESSAGE_FORMAT`
`static int`	`DEFAULT_MESSAGE_PRIORITY`
`protected org.apache.qpid.proton.amqp.messaging.DeliveryAnnotations`	`deliveryAnnotations`
`protected org.apache.qpid.proton.amqp.messaging.DeliveryAnnotations`	`deliveryAnnotationsForSendBuffer`
`protected int`	`deliveryAnnotationsPosition`
`protected int`	`encodedDeliveryAnnotationsSize`
`protected int`	`encodedHeaderSize`
`protected long`	`expiration`
`protected boolean`	`expirationReload`
`protected org.apache.activemq.artemis.utils.collections.TypedProperties`	`extraProperties`
`protected org.apache.qpid.proton.amqp.messaging.Header`	`header`
`protected int`	`headerPosition`
`protected boolean`	`isPaged`
`protected static org.slf4j.Logger`	`logger`
`static int`	`MAX_MESSAGE_PRIORITY`
`protected int`	`memoryEstimate`
`protected org.apache.qpid.proton.amqp.messaging.MessageAnnotations`	`messageAnnotations`
`protected int`	`messageAnnotationsPosition`
`protected byte`	`messageDataScanned`
`protected long`	`messageFormat`
`protected long`	`messageID`
`protected boolean`	`modified`
`protected int`	`originalEstimate`
`protected org.apache.qpid.proton.amqp.messaging.Properties`	`properties`
`protected int`	`propertiesPosition`
`protected Set<Object>`	`rejectedConsumers`
`protected int`	`remainingBodyPosition`
`protected long`	`scheduledTime`
`protected static int`	`VALUE_NOT_PRESENT`

Constructor Summary

Constructors
Modifier	Constructor	Description
`protected`	`AMQPMessage(long messageFormat)`
	`AMQPMessage(long messageFormat, org.apache.activemq.artemis.utils.collections.TypedProperties extraProperties, org.apache.activemq.artemis.core.persistence.CoreMessageObjectPools coreMessageObjectPools)`	Creates a new `AMQPMessage` instance from binary encoded message data.
`protected`	`AMQPMessage(AMQPMessage copy)`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`boolean`	`acceptsConsumer(long consumer)`
`protected static void`	`addAnnotationsAsProperties(String prefix, Map map, org.apache.qpid.proton.amqp.messaging.MessageAnnotations annotations)`
`protected SimpleString`	`cachedAddressSimpleString(String address)`
`void`	`clearInternalProperties()`
`boolean`	`containsProperty(String key)`
`boolean`	`containsProperty(SimpleString key)`
`abstract Message`	`copy()`
`protected org.apache.qpid.proton.codec.ReadableBuffer`	`createDeliveryCopy(int deliveryCount, org.apache.qpid.proton.amqp.messaging.DeliveryAnnotations deliveryAnnotations)`	it will create a copy with the relevant delivery annotation and its copy
`org.apache.activemq.artemis.utils.collections.TypedProperties`	`createExtraProperties()`
`protected abstract void`	`encodeMessage()`
`protected abstract void`	`ensureDataIsValid()`
`protected void`	`ensureMessageDataScanned()`
`protected void`	`ensureScanning()`
`String`	`getAddress()`
`SimpleString`	`getAddressSimpleString()`
`Object`	`getAMQPUserID()`	Before we added AMQP into Artemis the name getUserID was already taken by JMSMessageID.
`Object`	`getAnnotation(SimpleString key)`
`org.apache.qpid.proton.amqp.messaging.ApplicationProperties`	`getApplicationProperties()`	Returns a copy of the `ApplicationProperties` present in the message if present or null.
`protected Map<String,Object>`	`getApplicationPropertiesMap(boolean createIfAbsent)`
`org.apache.qpid.proton.amqp.messaging.Section`	`getBody()`	Retrieves the AMQP Section that composes the body of this message by decoding a fresh copy from the encoded message data.
`Boolean`	`getBooleanProperty(String key)`
`Boolean`	`getBooleanProperty(SimpleString key)`
`Object`	`getBrokerProperty(SimpleString key)`
`Byte`	`getByteProperty(String key)`
`Byte`	`getByteProperty(SimpleString key)`
`byte[]`	`getBytesProperty(String key)`
`byte[]`	`getBytesProperty(SimpleString key)`
`String`	`getConnectionID()`
`Object`	`getCorrelationID()`
`protected abstract org.apache.qpid.proton.codec.ReadableBuffer`	`getData()`
`AMQPMessage.MessageDataScanningStatus`	`getDataScanningStatus()`
`protected org.apache.qpid.proton.amqp.messaging.ApplicationProperties`	`getDecodedApplicationProperties()`	This will return application properties without attempting to decode it.
`protected org.apache.qpid.proton.amqp.messaging.MessageAnnotations`	`getDecodedMessageAnnotations()`
`org.apache.qpid.proton.amqp.messaging.DeliveryAnnotations`	`getDeliveryAnnotations()`	Returns a copy of the MessageAnnotations in the message if present or null.
`protected int`	`getDeliveryAnnotationsForSendBufferSize()`
`Double`	`getDoubleProperty(String key)`
`Double`	`getDoubleProperty(SimpleString key)`
`Object`	`getDuplicateProperty()`
`abstract int`	`getEncodeSize()`
`protected int`	`getEstimateSavedEncode()`
`long`	`getExpiration()`
`byte[]`	`getExtraBytesProperty(SimpleString key)`
`org.apache.activemq.artemis.utils.collections.TypedProperties`	`getExtraProperties()`
`Float`	`getFloatProperty(String key)`
`Float`	`getFloatProperty(SimpleString key)`
`org.apache.qpid.proton.amqp.messaging.Footer`	`getFooter()`	Retrieves the AMQP Footer encoded in the data of this message by decoding a fresh copy from the encoded message data.
`SimpleString`	`getGroupID()`
`int`	`getGroupSequence()`
`org.apache.qpid.proton.amqp.messaging.Header`	`getHeader()`	Returns a copy of the message Header if one is present, changes to the returned Header instance do not affect the original Message.
`Long`	`getIngressTimestamp()`
`Integer`	`getIntProperty(String key)`
`Integer`	`getIntProperty(SimpleString key)`
`SimpleString`	`getLastValueProperty()`
`Long`	`getLongProperty(String key)`
`Long`	`getLongProperty(SimpleString key)`
`abstract int`	`getMemoryEstimate()`
`protected Object`	`getMessageAnnotation(String annotation)`
`protected Object`	`getMessageAnnotation(org.apache.qpid.proton.amqp.Symbol annotation)`
`org.apache.qpid.proton.amqp.messaging.MessageAnnotations`	`getMessageAnnotations()`	Returns a copy of the DeliveryAnnotations in the message if present or null.
`protected Map<org.apache.qpid.proton.amqp.Symbol,Object>`	`getMessageAnnotationsMap(boolean createIfAbsent)`
`long`	`getMessageFormat()`
`long`	`getMessageID()`
`Object`	`getObjectProperty(String key)`
`Object`	`getObjectProperty(SimpleString key)`
`Object`	`getObjectPropertyForFilter(SimpleString key)`
`int`	`getOriginalEstimate()`
`Object`	`getOwner()`
`abstract long`	`getPersistentSize()`
`abstract org.apache.activemq.artemis.core.persistence.Persister<Message>`	`getPersister()`
`abstract int`	`getPersistSize()`
`byte`	`getPriority()`
`org.apache.qpid.proton.amqp.messaging.Properties`	`getProperties()`	Returns a copy of the message Properties if one is present, changes to the returned Properties instance do not affect the original Message.
`protected SimpleString.StringSimpleStringPool`	`getPropertyKeysPool()`
`Set<SimpleString>`	`getPropertyNames()`
`protected SimpleString.StringSimpleStringPool`	`getPropertyValuesPool()`
`String`	`getProtocolName()`
`org.apache.qpid.proton.message.impl.MessageImpl`	`getProtonMessage()`	Creates and returns a Proton-J MessageImpl wrapper around the message data.
`SimpleString`	`getReplyTo()`
`RoutingType`	`getRoutingType()`
`Long`	`getScheduledDeliveryTime()`
`org.apache.qpid.proton.codec.ReadableBuffer`	`getSendBuffer(int deliveryCount, org.apache.activemq.artemis.core.server.MessageReference reference)`	Gets a ByteBuf from the Message that contains the encoded bytes to be sent on the wire.
`Short`	`getShortProperty(String key)`
`Short`	`getShortProperty(SimpleString key)`
`SimpleString`	`getSimpleStringProperty(String key)`
`SimpleString`	`getSimpleStringProperty(SimpleString key)`
`String`	`getStringProperty(String key)`
`String`	`getStringProperty(SimpleString key)`
`long`	`getTimestamp()`
`Object`	`getUserID()`
`boolean`	`hasScheduledDeliveryTime()`
`protected int`	`internalPersistSize()`
`boolean`	`isDurable()`
`boolean`	`isPaged()`
`protected org.apache.qpid.proton.amqp.messaging.ApplicationProperties`	`lazyDecodeApplicationProperties()`
`protected org.apache.qpid.proton.amqp.messaging.ApplicationProperties`	`lazyDecodeApplicationProperties(org.apache.qpid.proton.codec.ReadableBuffer data)`
`protected void`	`lazyScanAfterReloadPersistence()`
`void`	`messageChanged()`
`abstract void`	`persist(ActiveMQBuffer targetRecord)`
`Message`	`putBooleanProperty(String key, boolean value)`
`Message`	`putBooleanProperty(SimpleString key, boolean value)`
`Message`	`putByteProperty(String key, byte value)`
`Message`	`putByteProperty(SimpleString key, byte value)`
`Message`	`putBytesProperty(String key, byte[] value)`
`Message`	`putBytesProperty(SimpleString key, byte[] value)`
`Message`	`putCharProperty(String key, char value)`
`Message`	`putCharProperty(SimpleString key, char value)`
`Message`	`putDoubleProperty(String key, double value)`
`Message`	`putDoubleProperty(SimpleString key, double value)`
`Message`	`putExtraBytesProperty(SimpleString key, byte[] value)`
`Message`	`putFloatProperty(String key, float value)`
`Message`	`putFloatProperty(SimpleString key, float value)`
`Message`	`putIntProperty(String key, int value)`
`Message`	`putIntProperty(SimpleString key, int value)`
`Message`	`putLongProperty(String key, long value)`
`Message`	`putLongProperty(SimpleString key, long value)`
`Message`	`putObjectProperty(String key, Object value)`
`Message`	`putObjectProperty(SimpleString key, Object value)`
`Message`	`putShortProperty(String key, short value)`
`Message`	`putShortProperty(SimpleString key, short value)`
`Message`	`putStringProperty(String key, String value)`
`Message`	`putStringProperty(SimpleString key, String value)`
`Message`	`putStringProperty(SimpleString key, SimpleString value)`
`void`	`receiveBuffer(io.netty.buffer.ByteBuf buffer)`
`abstract void`	`reencode()`
`void`	`rejectConsumer(long consumer)`
`void`	`reloadExpiration(long expiration)`
`abstract void`	`reloadPersistence(ActiveMQBuffer record, org.apache.activemq.artemis.core.persistence.CoreMessageObjectPools pools)`
`Object`	`removeAnnotation(SimpleString key)`
`byte[]`	`removeExtraBytesProperty(SimpleString key)`
`protected Object`	`removeMessageAnnotation(org.apache.qpid.proton.amqp.Symbol annotation)`
`Object`	`removeProperty(String key)`
`Object`	`removeProperty(SimpleString key)`
`protected void`	`resetMessageData()`
`protected <T> T`	`scanForMessageSection(int scanStartPosition, Class... targetTypes)`
`protected <T> T`	`scanForMessageSection(org.apache.qpid.proton.codec.ReadableBuffer buffer, int scanStartPosition, Class... targetTypes)`
`protected void`	`scanMessageData()`
`protected void`	`scanMessageData(org.apache.qpid.proton.codec.ReadableBuffer data)`
`void`	`sendBuffer(io.netty.buffer.ByteBuf buffer, int deliveryCount)`	Would be called by the Artemis Core components to encode the message into the provided send buffer.
`AMQPMessage`	`setAddress(String address)`
`AMQPMessage`	`setAddress(SimpleString address)`
`AMQPMessage`	`setAnnotation(SimpleString key, Object value)`
`Message`	`setBrokerProperty(SimpleString key, Object value)`
`Message`	`setConnectionID(String connectionID)`
`Message`	`setCorrelationID(Object correlationID)`
`void`	`setDeliveryAnnotationsForSendBuffer(org.apache.qpid.proton.amqp.messaging.DeliveryAnnotations deliveryAnnotations)`	Deprecated. use MessageReference.setProtocolData(deliveryAnnotations)
`Message`	`setDurable(boolean durable)`
`AMQPMessage`	`setExpiration(long expiration)`
`AMQPMessage`	`setExtraProperties(org.apache.activemq.artemis.utils.collections.TypedProperties extraProperties)`
`Message`	`setIngressTimestamp()`
`Message`	`setLastValueProperty(SimpleString lastValueName)`
`protected void`	`setMessageAnnotation(String annotation, Object value)`
`protected void`	`setMessageAnnotation(org.apache.qpid.proton.amqp.Symbol annotation, Object value)`
`protected void`	`setMessageAnnotations(org.apache.qpid.proton.amqp.messaging.MessageAnnotations messageAnnotations)`
`Message`	`setMessageID(long id)`
`void`	`setOwner(Object object)`
`void`	`setPaged()`
`Message`	`setPriority(byte priority)`
`AMQPMessage`	`setReplyTo(SimpleString address)`
`Message`	`setRoutingType(RoutingType routingType)`
`AMQPMessage`	`setScheduledDeliveryTime(Long time)`
`Message`	`setTimestamp(long timestamp)`
`Message`	`setUserID(Object userID)`
`CompositeData`	`toCompositeData(int fieldsLimit, int deliveryCount)`
`ICoreMessage`	`toCore()`
`ICoreMessage`	`toCore(org.apache.activemq.artemis.core.persistence.CoreMessageObjectPools coreMessageObjectPools)`
`String`	`toDebugString()`	This is different from toString, as this will print an expanded version of the buffer in Hex and programmers's readable format
`Map<String,Object>`	`toPropertyMap(int valueSizeLimit)`
`String`	`toString()`
`protected int`	`unmarshalledApplicationPropertiesMemoryEstimateFromData(org.apache.qpid.proton.codec.ReadableBuffer data)`
`protected void`	`writeDeliveryAnnotationsForSendBuffer(io.netty.buffer.ByteBuf result, org.apache.qpid.proton.amqp.messaging.DeliveryAnnotations deliveryAnnotations)`

Methods inherited from class org.apache.activemq.artemis.api.core.RefCountMessage
counterString, debugLocations, deferredDebug, deferredDebug, deferredDebug, disableErrorCheck, durableDown, durableUp, getDurableCount, getParentRef, getRefCount, getUsage, getUserContext, isRefDebugEnabled, isRefTraceEnabled, isReleased, onDown, onUp, refDown, refUp, registerDebug, releaseComplete, released, setParentRef, setUserContext, 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.Message
copy, copy, durableDown, durableUp, getAnnotationString, getBodyBuffer, getBodyInputStream, getDuplicateIDBytes, getDurableCount, getRefCount, getStringBody, getType, getUsage, getUserContext, getValidatedUserID, getWholeMessageSize, isExpired, isLargeMessage, refDown, referenceOriginalMessage, refUp, setGroupID, setGroupID, setGroupSequence, setType, setUserContext, setValidatedUserID, toMap, toMap, toPropertyMap, usageDown, usageUp

Field Detail

logger

protected static final org.slf4j.Logger logger

ADDRESS_PROPERTY

public static final SimpleString ADDRESS_PROPERTY

DEFAULT_MESSAGE_FORMAT
```
public static final int DEFAULT_MESSAGE_FORMAT
```
See Also:

Constant Field Values

DEFAULT_MESSAGE_PRIORITY
```
public static final int DEFAULT_MESSAGE_PRIORITY
```
See Also:

Constant Field Values

MAX_MESSAGE_PRIORITY
```
public static final int MAX_MESSAGE_PRIORITY
```
See Also:

Constant Field Values

VALUE_NOT_PRESENT
```
protected static final int VALUE_NOT_PRESENT
```
See Also:

Constant Field Values

messageDataScanned
```
protected byte messageDataScanned
```

modified
```
protected boolean modified
```

headerPosition
```
protected int headerPosition
```

encodedHeaderSize
```
protected int encodedHeaderSize
```

deliveryAnnotationsPosition

protected int deliveryAnnotationsPosition

encodedDeliveryAnnotationsSize

protected int encodedDeliveryAnnotationsSize

messageAnnotationsPosition

protected int messageAnnotationsPosition

propertiesPosition
```
protected int propertiesPosition
```

applicationPropertiesPosition

protected int applicationPropertiesPosition

remainingBodyPosition
```
protected int remainingBodyPosition
```

messageFormat
```
protected final long messageFormat
```

messageID
```
protected long messageID
```

address
```
protected SimpleString address
```

memoryEstimate
```
protected volatile int memoryEstimate
```

originalEstimate

protected volatile int originalEstimate

expiration
```
protected long expiration
```

expirationReload
```
protected boolean expirationReload
```

scheduledTime
```
protected long scheduledTime
```

isPaged
```
protected boolean isPaged
```

header

protected org.apache.qpid.proton.amqp.messaging.Header header

messageAnnotations

protected org.apache.qpid.proton.amqp.messaging.MessageAnnotations messageAnnotations

properties

protected org.apache.qpid.proton.amqp.messaging.Properties properties

applicationProperties

protected org.apache.qpid.proton.amqp.messaging.ApplicationProperties applicationProperties

connectionID
```
protected String connectionID
```

coreMessageObjectPools

protected final org.apache.activemq.artemis.core.persistence.CoreMessageObjectPools coreMessageObjectPools

rejectedConsumers

protected Set<Object> rejectedConsumers

deliveryAnnotationsForSendBuffer

protected org.apache.qpid.proton.amqp.messaging.DeliveryAnnotations deliveryAnnotationsForSendBuffer

deliveryAnnotations

protected org.apache.qpid.proton.amqp.messaging.DeliveryAnnotations deliveryAnnotations

extraProperties

protected volatile org.apache.activemq.artemis.utils.collections.TypedProperties extraProperties

Constructor Detail

AMQPMessage
```
public AMQPMessage(long messageFormat,
                   org.apache.activemq.artemis.utils.collections.TypedProperties extraProperties,
                   org.apache.activemq.artemis.core.persistence.CoreMessageObjectPools coreMessageObjectPools)
```
Creates a new AMQPMessage instance from binary encoded message data.

Parameters:

messageFormat - The Message format tag given the in Transfer that carried this message

extraProperties - Broker specific extra properties that should be carried with this message

AMQPMessage

protected AMQPMessage(AMQPMessage copy)

AMQPMessage

protected AMQPMessage(long messageFormat)

Method Detail

getProtocolName
```
public String getProtocolName()
```
Specified by:

getProtocolName in interface Message

getDataScanningStatus

public final AMQPMessage.MessageDataScanningStatus getDataScanningStatus()

isPaged
```
public boolean isPaged()
```
Specified by:

isPaged in interface Message

setPaged
```
public void setPaged()
```
Specified by:

setPaged in interface Message

getDecodedApplicationProperties
```
protected org.apache.qpid.proton.amqp.messaging.ApplicationProperties getDecodedApplicationProperties()
```
This will return application properties without attempting to decode it. That means, if applicationProperties were never parsed before, this will return null, even if there is application properties. This was created as an internal method for testing, as we need to validate if the application properties are not decoded until needed.

getDecodedMessageAnnotations

protected org.apache.qpid.proton.amqp.messaging.MessageAnnotations getDecodedMessageAnnotations()

getData

protected abstract org.apache.qpid.proton.codec.ReadableBuffer getData()

getProtonMessage
```
public final org.apache.qpid.proton.message.impl.MessageImpl getProtonMessage()
```
Creates and returns a Proton-J MessageImpl wrapper around the message data. Changes to the returned Message are not reflected in this message.

Returns:

a MessageImpl that wraps the AMQP message data in this AMQPMessage

getObjectPropertyForFilter
```
public Object getObjectPropertyForFilter(SimpleString key)
```
Specified by:

getObjectPropertyForFilter in interface Message

getHeader
```
public final org.apache.qpid.proton.amqp.messaging.Header getHeader()
```
Returns a copy of the message Header if one is present, changes to the returned Header instance do not affect the original Message.

Returns:

a copy of the Message Header if one exists or null if none present.

ensureScanning
```
protected void ensureScanning()
```

getDeliveryAnnotations
```
public final org.apache.qpid.proton.amqp.messaging.DeliveryAnnotations getDeliveryAnnotations()
```
Returns a copy of the MessageAnnotations in the message if present or null. Changes to the returned DeliveryAnnotations instance do not affect the original Message.

Returns:

a copy of the DeliveryAnnotations present in the message or null if non present.

setDeliveryAnnotationsForSendBuffer
```
@Deprecated
public final void setDeliveryAnnotationsForSendBuffer(org.apache.qpid.proton.amqp.messaging.DeliveryAnnotations deliveryAnnotations)
```
Deprecated.
use MessageReference.setProtocolData(deliveryAnnotations)

Sets the delivery annotations to be included when encoding the message for sending it on the wire. The broker can add additional message annotations as long as the annotations being added follow the rules from the spec. If the user adds something that the remote doesn't understand and it is not prefixed with "x-opt" the remote can just kill the link. See: http://docs.oasis-open.org/amqp/core/v1.0/os/amqp-core-messaging-v1.0-os.html#type-annotations

Parameters:

deliveryAnnotations - delivery annotations used in the sendBuffer() method

getMessageAnnotations
```
public final org.apache.qpid.proton.amqp.messaging.MessageAnnotations getMessageAnnotations()
```
Returns a copy of the DeliveryAnnotations in the message if present or null. Changes to the returned MessageAnnotations instance do not affect the original Message.

Returns:

a copy of the MessageAnnotations present in the message or null if non present.

getProperties
```
public final org.apache.qpid.proton.amqp.messaging.Properties getProperties()
```
Returns a copy of the message Properties if one is present, changes to the returned Properties instance do not affect the original Message.

Returns:

a copy of the Message Properties if one exists or null if none present.

getApplicationProperties
```
public final org.apache.qpid.proton.amqp.messaging.ApplicationProperties getApplicationProperties()
```
Returns a copy of the ApplicationProperties present in the message if present or null. Changes to the returned MessageAnnotations instance do not affect the original Message.

Returns:

a copy of the ApplicationProperties present in the message or null if non present.

toDebugString
```
public final String toDebugString()
```
This is different from toString, as this will print an expanded version of the buffer in Hex and programmers's readable format

getBody
```
public final org.apache.qpid.proton.amqp.messaging.Section getBody()
```
Retrieves the AMQP Section that composes the body of this message by decoding a fresh copy from the encoded message data. Changes to the returned value are not reflected in the value encoded in the original message.

Returns:

the Section that makes up the body of this message.

getFooter
```
public final org.apache.qpid.proton.amqp.messaging.Footer getFooter()
```
Retrieves the AMQP Footer encoded in the data of this message by decoding a fresh copy from the encoded message data. Changes to the returned value are not reflected in the value encoded in the original message.

Returns:

the Footer that was encoded into this AMQP Message.

scanForMessageSection

protected <T> T scanForMessageSection(int scanStartPosition,
                                      Class... targetTypes)

scanForMessageSection

protected <T> T scanForMessageSection(org.apache.qpid.proton.codec.ReadableBuffer buffer,
                                      int scanStartPosition,
                                      Class... targetTypes)

lazyDecodeApplicationProperties

protected org.apache.qpid.proton.amqp.messaging.ApplicationProperties lazyDecodeApplicationProperties()

lazyDecodeApplicationProperties

protected org.apache.qpid.proton.amqp.messaging.ApplicationProperties lazyDecodeApplicationProperties(org.apache.qpid.proton.codec.ReadableBuffer data)

unmarshalledApplicationPropertiesMemoryEstimateFromData

protected int unmarshalledApplicationPropertiesMemoryEstimateFromData(org.apache.qpid.proton.codec.ReadableBuffer data)

getApplicationPropertiesMap

protected Map<String,Object> getApplicationPropertiesMap(boolean createIfAbsent)

getMessageAnnotationsMap

protected Map<org.apache.qpid.proton.amqp.Symbol,Object> getMessageAnnotationsMap(boolean createIfAbsent)

getMessageAnnotation

protected Object getMessageAnnotation(String annotation)

getMessageAnnotation

protected Object getMessageAnnotation(org.apache.qpid.proton.amqp.Symbol annotation)

removeMessageAnnotation

protected Object removeMessageAnnotation(org.apache.qpid.proton.amqp.Symbol annotation)

setMessageAnnotation

protected void setMessageAnnotation(String annotation,
                                    Object value)

setMessageAnnotation

protected void setMessageAnnotation(org.apache.qpid.proton.amqp.Symbol annotation,
                                    Object value)

setMessageAnnotations

protected void setMessageAnnotations(org.apache.qpid.proton.amqp.messaging.MessageAnnotations messageAnnotations)

ensureMessageDataScanned

protected void ensureMessageDataScanned()

getEstimateSavedEncode

protected int getEstimateSavedEncode()

resetMessageData
```
protected void resetMessageData()
```

scanMessageData
```
protected void scanMessageData()
```

scanMessageData

protected void scanMessageData(org.apache.qpid.proton.codec.ReadableBuffer data)

copy
```
public abstract Message copy()
```
Specified by:

copy in interface Message

sendBuffer
```
public final void sendBuffer(io.netty.buffer.ByteBuf buffer,
                             int deliveryCount)
```
Would be called by the Artemis Core components to encode the message into the provided send buffer. Because of how Proton message data handling works this method is not currently used by the AMQP protocol head and will not be called for out-bound sends.

Specified by:

sendBuffer in interface Message

See Also:

for the actual method used for message sends.

getSendBuffer
```
public org.apache.qpid.proton.codec.ReadableBuffer getSendBuffer(int deliveryCount,
                                                                 org.apache.activemq.artemis.core.server.MessageReference reference)
```
Gets a ByteBuf from the Message that contains the encoded bytes to be sent on the wire.
When possible this method will present the bytes to the caller without copying them into a new buffer copy. If copying is needed a new Netty buffer is created and returned. The caller should ensure that the reference count on the returned buffer is always decremented to avoid a leak in the case of a copied buffer being returned.

Parameters:

deliveryCount - The new delivery count for this message.

Returns:

a Netty ByteBuf containing the encoded bytes of this Message instance.

createDeliveryCopy

protected org.apache.qpid.proton.codec.ReadableBuffer createDeliveryCopy(int deliveryCount,
                                                                         org.apache.qpid.proton.amqp.messaging.DeliveryAnnotations deliveryAnnotations)

it will create a copy with the relevant delivery annotation and its copy

writeDeliveryAnnotationsForSendBuffer

protected void writeDeliveryAnnotationsForSendBuffer(io.netty.buffer.ByteBuf result,
                                                     org.apache.qpid.proton.amqp.messaging.DeliveryAnnotations deliveryAnnotations)

getDeliveryAnnotationsForSendBufferSize

protected int getDeliveryAnnotationsForSendBufferSize()

messageChanged
```
public void messageChanged()
```
Specified by:

messageChanged in interface Message

getEncodeSize
```
public abstract int getEncodeSize()
```
Specified by:

getEncodeSize in interface Message

receiveBuffer

public final void receiveBuffer(io.netty.buffer.ByteBuf buffer)

Specified by:: receiveBuffer in interface Message

getMemoryEstimate
```
public abstract int getMemoryEstimate()
```
Specified by:

getMemoryEstimate in interface Message

getOriginalEstimate
```
public int getOriginalEstimate()
```
Specified by:

getOriginalEstimate in interface Message

toPropertyMap

public Map<String,Object> toPropertyMap(int valueSizeLimit)

Specified by:: toPropertyMap in interface Message

addAnnotationsAsProperties

protected static void addAnnotationsAsProperties(String prefix,
                                                 Map map,
                                                 org.apache.qpid.proton.amqp.messaging.MessageAnnotations annotations)

toCore

public ICoreMessage toCore(org.apache.activemq.artemis.core.persistence.CoreMessageObjectPools coreMessageObjectPools)

Specified by:: toCore in interface Message

toCore
```
public ICoreMessage toCore()
```
Specified by:

toCore in interface Message

persist

public abstract void persist(ActiveMQBuffer targetRecord)

Specified by:: persist in interface Message

getPersistSize
```
public abstract int getPersistSize()
```
Specified by:

getPersistSize in interface Message

internalPersistSize
```
protected int internalPersistSize()
```

reloadPersistence

public abstract void reloadPersistence(ActiveMQBuffer record,
                                       org.apache.activemq.artemis.core.persistence.CoreMessageObjectPools pools)

Specified by:: reloadPersistence in interface Message

lazyScanAfterReloadPersistence

protected void lazyScanAfterReloadPersistence()

getPersistentSize

public abstract long getPersistentSize()
                                throws ActiveMQException

Specified by:: getPersistentSize in interface Message
Throws:: ActiveMQException

getPersister

public abstract org.apache.activemq.artemis.core.persistence.Persister<Message> getPersister()

Specified by:: getPersister in interface Message

reencode
```
public abstract void reencode()
```
Specified by:

reencode in interface Message

ensureDataIsValid

protected abstract void ensureDataIsValid()

encodeMessage

protected abstract void encodeMessage()

createExtraProperties

public final org.apache.activemq.artemis.utils.collections.TypedProperties createExtraProperties()

getExtraProperties

public final org.apache.activemq.artemis.utils.collections.TypedProperties getExtraProperties()

setExtraProperties

public final AMQPMessage setExtraProperties(org.apache.activemq.artemis.utils.collections.TypedProperties extraProperties)

putExtraBytesProperty

public final Message putExtraBytesProperty(SimpleString key,
                                           byte[] value)

Specified by:: putExtraBytesProperty in interface Message

getExtraBytesProperty

public final byte[] getExtraBytesProperty(SimpleString key)
                                   throws ActiveMQPropertyConversionException

Specified by:: getExtraBytesProperty in interface Message
Throws:: ActiveMQPropertyConversionException

clearInternalProperties
```
public void clearInternalProperties()
```
Specified by:

clearInternalProperties in interface Message

removeExtraBytesProperty

public final byte[] removeExtraBytesProperty(SimpleString key)
                                      throws ActiveMQPropertyConversionException

Specified by:: removeExtraBytesProperty in interface Message
Throws:: ActiveMQPropertyConversionException

setConnectionID

public final Message setConnectionID(String connectionID)

Specified by:: setConnectionID in interface Message

getConnectionID
```
public final String getConnectionID()
```
Specified by:

getConnectionID in interface Message

getMessageFormat
```
public final long getMessageFormat()
```

getMessageID
```
public final long getMessageID()
```
Specified by:

getMessageID in interface Message

setMessageID
```
public final Message setMessageID(long id)
```
Specified by:

setMessageID in interface Message

getExpiration
```
public final long getExpiration()
```
Specified by:

getExpiration in interface Message

reloadExpiration

public void reloadExpiration(long expiration)

setExpiration

public final AMQPMessage setExpiration(long expiration)

Specified by:: setExpiration in interface Message

getUserID
```
public final Object getUserID()
```
Specified by:

getUserID in interface Message

getAMQPUserID
```
public final Object getAMQPUserID()
```
Before we added AMQP into Artemis the name getUserID was already taken by JMSMessageID. We cannot simply change the names now as it would break the API for existing clients. This is to return and read the proper AMQP userID.

Returns:

the UserID value in the AMQP Properties if one is present.

setUserID

public final Message setUserID(Object userID)

Specified by:: setUserID in interface Message

getDuplicateProperty
```
public final Object getDuplicateProperty()
```
Specified by:

getDuplicateProperty in interface Message

isDurable
```
public boolean isDurable()
```
Specified by:

isDurable in interface Message

setDurable

public final Message setDurable(boolean durable)

Specified by:: setDurable in interface Message

getAddress
```
public final String getAddress()
```
Specified by:

getAddress in interface Message

setAddress

public final AMQPMessage setAddress(String address)

Specified by:: setAddress in interface Message

setAddress

public final AMQPMessage setAddress(SimpleString address)

Specified by:: setAddress in interface Message

getAddressSimpleString
```
public final SimpleString getAddressSimpleString()
```
Specified by:

getAddressSimpleString in interface Message

cachedAddressSimpleString

protected SimpleString cachedAddressSimpleString(String address)

getTimestamp
```
public final long getTimestamp()
```
Specified by:

getTimestamp in interface Message

setTimestamp

public final Message setTimestamp(long timestamp)

Specified by:: setTimestamp in interface Message

getPriority
```
public final byte getPriority()
```
Specified by:

getPriority in interface Message

setPriority

public final Message setPriority(byte priority)

Specified by:: setPriority in interface Message

getReplyTo
```
public final SimpleString getReplyTo()
```
Specified by:

getReplyTo in interface Message

setReplyTo

public final AMQPMessage setReplyTo(SimpleString address)

Specified by:: setReplyTo in interface Message

getRoutingType
```
public final RoutingType getRoutingType()
```
Specified by:

getRoutingType in interface Message

setRoutingType

public final Message setRoutingType(RoutingType routingType)

Specified by:: setRoutingType in interface Message

getGroupID
```
public final SimpleString getGroupID()
```
Specified by:

getGroupID in interface Message

getGroupSequence
```
public final int getGroupSequence()
```
Specified by:

getGroupSequence in interface Message

getCorrelationID
```
public final Object getCorrelationID()
```
Specified by:

getCorrelationID in interface Message

setCorrelationID

public final Message setCorrelationID(Object correlationID)

Specified by:: setCorrelationID in interface Message

hasScheduledDeliveryTime
```
public boolean hasScheduledDeliveryTime()
```
Specified by:

hasScheduledDeliveryTime in interface Message

getScheduledDeliveryTime
```
public final Long getScheduledDeliveryTime()
```
Specified by:

getScheduledDeliveryTime in interface Message

setScheduledDeliveryTime
```
public final AMQPMessage setScheduledDeliveryTime(Long time)
```
Specified by:

setScheduledDeliveryTime in interface Message

removeAnnotation

public final Object removeAnnotation(SimpleString key)

Specified by:: removeAnnotation in interface Message

getAnnotation

public final Object getAnnotation(SimpleString key)

Specified by:: getAnnotation in interface Message

setAnnotation

public final AMQPMessage setAnnotation(SimpleString key,
                                       Object value)

Specified by:: setAnnotation in interface Message

setBrokerProperty

public Message setBrokerProperty(SimpleString key,
                                 Object value)

Specified by:: setBrokerProperty in interface Message

getBrokerProperty
```
public Object getBrokerProperty(SimpleString key)
```
Specified by:

getBrokerProperty in interface Message

setIngressTimestamp
```
public final Message setIngressTimestamp()
```
Specified by:

setIngressTimestamp in interface Message

getIngressTimestamp
```
public Long getIngressTimestamp()
```
Specified by:

getIngressTimestamp in interface Message

removeProperty

public final Object removeProperty(SimpleString key)

Specified by:: removeProperty in interface Message

removeProperty
```
public final Object removeProperty(String key)
```
Specified by:

removeProperty in interface Message

containsProperty
```
public final boolean containsProperty(SimpleString key)
```
Specified by:

containsProperty in interface Message

containsProperty
```
public final boolean containsProperty(String key)
```
Specified by:

containsProperty in interface Message

getBooleanProperty

public final Boolean getBooleanProperty(String key)
                                 throws ActiveMQPropertyConversionException

Specified by:: getBooleanProperty in interface Message
Throws:: ActiveMQPropertyConversionException

getByteProperty

public final Byte getByteProperty(String key)
                           throws ActiveMQPropertyConversionException

Specified by:: getByteProperty in interface Message
Throws:: ActiveMQPropertyConversionException

getDoubleProperty

public final Double getDoubleProperty(String key)
                               throws ActiveMQPropertyConversionException

Specified by:: getDoubleProperty in interface Message
Throws:: ActiveMQPropertyConversionException

getIntProperty

public final Integer getIntProperty(String key)
                             throws ActiveMQPropertyConversionException

Specified by:: getIntProperty in interface Message
Throws:: ActiveMQPropertyConversionException

getLongProperty

public final Long getLongProperty(String key)
                           throws ActiveMQPropertyConversionException

Specified by:: getLongProperty in interface Message
Throws:: ActiveMQPropertyConversionException

getObjectProperty
```
public final Object getObjectProperty(String key)
```
Specified by:

getObjectProperty in interface Message

getShortProperty

public final Short getShortProperty(String key)
                             throws ActiveMQPropertyConversionException

Specified by:: getShortProperty in interface Message
Throws:: ActiveMQPropertyConversionException

getFloatProperty

public final Float getFloatProperty(String key)
                             throws ActiveMQPropertyConversionException

Specified by:: getFloatProperty in interface Message
Throws:: ActiveMQPropertyConversionException

getStringProperty

public final String getStringProperty(String key)
                               throws ActiveMQPropertyConversionException

Specified by:: getStringProperty in interface Message
Throws:: ActiveMQPropertyConversionException

getPropertyNames
```
public final Set<SimpleString> getPropertyNames()
```
Specified by:

getPropertyNames in interface Message

getBooleanProperty

public final Boolean getBooleanProperty(SimpleString key)
                                 throws ActiveMQPropertyConversionException

Specified by:: getBooleanProperty in interface Message
Throws:: ActiveMQPropertyConversionException

getByteProperty

public final Byte getByteProperty(SimpleString key)
                           throws ActiveMQPropertyConversionException

Specified by:: getByteProperty in interface Message
Throws:: ActiveMQPropertyConversionException

getBytesProperty

public final byte[] getBytesProperty(String key)
                              throws ActiveMQPropertyConversionException

Specified by:: getBytesProperty in interface Message
Throws:: ActiveMQPropertyConversionException

getDoubleProperty

public final Double getDoubleProperty(SimpleString key)
                               throws ActiveMQPropertyConversionException

Specified by:: getDoubleProperty in interface Message
Throws:: ActiveMQPropertyConversionException

getIntProperty

public final Integer getIntProperty(SimpleString key)
                             throws ActiveMQPropertyConversionException

Specified by:: getIntProperty in interface Message
Throws:: ActiveMQPropertyConversionException

getLongProperty

public final Long getLongProperty(SimpleString key)
                           throws ActiveMQPropertyConversionException

Specified by:: getLongProperty in interface Message
Throws:: ActiveMQPropertyConversionException

getObjectProperty

public final Object getObjectProperty(SimpleString key)

Specified by:: getObjectProperty in interface Message

getShortProperty

public final Short getShortProperty(SimpleString key)
                             throws ActiveMQPropertyConversionException

Specified by:: getShortProperty in interface Message
Throws:: ActiveMQPropertyConversionException

getFloatProperty

public final Float getFloatProperty(SimpleString key)
                             throws ActiveMQPropertyConversionException

Specified by:: getFloatProperty in interface Message
Throws:: ActiveMQPropertyConversionException

getStringProperty

public final String getStringProperty(SimpleString key)
                               throws ActiveMQPropertyConversionException

Specified by:: getStringProperty in interface Message
Throws:: ActiveMQPropertyConversionException

getSimpleStringProperty

public final SimpleString getSimpleStringProperty(SimpleString key)
                                           throws ActiveMQPropertyConversionException

Specified by:: getSimpleStringProperty in interface Message
Throws:: ActiveMQPropertyConversionException

getBytesProperty

public final byte[] getBytesProperty(SimpleString key)
                              throws ActiveMQPropertyConversionException

Specified by:: getBytesProperty in interface Message
Throws:: ActiveMQPropertyConversionException

getSimpleStringProperty

public final SimpleString getSimpleStringProperty(String key)
                                           throws ActiveMQPropertyConversionException

Specified by:: getSimpleStringProperty in interface Message
Throws:: ActiveMQPropertyConversionException

putBooleanProperty

public final Message putBooleanProperty(String key,
                                        boolean value)

Specified by:: putBooleanProperty in interface Message

putByteProperty

public final Message putByteProperty(String key,
                                     byte value)

Specified by:: putByteProperty in interface Message

putBytesProperty

public final Message putBytesProperty(String key,
                                      byte[] value)

Specified by:: putBytesProperty in interface Message

putShortProperty

public final Message putShortProperty(String key,
                                      short value)

Specified by:: putShortProperty in interface Message

putCharProperty

public final Message putCharProperty(String key,
                                     char value)

Specified by:: putCharProperty in interface Message

putIntProperty

public final Message putIntProperty(String key,
                                    int value)

Specified by:: putIntProperty in interface Message

putLongProperty

public final Message putLongProperty(String key,
                                     long value)

Specified by:: putLongProperty in interface Message

putFloatProperty

public final Message putFloatProperty(String key,
                                      float value)

Specified by:: putFloatProperty in interface Message

putDoubleProperty

public final Message putDoubleProperty(String key,
                                       double value)

Specified by:: putDoubleProperty in interface Message

putBooleanProperty

public final Message putBooleanProperty(SimpleString key,
                                        boolean value)

Specified by:: putBooleanProperty in interface Message

putByteProperty

public final Message putByteProperty(SimpleString key,
                                     byte value)

Specified by:: putByteProperty in interface Message

putBytesProperty

public final Message putBytesProperty(SimpleString key,
                                      byte[] value)

Specified by:: putBytesProperty in interface Message

putShortProperty

public final Message putShortProperty(SimpleString key,
                                      short value)

Specified by:: putShortProperty in interface Message

putCharProperty

public final Message putCharProperty(SimpleString key,
                                     char value)

Specified by:: putCharProperty in interface Message

putIntProperty

public final Message putIntProperty(SimpleString key,
                                    int value)

Specified by:: putIntProperty in interface Message

putLongProperty

public final Message putLongProperty(SimpleString key,
                                     long value)

Specified by:: putLongProperty in interface Message

putFloatProperty

public final Message putFloatProperty(SimpleString key,
                                      float value)

Specified by:: putFloatProperty in interface Message

putDoubleProperty

public final Message putDoubleProperty(SimpleString key,
                                       double value)

Specified by:: putDoubleProperty in interface Message

putStringProperty

public final Message putStringProperty(String key,
                                       String value)

Specified by:: putStringProperty in interface Message

putObjectProperty

public final Message putObjectProperty(String key,
                                       Object value)
                                throws ActiveMQPropertyConversionException

Specified by:: putObjectProperty in interface Message
Throws:: ActiveMQPropertyConversionException

putObjectProperty

public final Message putObjectProperty(SimpleString key,
                                       Object value)
                                throws ActiveMQPropertyConversionException

Specified by:: putObjectProperty in interface Message
Throws:: ActiveMQPropertyConversionException

putStringProperty

public final Message putStringProperty(SimpleString key,
                                       SimpleString value)

Specified by:: putStringProperty in interface Message

putStringProperty

public final Message putStringProperty(SimpleString key,
                                       String value)

Specified by:: putStringProperty in interface Message

getLastValueProperty
```
public final SimpleString getLastValueProperty()
```
Specified by:

getLastValueProperty in interface Message

setLastValueProperty

public final Message setLastValueProperty(SimpleString lastValueName)

Specified by:: setLastValueProperty in interface Message

toString
```
public String toString()
```
Overrides:

toString in class Object

acceptsConsumer
```
public final boolean acceptsConsumer(long consumer)
```
Specified by:

acceptsConsumer in interface Message

rejectConsumer
```
public final void rejectConsumer(long consumer)
```
Specified by:

rejectConsumer in interface Message

getPropertyKeysPool

protected SimpleString.StringSimpleStringPool getPropertyKeysPool()

getPropertyValuesPool

protected SimpleString.StringSimpleStringPool getPropertyValuesPool()

getOwner
```
public Object getOwner()
```
Specified by:

getOwner in interface Message

setOwner
```
public void setOwner(Object object)
```
Specified by:

setOwner in interface Message

toCompositeData

public CompositeData toCompositeData(int fieldsLimit,
                                     int deliveryCount)
                              throws OpenDataException

Specified by:: toCompositeData in interface Message
Throws:: OpenDataException

Class AMQPMessage

Nested Class Summary

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

Field Detail

logger

ADDRESS_PROPERTY

DEFAULT_MESSAGE_FORMAT

DEFAULT_MESSAGE_PRIORITY

MAX_MESSAGE_PRIORITY

VALUE_NOT_PRESENT

messageDataScanned

modified

headerPosition

encodedHeaderSize

deliveryAnnotationsPosition

encodedDeliveryAnnotationsSize

messageAnnotationsPosition

propertiesPosition

applicationPropertiesPosition

remainingBodyPosition

messageFormat

messageID

address

memoryEstimate

originalEstimate

expiration

expirationReload

scheduledTime

isPaged

header

messageAnnotations

properties

applicationProperties

connectionID

coreMessageObjectPools

rejectedConsumers

deliveryAnnotationsForSendBuffer

deliveryAnnotations

extraProperties

Constructor Detail

AMQPMessage

AMQPMessage

AMQPMessage

Method Detail

getProtocolName

getDataScanningStatus

isPaged

setPaged

getDecodedApplicationProperties

getDecodedMessageAnnotations

getData

getProtonMessage

getObjectPropertyForFilter

getHeader

ensureScanning

getDeliveryAnnotations

setDeliveryAnnotationsForSendBuffer

getMessageAnnotations

getProperties

getApplicationProperties

toDebugString

getBody

getFooter

scanForMessageSection

scanForMessageSection

lazyDecodeApplicationProperties

lazyDecodeApplicationProperties

unmarshalledApplicationPropertiesMemoryEstimateFromData

getApplicationPropertiesMap

getMessageAnnotationsMap

getMessageAnnotation

getMessageAnnotation

removeMessageAnnotation

setMessageAnnotation