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

Class PagingStoreImpl

java.lang.Object

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

All Implemented Interfaces:

PagingStore, ActiveMQComponent

public class PagingStoreImpl
extends Object
implements PagingStore

See Also:

PagingStore

Constructor Summary

Constructors

Constructor and Description
PagingStoreImpl(SimpleString address, ScheduledExecutorService scheduledExecutor, long syncTimeout, PagingManager pagingManager, StorageManager storageManager, SequentialFileFactory fileFactory, PagingStoreFactory storeFactory, SimpleString storeName, AddressSettings addressSettings, Executor executor, boolean syncNonTransactional)

Method Summary

Modifier and Type	Method and Description
void	addSize(int size)
void	applySetting(AddressSettings addressSettings)
boolean	checkMemory(Runnable runWhenAvailable)
boolean	checkPageFileExists(int pageNumber)
boolean	checkReleasedMemory() It will return true if the destination is leaving blocking.
boolean	checkReleaseMemory(boolean globalOversized, long newSize)
Page	createPage(int pageNumber)
Page	depage() Returns a Page out of the Page System without reading it.
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	isStarted()
boolean	lock(long timeout) Write lock the PagingStore.
boolean	page(ServerMessage message, Transaction tx, RouteContextList listCtx, ReentrantReadWriteLock.ReadLock managerLock) 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.
void	start()
boolean	startPaging()
void	stop()
void	stopPaging()
void	sync() Schedules sync to the file storage.
String	toString()
void	unlock() Releases locks acquired with PagingStore.lock(long).

Methods inherited from class java.lang.Object

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

Constructor Detail

PagingStoreImpl

public PagingStoreImpl(SimpleString address,
                       ScheduledExecutorService scheduledExecutor,
                       long syncTimeout,
                       PagingManager pagingManager,
                       StorageManager storageManager,
                       SequentialFileFactory fileFactory,
                       PagingStoreFactory storeFactory,
                       SimpleString storeName,
                       AddressSettings addressSettings,
                       Executor executor,
                       boolean syncNonTransactional)

Method Detail

applySetting

public void applySetting(AddressSettings addressSettings)

Specified by:

applySetting in interface PagingStore

Parameters:

addressSettings -

toString

public String toString()

Overrides:

toString in class Object

lock

public boolean lock(long timeout)

Description copied from interface: PagingStore

Write lock the PagingStore.

Specified by:

lock in interface 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

public void unlock()

Description copied from interface: PagingStore

Releases locks acquired with PagingStore.lock(long).

Specified by:

unlock in interface PagingStore

getCursorProvider

public PageCursorProvider getCursorProvider()

Specified by:

getCursorProvider in interface PagingStore

getFirstPage

public long getFirstPage()

Specified by:

getFirstPage in interface PagingStore

getAddress

public SimpleString getAddress()

Specified by:

getAddress in interface PagingStore

getAddressSize

public long getAddressSize()

Specified by:

getAddressSize in interface PagingStore

getMaxSize

public long getMaxSize()

Specified by:

getMaxSize in interface PagingStore

getAddressFullMessagePolicy

public AddressFullMessagePolicy getAddressFullMessagePolicy()

Specified by:

getAddressFullMessagePolicy in interface PagingStore

getPageSizeBytes

public long getPageSizeBytes()

Specified by:

getPageSizeBytes in interface PagingStore

getFolder

public File getFolder()

Specified by:

getFolder in interface PagingStore

isPaging

public boolean isPaging()

Specified by:

isPaging in interface PagingStore

getNumberOfPages

public int getNumberOfPages()

Specified by:

getNumberOfPages in interface PagingStore

getCurrentWritingPage

public int getCurrentWritingPage()

Description copied from interface: PagingStore

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

Specified by:

getCurrentWritingPage in interface PagingStore

getStoreName

public SimpleString getStoreName()

Specified by:

getStoreName in interface PagingStore

sync

public void sync()
          throws Exception

Description copied from interface: PagingStore

Schedules sync to the file storage.

Specified by:

sync in interface PagingStore

Throws:

Exception

ioSync

public void ioSync()
            throws Exception

Description copied from interface: PagingStore

Performs a real sync on the current IO file.

Specified by:

ioSync in interface PagingStore

Throws:

Exception

processReload

public void processReload()
                   throws Exception

Specified by:

processReload in interface PagingStore

Throws:

Exception

getPagingManager

public PagingManager getPagingManager()

Specified by:

getPagingManager in interface PagingStore

isStarted

public boolean isStarted()

Specified by:

isStarted in interface ActiveMQComponent

stop

public void stop()
          throws Exception

Specified by:

stop in interface ActiveMQComponent

Throws:

Exception

flushExecutors

public void flushExecutors()

Description copied from interface: PagingStore

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

Specified by:

flushExecutors in interface PagingStore

start

public void start()
           throws Exception

Specified by:

start in interface ActiveMQComponent

Throws:

Exception

stopPaging

public void stopPaging()

Specified by:

stopPaging in interface PagingStore

startPaging

public boolean startPaging()

Specified by:

startPaging in interface PagingStore

Returns:

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

getCurrentPage

public Page getCurrentPage()

Specified by:

getCurrentPage in interface PagingStore

checkPageFileExists

public boolean checkPageFileExists(int pageNumber)

Specified by:

checkPageFileExists in interface PagingStore

createPage

public Page createPage(int pageNumber)
                throws Exception

Specified by:

createPage in interface PagingStore

Throws:

Exception

forceAnotherPage

public void forceAnotherPage()
                      throws Exception

Specified by:

forceAnotherPage in interface PagingStore

Throws:

Exception

depage

public Page depage()
            throws Exception

Returns a Page out of the Page System without reading it.

The method calling this method will remove the page and will start reading it outside of any locks. This method could also replace the current file by a new file, and that process is done through acquiring a writeLock on currentPageLock.

Observation: This method is used internally as part of the regular depage process, but externally is used only on tests, and that's why this method is part of the Testable Interface

Specified by:

depage in interface PagingStore

Throws:

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

checkMemory

public boolean checkMemory(Runnable runWhenAvailable)

Specified by:

checkMemory in interface PagingStore

addSize

public void addSize(int size)

Specified by:

addSize in interface PagingStore

checkReleasedMemory

public boolean checkReleasedMemory()

Description copied from interface: PagingStore

It will return true if the destination is leaving blocking.

Specified by:

checkReleasedMemory in interface PagingStore

checkReleaseMemory

public boolean checkReleaseMemory(boolean globalOversized,
                                  long newSize)

page

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

Description copied from interface: PagingStore

Write message to page if we are paging.

Specified by:

page in interface PagingStore

managerLock - 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

disableCleanup

public void disableCleanup()

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

Specified by:

disableCleanup in interface PagingStore

enableCleanup

public void enableCleanup()

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

Specified by:

enableCleanup in interface PagingStore

isFull

public boolean isFull()

Specified by:

isFull in interface PagingStore

isRejectingMessages

public boolean isRejectingMessages()

Specified by:

isRejectingMessages in interface PagingStore

getCurrentIds

public Collection<Integer> getCurrentIds()
                                  throws Exception

Description copied from interface: PagingStore

Files to synchronize with a remote backup.

Specified by:

getCurrentIds in interface PagingStore

Returns:

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

Throws:

Exception

sendPages

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

Description copied from interface: PagingStore

Sends the pages with given IDs to the ReplicationManager.

Sending is done here to avoid exposing the internal SequentialFiles.

Specified by:

sendPages in interface PagingStore

Throws:

Exception