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

Class PageSubscriptionImpl

java.lang.Object

org.apache.activemq.artemis.core.paging.cursor.impl.PageSubscriptionImpl

All Implemented Interfaces:

PageSubscription

public final class PageSubscriptionImpl
extends Object
implements PageSubscription

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	PageSubscriptionImpl.PageCursorInfo	This will hold information about the pending ACKs towards a page.

Method Summary

Modifier and Type	Method	Description
void	ack(PagedReference reference)
void	ackTx(Transaction tx, PagedReference reference)
void	addPendingDelivery(PagedMessage pagedMessage)
void	bookmark(PagePosition position)
void	cleanupEntries(boolean completeDelete)	It will cleanup all the records for completed pages
void	confirmPosition(PagePosition position)
void	confirmPosition(Transaction tx, PagePosition position)
boolean	contains(PagedReference ref)
void	counterSnapshot()	Save a snapshot of the current counter value in the journal
void	destroy()	All the data associated with the cursor should go away here
void	disableAutoCleanup()
void	enableAutoCleanup()
void	forEachConsumedPage(Consumer<ConsumedPage> pageConsumer)
PageSubscriptionCounter	getCounter()
long	getDeliveredCount()
long	getDeliveredSize()
long	getFirstPage()
long	getId()
long	getMessageCount()
PageSubscriptionImpl.PageCursorInfo	getPageInfo(long pageNr)
PagingStore	getPagingStore()
long	getPersistentSize()
PageCursorProvider	getProvider()
Queue	getQueue()
AtomicInteger	getScheduledCleanupCount()	for tests
void	incrementDeliveredSize(long size)
boolean	isComplete(long page)
boolean	isCounterPending()
boolean	isPaging()	Used as a delegate method to PagingStore.isPaging()
boolean	isPersistent()
PageIterator	iterator()
PageIterator	iterator(boolean browsing)
void	lateDeliveryRollback(PagePosition position)
PageSubscriptionImpl.PageCursorInfo	locatePageInfo(long pageNr)
void	notEmpty()	This is a callback to inform the PageSubscription that something was routed, so the empty flag can be cleared
void	onDeletePage(Page deletedPage)
void	onPageModeCleared(Transaction tx)
void	positionIgnored(PagePosition position)	To be called when the cursor decided to ignore a position.
void	printDebug()
void	printDebug(String msg)
void	processReload()
PagedMessage	queryMessage(PagePosition pos)	To be used to requery the reference
void	redeliver(PageIterator iterator, PagedReference pagedReference)
void	reloadACK(PagePosition position)	Theres no need to synchronize this method as it's only called from journal load on startup
boolean	reloadPageCompletion(PagePosition position)	A page marked as complete will be ignored until it's cleared.
void	reloadPageInfo(long pageNr)
void	reloadPreparedACK(Transaction tx, PagePosition position)	To be used to avoid a redelivery of a prepared ACK after load
void	removePendingDelivery(PagedMessage pagedMessage)
void	scanAck(BooleanSupplier retryBeforeScan, ToIntFunction<PagedReference> scanFunction, Runnable found, Runnable notFound)	This method will schedule scanning over Paging, however a retry should be done before the scanning.
void	scheduleCleanupCheck()
void	setQueue(Queue queue)
void	stop()
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

getScheduledCleanupCount

public AtomicInteger getScheduledCleanupCount()

for tests

scanAck

public void scanAck(BooleanSupplier retryBeforeScan,
                    ToIntFunction<PagedReference> scanFunction,
                    Runnable found,
                    Runnable notFound)

Description copied from interface: PageSubscription

This method will schedule scanning over Paging, however a retry should be done before the scanning.

Specified by:

scanAck in interface PageSubscription

Parameters:

retryBeforeScan - if this function is called and returns true, the scan for this element will not be called. It would be caller's responsibility to call found.

getPagingStore

public PagingStore getPagingStore()

Specified by:

getPagingStore in interface PageSubscription

getQueue

public Queue getQueue()

Specified by:

getQueue in interface PageSubscription

isPaging

public boolean isPaging()

Description copied from interface: PageSubscription

Used as a delegate method to PagingStore.isPaging()

Specified by:

isPaging in interface PageSubscription

setQueue

public void setQueue(Queue queue)

Specified by:

setQueue in interface PageSubscription

disableAutoCleanup

public void disableAutoCleanup()

Specified by:

disableAutoCleanup in interface PageSubscription

enableAutoCleanup

public void enableAutoCleanup()

Specified by:

enableAutoCleanup in interface PageSubscription

getProvider

public PageCursorProvider getProvider()

notEmpty

public void notEmpty()

Description copied from interface: PageSubscription

This is a callback to inform the PageSubscription that something was routed, so the empty flag can be cleared

Specified by:

notEmpty in interface PageSubscription

bookmark

public void bookmark(PagePosition position)
              throws Exception

Specified by:

bookmark in interface PageSubscription

Throws:

Exception

getMessageCount

public long getMessageCount()

Specified by:

getMessageCount in interface PageSubscription

isCounterPending

public boolean isCounterPending()

Specified by:

isCounterPending in interface PageSubscription

getPersistentSize

public long getPersistentSize()

Specified by:

getPersistentSize in interface PageSubscription

getCounter

public PageSubscriptionCounter getCounter()

Specified by:

getCounter in interface PageSubscription

reloadPageCompletion

public boolean reloadPageCompletion(PagePosition position)
                             throws Exception

A page marked as complete will be ignored until it's cleared.

Usually paging is a stream of messages but in certain scenarios (such as a pending prepared TX) we may have big holes on the page streaming, and we will need to ignore such pages on the cursor/subscription.

Specified by:

reloadPageCompletion in interface PageSubscription

Throws:

Exception

scheduleCleanupCheck

public void scheduleCleanupCheck()

Specified by:

scheduleCleanupCheck in interface PageSubscription

onPageModeCleared

public void onPageModeCleared(Transaction tx)
                       throws Exception

Specified by:

onPageModeCleared in interface PageSubscription

Throws:

Exception

cleanupEntries

public void cleanupEntries(boolean completeDelete)
                    throws Exception

It will cleanup all the records for completed pages

Specified by:

cleanupEntries in interface PageSubscription

Throws:

Exception

toString

public String toString()

Overrides:

toString in class Object

iterator

public PageIterator iterator()

Specified by:

iterator in interface PageSubscription

iterator

public PageIterator iterator(boolean browsing)

Specified by:

iterator in interface PageSubscription

confirmPosition

public void confirmPosition(Transaction tx,
                            PagePosition position)
                     throws Exception

Specified by:

confirmPosition in interface PageSubscription

Throws:

Exception

ackTx

public void ackTx(Transaction tx,
                  PagedReference reference)
           throws Exception

Specified by:

ackTx in interface PageSubscription

Throws:

Exception

ack

public void ack(PagedReference reference)
         throws Exception

Specified by:

ack in interface PageSubscription

Throws:

Exception

contains

public boolean contains(PagedReference ref)
                 throws Exception

Specified by:

contains in interface PageSubscription

Throws:

Exception

confirmPosition

public void confirmPosition(PagePosition position)
                     throws Exception

Specified by:

confirmPosition in interface PageSubscription

Throws:

Exception

getFirstPage

public long getFirstPage()

Specified by:

getFirstPage in interface PageSubscription

Returns:

the first page in use or MAX_LONG if none is in use

addPendingDelivery

public void addPendingDelivery(PagedMessage pagedMessage)

Specified by:

addPendingDelivery in interface PageSubscription

removePendingDelivery

public void removePendingDelivery(PagedMessage pagedMessage)

Specified by:

removePendingDelivery in interface PageSubscription

redeliver

public void redeliver(PageIterator iterator,
                      PagedReference pagedReference)

Specified by:

redeliver in interface PageSubscription

queryMessage

public PagedMessage queryMessage(PagePosition pos)

Description copied from interface: PageSubscription

To be used to requery the reference

Specified by:

queryMessage in interface PageSubscription

Returns:

reloadACK

public void reloadACK(PagePosition position)

Theres no need to synchronize this method as it's only called from journal load on startup

Specified by:

reloadACK in interface PageSubscription

reloadPreparedACK

public void reloadPreparedACK(Transaction tx,
                              PagePosition position)

Description copied from interface: PageSubscription

To be used to avoid a redelivery of a prepared ACK after load

Specified by:

reloadPreparedACK in interface PageSubscription

positionIgnored

public void positionIgnored(PagePosition position)

Description copied from interface: PageSubscription

To be called when the cursor decided to ignore a position.

Specified by:

positionIgnored in interface PageSubscription

lateDeliveryRollback

public void lateDeliveryRollback(PagePosition position)

Specified by:

lateDeliveryRollback in interface PageSubscription

forEachConsumedPage

public void forEachConsumedPage(Consumer<ConsumedPage> pageConsumer)

Specified by:

forEachConsumedPage in interface PageSubscription

isComplete

public boolean isComplete(long page)

Specified by:

isComplete in interface PageSubscription

Returns:

destroy

public void destroy()
             throws Exception

All the data associated with the cursor should go away here

Specified by:

destroy in interface PageSubscription

Throws:

Exception

getId

public long getId()

Specified by:

getId in interface PageSubscription

isPersistent

public boolean isPersistent()

Specified by:

isPersistent in interface PageSubscription

processReload

public void processReload()
                   throws Exception

Specified by:

processReload in interface PageSubscription

Throws:

Exception

stop

public void stop()

Specified by:

stop in interface PageSubscription

counterSnapshot

public void counterSnapshot()

Description copied from interface: PageSubscription

Save a snapshot of the current counter value in the journal

Specified by:

counterSnapshot in interface PageSubscription

printDebug

public void printDebug()

Specified by:

printDebug in interface PageSubscription

printDebug

public void printDebug(String msg)

onDeletePage

public void onDeletePage(Page deletedPage)
                  throws Exception

Specified by:

onDeletePage in interface PageSubscription

Throws:

Exception

reloadPageInfo

public void reloadPageInfo(long pageNr)

Specified by:

reloadPageInfo in interface PageSubscription

locatePageInfo

public PageSubscriptionImpl.PageCursorInfo locatePageInfo(long pageNr)

Specified by:

locatePageInfo in interface PageSubscription

getPageInfo

public PageSubscriptionImpl.PageCursorInfo getPageInfo(long pageNr)

getDeliveredCount

public long getDeliveredCount()

Specified by:

getDeliveredCount in interface PageSubscription

Returns:

the deliveredCount

getDeliveredSize

public long getDeliveredSize()

Specified by:

getDeliveredSize in interface PageSubscription

Returns:

the deliveredSize

incrementDeliveredSize

public void incrementDeliveredSize(long size)

Specified by:

incrementDeliveredSize in interface PageSubscription