Package org.apache.activemq.artemis.core.paging.cursor

Class PagedReferenceImpl

java.lang.Object

org.apache.activemq.artemis.utils.collections.LinkedListImpl.Node<PagedReferenceImpl>

org.apache.activemq.artemis.core.paging.cursor.PagedReferenceImpl

All Implemented Interfaces:

Runnable, PagedReference, MessageReference

Direct Known Subclasses:

QueryPagedReferenceImpl

public class PagedReferenceImpl
extends LinkedListImpl.Node<PagedReferenceImpl>
implements PagedReference, Runnable

Nested Class Summary

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

MessageReference.Factory

Field Summary

Fields

Modifier and Type	Field	Description
protected PagedMessage	message
protected PageSubscription	subscription

Constructor Summary

Constructors

Constructor	Description
PagedReferenceImpl(PagedMessage message, PageSubscription subscription)

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, ServerConsumer consumer)
void	addPendingFlag()
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.
PagedMessage	getPagedMessage()
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
PagePosition	getPosition()	This will create a new PagePosition, or return one previously created.
Object	getProtocolData()	To be used on holding protocol specific data during the delivery.
Queue	getQueue()
long	getScheduledDeliveryTime()
long	getTransactionID()
void	handled()
boolean	hasConsumerId()
void	incrementDeliveryCount()
boolean	isAlreadyAcked()
boolean	isDurable()
boolean	isInDelivery()
boolean	isLargeMessage()
boolean	isPaged()
void	onDelivery(Consumer<? super MessageReference> onDelivery)	This is to be used in cases where a message delivery happens on an executor.
void	removePendingFlag()
void	run()	It will call Consumer.accept(Object) on this of the Consumer registered in onDelivery(Consumer), if any.
void	setAlreadyAcked()
void	setConsumerId(long consumerID)
void	setDeliveryCount(int deliveryCount)
void	setInDelivery(boolean inDelivery)
void	setPersistedCount(int count)
void	setProtocolData(Object protocolData)	To be used on holding protocol specific data during the delivery.
void	setScheduledDeliveryTime(long scheduledDeliveryTime)
String	toString()

Methods inherited from class org.apache.activemq.artemis.utils.collections.LinkedListImpl.Node

next, prev, val

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.core.server.MessageReference

skipDelivery

Field Detail

message

protected PagedMessage message

subscription

protected final PageSubscription subscription

Constructor Detail

PagedReferenceImpl

public PagedReferenceImpl(PagedMessage message,
                          PageSubscription subscription)

Method Detail

getPosition

public PagePosition getPosition()

This will create a new PagePosition, or return one previously created. This method is used to avoid repetitions on browsing iteration only.

Specified by:

getPosition in interface PagedReference

getProtocolData

public Object getProtocolData()

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 void setProtocolData(Object protocolData)

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

getMessage

public Message getMessage()

Specified by:

getMessage in interface MessageReference

onDelivery

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

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

run

public void run()

It will call Consumer.accept(Object) on this of the Consumer registered in onDelivery(Consumer), if any.

Specified by:

run in interface Runnable

getPagedMessage

public PagedMessage getPagedMessage()

Specified by:

getPagedMessage in interface PagedReference

isPaged

public boolean isPaged()

Specified by:

isPaged in interface MessageReference

setPersistedCount

public void setPersistedCount(int count)

Specified by:

setPersistedCount in interface MessageReference

getPersistedCount

public int getPersistedCount()

Specified by:

getPersistedCount 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

Returns:

copy

public MessageReference copy(Queue queue)

Specified by:

copy in interface MessageReference

getScheduledDeliveryTime

public long getScheduledDeliveryTime()

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

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

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

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

toString

public String toString()

Overrides:

toString in class LinkedListImpl.Node<PagedReferenceImpl>

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

isLargeMessage

public boolean isLargeMessage()

Specified by:

isLargeMessage in interface PagedReference

getTransactionID

public long getTransactionID()

Specified by:

getTransactionID in interface PagedReference

addPendingFlag

public void addPendingFlag()

Specified by:

addPendingFlag in interface PagedReference

removePendingFlag

public void removePendingFlag()

Specified by:

removePendingFlag in interface PagedReference

getMessageID

public long getMessageID()

Specified by:

getMessageID in interface MessageReference

getLastValueProperty

public SimpleString getLastValueProperty()

Specified by:

getLastValueProperty in interface MessageReference

getPersistentSize

public long getPersistentSize()

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

Returns:

isDurable

public boolean isDurable()

Specified by:

isDurable in interface MessageReference