Package org.apache.activemq.artemis.core.message.impl

Class CoreMessage

java.lang.Object

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

org.apache.activemq.artemis.core.message.impl.CoreMessage

All Implemented Interfaces:

ICoreMessage, Message

Direct Known Subclasses:

ClientMessageImpl, LargeServerMessageImpl

public class CoreMessage
extends RefCountMessage
implements ICoreMessage

Field Summary

Fields

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

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

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
	CoreMessage()
	CoreMessage(long id, int bufferSize)
	CoreMessage(long id, int bufferSize, CoreMessageObjectPools coreMessageObjectPools)
protected	CoreMessage(CoreMessage other)
protected	CoreMessage(CoreMessage other, TypedProperties copyProperties)
	CoreMessage(CoreMessageObjectPools coreMessageObjectPools)

Method Summary

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

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

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

isConfirmed, setConfirmed, toMap

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

acceptsConsumer, copy, durableDown, durableUp, getAnnotationString, getBrokerProperty, getConnectionID, getDuplicateIDBytes, getDurableCount, getExtraBytesProperty, getIngressTimestamp, getObjectPropertyForFilter, getOriginalEstimate, getRefCount, getUsage, getUserContext, getWholeMessageSize, isExpired, putExtraBytesProperty, reencode, refDown, referenceOriginalMessage, refUp, rejectConsumer, removeExtraBytesProperty, routed, setAnnotation, setBrokerProperty, setConnectionID, setIngressTimestamp, setUserContext, toMap, toPropertyMap, toPropertyMap, usageDown, usageUp

Field Details

BUFFER_HEADER_SPACE

public static final int BUFFER_HEADER_SPACE

See Also:

• Constant Field Values

memoryEstimate

protected volatile int memoryEstimate

BODY_OFFSET

public static final int BODY_OFFSET

See Also:

• Constant Field Values

buffer

protected io.netty.buffer.ByteBuf buffer

That is the readInto for the whole message, including properties. It does not include the buffer for the Packet send and receive header on core protocol

writableBuffer

protected volatile ResetLimitWrappedActiveMQBuffer writableBuffer

endOfBodyPosition

protected int endOfBodyPosition

messageIDPosition

protected int messageIDPosition

messageID

protected long messageID

address

protected SimpleString address

type

protected byte type

durable

protected boolean durable

paged

protected boolean paged

timestamp

protected long timestamp

priority

protected byte priority

properties

protected volatile TypedProperties properties

Constructor Details

CoreMessage

public CoreMessage(CoreMessageObjectPools coreMessageObjectPools)

CoreMessage

public CoreMessage()

CoreMessage

protected CoreMessage(CoreMessage other)

CoreMessage

public CoreMessage(long id,
 int bufferSize)

CoreMessage

public CoreMessage(long id,
 int bufferSize,
 CoreMessageObjectPools coreMessageObjectPools)

CoreMessage

protected CoreMessage(CoreMessage other,
 TypedProperties copyProperties)

Method Details

setPaged

public void setPaged()

Specified by:

setPaged in interface Message

isPaged

public boolean isPaged()

Specified by:

isPaged in interface Message

getProtocolName

public String getProtocolName()

Specified by:

getProtocolName in interface Message

getAnnotation

public Object getAnnotation(SimpleString key)

On core there's no delivery annotation

Specified by:

getAnnotation in interface Message

removeAnnotation

public Object removeAnnotation(SimpleString key)

On core there's no delivery annotation

Specified by:

removeAnnotation in interface Message

clearInternalProperties

public void clearInternalProperties()

Specified by:

clearInternalProperties in interface Message

clearAMQPProperties

public void clearAMQPProperties()

Specified by:

clearAMQPProperties in interface Message

getPersister

public Persister<Message> getPersister()

Specified by:

getPersister in interface Message

initBuffer

public CoreMessage initBuffer(int initialMessageBufferSize)

getReplyTo

public SimpleString getReplyTo()

Specified by:

getReplyTo in interface Message

getRoutingType

public RoutingType getRoutingType()

Specified by:

getRoutingType in interface Message

setRoutingType

public Message setRoutingType(RoutingType routingType)

Specified by:

setRoutingType in interface Message

setReplyTo

public CoreMessage setReplyTo(SimpleString address)

Specified by:

setReplyTo in interface Message

receiveBuffer

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

Description copied from interface: Message

Used to receive this message from an encoded medium buffer

Specified by:

receiveBuffer in interface Message

receiveBuffer_1X

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

This will fix the incoming body of 1.x messages

Specified by:

receiveBuffer_1X in interface ICoreMessage

getReadOnlyBodyBuffer

public ActiveMQBuffer getReadOnlyBodyBuffer()

Description copied from interface: ICoreMessage

Returns a new Buffer slicing the current Body.

Specified by:

getReadOnlyBodyBuffer in interface ICoreMessage

Returns:

a new Buffer slicing the current Body

getBodyBufferSize

public int getBodyBufferSize()

Description copied from interface: ICoreMessage

Returns the length in bytes of the body buffer.

Specified by:

getBodyBufferSize in interface ICoreMessage

Returns:

the length in bytes of the body buffer

getDataBuffer

public ActiveMQBuffer getDataBuffer()

This will return the proper buffer to represent the data of the Message. If compressed it will decompress. If large, it will read from the file or streaming.

Specified by:

getDataBuffer in interface ICoreMessage

Returns:

a readOnlyBodyBuffer or a decompressed one if the message is compressed or the large message buffer

getGroupID

public SimpleString getGroupID()

Specified by:

getGroupID in interface Message

setGroupID

public CoreMessage setGroupID(SimpleString groupId)

Specified by:

setGroupID in interface Message

setGroupID

public CoreMessage setGroupID(String groupId)

Specified by:

setGroupID in interface Message

getGroupSequence

public int getGroupSequence()

Specified by:

getGroupSequence in interface Message

setGroupSequence

public CoreMessage setGroupSequence(int sequence)

Specified by:

setGroupSequence in interface Message

getCorrelationID

public Object getCorrelationID()

Specified by:

getCorrelationID in interface Message

setCorrelationID

public Message setCorrelationID(Object correlationID)

Specified by:

setCorrelationID in interface Message

sendBuffer

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

Description copied from interface: Message

Used to send this message to an encoded medium buffer.

Specified by:

sendBuffer in interface Message

Parameters:

deliveryCount - Some protocols (AMQP) will have this as part of the message. ignored on core

sendBuffer - the buffer used.

sendBuffer_1X

public void sendBuffer_1X(io.netty.buffer.ByteBuf sendBuffer)

Recast the message as an 1.4 message

Specified by:

sendBuffer_1X in interface ICoreMessage

checkEncode

protected void checkEncode()

getScheduledDeliveryTime

public Long getScheduledDeliveryTime()

Description copied from interface: Message

Used to calculate what is the delivery time. Return null if not scheduled.

Specified by:

getScheduledDeliveryTime in interface Message

setScheduledDeliveryTime

public CoreMessage setScheduledDeliveryTime(Long time)

Specified by:

setScheduledDeliveryTime in interface Message

getBodyInputStream

public InputStream getBodyInputStream()

Specified by:

getBodyInputStream in interface ICoreMessage

Specified by:

getBodyInputStream in interface Message

getBodyBuffer

public ActiveMQBuffer getBodyBuffer()

The buffer to write the body. Warning: If you just want to read the content of a message, use ICoreMessage.getDataBuffer() or ICoreMessage.getReadOnlyBodyBuffer()

Specified by:

getBodyBuffer in interface ICoreMessage

Specified by:

getBodyBuffer in interface Message

getEndOfBodyPosition

public int getEndOfBodyPosition()

Specified by:

getEndOfBodyPosition in interface ICoreMessage

messageChanged

public void messageChanged()

Description copied from interface: Message

WARNING: Calling this method on a AMQPMessage will allow the non mutable part of the message to be modified.

Specified by:

messageChanged in interface Message

internalSetMessageID

protected void internalSetMessageID(long messageID)

This method serves as a purpose of extension. Large Message on a Core Message will have to set the messageID on the attached NewLargeMessage

moveHeadersAndProperties

public void moveHeadersAndProperties(Message msg)

Description copied from interface: ICoreMessage

Used on large messages treatment. this method is used to transfer properties from a temporary CoreMessage to a definitive one. This is used when before a Message was defined as a LargeMessages, its properties are then moved from the Temporary message to its final LargeMessage object.

Be careful as this will not perform a copy of the Properties. For real copy, use the copy methods or copy constructors.

Specified by:

moveHeadersAndProperties in interface ICoreMessage

copy

public Message copy()

Description copied from interface: Message

It will generate a new instance of the message encode, being a deep copy, new properties, new everything

Specified by:

copy in interface Message

copy

public Message copy(long newID)

Description copied from interface: Message

It will generate a new instance of the message encode, being a deep copy, new properties, new everything

Specified by:

copy in interface Message

getExpiration

public long getExpiration()

Description copied from interface: Message

Returns the expiration time of this message.

Specified by:

getExpiration in interface Message

Returns:

the expiration time of this message

getTimestamp

public long getTimestamp()

Specified by:

getTimestamp in interface Message

setTimestamp

public CoreMessage setTimestamp(long timestamp)

Specified by:

setTimestamp in interface Message

getMessageID

public long getMessageID()

Description copied from interface: Message

Returns the messageID; the messageID is set when the message is handled by the server.

Specified by:

getMessageID in interface Message

Returns:

the messageID; the messageID is set when the message is handled by the server

getPriority

public byte getPriority()

Description copied from interface: Message

Returns the message priority; values range from 0 (less priority) to 9 (more priority) inclusive.

Specified by:

getPriority in interface Message

Returns:

the message priority; values range from 0 (less priority) to 9 (more priority) inclusive

getUserID

public UUID getUserID()

Description copied from interface: Message

This represents historically the JMSMessageID. We had in the past used this for the MessageID that was sent on core messages...

later on when we added AMQP this name clashed with AMQPMessage.getUserID();

Specified by:

getUserID in interface Message

Returns:

the user id

setUserID

public CoreMessage setUserID(Object uuid)

Specified by:

setUserID in interface Message

getValidatedUserID

public String getValidatedUserID()

Specified by:

getValidatedUserID in interface Message

setValidatedUserID

public CoreMessage setValidatedUserID(String validatedUserID)

Specified by:

setValidatedUserID in interface Message

setMessageID

public CoreMessage setMessageID(long messageID)

Specified by:

setMessageID in interface Message

setAddress

public CoreMessage setAddress(SimpleString address)

Description copied from interface: Message

This will set the address on CoreMessage.

Note for AMQPMessages: in AMQPMessages this will not really change the address on the message. Instead it will add a property on extraProperties which only transverse internally at the broker. Whatever you change here it won't affect anything towards the received message.

If you wish to change AMQPMessages address you will have to do it directly at the AMQP Message, however beware that AMQPMessages are not supposed to be changed at the broker, so only do it if you know what you are doing.

Specified by:

setAddress in interface Message

getAddressSimpleString

public SimpleString getAddressSimpleString()

Specified by:

getAddressSimpleString in interface Message

setExpiration

public CoreMessage setExpiration(long expiration)

Description copied from interface: Message

Sets the expiration of this message.

Specified by:

setExpiration in interface Message

Parameters:

expiration - expiration time

setPriority

public CoreMessage setPriority(byte priority)

Description copied from interface: Message

Sets the message priority.

Value must be between 0 and 9 inclusive.

Specified by:

setPriority in interface Message

Parameters:

priority - the new message priority

setUserID

public CoreMessage setUserID(UUID userID)

getProperties

public final TypedProperties getProperties()

I am keeping this synchronized as the decode of the Properties is lazy

getMemoryEstimate

public int getMemoryEstimate()

Specified by:

getMemoryEstimate in interface Message

isServerMessage

public boolean isServerMessage()

Description copied from interface: ICoreMessage

We are really interested if this is a LargeServerMessage.

Specified by:

isServerMessage in interface ICoreMessage

getType

public byte getType()

Specified by:

getType in interface ICoreMessage

Specified by:

getType in interface Message

setType

public CoreMessage setType(byte type)

Specified by:

setType in interface ICoreMessage

Specified by:

setType in interface Message

decodeHeadersAndProperties

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

encode

public CoreMessage encode()

encodeHeadersAndProperties

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

getHeadersAndPropertiesEncodeSize

public int getHeadersAndPropertiesEncodeSize()

Specified by:

getHeadersAndPropertiesEncodeSize in interface ICoreMessage

getDuplicateProperty

public Object getDuplicateProperty()

Specified by:

getDuplicateProperty in interface Message

getLastValueProperty

public SimpleString getLastValueProperty()

Specified by:

getLastValueProperty in interface Message

setLastValueProperty

public Message setLastValueProperty(SimpleString lastValueName)

Specified by:

setLastValueProperty in interface Message

getEncodeSize

public int getEncodeSize()

Description copied from interface: Message

Returns the size of the encoded message.

Specified by:

getEncodeSize in interface Message

Returns:

the size of the encoded message

isLargeMessage

public boolean isLargeMessage()

Specified by:

isLargeMessage in interface Message

getAddress

public String getAddress()

Specified by:

getAddress in interface Message

setAddress

public CoreMessage setAddress(String address)

Description copied from interface: Message

Look at Message.setAddress(SimpleString) for the doc.

Specified by:

setAddress in interface Message

setBuffer

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

Description copied from interface: ICoreMessage

The buffer will belong to this message, until release is called.

Specified by:

setBuffer in interface ICoreMessage

getBuffer

public io.netty.buffer.ByteBuf getBuffer()

Specified by:

getBuffer in interface ICoreMessage

isDurable

public boolean isDurable()

Description copied from interface: Message

Returns whether this message is durable or not.

Specified by:

isDurable in interface Message

Returns:

whether this message is durable or not

setDurable

public CoreMessage setDurable(boolean durable)

Description copied from interface: Message

Sets whether this message is durable or not.

Specified by:

setDurable in interface Message

Parameters:

durable - true to flag this message as durable, false else

putBooleanProperty

public CoreMessage putBooleanProperty(String key,
 boolean value)

Description copied from interface: Message

Callers must call Message.reencode() in order to be sent to clients

Specified by:

putBooleanProperty in interface Message

putBooleanProperty

public CoreMessage putBooleanProperty(SimpleString key,
 boolean value)

Description copied from interface: Message

Callers must call Message.reencode() in order to be sent to clients

Specified by:

putBooleanProperty in interface Message

getBooleanProperty

public Boolean getBooleanProperty(SimpleString key)
                           throws ActiveMQPropertyConversionException

Specified by:

getBooleanProperty in interface Message

Throws:

ActiveMQPropertyConversionException

getBooleanProperty

public Boolean getBooleanProperty(String key)
                           throws ActiveMQPropertyConversionException

Specified by:

getBooleanProperty in interface Message

Throws:

ActiveMQPropertyConversionException

putByteProperty

public CoreMessage putByteProperty(SimpleString key,
 byte value)

Description copied from interface: Message

Callers must call Message.reencode() in order to be sent to clients

Specified by:

putByteProperty in interface Message

putByteProperty

public CoreMessage putByteProperty(String key,
 byte value)

Description copied from interface: Message

Callers must call Message.reencode() in order to be sent to clients

Specified by:

putByteProperty in interface Message

getByteProperty

public Byte getByteProperty(SimpleString key)
                     throws ActiveMQPropertyConversionException

Specified by:

getByteProperty in interface Message

Throws:

ActiveMQPropertyConversionException

getByteProperty

public Byte getByteProperty(String key)
                     throws ActiveMQPropertyConversionException

Specified by:

getByteProperty in interface Message

Throws:

ActiveMQPropertyConversionException

putBytesProperty

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

Description copied from interface: Message

Callers must call Message.reencode() in order to be sent to clients

Specified by:

putBytesProperty in interface Message

putBytesProperty

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

Description copied from interface: Message

Callers must call Message.reencode() in order to be sent to clients

Specified by:

putBytesProperty in interface Message

getBytesProperty

public byte[] getBytesProperty(SimpleString key)
                        throws ActiveMQPropertyConversionException

Specified by:

getBytesProperty in interface Message

Throws:

ActiveMQPropertyConversionException

getBytesProperty

public byte[] getBytesProperty(String key)
                        throws ActiveMQPropertyConversionException

Specified by:

getBytesProperty in interface Message

Throws:

ActiveMQPropertyConversionException

putCharProperty

public CoreMessage putCharProperty(SimpleString key,
 char value)

Description copied from interface: Message

Callers must call Message.reencode() in order to be sent to clients

Specified by:

putCharProperty in interface Message

putCharProperty

public CoreMessage putCharProperty(String key,
 char value)

Description copied from interface: Message

Callers must call Message.reencode() in order to be sent to clients

Specified by:

putCharProperty in interface Message

putShortProperty

public CoreMessage putShortProperty(SimpleString key,
 short value)

Description copied from interface: Message

Callers must call Message.reencode() in order to be sent to clients

Specified by:

putShortProperty in interface Message

putShortProperty

public CoreMessage putShortProperty(String key,
 short value)

Description copied from interface: Message

Callers must call Message.reencode() in order to be sent to clients

Specified by:

putShortProperty in interface Message

putIntProperty

public CoreMessage putIntProperty(SimpleString key,
 int value)

Description copied from interface: Message

Callers must call Message.reencode() in order to be sent to clients

Specified by:

putIntProperty in interface Message

putIntProperty

public CoreMessage putIntProperty(String key,
 int value)

Description copied from interface: Message

Callers must call Message.reencode() in order to be sent to clients

Specified by:

putIntProperty in interface Message

getIntProperty

public Integer getIntProperty(SimpleString key)
                       throws ActiveMQPropertyConversionException

Specified by:

getIntProperty in interface Message

Throws:

ActiveMQPropertyConversionException

getIntProperty

public Integer getIntProperty(String key)
                       throws ActiveMQPropertyConversionException

Specified by:

getIntProperty in interface Message

Throws:

ActiveMQPropertyConversionException

putLongProperty

public CoreMessage putLongProperty(SimpleString key,
 long value)

Description copied from interface: Message

Callers must call Message.reencode() in order to be sent to clients

Specified by:

putLongProperty in interface Message

putLongProperty

public CoreMessage putLongProperty(String key,
 long value)

Description copied from interface: Message

Callers must call Message.reencode() in order to be sent to clients

Specified by:

putLongProperty in interface Message

getLongProperty

public Long getLongProperty(SimpleString key)
                     throws ActiveMQPropertyConversionException

Specified by:

getLongProperty in interface Message

Throws:

ActiveMQPropertyConversionException

getLongProperty

public Long getLongProperty(String key)
                     throws ActiveMQPropertyConversionException

Specified by:

getLongProperty in interface Message

Throws:

ActiveMQPropertyConversionException

putFloatProperty

public CoreMessage putFloatProperty(SimpleString key,
 float value)

Description copied from interface: Message

Callers must call Message.reencode() in order to be sent to clients

Specified by:

putFloatProperty in interface Message

putFloatProperty

public CoreMessage putFloatProperty(String key,
 float value)

Description copied from interface: Message

Callers must call Message.reencode() in order to be sent to clients

Specified by:

putFloatProperty in interface Message

putDoubleProperty

public CoreMessage putDoubleProperty(SimpleString key,
 double value)

Description copied from interface: Message

Callers must call Message.reencode() in order to be sent to clients

Specified by:

putDoubleProperty in interface Message

putDoubleProperty

public CoreMessage putDoubleProperty(String key,
 double value)

Description copied from interface: Message

Callers must call Message.reencode() in order to be sent to clients

Specified by:

putDoubleProperty in interface Message

getDoubleProperty

public Double getDoubleProperty(SimpleString key)
                         throws ActiveMQPropertyConversionException

Specified by:

getDoubleProperty in interface Message

Throws:

ActiveMQPropertyConversionException

getDoubleProperty

public Double getDoubleProperty(String key)
                         throws ActiveMQPropertyConversionException

Specified by:

getDoubleProperty in interface Message

Throws:

ActiveMQPropertyConversionException

putStringProperty

public CoreMessage putStringProperty(SimpleString key,
 SimpleString value)

Specified by:

putStringProperty in interface Message

putStringProperty

public CoreMessage putStringProperty(SimpleString key,
 String value)

Specified by:

putStringProperty in interface Message

putStringProperty

public CoreMessage putStringProperty(String key,
 String value)

Description copied from interface: Message

Puts a String property in this message.

Callers must call Message.reencode() in order to be sent to clients

Specified by:

putStringProperty in interface Message

Parameters:

key - property name

value - property value

putObjectProperty

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

Description copied from interface: Message

Callers must call Message.reencode() in order to be sent to clients

Specified by:

putObjectProperty in interface Message

Throws:

ActiveMQPropertyConversionException

getObjectProperty

public Object getObjectProperty(String key)

Specified by:

getObjectProperty in interface Message

getObjectProperty

public Object getObjectProperty(SimpleString key)

Specified by:

getObjectProperty in interface Message

putObjectProperty

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

Description copied from interface: Message

Callers must call Message.reencode() in order to be sent to clients

Specified by:

putObjectProperty in interface Message

Throws:

ActiveMQPropertyConversionException

getShortProperty

public Short getShortProperty(SimpleString key)
                       throws ActiveMQPropertyConversionException

Specified by:

getShortProperty in interface Message

Throws:

ActiveMQPropertyConversionException

getShortProperty

public Short getShortProperty(String key)
                       throws ActiveMQPropertyConversionException

Specified by:

getShortProperty in interface Message

Throws:

ActiveMQPropertyConversionException

getFloatProperty

public Float getFloatProperty(SimpleString key)
                       throws ActiveMQPropertyConversionException

Specified by:

getFloatProperty in interface Message

Throws:

ActiveMQPropertyConversionException

getFloatProperty

public Float getFloatProperty(String key)
                       throws ActiveMQPropertyConversionException

Specified by:

getFloatProperty in interface Message

Throws:

ActiveMQPropertyConversionException

getStringProperty

public String getStringProperty(SimpleString key)
                         throws ActiveMQPropertyConversionException

Specified by:

getStringProperty in interface Message

Throws:

ActiveMQPropertyConversionException

getStringProperty

public String getStringProperty(String key)
                         throws ActiveMQPropertyConversionException

Specified by:

getStringProperty in interface Message

Throws:

ActiveMQPropertyConversionException

getSimpleStringProperty

public SimpleString getSimpleStringProperty(SimpleString key)
                                     throws ActiveMQPropertyConversionException

Specified by:

getSimpleStringProperty in interface Message

Throws:

ActiveMQPropertyConversionException

getSimpleStringProperty

public SimpleString getSimpleStringProperty(String key)
                                     throws ActiveMQPropertyConversionException

Specified by:

getSimpleStringProperty in interface Message

Throws:

ActiveMQPropertyConversionException

removeProperty

public Object removeProperty(SimpleString key)

Specified by:

removeProperty in interface Message

removeProperty

public Object removeProperty(String key)

Specified by:

removeProperty in interface Message

hasScheduledDeliveryTime

public boolean hasScheduledDeliveryTime()

Description copied from interface: Message

Search for the existence of the property: an implementor can save the message to be decoded, if possible.

Specified by:

hasScheduledDeliveryTime in interface Message

searchProperty

public boolean searchProperty(SimpleString key)

Differently from containsProperty(SimpleString), this method can save decoding the message, performing a search of the key property and falling back to containsProperty(SimpleString) if not possible or if already decoded.

containsProperty

public boolean containsProperty(SimpleString key)

Specified by:

containsProperty in interface Message

containsProperty

public boolean containsProperty(String key)

Specified by:

containsProperty in interface Message

getPropertyNames

public Set<SimpleString> getPropertyNames()

Description copied from interface: Message

Returns all the names of the properties for this message.

Specified by:

getPropertyNames in interface Message

Returns:

all the names of the properties for this message

getLargeBodyReader

public LargeBodyReader getLargeBodyReader()
                                   throws ActiveMQException

Specified by:

getLargeBodyReader in interface ICoreMessage

Throws:

ActiveMQException

getPersistSize

public int getPersistSize()

Specified by:

getPersistSize in interface Message

persist

public void persist(ActiveMQBuffer targetRecord)

Specified by:

persist in interface Message

reloadPersistence

public void reloadPersistence(ActiveMQBuffer record,
 CoreMessageObjectPools pools)

Specified by:

reloadPersistence in interface Message

toCore

public CoreMessage toCore()

Description copied from interface: Message

This should make you convert your message into Core format.

Specified by:

toCore in interface Message

toCore

public CoreMessage toCore(CoreMessageObjectPools coreMessageObjectPools)

Description copied from interface: Message

This should make you convert your message into Core format.

Specified by:

toCore in interface Message

toString

public String toString()

Overrides:

toString in class Object

getPersistentSize

public long getPersistentSize()
                       throws ActiveMQException

Description copied from interface: Message

This is the size of the message when persisted on disk which is used for metrics tracking Note that even if the message itself is not persisted on disk (ie non-durable) this value is still used for metrics tracking If a normal message it will be the encoded message size If a large message it will be encoded message size + large message body size

Specified by:

getPersistentSize in interface Message

Throws:

ActiveMQException

getOwner

public Object getOwner()

Specified by:

getOwner in interface Message

setOwner

public void setOwner(Object object)

Specified by:

setOwner in interface Message

getStringBody

public String getStringBody()

Specified by:

getStringBody in interface Message

toCompositeData

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

Specified by:

toCompositeData in interface Message

Throws:

OpenDataException