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

Class PageCursorProviderImpl

java.lang.Object

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

All Implemented Interfaces:

PageCursorProvider

public class PageCursorProviderImpl
extends Object
implements PageCursorProvider

A PageProviderIMpl TODO: this may be moved entirely into PagingStore as there's an one-to-one relationship here However I want to keep this isolated as much as possible during development

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	cleanupEnabled
protected PagingStore	pagingStore
protected AtomicInteger	scheduledCleanup As an optimization, avoid subsequent schedules as they are unnecessary
protected StorageManager	storageManager

Constructor Summary

Constructors

Constructor and Description
PageCursorProviderImpl(PagingStore pagingStore, StorageManager storageManager, Executor executor, int maxCacheSize)

Method Summary

Modifier and Type	Method and Description
void	addPageCache(PageCache cache)
void	cleanup() Perform the cleanup at the caller's thread (for startup and recovery)
protected void	cleanupComplete(ArrayList<PageSubscription> cursorList)
void	clearCache() Used on tests, to simulate a scenario where the VM cleared space
void	close(PageSubscription cursor)
protected org.apache.activemq.artemis.core.paging.cursor.impl.PageCacheImpl	createPageCache(long pageId)
PageSubscription	createSubscription(long cursorID, Filter filter, boolean persistent)
void	disableCleanup()
protected void	finishCleanup(ArrayList<Page> depagedPages)
void	flushExecutors()
int	getCacheSize()
PagedMessage	getMessage(PagePosition pos)
PageCache	getPageCache(long pageId)
PageSubscription	getSubscription(long cursorID)
PagedReference	newReference(PagePosition pos, PagedMessage msg, PageSubscription subscription)
protected void	onDeletePage(Page deletedPage)
void	onPageModeCleared() Delete everything associated with any queue on this address.
void	printDebug()
void	processReload()
void	resumeCleanup()
void	scheduleCleanup()
void	setCacheMaxSize(int size)
void	stop()
protected void	storeBookmark(ArrayList<PageSubscription> cursorList, Page currentPage)
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

scheduledCleanup

protected final AtomicInteger scheduledCleanup

As an optimization, avoid subsequent schedules as they are unnecessary

cleanupEnabled

protected volatile boolean cleanupEnabled

pagingStore

protected final PagingStore pagingStore

storageManager

protected final StorageManager storageManager

Constructor Detail

PageCursorProviderImpl

public PageCursorProviderImpl(PagingStore pagingStore,
                              StorageManager storageManager,
                              Executor executor,
                              int maxCacheSize)

Method Detail

createSubscription

public PageSubscription createSubscription(long cursorID,
                                           Filter filter,
                                           boolean persistent)

Specified by:

createSubscription in interface PageCursorProvider

getSubscription

public PageSubscription getSubscription(long cursorID)

Specified by:

getSubscription in interface PageCursorProvider

Parameters:

cursorID - The cursorID should be the same as the queueId associated for persistence

Returns:

getMessage

public PagedMessage getMessage(PagePosition pos)

Specified by:

getMessage in interface PageCursorProvider

newReference

public PagedReference newReference(PagePosition pos,
                                   PagedMessage msg,
                                   PageSubscription subscription)

Specified by:

newReference in interface PageCursorProvider

getPageCache

public PageCache getPageCache(long pageId)

Specified by:

getPageCache in interface PageCursorProvider

addPageCache

public void addPageCache(PageCache cache)

Specified by:

addPageCache in interface PageCursorProvider

setCacheMaxSize

public void setCacheMaxSize(int size)

Specified by:

setCacheMaxSize in interface PageCursorProvider

getCacheSize

public int getCacheSize()

Specified by:

getCacheSize in interface PageCursorProvider

clearCache

public void clearCache()

Description copied from interface: PageCursorProvider

Used on tests, to simulate a scenario where the VM cleared space

Specified by:

clearCache in interface PageCursorProvider

processReload

public void processReload()
                   throws Exception

Specified by:

processReload in interface PageCursorProvider

Throws:

Exception

stop

public void stop()

Specified by:

stop in interface PageCursorProvider

flushExecutors

public void flushExecutors()

Specified by:

flushExecutors in interface PageCursorProvider

close

public void close(PageSubscription cursor)

Specified by:

close in interface PageCursorProvider

scheduleCleanup

public void scheduleCleanup()

Specified by:

scheduleCleanup in interface PageCursorProvider

onPageModeCleared

public void onPageModeCleared()

Delete everything associated with any queue on this address. This is to be called when the address is about to be released from paging. Hence the PagingStore will be holding a write lock, meaning no messages are going to be paged at this time. So, we shouldn't lock anything after this method, to avoid dead locks between the writeLock and any synchronization with the CursorProvider.

Specified by:

onPageModeCleared in interface PageCursorProvider

disableCleanup

public void disableCleanup()

Specified by:

disableCleanup in interface PageCursorProvider

resumeCleanup

public void resumeCleanup()

Specified by:

resumeCleanup in interface PageCursorProvider

cleanup

public void cleanup()

Description copied from interface: PageCursorProvider

Perform the cleanup at the caller's thread (for startup and recovery)

Specified by:

cleanup in interface PageCursorProvider

cleanupComplete

protected void cleanupComplete(ArrayList<PageSubscription> cursorList)
                        throws Exception

Throws:

Exception

finishCleanup

protected void finishCleanup(ArrayList<Page> depagedPages)

onDeletePage

protected void onDeletePage(Page deletedPage)
                     throws Exception

Throws:

Exception

storeBookmark

protected void storeBookmark(ArrayList<PageSubscription> cursorList,
                             Page currentPage)
                      throws Exception

Parameters:

cursorList -

currentPage -

Throws:

Exception

printDebug

public void printDebug()

Specified by:

printDebug in interface PageCursorProvider

toString

public String toString()

Overrides:

toString in class Object

createPageCache

protected org.apache.activemq.artemis.core.paging.cursor.impl.PageCacheImpl createPageCache(long pageId)
                                                                                     throws Exception

Throws:

Exception