Class AMQPMessage

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 enum	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 final SimpleString	ADDRESS_PROPERTY
protected org.apache.qpid.proton.amqp.messaging.ApplicationProperties	applicationProperties
protected int	applicationPropertiesPosition
protected String	connectionID
protected final org.apache.activemq.artemis.core.persistence.CoreMessageObjectPools	coreMessageObjectPools
static final int	DEFAULT_MESSAGE_FORMAT
static final 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 final org.slf4j.Logger	logger
static final int	MAX_MESSAGE_PRIORITY
protected int	memoryEstimate
protected org.apache.qpid.proton.amqp.messaging.MessageAnnotations	messageAnnotations
protected int	messageAnnotationsPosition
protected byte	messageDataScanned
protected final long	messageFormat
protected long	messageID
protected boolean	modified
protected int	originalEstimate
protected byte	priority
protected org.apache.qpid.proton.amqp.messaging.Properties	properties
protected int	propertiesPosition
protected Set<Object>	rejectedConsumers
protected int	remainingBodyPosition
protected boolean	routed
protected long	scheduledTime
protected static final int	VALUE_NOT_PRESENT

Fields inherited from interface Message

AMQP_PROPERTY_PREDICATE, 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_INGRESS_TIMESTAMP, HDR_LARGE_BODY_SIZE, HDR_LARGE_COMPRESSED, HDR_LAST_VALUE_NAME, HDR_ORIG_MESSAGE_ID, HDR_ORIG_ROUTING_TYPE, 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, PREFIX_AMQP_ANNOTATIONS, STREAM_TYPE, TEXT_TYPE

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

Modifier and Type	Method	Description
final 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()
final boolean	containsProperty(String key)
final 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
final org.apache.activemq.artemis.utils.collections.TypedProperties	createExtraProperties()
protected abstract void	encodeMessage()
protected abstract void	ensureDataIsValid()
protected void	ensureMessageDataScanned()
protected void	ensureScanning()
final String	getAddress()
final SimpleString	getAddressSimpleString()
final Object	getAMQPUserID()	Before we added AMQP into Artemis the name getUserID was already taken by JMSMessageID.
final Object	getAnnotation(SimpleString key)
final org.apache.qpid.proton.amqp.messaging.ApplicationProperties	getApplicationProperties()	Returns a copy of the message's ApplicationProperties or null if none present; changes to the returned ApplicationProperties instance do not affect the original message.
protected Map<String,Object>	getApplicationPropertiesMap(boolean createIfAbsent)
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.
final Boolean	getBooleanProperty(String key)
final Boolean	getBooleanProperty(SimpleString key)
Object	getBrokerProperty(SimpleString key)
final Byte	getByteProperty(String key)
final Byte	getByteProperty(SimpleString key)
final byte[]	getBytesProperty(String key)
final byte[]	getBytesProperty(SimpleString key)
final String	getConnectionID()
final Object	getCorrelationID()
protected abstract org.apache.qpid.proton.codec.ReadableBuffer	getData()
final 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()
final org.apache.qpid.proton.amqp.messaging.DeliveryAnnotations	getDeliveryAnnotations()	Returns a copy of the DeliveryAnnotations present in the message or null if non present; changes to the returned DeliveryAnnotations instance do not affect the original message.
protected int	getDeliveryAnnotationsForSendBufferSize()
final Double	getDoubleProperty(String key)
final Double	getDoubleProperty(SimpleString key)
final Object	getDuplicateProperty()
abstract int	getEncodeSize()
protected int	getEstimateSavedEncode()
final long	getExpiration()
final byte[]	getExtraBytesProperty(SimpleString key)
final org.apache.activemq.artemis.utils.collections.TypedProperties	getExtraProperties()
final Float	getFloatProperty(String key)
final Float	getFloatProperty(SimpleString key)
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.
final SimpleString	getGroupID()
final int	getGroupSequence()
final org.apache.qpid.proton.amqp.messaging.Header	getHeader()	Returns a copy of this message's Header if one exists or null if none present; changes to the returned Header instance do not affect the original message.
Long	getIngressTimestamp()
final Integer	getIntProperty(String key)
final Integer	getIntProperty(SimpleString key)
final SimpleString	getLastValueProperty()
final Long	getLongProperty(String key)
final Long	getLongProperty(SimpleString key)
abstract int	getMemoryEstimate()
protected Object	getMessageAnnotation(String annotation)
protected Object	getMessageAnnotation(org.apache.qpid.proton.amqp.Symbol annotation)
final org.apache.qpid.proton.amqp.messaging.MessageAnnotations	getMessageAnnotations()	Returns a copy of the message's MessageAnnotations or null if none present; changes to the returned MessageAnnotations instance do not affect the original message.
protected Map<org.apache.qpid.proton.amqp.Symbol, Object>	getMessageAnnotationsMap(boolean createIfAbsent)
final long	getMessageFormat()
final long	getMessageID()
final Object	getObjectProperty(String key)
final 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()
final byte	getPriority()
final org.apache.qpid.proton.amqp.messaging.Properties	getProperties()	Returns a copy of the message's Properties if one exists or null if none present; changes to the returned Properties instance do not affect the original message.
protected SimpleString.StringSimpleStringPool	getPropertyKeysPool()
final Set<SimpleString>	getPropertyNames()
protected SimpleString.StringSimpleStringPool	getPropertyValuesPool()
String	getProtocolName()
final org.apache.qpid.proton.message.impl.MessageImpl	getProtonMessage()	Creates and returns a Proton-J MessageImpl wrapper around the message data.
final SimpleString	getReplyTo()
final RoutingType	getRoutingType()
final 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.
final Short	getShortProperty(String key)
final Short	getShortProperty(SimpleString key)
final SimpleString	getSimpleStringProperty(String key)
final SimpleString	getSimpleStringProperty(SimpleString key)
final String	getStringProperty(String key)
final String	getStringProperty(SimpleString key)
final String	getSubject()
final long	getTimestamp()
final 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)
final Message	putBooleanProperty(String key, boolean value)
final Message	putBooleanProperty(SimpleString key, boolean value)
final Message	putByteProperty(String key, byte value)
final Message	putByteProperty(SimpleString key, byte value)
final Message	putBytesProperty(String key, byte[] value)
final Message	putBytesProperty(SimpleString key, byte[] value)
final Message	putCharProperty(String key, char value)
final Message	putCharProperty(SimpleString key, char value)
final Message	putDoubleProperty(String key, double value)
final Message	putDoubleProperty(SimpleString key, double value)
final Message	putExtraBytesProperty(SimpleString key, byte[] value)
final Message	putFloatProperty(String key, float value)
final Message	putFloatProperty(SimpleString key, float value)
final Message	putIntProperty(String key, int value)
final Message	putIntProperty(SimpleString key, int value)
final Message	putLongProperty(String key, long value)
final Message	putLongProperty(SimpleString key, long value)
final Message	putObjectProperty(String key, Object value)
final Message	putObjectProperty(SimpleString key, Object value)
final Message	putShortProperty(String key, short value)
final Message	putShortProperty(SimpleString key, short value)
final Message	putStringProperty(String key, String value)
final Message	putStringProperty(SimpleString key, String value)
final Message	putStringProperty(SimpleString key, SimpleString value)
final void	receiveBuffer(io.netty.buffer.ByteBuf buffer)
abstract void	reencode()
final void	rejectConsumer(long consumer)
void	reloadExpiration(long expiration)
abstract void	reloadPersistence(ActiveMQBuffer record, org.apache.activemq.artemis.core.persistence.CoreMessageObjectPools pools)
final Object	removeAnnotation(SimpleString key)
final byte[]	removeExtraBytesProperty(SimpleString key)
protected Object	removeMessageAnnotation(org.apache.qpid.proton.amqp.Symbol annotation)
final Object	removeProperty(String key)
final Object	removeProperty(SimpleString key)
protected void	resetMessageData()
void	routed()
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)
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.
final AMQPMessage	setAddress(String address)
final AMQPMessage	setAddress(SimpleString address)
final AMQPMessage	setAnnotation(SimpleString key, Object value)
Message	setBrokerProperty(SimpleString key, Object value)
final Message	setConnectionID(String connectionID)
final Message	setCorrelationID(Object correlationID)
final void	setDeliveryAnnotationsForSendBuffer(org.apache.qpid.proton.amqp.messaging.DeliveryAnnotations deliveryAnnotations)	Deprecated. use MessageReference.setProtocolData(Class, Object)
final Message	setDurable(boolean durable)
final AMQPMessage	setExpiration(long expiration)
final AMQPMessage	setExtraProperties(org.apache.activemq.artemis.utils.collections.TypedProperties extraProperties)
final Message	setIngressTimestamp()
final 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)
final Message	setMessageID(long id)
void	setOwner(Object object)
void	setPaged()
final Message	setPriority(byte priority)
final AMQPMessage	setReplyTo(SimpleString address)
final Message	setRoutingType(RoutingType routingType)
final AMQPMessage	setScheduledDeliveryTime(Long time)
final Message	setTimestamp(long timestamp)
final Message	setUserID(Object userID)
CompositeData	toCompositeData(int fieldsLimit, int deliveryCount)
ICoreMessage	toCore()
ICoreMessage	toCore(org.apache.activemq.artemis.core.persistence.CoreMessageObjectPools coreMessageObjectPools)
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
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 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 Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface Message

clearAMQPProperties, 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 Details

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

priority

protected byte priority

isPaged

protected boolean isPaged

routed

protected volatile boolean routed

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 Details

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 Details

routed

public void routed()

Specified by:

routed in interface Message

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 this message's Header if one exists or null if none present; changes to the returned Header instance do not affect the original message.

Returns:

a copy of this message's Header if one exists or null if none present; changes to the returned Header instance do not affect the original message

ensureScanning

protected void ensureScanning()

getDeliveryAnnotations

public final org.apache.qpid.proton.amqp.messaging.DeliveryAnnotations getDeliveryAnnotations()

Returns a copy of the DeliveryAnnotations present in the message or null if non present; 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; changes to the returned DeliveryAnnotations instance do not affect the original message

setDeliveryAnnotationsForSendBuffer

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

Deprecated.

use MessageReference.setProtocolData(Class, Object)

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 message's MessageAnnotations or null if none present; changes to the returned MessageAnnotations instance do not affect the original message.

Returns:

a copy of the message's MessageAnnotations or null if none present; changes to the returned MessageAnnotations instance do not affect the original message

getProperties

public final org.apache.qpid.proton.amqp.messaging.Properties getProperties()

Returns a copy of the message's Properties if one exists or null if none present; changes to the returned Properties instance do not affect the original message.

Returns:

a copy of the message's Properties if one exists or null if none present; changes to the returned Properties instance do not affect the original message

getApplicationProperties

public final org.apache.qpid.proton.amqp.messaging.ApplicationProperties getApplicationProperties()

Returns a copy of the message's ApplicationProperties or null if none present; changes to the returned ApplicationProperties instance do not affect the original message.

Returns:

a copy of the message's ApplicationProperties or null if none present; changes to the returned ApplicationProperties instance do not affect the original message

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

getSubject

public final String getSubject()

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