org.apache.activemq.artemis.core.paging

Interface PagingManager

All Superinterfaces:

ActiveMQComponent, HierarchicalRepositoryChangeListener

All Known Implementing Classes:

PagingManagerImpl

public interface PagingManager
extends ActiveMQComponent, HierarchicalRepositoryChangeListener

 +--------------+      1  +----------------+       N +--------------+       N +--------+       1 +-------------------+
 | PostOffice |-------> |PagingManager|-------> |PagingStore | ------> | Page  | ------> | SequentialFile |
 +--------------+         +----------------+         +--------------+         +--------+         +-------------------+
 |                  1 ^
 |                    |
 |                    |
 |                    | 1
 |            N +----------+
 +------------> | Address |
 +----------+
 

Method Summary

Modifier and Type	Method and Description
void	addBlockedStore(PagingStore store)
PagingManager	addSize(int size) Add size at the global count level.
void	addTransaction(PageTransactionInfo pageTransaction) Point to inform/restoring Transactions used when the messages were added into paging
void	checkMemory(Runnable runWhenAvailable) Use this when you have no refernce of an address.
void	deletePageStore(SimpleString storeName)
void	disableCleanup()
default long	getGlobalSize()
PagingStore	getPageStore(SimpleString address) Returns the PageStore associated with the address.
SimpleString[]	getStoreNames()
PageTransactionInfo	getTransaction(long transactionID) Point to inform/restoring Transactions used when the messages were added into paging
Map<Long,PageTransactionInfo>	getTransactions()
void	injectMonitor(FileStoreMonitor monitor)
boolean	isDiskFull()
boolean	isGlobalFull()
boolean	isUsingGlobalSize()
void	lock() Lock the manager.
void	processReload()
void	reloadStores() Reload previously created PagingStores into memory
void	removeTransaction(long transactionID)
void	resumeCleanup()
void	unlock() Unlock the manager.

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

isStarted, start, stop

Methods inherited from interface org.apache.activemq.artemis.core.settings.HierarchicalRepositoryChangeListener

onChange

Method Detail

getPageStore

PagingStore getPageStore(SimpleString address)
                  throws Exception

Returns the PageStore associated with the address. A new page store is created if necessary.

Throws:

Exception

addTransaction

void addTransaction(PageTransactionInfo pageTransaction)

Point to inform/restoring Transactions used when the messages were added into paging

getTransaction

PageTransactionInfo getTransaction(long transactionID)

Point to inform/restoring Transactions used when the messages were added into paging

removeTransaction

void removeTransaction(long transactionID)

Parameters:

transactionID -

getTransactions

Map<Long,PageTransactionInfo> getTransactions()

reloadStores

void reloadStores()
           throws Exception

Reload previously created PagingStores into memory

Throws:

Exception

getStoreNames

SimpleString[] getStoreNames()

deletePageStore

void deletePageStore(SimpleString storeName)
              throws Exception

Throws:

Exception

processReload

void processReload()
            throws Exception

Throws:

Exception

disableCleanup

void disableCleanup()

resumeCleanup

void resumeCleanup()

addBlockedStore

void addBlockedStore(PagingStore store)

injectMonitor

void injectMonitor(FileStoreMonitor monitor)
            throws Exception

Throws:

Exception

lock

void lock()

Lock the manager. This method should not be called during normal PagingManager usage.

unlock

void unlock()

Unlock the manager.

See Also:

lock()

addSize

PagingManager addSize(int size)

Add size at the global count level. if totalSize > globalMaxSize it will return true

isUsingGlobalSize

boolean isUsingGlobalSize()

isGlobalFull

boolean isGlobalFull()

isDiskFull

boolean isDiskFull()

getGlobalSize

default long getGlobalSize()

checkMemory

void checkMemory(Runnable runWhenAvailable)

Use this when you have no refernce of an address. (anonymous AMQP Producers for example)

Parameters:

runWhenAvailable -