org.apache.activemq.artemis.core.paging

Interface PagingStore

All Superinterfaces:

ActiveMQComponent

All Known Implementing Classes:

PagingStoreImpl

public interface PagingStore
extends ActiveMQComponent

The implementation will take care of details such as PageSize.

The producers will write directly to PagingStore, and the store will decide what Page file should be used based on configured size.

See Also:

PagingManager

Method Summary

Modifier and Type	Method and Description
void	addSize(int size)
void	applySetting(AddressSettings addressSettings)
boolean	checkMemory(Runnable runnable)
boolean	checkPageFileExists(int page)
boolean	checkReleasedMemory() It will return true if the destination is leaving blocking.
Page	createPage(int page)
Page	depage() Remove the first page from the Writing Queue.
void	disableCleanup() This method will disable cleanup of pages.
void	enableCleanup() This method will re-enable cleanup of pages.
void	flushExecutors() This is used mostly by tests.
void	forceAnotherPage()
SimpleString	getAddress()
AddressFullMessagePolicy	getAddressFullMessagePolicy()
long	getAddressSize()
Collection<Integer>	getCurrentIds() Files to synchronize with a remote backup.
Page	getCurrentPage()
int	getCurrentWritingPage() Returns the page id of the current page in which the system is writing files.
PageCursorProvider	getCursorProvider()
long	getFirstPage()
File	getFolder()
long	getMaxSize()
int	getNumberOfPages()
long	getPageSizeBytes()
PagingManager	getPagingManager()
SimpleString	getStoreName()
void	ioSync() Performs a real sync on the current IO file.
boolean	isFull()
boolean	isPaging()
boolean	isRejectingMessages()
boolean	lock(long timeout) Write lock the PagingStore.
boolean	page(ServerMessage message, Transaction tx, RouteContextList listCtx, ReentrantReadWriteLock.ReadLock readLock) Write message to page if we are paging.
void	processReload()
void	sendPages(ReplicationManager replicator, Collection<Integer> pageIds) Sends the pages with given IDs to the ReplicationManager.
boolean	startPaging()
void	stopPaging()
void	sync() Schedules sync to the file storage.
void	unlock() Releases locks acquired with lock(long).

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

isStarted, start, stop

Method Detail

getAddress

SimpleString getAddress()

getNumberOfPages

int getNumberOfPages()

getCurrentWritingPage

int getCurrentWritingPage()

Returns the page id of the current page in which the system is writing files.

getStoreName

SimpleString getStoreName()

getFolder

File getFolder()

getAddressFullMessagePolicy

AddressFullMessagePolicy getAddressFullMessagePolicy()

getFirstPage

long getFirstPage()

getPageSizeBytes

long getPageSizeBytes()

getAddressSize

long getAddressSize()

getMaxSize

long getMaxSize()

applySetting

void applySetting(AddressSettings addressSettings)

isPaging

boolean isPaging()

sync

void sync()
   throws Exception

Schedules sync to the file storage.

Throws:

Exception

ioSync

void ioSync()
     throws Exception

Performs a real sync on the current IO file.

Throws:

Exception

page

boolean page(ServerMessage message,
             Transaction tx,
             RouteContextList listCtx,
             ReentrantReadWriteLock.ReadLock readLock)
      throws Exception

Write message to page if we are paging.

Parameters:

readLock - a read lock from the storage manager. This is an encapsulation violation made to keep the code less complex. If give null the method will throw a NullPointerException

Returns:

true if we are paging and have handled the data, false if the data needs to be sent to the journal

Throws:

NullPointerException - if readLock is null

Exception

createPage

Page createPage(int page)
         throws Exception

Throws:

Exception

checkPageFileExists

boolean checkPageFileExists(int page)
                     throws Exception

Throws:

Exception

getPagingManager

PagingManager getPagingManager()

getCursorProvider

PageCursorProvider getCursorProvider()

processReload

void processReload()
            throws Exception

Throws:

Exception

depage

Page depage()
     throws Exception

Remove the first page from the Writing Queue. The file will still exist until Page.delete is called, So, case the system is reloaded the same Page will be loaded back if delete is not called.

Throws:

Exception - Note: This should still be part of the interface, even though ActiveMQ Artemis only uses through the

forceAnotherPage

void forceAnotherPage()
               throws Exception

Throws:

Exception

getCurrentPage

Page getCurrentPage()

startPaging

boolean startPaging()
             throws Exception

Returns:

true if paging was started, or false if paging was already started before this call

Throws:

Exception

stopPaging

void stopPaging()
         throws Exception

Throws:

Exception

addSize

void addSize(int size)

checkMemory

boolean checkMemory(Runnable runnable)

isFull

boolean isFull()

isRejectingMessages

boolean isRejectingMessages()

checkReleasedMemory

boolean checkReleasedMemory()

It will return true if the destination is leaving blocking.

lock

boolean lock(long timeout)

Write lock the PagingStore.

Parameters:

timeout - milliseconds to wait for the lock. If value is -1 then wait indefinitely.

Returns:

true if the lock was obtained, false otherwise

unlock

void unlock()

Releases locks acquired with lock(long).

flushExecutors

void flushExecutors()

This is used mostly by tests. We will wait any pending runnable to finish its execution

getCurrentIds

Collection<Integer> getCurrentIds()
                           throws Exception

Files to synchronize with a remote backup.

Returns:

a collection of page IDs which must be synchronized with a replicating backup

Throws:

Exception

sendPages

void sendPages(ReplicationManager replicator,
               Collection<Integer> pageIds)
        throws Exception

Sends the pages with given IDs to the ReplicationManager.

Sending is done here to avoid exposing the internal SequentialFiles.

Parameters:

replicator -

pageIds -

Throws:

Exception

disableCleanup

void disableCleanup()

This method will disable cleanup of pages. No page will be deleted after this call.

enableCleanup

void enableCleanup()

This method will re-enable cleanup of pages. Notice that it will also start cleanup threads.