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

Class GroupFirstMessageReference

java.lang.Object

org.apache.activemq.artemis.core.server.impl.GroupFirstMessageReference

All Implemented Interfaces:

MessageReference

public class GroupFirstMessageReference
extends Object
implements MessageReference

This MessageReference should only be created the first time a group is assigned to a consumer, it allows us to make a copy of the message to add the property safely as a delivery semantic, without affecting the underlying message.

The overhead is low, as noted above only should be created on first message in a group to a consumer.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.activemq.artemis.core.server.MessageReference

MessageReference.Factory

Constructor Summary

Constructors

Constructor	Description
GroupFirstMessageReference(SimpleString key, MessageReference messageReference)

Method Summary

Modifier and Type	Method	Description
void	acknowledge()
void	acknowledge(Transaction tx)
void	acknowledge(Transaction tx, AckReason reason, ServerConsumer consumer)
void	acknowledge(Transaction tx, AckReason reason, ServerConsumer consumer, boolean delivering)
void	acknowledge(Transaction tx, ServerConsumer consumer)
MessageReference	copy(Queue queue)
void	decrementDeliveryCount()
void	emptyConsumerID()
long	getConsumerId()
int	getDeliveryCount()
SimpleString	getLastValueProperty()
Message	getMessage()
long	getMessageID()
int	getMessageMemoryEstimate()	We define this method aggregation here because on paging we need to hold the original estimate, so we need to perform some extra steps on paging.
int	getPersistedCount()
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 for the amount of data on a queue
<T> T	getProtocolData(Class<T> typeClass)	To be used on holding protocol specific data during the delivery.
Queue	getQueue()
long	getScheduledDeliveryTime()	Returns The time in the future that delivery will be delayed until, or zero if no scheduled delivery will occur.
long	getSequence()
void	handled()
boolean	hasConsumerId()
void	incrementDeliveryCount()
boolean	isAlreadyAcked()
boolean	isDurable()
boolean	isInDelivery()
boolean	isPaged()
void	onDelivery(Consumer<? super MessageReference> callback)	This is to be used in cases where a message delivery happens on an executor.
void	setAlreadyAcked()
void	setConsumerId(long consumerID)
void	setDeliveryCount(int deliveryCount)
void	setInDelivery(boolean inDelivery)
void	setPersistedCount(int deliveryCount)
<T> void	setProtocolData(Class<T> typeClass, T data)	To be used on holding protocol specific data during the delivery.
void	setScheduledDeliveryTime(long scheduledDeliveryTime)
void	setSequence(long nextSequence)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.activemq.artemis.core.server.MessageReference

skipDelivery

Constructor Details

GroupFirstMessageReference

public GroupFirstMessageReference(SimpleString key,
 MessageReference messageReference)

Method Details

getMessage

public Message getMessage()

Specified by:

getMessage in interface MessageReference

isPaged

public boolean isPaged()

Specified by:

isPaged in interface MessageReference

getMessageID

public long getMessageID()

Specified by:

getMessageID in interface MessageReference

isDurable

public boolean isDurable()

Specified by:

isDurable in interface MessageReference

getLastValueProperty

public SimpleString getLastValueProperty()

Specified by:

getLastValueProperty in interface MessageReference

onDelivery

public void onDelivery(Consumer<? super MessageReference> callback)

Description copied from interface: MessageReference

This is to be used in cases where a message delivery happens on an executor. Most MessageReference implementations will allow execution, and if it does, and the protocol requires an execution per message, this callback may be used.

At the time of this implementation only AMQP was used.

Specified by:

onDelivery in interface MessageReference

getMessageMemoryEstimate

public int getMessageMemoryEstimate()

Description copied from interface: MessageReference

We define this method aggregation here because on paging we need to hold the original estimate, so we need to perform some extra steps on paging.

Specified by:

getMessageMemoryEstimate in interface MessageReference

getProtocolData

public <T> T getProtocolData(Class<T> typeClass)

Description copied from interface: MessageReference

To be used on holding protocol specific data during the delivery. This will be only valid while the message is on the delivering queue at the consumer

Specified by:

getProtocolData in interface MessageReference

setProtocolData

public <T> void setProtocolData(Class<T> typeClass,
 T data)

Description copied from interface: MessageReference

To be used on holding protocol specific data during the delivery. This will be only valid while the message is on the delivering queue at the consumer

Specified by:

setProtocolData in interface MessageReference

copy

public MessageReference copy(Queue queue)

Specified by:

copy in interface MessageReference

getScheduledDeliveryTime

public long getScheduledDeliveryTime()

Description copied from interface: MessageReference

Returns The time in the future that delivery will be delayed until, or zero if no scheduled delivery will occur.

Specified by:

getScheduledDeliveryTime in interface MessageReference

Returns:

The time in the future that delivery will be delayed until, or zero if no scheduled delivery will occur

setScheduledDeliveryTime

public void setScheduledDeliveryTime(long scheduledDeliveryTime)

Specified by:

setScheduledDeliveryTime in interface MessageReference

getDeliveryCount

public int getDeliveryCount()

Specified by:

getDeliveryCount in interface MessageReference

setDeliveryCount

public void setDeliveryCount(int deliveryCount)

Specified by:

setDeliveryCount in interface MessageReference

setPersistedCount

public void setPersistedCount(int deliveryCount)

Specified by:

setPersistedCount in interface MessageReference

getPersistedCount

public int getPersistedCount()

Specified by:

getPersistedCount in interface MessageReference

incrementDeliveryCount

public void incrementDeliveryCount()

Specified by:

incrementDeliveryCount in interface MessageReference

decrementDeliveryCount

public void decrementDeliveryCount()

Specified by:

decrementDeliveryCount in interface MessageReference

getQueue

public Queue getQueue()

Specified by:

getQueue in interface MessageReference

acknowledge

public void acknowledge()
                 throws Exception

Specified by:

acknowledge in interface MessageReference

Throws:

Exception

acknowledge

public void acknowledge(Transaction tx)
                 throws Exception

Specified by:

acknowledge in interface MessageReference

Throws:

Exception

acknowledge

public void acknowledge(Transaction tx,
 ServerConsumer consumer)
                 throws Exception

Specified by:

acknowledge in interface MessageReference

Throws:

Exception

acknowledge

public void acknowledge(Transaction tx,
 AckReason reason,
 ServerConsumer consumer)
                 throws Exception

Specified by:

acknowledge in interface MessageReference

Throws:

Exception

acknowledge

public void acknowledge(Transaction tx,
 AckReason reason,
 ServerConsumer consumer,
 boolean delivering)
                 throws Exception

Specified by:

acknowledge in interface MessageReference

Throws:

Exception

emptyConsumerID

public void emptyConsumerID()

Specified by:

emptyConsumerID in interface MessageReference

setConsumerId

public void setConsumerId(long consumerID)

Specified by:

setConsumerId in interface MessageReference

hasConsumerId

public boolean hasConsumerId()

Specified by:

hasConsumerId in interface MessageReference

getConsumerId

public long getConsumerId()

Specified by:

getConsumerId in interface MessageReference

handled

public void handled()

Specified by:

handled in interface MessageReference

setInDelivery

public void setInDelivery(boolean inDelivery)

Specified by:

setInDelivery in interface MessageReference

isInDelivery

public boolean isInDelivery()

Specified by:

isInDelivery in interface MessageReference

setAlreadyAcked

public void setAlreadyAcked()

Specified by:

setAlreadyAcked in interface MessageReference

isAlreadyAcked

public boolean isAlreadyAcked()

Specified by:

isAlreadyAcked in interface MessageReference

getPersistentSize

public long getPersistentSize()
                       throws ActiveMQException

Description copied from interface: MessageReference

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 for the amount of data on a queue

Specified by:

getPersistentSize in interface MessageReference

Throws:

ActiveMQException

getSequence

public long getSequence()

Specified by:

getSequence in interface MessageReference

setSequence

public void setSequence(long nextSequence)

Specified by:

setSequence in interface MessageReference