org.apache.activemq.artemis.protocol.amqp.broker

Class AMQPMessage

java.lang.Object

org.apache.activemq.artemis.api.core.RefCountMessage

org.apache.activemq.artemis.protocol.amqp.broker.AMQPMessage

All Implemented Interfaces:

Message

public class AMQPMessage
extends RefCountMessage

Field Summary

Fields

Modifier and Type	Field and Description
static SimpleString	ADDRESS_PROPERTY
static int	DEFAULT_MESSAGE_PRIORITY
static int	MAX_MESSAGE_PRIORITY

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

BYTES_TYPE, DEFAULT_TYPE, EMBEDDED_TYPE, HDR_ACTUAL_EXPIRY_TIME, HDR_BRIDGE_DUPLICATE_ID, HDR_CONTENT_TYPE, HDR_DUPLICATE_DETECTION_ID, HDR_GROUP_ID, HDR_LARGE_BODY_SIZE, HDR_LARGE_COMPRESSED, HDR_LAST_VALUE_NAME, HDR_ORIG_MESSAGE_ID, HDR_ORIGINAL_ADDRESS, HDR_ORIGINAL_QUEUE, HDR_PREFIX, HDR_ROUTE_TO_ACK_IDS, HDR_ROUTE_TO_IDS, HDR_ROUTING_TYPE, HDR_SCALEDOWN_TO_IDS, HDR_SCHEDULED_DELIVERY_TIME, HDR_VALIDATED_USER, MAP_TYPE, memoryOffset, OBJECT_TYPE, STREAM_TYPE, TEXT_TYPE

Constructor Summary

Constructors

Constructor and Description
AMQPMessage(long messageFormat) for persistence reload
AMQPMessage(long messageFormat, byte[] data, TypedProperties extraProperties)
AMQPMessage(long messageFormat, byte[] data, TypedProperties extraProperties, org.apache.activemq.artemis.core.message.impl.CoreMessageObjectPools coreMessageObjectPools)
AMQPMessage(long messageFormat, org.apache.qpid.proton.message.Message message)
AMQPMessage(long messageFormat, org.apache.qpid.proton.codec.ReadableBuffer data, TypedProperties extraProperties, org.apache.activemq.artemis.core.message.impl.CoreMessageObjectPools coreMessageObjectPools)
AMQPMessage(org.apache.qpid.proton.message.Message message)

Method Summary

Modifier and Type	Method and Description
boolean	acceptsConsumer(long consumer)
SimpleString	cachedAddressSimpleString(String address)
boolean	containsProperty(SimpleString key)
boolean	containsProperty(String key)
Message	copy()
Message	copy(long newID)
TypedProperties	createExtraProperties()
String	getAddress()
SimpleString	getAddressSimpleString()
Object	getAMQPUserID() Before we added AMQP into Artemis / Hornetq, the name getUserID was already taken by JMSMessageID.
Object	getAnnotation(SimpleString key)
Boolean	getBooleanProperty(SimpleString key)
Boolean	getBooleanProperty(String key)
io.netty.buffer.ByteBuf	getBuffer()
Byte	getByteProperty(SimpleString key)
Byte	getByteProperty(String key)
byte[]	getBytesProperty(SimpleString key)
byte[]	getBytesProperty(String key)
String	getConnectionID()
Double	getDoubleProperty(SimpleString key)
Double	getDoubleProperty(String key)
Object	getDuplicateProperty()
int	getEncodeSize()
long	getExpiration()
byte[]	getExtraBytesProperty(SimpleString key)
TypedProperties	getExtraProperties()
Float	getFloatProperty(SimpleString key)
Float	getFloatProperty(String key)
SimpleString	getGroupID()
org.apache.qpid.proton.amqp.messaging.Header	getHeader()
Integer	getIntProperty(SimpleString key)
Integer	getIntProperty(String key)
SimpleString	getLastValueProperty()
Long	getLongProperty(SimpleString key)
Long	getLongProperty(String key)
int	getMemoryEstimate()
org.apache.qpid.proton.amqp.messaging.MessageAnnotations	getMessageAnnotations()
long	getMessageFormat()
long	getMessageID()
Object	getObjectProperty(SimpleString key)
Object	getObjectProperty(String key)
long	getPersistentSize()
Persister<Message>	getPersister()
int	getPersistSize()
byte	getPriority()
org.apache.qpid.proton.amqp.messaging.Properties	getProperties()
Set<SimpleString>	getPropertyNames()
org.apache.qpid.proton.message.impl.MessageImpl	getProtonMessage()
SimpleString	getReplyTo()
RoutingType	getRoutingType()
Long	getScheduledDeliveryTime()
org.apache.qpid.proton.codec.ReadableBuffer	getSendBuffer(int deliveryCount) Gets a ByteBuf from the Message that contains the encoded bytes to be sent on the wire.
Short	getShortProperty(SimpleString key)
Short	getShortProperty(String key)
SimpleString	getSimpleStringProperty(SimpleString key)
SimpleString	getSimpleStringProperty(String key)
String	getStringProperty(SimpleString key)
String	getStringProperty(String key)
long	getTimestamp()
Object	getUserID()
boolean	isDurable()
void	messageChanged()
void	persist(ActiveMQBuffer targetRecord)
Message	putBooleanProperty(SimpleString key, boolean value)
Message	putBooleanProperty(String key, boolean value)
Message	putByteProperty(SimpleString key, byte value)
Message	putByteProperty(String key, byte value)
Message	putBytesProperty(SimpleString key, byte[] value)
Message	putBytesProperty(String key, byte[] value)
Message	putCharProperty(SimpleString key, char value)
Message	putCharProperty(String key, char value)
Message	putDoubleProperty(SimpleString key, double value)
Message	putDoubleProperty(String key, double value)
Message	putExtraBytesProperty(SimpleString key, byte[] value)
Message	putFloatProperty(SimpleString key, float value)
Message	putFloatProperty(String key, float value)
Message	putIntProperty(SimpleString key, int value)
Message	putIntProperty(String key, int value)
Message	putLongProperty(SimpleString key, long value)
Message	putLongProperty(String key, long value)
Message	putObjectProperty(SimpleString key, Object value)
Message	putObjectProperty(String key, Object value)
Message	putShortProperty(SimpleString key, short value)
Message	putShortProperty(String key, short value)
Message	putStringProperty(SimpleString key, SimpleString value)
Message	putStringProperty(SimpleString key, String value)
Message	putStringProperty(String key, String value)
void	receiveBuffer(io.netty.buffer.ByteBuf buffer)
void	reencode()
void	rejectConsumer(long consumer)
void	reloadPersistence(ActiveMQBuffer record)
Object	removeAnnotation(SimpleString key)
byte[]	removeExtraBytesProperty(SimpleString key)
Object	removeProperty(SimpleString key)
Object	removeProperty(String key)
void	sendBuffer(io.netty.buffer.ByteBuf buffer, int deliveryCount)
AMQPMessage	setAddress(SimpleString address)
AMQPMessage	setAddress(String address)
AMQPMessage	setAnnotation(SimpleString key, Object value)
AMQPMessage	setBuffer(io.netty.buffer.ByteBuf buffer)
Message	setConnectionID(String connectionID)
Message	setDurable(boolean durable)
AMQPMessage	setExpiration(long expiration)
AMQPMessage	setExtraProperties(TypedProperties extraProperties)
Message	setLastValueProperty(SimpleString lastValueName)
Message	setMessageID(long id)
Message	setPriority(byte priority)
AMQPMessage	setReplyTo(SimpleString address)
Message	setRoutingType(RoutingType routingType)
AMQPMessage	setScheduledDeliveryTime(Long time)
Message	setTimestamp(long timestamp)
Message	setUserID(Object userID)
ICoreMessage	toCore()
ICoreMessage	toCore(org.apache.activemq.artemis.core.message.impl.CoreMessageObjectPools coreMessageObjectPools)
String	toString()

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

decrementDurableRefCount, decrementRefCount, getContext, getRefCount, incrementDurableRefCount, incrementRefCount, setContext

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

cleanupInternalProperties, getAnnotationString, getBodyBuffer, getBodyInputStream, getDuplicateIDBytes, getType, getValidatedUserID, isExpired, isLargeMessage, referenceOriginalMessage, releaseBuffer, setType, setValidatedUserID, toMap, toPropertyMap

Field Detail

ADDRESS_PROPERTY

public static final SimpleString ADDRESS_PROPERTY

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

Constructor Detail

AMQPMessage

public AMQPMessage(long messageFormat,
                   byte[] data,
                   TypedProperties extraProperties)

AMQPMessage

public AMQPMessage(long messageFormat,
                   byte[] data,
                   TypedProperties extraProperties,
                   org.apache.activemq.artemis.core.message.impl.CoreMessageObjectPools coreMessageObjectPools)

AMQPMessage

public AMQPMessage(long messageFormat,
                   org.apache.qpid.proton.codec.ReadableBuffer data,
                   TypedProperties extraProperties,
                   org.apache.activemq.artemis.core.message.impl.CoreMessageObjectPools coreMessageObjectPools)

AMQPMessage

public AMQPMessage(long messageFormat)

for persistence reload

AMQPMessage

public AMQPMessage(long messageFormat,
                   org.apache.qpid.proton.message.Message message)

AMQPMessage

public AMQPMessage(org.apache.qpid.proton.message.Message message)

Method Detail

getProtonMessage

public org.apache.qpid.proton.message.impl.MessageImpl getProtonMessage()

setConnectionID

public Message setConnectionID(String connectionID)

getConnectionID

public String getConnectionID()

getMessageAnnotations

public org.apache.qpid.proton.amqp.messaging.MessageAnnotations getMessageAnnotations()

getHeader

public org.apache.qpid.proton.amqp.messaging.Header getHeader()

getProperties

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

getRoutingType

public RoutingType getRoutingType()

setRoutingType

public Message setRoutingType(RoutingType routingType)

getGroupID

public SimpleString getGroupID()

getScheduledDeliveryTime

public Long getScheduledDeliveryTime()

setScheduledDeliveryTime

public AMQPMessage setScheduledDeliveryTime(Long time)

getPersister

public Persister<Message> getPersister()

acceptsConsumer

public boolean acceptsConsumer(long consumer)

rejectConsumer

public void rejectConsumer(long consumer)

getMessageFormat

public long getMessageFormat()

messageChanged

public void messageChanged()

getBuffer

public io.netty.buffer.ByteBuf getBuffer()

setBuffer

public AMQPMessage setBuffer(io.netty.buffer.ByteBuf buffer)

copy

public Message copy()

copy

public Message copy(long newID)

getMessageID

public long getMessageID()

setMessageID

public Message setMessageID(long id)

getExpiration

public long getExpiration()

setExpiration

public AMQPMessage setExpiration(long expiration)

getUserID

public Object getUserID()

getAMQPUserID

public Object getAMQPUserID()

Before we added AMQP into Artemis / Hornetq, 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:

setUserID

public Message setUserID(Object userID)

isDurable

public boolean isDurable()

getDuplicateProperty

public Object getDuplicateProperty()

setDurable

public Message setDurable(boolean durable)

getAddress

public String getAddress()

cachedAddressSimpleString

public SimpleString cachedAddressSimpleString(String address)

setAddress

public AMQPMessage setAddress(String address)

setAddress

public AMQPMessage setAddress(SimpleString address)

getAddressSimpleString

public SimpleString getAddressSimpleString()

getTimestamp

public long getTimestamp()

setTimestamp

public Message setTimestamp(long timestamp)

getPriority

public byte getPriority()

setPriority

public Message setPriority(byte priority)

receiveBuffer

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

getEncodeSize

public int getEncodeSize()

sendBuffer

public void sendBuffer(io.netty.buffer.ByteBuf buffer,
                       int deliveryCount)

getSendBuffer

public org.apache.qpid.proton.codec.ReadableBuffer getSendBuffer(int deliveryCount)

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

createExtraProperties

public TypedProperties createExtraProperties()

getExtraProperties

public TypedProperties getExtraProperties()

setExtraProperties

public AMQPMessage setExtraProperties(TypedProperties extraProperties)

putExtraBytesProperty

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

getExtraBytesProperty

public byte[] getExtraBytesProperty(SimpleString key)
                             throws ActiveMQPropertyConversionException

Throws:

ActiveMQPropertyConversionException

removeExtraBytesProperty

public byte[] removeExtraBytesProperty(SimpleString key)
                                throws ActiveMQPropertyConversionException

Throws:

ActiveMQPropertyConversionException

putBooleanProperty

public Message putBooleanProperty(String key,
                                  boolean value)

putByteProperty

public Message putByteProperty(String key,
                               byte value)

putBytesProperty

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

putShortProperty

public Message putShortProperty(String key,
                                short value)

putCharProperty

public Message putCharProperty(String key,
                               char value)

putIntProperty

public Message putIntProperty(String key,
                              int value)

putLongProperty

public Message putLongProperty(String key,
                               long value)

putFloatProperty

public Message putFloatProperty(String key,
                                float value)

putDoubleProperty

public Message putDoubleProperty(String key,
                                 double value)

putBooleanProperty

public Message putBooleanProperty(SimpleString key,
                                  boolean value)

putByteProperty

public Message putByteProperty(SimpleString key,
                               byte value)

putBytesProperty

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

putShortProperty

public Message putShortProperty(SimpleString key,
                                short value)

putCharProperty

public Message putCharProperty(SimpleString key,
                               char value)

putIntProperty

public Message putIntProperty(SimpleString key,
                              int value)

putLongProperty

public Message putLongProperty(SimpleString key,
                               long value)

putFloatProperty

public Message putFloatProperty(SimpleString key,
                                float value)

putDoubleProperty

public Message putDoubleProperty(SimpleString key,
                                 double value)

putStringProperty

public Message putStringProperty(String key,
                                 String value)

putObjectProperty

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

Throws:

ActiveMQPropertyConversionException

putObjectProperty

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

Throws:

ActiveMQPropertyConversionException

removeProperty

public Object removeProperty(String key)

containsProperty

public boolean containsProperty(String key)

getBooleanProperty

public Boolean getBooleanProperty(String key)
                           throws ActiveMQPropertyConversionException

Throws:

ActiveMQPropertyConversionException

getByteProperty

public Byte getByteProperty(String key)
                     throws ActiveMQPropertyConversionException

Throws:

ActiveMQPropertyConversionException

getDoubleProperty

public Double getDoubleProperty(String key)
                         throws ActiveMQPropertyConversionException

Throws:

ActiveMQPropertyConversionException

getIntProperty

public Integer getIntProperty(String key)
                       throws ActiveMQPropertyConversionException

Throws:

ActiveMQPropertyConversionException

getLongProperty

public Long getLongProperty(String key)
                     throws ActiveMQPropertyConversionException

Throws:

ActiveMQPropertyConversionException

getObjectProperty

public Object getObjectProperty(String key)

getShortProperty

public Short getShortProperty(String key)
                       throws ActiveMQPropertyConversionException

Throws:

ActiveMQPropertyConversionException

getFloatProperty

public Float getFloatProperty(String key)
                       throws ActiveMQPropertyConversionException

Throws:

ActiveMQPropertyConversionException

getStringProperty

public String getStringProperty(String key)
                         throws ActiveMQPropertyConversionException

Throws:

ActiveMQPropertyConversionException

removeAnnotation

public Object removeAnnotation(SimpleString key)

getAnnotation

public Object getAnnotation(SimpleString key)

setAnnotation

public AMQPMessage setAnnotation(SimpleString key,
                                 Object value)

reencode

public void reencode()

getSimpleStringProperty

public SimpleString getSimpleStringProperty(String key)
                                     throws ActiveMQPropertyConversionException

Throws:

ActiveMQPropertyConversionException

getBytesProperty

public byte[] getBytesProperty(String key)
                        throws ActiveMQPropertyConversionException

Throws:

ActiveMQPropertyConversionException

removeProperty

public Object removeProperty(SimpleString key)

containsProperty

public boolean containsProperty(SimpleString key)

getBooleanProperty

public Boolean getBooleanProperty(SimpleString key)
                           throws ActiveMQPropertyConversionException

Throws:

ActiveMQPropertyConversionException

getByteProperty

public Byte getByteProperty(SimpleString key)
                     throws ActiveMQPropertyConversionException

Throws:

ActiveMQPropertyConversionException

getDoubleProperty

public Double getDoubleProperty(SimpleString key)
                         throws ActiveMQPropertyConversionException

Throws:

ActiveMQPropertyConversionException

getIntProperty

public Integer getIntProperty(SimpleString key)
                       throws ActiveMQPropertyConversionException

Throws:

ActiveMQPropertyConversionException

getLongProperty

public Long getLongProperty(SimpleString key)
                     throws ActiveMQPropertyConversionException

Throws:

ActiveMQPropertyConversionException

getObjectProperty

public Object getObjectProperty(SimpleString key)

getShortProperty

public Short getShortProperty(SimpleString key)
                       throws ActiveMQPropertyConversionException

Throws:

ActiveMQPropertyConversionException

getFloatProperty

public Float getFloatProperty(SimpleString key)
                       throws ActiveMQPropertyConversionException

Throws:

ActiveMQPropertyConversionException

getStringProperty

public String getStringProperty(SimpleString key)
                         throws ActiveMQPropertyConversionException

Throws:

ActiveMQPropertyConversionException

getSimpleStringProperty

public SimpleString getSimpleStringProperty(SimpleString key)
                                     throws ActiveMQPropertyConversionException

Throws:

ActiveMQPropertyConversionException

getBytesProperty

public byte[] getBytesProperty(SimpleString key)
                        throws ActiveMQPropertyConversionException

Throws:

ActiveMQPropertyConversionException

putStringProperty

public Message putStringProperty(SimpleString key,
                                 SimpleString value)

putStringProperty

public Message putStringProperty(SimpleString key,
                                 String value)

getPropertyNames

public Set<SimpleString> getPropertyNames()

getMemoryEstimate

public int getMemoryEstimate()

toCore

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

toCore

public ICoreMessage toCore()

getLastValueProperty

public SimpleString getLastValueProperty()

setLastValueProperty

public Message setLastValueProperty(SimpleString lastValueName)

getReplyTo

public SimpleString getReplyTo()

setReplyTo

public AMQPMessage setReplyTo(SimpleString address)

getPersistSize

public int getPersistSize()

persist

public void persist(ActiveMQBuffer targetRecord)

reloadPersistence

public void reloadPersistence(ActiveMQBuffer record)

toString

public String toString()

Overrides:

toString in class Object

getPersistentSize

public long getPersistentSize()
                       throws ActiveMQException

Throws:

ActiveMQException