java.lang.Object
- org.apache.activemq.artemis.utils.critical.CriticalComponentImpl
- - org.apache.activemq.artemis.core.persistence.impl.journal.AbstractJournalStorageManager

All Implemented Interfaces:

StorageManager, ActiveMQComponent, CriticalComponent, IDGenerator

Direct Known Subclasses:

JournalStorageManager
```
public abstract class AbstractJournalStorageManager
extends CriticalComponentImpl
implements StorageManager
```
Controls access to the journals and other storage files such as the ones used to store pages and large messages. This class must control writing of any non-transient data, as it is the key point for synchronizing any replicating backup server.
Using this class also ensures that locks are acquired in the right order, avoiding dead-locks.

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class AbstractJournalStorageManager.JournalContent
- Nested classes/interfaces inherited from interface org.apache.activemq.artemis.core.persistence.StorageManager
  StorageManager.LargeMessageExtension

Field Summary

Fields
Modifier and Type	Field	Description
`protected Journal`	`bindingsJournal`
`protected Configuration`	`config`
`protected static int`	`CRITICAL_PATHS`
`protected static int`	`CRITICAL_STOP`
`protected static int`	`CRITICAL_STOP_2`
`protected static int`	`CRITICAL_STORE`
`protected static ArtemisCloseable`	`dummyCloseable`
`protected ExecutorFactory`	`executorFactory`	Used to create Operation Contexts
`protected BatchingIDGenerator`	`idGenerator`
`protected IOCriticalErrorListener`	`ioCriticalErrorListener`
`protected ExecutorFactory`	`ioExecutorFactory`
`protected boolean`	`journalLoaded`
`protected ConcurrentLongHashMap<LargeServerMessage>`	`largeMessagesToDelete`
`protected Map<SimpleString,PersistedAddressSetting>`	`mapPersistedAddressSettings`
`protected Map<String,PersistedDivertConfiguration>`	`mapPersistedDivertConfigurations`
`protected Map<String,Map<String,PersistedKeyValuePair>>`	`mapPersistedKeyValuePairs`
`protected Map<String,PersistedRole>`	`mapPersistedRoles`
`protected Map<SimpleString,PersistedSecuritySetting>`	`mapPersistedSecuritySettings`
`protected Map<String,PersistedUser>`	`mapPersistedUsers`
`protected Journal`	`messageJournal`
`protected ScheduledExecutorService`	`scheduledExecutorService`
`protected boolean`	`started`
`protected ReentrantReadWriteLock`	`storageManagerLock`
`protected ArtemisCloseable`	`unlockCloseable`

Constructor Summary

Constructors
Constructor	Description
`AbstractJournalStorageManager(Configuration config, CriticalAnalyzer analyzer, ExecutorFactory executorFactory, ScheduledExecutorService scheduledExecutorService, ExecutorFactory ioExecutorFactory)`
`AbstractJournalStorageManager(Configuration config, CriticalAnalyzer analyzer, ExecutorFactory executorFactory, ScheduledExecutorService scheduledExecutorService, ExecutorFactory ioExecutorFactory, IOCriticalErrorListener criticalErrorListener)`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`addAddressBinding(long tx, AddressInfo addressInfo)`
`void`	`addGrouping(GroupBinding groupBinding)`
`void`	`addQueueBinding(long tx, Binding binding)`
`boolean`	`addToPage(PagingStore store, Message msg, Transaction tx, RouteContextList listCtx)`	Write message to page if we are paging.
`void`	`afterCompleteOperations(IOCallback run)`
`void`	`afterStoreOperations(IOCallback run)`	This is similar to afterComplete, however this only cares about the journal part.
`protected abstract void`	`beforeStart()`
`protected abstract void`	`beforeStop()`
`void`	`checkInvalidPageTransactions(PagingManager pagingManager, Set<PageTransactionInfo> invalidPageTransactions)`
`void`	`clearContext()`
`ArtemisCloseable`	`closeableReadLock()`	Read lock the StorageManager.
`void`	`commit(long txID)`
`void`	`commit(long txID, boolean lineUpContext)`
`void`	`commitBindings(long txID)`
`protected void`	`confirmLargeMessage(LargeServerMessage largeServerMessage)`
`void`	`confirmPendingLargeMessage(long recordID)`	We don't need messageID now but we are likely to need it we ever decide to support a database
`void`	`confirmPendingLargeMessageTX(Transaction tx, long messageID, long recordID)`	Confirms that a large message was finished
`void`	`criticalError(Throwable error)`
`void`	`deleteAddressBinding(long tx, long addressBindingID)`
`void`	`deleteAddressSetting(SimpleString addressMatch)`
`void`	`deleteAddressStatus(long recordID)`
`void`	`deleteCursorAcknowledge(long ackID)`
`void`	`deleteCursorAcknowledgeTransactional(long txID, long ackID)`
`void`	`deleteDivertConfiguration(String divertName)`
`void`	`deleteDuplicateID(long recordID)`
`void`	`deleteDuplicateIDTransactional(long txID, long recordID)`
`void`	`deleteGrouping(long tx, GroupBinding groupBinding)`
`void`	`deleteHeuristicCompletion(long id)`
`void`	`deleteID(long journalD)`
`void`	`deleteIncrementRecord(long txID, long recordID)`
`void`	`deleteKeyValuePair(String mapId, String key)`
`void`	`deleteMessage(long messageID)`
`void`	`deletePageComplete(long ackID)`
`void`	`deletePageCounter(long txID, long recordID)`
`void`	`deletePageTransactional(long recordID)`
`void`	`deletePendingPageCounter(long txID, long recordID)`
`void`	`deleteQueueBinding(long tx, long queueBindingID)`
`void`	`deleteQueueStatus(long recordID)`
`void`	`deleteRole(String username)`
`void`	`deleteSecuritySetting(SimpleString addressMatch)`
`void`	`deleteUser(String username)`
`long`	`generateID()`
`Journal`	`getBindingsJournal()`
`Configuration`	`getConfig()`
`OperationContext`	`getContext()`	Get the context associated with the thread for later reuse
`long`	`getCurrentID()`
`IDGenerator`	`getIDGenerator()`
`long`	`getMaxRecordSize()`
`Journal`	`getMessageJournal()`
`Map<String,PersistedKeyValuePair>`	`getPersistedKeyValuePairs(String mapId)`
`Map<String,PersistedRole>`	`getPersistedRoles()`
`Map<String,PersistedUser>`	`getPersistedUsers()`
`protected abstract void`	`init(Configuration config, IOCriticalErrorListener criticalErrorListener)`	Called during initialization.
`boolean`	`isStarted()`
`void`	`lineUpContext()`
`JournalLoadInformation`	`loadBindingJournal(List<QueueBindingInfo> queueBindingInfos, List<GroupingInfo> groupingInfos, List<AddressBindingInfo> addressBindingInfos)`
`JournalLoadInformation[]`	`loadInternalOnly()`	TODO: Is this still being used ?
`JournalLoadInformation`	`loadMessageJournal(PostOffice postOffice, PagingManager pagingManager, ResourceManager resourceManager, Map<Long,QueueBindingInfo> queueInfos, Map<SimpleString,List<Pair<byte[],Long>>> duplicateIDMap, Set<Pair<Long,Long>> pendingLargeMessages, List<PageCountPending> pendingNonTXPageCounter, JournalLoader journalLoader)`
`protected static PersistentAddressBindingEncoding`	`newAddressBindingEncoding(long id, ActiveMQBuffer buffer)`
`OperationContext`	`newContext(Executor executor1)`	It just creates an OperationContext without associating it
`protected static PersistentQueueBindingEncoding`	`newQueueBindingEncoding(long id, ActiveMQBuffer buffer)`
`protected static QueueStatusEncoding`	`newQueueStatusEncoding(long id, ActiveMQBuffer buffer)`
`protected static PersistedSecuritySetting`	`newSecurityRecord(long id, ActiveMQBuffer buffer)`
`OperationContext`	`newSingleThreadContext()`
`protected abstract LargeServerMessage`	`parseLargeMessage(ActiveMQBuffer buff)`
`protected abstract void`	`performCachedLargeMessageDeletes()`	Assumption is that this is only called with a writeLock on the StorageManager.
`void`	`persistIdGenerator()`	Closes the `IDGenerator` persisting the current record ID.
`void`	`prepare(long txID, Xid xid)`
`List<PersistedAddressSetting>`	`recoverAddressSettings()`
`List<PersistedDivertConfiguration>`	`recoverDivertConfigurations()`
`List<PersistedSecuritySetting>`	`recoverSecuritySettings()`
`void`	`rollback(long txID)`
`void`	`rollbackBindings(long txID)`
`void`	`setContext(OperationContext context)`	Set the context back to the thread
`void`	`start()`
`void`	`stop()`
`void`	`stop(boolean ioCriticalError, boolean sendFailover)`
`void`	`storeAcknowledge(long queueID, long messageID)`
`void`	`storeAcknowledgeTransactional(long txID, long queueID, long messageID)`
`void`	`storeAddressSetting(PersistedAddressSetting addressSetting)`
`long`	`storeAddressStatus(long addressID, AddressQueueStatus status)`
`void`	`storeCursorAcknowledge(long queueID, PagePosition position)`
`void`	`storeCursorAcknowledgeTransactional(long txID, long queueID, PagePosition position)`
`void`	`storeDivertConfiguration(PersistedDivertConfiguration persistedDivertConfiguration)`
`void`	`storeDuplicateID(SimpleString address, byte[] duplID, long recordID)`
`void`	`storeDuplicateIDTransactional(long txID, SimpleString address, byte[] duplID, long recordID)`
`long`	`storeHeuristicCompletion(Xid xid, boolean isCommit)`
`void`	`storeID(long journalID, long id)`	Stores the id from IDManager.
`void`	`storeKeyValuePair(PersistedKeyValuePair persistedKeyValuePair)`
`void`	`storeMessage(Message message)`
`void`	`storeMessageTransactional(long txID, Message message)`
`void`	`storePageCompleteTransactional(long txID, long queueID, PagePosition position)`
`long`	`storePageCounter(long txID, long queueID, long value, long persistentSize)`
`long`	`storePageCounterInc(long queueID, int value, long persistentSize)`
`long`	`storePageCounterInc(long txID, long queueID, int value, long persistentSize)`
`void`	`storePageTransaction(long txID, PageTransactionInfo pageTransaction)`
`long`	`storePendingCounter(long queueID, long pageID)`
`long`	`storeQueueStatus(long queueID, AddressQueueStatus status)`
`void`	`storeReference(long queueID, long messageID, boolean last)`
`void`	`storeReferenceTransactional(long txID, long queueID, long messageID)`
`void`	`storeRole(PersistedRole persistedRole)`
`void`	`storeSecuritySetting(PersistedSecuritySetting persistedRoles)`
`void`	`storeUser(PersistedUser persistedUser)`
`void`	`updateDeliveryCount(MessageReference ref)`
`void`	`updateDuplicateIDTransactional(long txID, SimpleString address, byte[] duplID, long recordID)`
`void`	`updatePageTransaction(long txID, PageTransactionInfo pageTransaction, int depages)`
`void`	`updateQueueBinding(long tx, Binding binding)`
`void`	`updateScheduledDeliveryTime(MessageReference ref)`
`void`	`updateScheduledDeliveryTimeTransactional(long txID, MessageReference ref)`
`void`	`waitOnOperations()`	Block until the operations are done.
`boolean`	`waitOnOperations(long timeout)`	Block until the operations are done.

Methods inherited from class org.apache.activemq.artemis.utils.critical.CriticalComponentImpl
checkExpiration, getCriticalAnalyzer, measureCritical

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

Methods inherited from interface org.apache.activemq.artemis.core.persistence.StorageManager
addBytesToLargeMessage, addBytesToLargeMessage, allocateDirectBuffer, createFileForLargeMessage, createFileForLargeMessage, createLargeMessage, createLargeMessage, deleteLargeMessageBody, freeDirectBuffer, getJournalSequentialFileFactory, injectMonitor, largeMessageClosed, largeMessageCreated, pageClosed, pageDeleted, pageWrite, startReplication, stopReplication

Field Detail

CRITICAL_PATHS
```
protected static final int CRITICAL_PATHS
```
See Also:

Constant Field Values

CRITICAL_STORE
```
protected static final int CRITICAL_STORE
```
See Also:

Constant Field Values

CRITICAL_STOP
```
protected static final int CRITICAL_STOP
```
See Also:

Constant Field Values

CRITICAL_STOP_2
```
protected static final int CRITICAL_STOP_2
```
See Also:

Constant Field Values

idGenerator

protected BatchingIDGenerator idGenerator

ioExecutorFactory

protected final ExecutorFactory ioExecutorFactory

scheduledExecutorService

protected final ScheduledExecutorService scheduledExecutorService

storageManagerLock

protected final ReentrantReadWriteLock storageManagerLock

unlockCloseable

protected final ArtemisCloseable unlockCloseable

dummyCloseable

protected static final ArtemisCloseable dummyCloseable

messageJournal
```
protected Journal messageJournal
```

bindingsJournal
```
protected Journal bindingsJournal
```

started
```
protected volatile boolean started
```

executorFactory

protected final ExecutorFactory executorFactory

Used to create Operation Contexts

journalLoaded
```
protected boolean journalLoaded
```

ioCriticalErrorListener

protected final IOCriticalErrorListener ioCriticalErrorListener

config
```
protected final Configuration config
```

mapPersistedSecuritySettings

protected final Map<SimpleString,PersistedSecuritySetting> mapPersistedSecuritySettings

mapPersistedAddressSettings

protected final Map<SimpleString,PersistedAddressSetting> mapPersistedAddressSettings

mapPersistedDivertConfigurations

protected final Map<String,PersistedDivertConfiguration> mapPersistedDivertConfigurations

mapPersistedUsers

protected final Map<String,PersistedUser> mapPersistedUsers

mapPersistedRoles

protected final Map<String,PersistedRole> mapPersistedRoles

mapPersistedKeyValuePairs

protected final Map<String,Map<String,PersistedKeyValuePair>> mapPersistedKeyValuePairs

largeMessagesToDelete

protected final ConcurrentLongHashMap<LargeServerMessage> largeMessagesToDelete

Constructor Detail

AbstractJournalStorageManager

public AbstractJournalStorageManager(Configuration config,
                                     CriticalAnalyzer analyzer,
                                     ExecutorFactory executorFactory,
                                     ScheduledExecutorService scheduledExecutorService,
                                     ExecutorFactory ioExecutorFactory)

AbstractJournalStorageManager

public AbstractJournalStorageManager(Configuration config,
                                     CriticalAnalyzer analyzer,
                                     ExecutorFactory executorFactory,
                                     ScheduledExecutorService scheduledExecutorService,
                                     ExecutorFactory ioExecutorFactory,
                                     IOCriticalErrorListener criticalErrorListener)

Method Detail

getConfig
```
public Configuration getConfig()
```

getMaxRecordSize
```
public long getMaxRecordSize()
```
Specified by:

getMaxRecordSize in interface StorageManager

init

protected abstract void init(Configuration config,
                             IOCriticalErrorListener criticalErrorListener)

Called during initialization. Used by implementations to setup Journals, Stores etc...

Parameters:: config -; criticalErrorListener -

criticalError
```
public void criticalError(Throwable error)
```
Specified by:

criticalError in interface StorageManager

clearContext
```
public void clearContext()
```
Specified by:

clearContext in interface StorageManager

getIDGenerator
```
public IDGenerator getIDGenerator()
```

waitOnOperations
```
public final void waitOnOperations()
                            throws Exception
```
Description copied from interface: StorageManager

Block until the operations are done. Warning: Don't use it inside an ordered executor, otherwise the system may lock up in case of the pools are full

Specified by:

waitOnOperations in interface StorageManager

Throws:

Exception

waitOnOperations
```
public final boolean waitOnOperations(long timeout)
                               throws Exception
```
Description copied from interface: StorageManager

Block until the operations are done. Warning: Don't use it inside an ordered executor, otherwise the system may lock up in case of the pools are full

Specified by:

waitOnOperations in interface StorageManager

Throws:

Exception

getContext
```
public OperationContext getContext()
```
Description copied from interface: StorageManager

Get the context associated with the thread for later reuse

Specified by:

getContext in interface StorageManager

setContext
```
public void setContext(OperationContext context)
```
Description copied from interface: StorageManager

Set the context back to the thread

Specified by:

setContext in interface StorageManager

newSingleThreadContext
```
public OperationContext newSingleThreadContext()
```
Specified by:

newSingleThreadContext in interface StorageManager

newContext
```
public OperationContext newContext(Executor executor1)
```
Description copied from interface: StorageManager

It just creates an OperationContext without associating it

Specified by:

newContext in interface StorageManager

afterCompleteOperations
```
public void afterCompleteOperations(IOCallback run)
```
Specified by:

afterCompleteOperations in interface StorageManager

afterStoreOperations
```
public void afterStoreOperations(IOCallback run)
```
Description copied from interface: StorageManager

This is similar to afterComplete, however this only cares about the journal part.

Specified by:

afterStoreOperations in interface StorageManager

generateID
```
public long generateID()
```
Specified by:

generateID in interface IDGenerator

getCurrentID
```
public long getCurrentID()
```
Specified by:

getCurrentID in interface IDGenerator

confirmPendingLargeMessageTX

public void confirmPendingLargeMessageTX(Transaction tx,
                                         long messageID,
                                         long recordID)
                                  throws Exception

Description copied from interface: StorageManager

Confirms that a large message was finished

Specified by:: confirmPendingLargeMessageTX in interface StorageManager
Throws:: Exception

confirmPendingLargeMessage
```
public void confirmPendingLargeMessage(long recordID)
                                throws Exception
```
We don't need messageID now but we are likely to need it we ever decide to support a database

Specified by:

confirmPendingLargeMessage in interface StorageManager

Throws:

Exception

storeMessage

public void storeMessage(Message message)
                  throws Exception

Specified by:: storeMessage in interface StorageManager
Throws:: Exception

storeReference

public void storeReference(long queueID,
                           long messageID,
                           boolean last)
                    throws Exception

Specified by:: storeReference in interface StorageManager
Throws:: Exception

closeableReadLock
```
public ArtemisCloseable closeableReadLock()
```
Description copied from interface: StorageManager

Read lock the StorageManager. USE WITH CARE!
The main lock is used to write lock the whole manager when starting replication. Sub-systems, say Paging classes, that use locks of their own AND also write through the StorageManager MUST first read lock the storageManager before taking their own locks. Otherwise, we may dead-lock when starting replication sync.

Specified by:

closeableReadLock in interface StorageManager

storeAcknowledge

public void storeAcknowledge(long queueID,
                             long messageID)
                      throws Exception

Specified by:: storeAcknowledge in interface StorageManager
Throws:: Exception

storeCursorAcknowledge

public void storeCursorAcknowledge(long queueID,
                                   PagePosition position)
                            throws Exception

Specified by:: storeCursorAcknowledge in interface StorageManager
Throws:: Exception

deleteMessage

public void deleteMessage(long messageID)
                   throws Exception

Specified by:: deleteMessage in interface StorageManager
Throws:: Exception

updateScheduledDeliveryTime

public void updateScheduledDeliveryTime(MessageReference ref)
                                 throws Exception

Specified by:: updateScheduledDeliveryTime in interface StorageManager
Throws:: Exception

storeDuplicateID

public void storeDuplicateID(SimpleString address,
                             byte[] duplID,
                             long recordID)
                      throws Exception

Specified by:: storeDuplicateID in interface StorageManager
Throws:: Exception

deleteDuplicateID

public void deleteDuplicateID(long recordID)
                       throws Exception

Specified by:: deleteDuplicateID in interface StorageManager
Throws:: Exception

storeMessageTransactional

public void storeMessageTransactional(long txID,
                                      Message message)
                               throws Exception

Specified by:: storeMessageTransactional in interface StorageManager
Throws:: Exception

storePageTransaction

public void storePageTransaction(long txID,
                                 PageTransactionInfo pageTransaction)
                          throws Exception

Specified by:: storePageTransaction in interface StorageManager
Throws:: Exception

updatePageTransaction

public void updatePageTransaction(long txID,
                                  PageTransactionInfo pageTransaction,
                                  int depages)
                           throws Exception

Specified by:: updatePageTransaction in interface StorageManager
Throws:: Exception

storeReferenceTransactional

public void storeReferenceTransactional(long txID,
                                        long queueID,
                                        long messageID)
                                 throws Exception

Specified by:: storeReferenceTransactional in interface StorageManager
Throws:: Exception

storeAcknowledgeTransactional

public void storeAcknowledgeTransactional(long txID,
                                          long queueID,
                                          long messageID)
                                   throws Exception

Specified by:: storeAcknowledgeTransactional in interface StorageManager
Throws:: Exception

storeCursorAcknowledgeTransactional

public void storeCursorAcknowledgeTransactional(long txID,
                                                long queueID,
                                                PagePosition position)
                                         throws Exception

Specified by:: storeCursorAcknowledgeTransactional in interface StorageManager
Throws:: Exception

storePageCompleteTransactional

public void storePageCompleteTransactional(long txID,
                                           long queueID,
                                           PagePosition position)
                                    throws Exception

Specified by:: storePageCompleteTransactional in interface StorageManager
Throws:: Exception

deletePageComplete
```
public void deletePageComplete(long ackID)
                        throws Exception
```
Specified by:

deletePageComplete in interface StorageManager

Throws:

Exception

deleteCursorAcknowledgeTransactional

public void deleteCursorAcknowledgeTransactional(long txID,
                                                 long ackID)
                                          throws Exception

Specified by:: deleteCursorAcknowledgeTransactional in interface StorageManager
Throws:: Exception

deleteCursorAcknowledge
```
public void deleteCursorAcknowledge(long ackID)
                             throws Exception
```
Specified by:

deleteCursorAcknowledge in interface StorageManager

Throws:

Exception

storeHeuristicCompletion

public long storeHeuristicCompletion(Xid xid,
                                     boolean isCommit)
                              throws Exception

Specified by:: storeHeuristicCompletion in interface StorageManager
Throws:: Exception

deleteHeuristicCompletion
```
public void deleteHeuristicCompletion(long id)
                               throws Exception
```
Specified by:

deleteHeuristicCompletion in interface StorageManager

Throws:

Exception

deletePageTransactional

public void deletePageTransactional(long recordID)
                             throws Exception

Specified by:: deletePageTransactional in interface StorageManager
Throws:: Exception

updateScheduledDeliveryTimeTransactional

public void updateScheduledDeliveryTimeTransactional(long txID,
                                                     MessageReference ref)
                                              throws Exception

Specified by:: updateScheduledDeliveryTimeTransactional in interface StorageManager
Throws:: Exception

prepare

public void prepare(long txID,
                    Xid xid)
             throws Exception

Specified by:: prepare in interface StorageManager
Throws:: Exception

commit
```
public void commit(long txID)
            throws Exception
```
Specified by:

commit in interface StorageManager

Throws:

Exception

commitBindings
```
public void commitBindings(long txID)
                    throws Exception
```
Specified by:

commitBindings in interface StorageManager

Throws:

Exception

rollbackBindings
```
public void rollbackBindings(long txID)
                      throws Exception
```
Specified by:

rollbackBindings in interface StorageManager

Throws:

Exception

commit

public void commit(long txID,
                   boolean lineUpContext)
            throws Exception

Specified by:: commit in interface StorageManager
Throws:: Exception

rollback
```
public void rollback(long txID)
              throws Exception
```
Specified by:

rollback in interface StorageManager

Throws:

Exception

storeDuplicateIDTransactional

public void storeDuplicateIDTransactional(long txID,
                                          SimpleString address,
                                          byte[] duplID,
                                          long recordID)
                                   throws Exception

Specified by:: storeDuplicateIDTransactional in interface StorageManager
Throws:: Exception

updateDuplicateIDTransactional

public void updateDuplicateIDTransactional(long txID,
                                           SimpleString address,
                                           byte[] duplID,
                                           long recordID)
                                    throws Exception

Specified by:: updateDuplicateIDTransactional in interface StorageManager
Throws:: Exception

deleteDuplicateIDTransactional

public void deleteDuplicateIDTransactional(long txID,
                                           long recordID)
                                    throws Exception

Specified by:: deleteDuplicateIDTransactional in interface StorageManager
Throws:: Exception

updateDeliveryCount

public void updateDeliveryCount(MessageReference ref)
                         throws Exception

Specified by:: updateDeliveryCount in interface StorageManager
Throws:: Exception

storeAddressSetting

public void storeAddressSetting(PersistedAddressSetting addressSetting)
                         throws Exception

Specified by:: storeAddressSetting in interface StorageManager
Throws:: Exception

recoverAddressSettings

public List<PersistedAddressSetting> recoverAddressSettings()
                                                     throws Exception

Specified by:: recoverAddressSettings in interface StorageManager
Throws:: Exception

recoverSecuritySettings

public List<PersistedSecuritySetting> recoverSecuritySettings()
                                                       throws Exception

Specified by:: recoverSecuritySettings in interface StorageManager
Throws:: Exception

storeSecuritySetting

public void storeSecuritySetting(PersistedSecuritySetting persistedRoles)
                          throws Exception

Specified by:: storeSecuritySetting in interface StorageManager
Throws:: Exception

storeDivertConfiguration

public void storeDivertConfiguration(PersistedDivertConfiguration persistedDivertConfiguration)
                              throws Exception

Specified by:: storeDivertConfiguration in interface StorageManager
Throws:: Exception

deleteDivertConfiguration

public void deleteDivertConfiguration(String divertName)
                               throws Exception

Specified by:: deleteDivertConfiguration in interface StorageManager
Throws:: Exception

recoverDivertConfigurations
```
public List<PersistedDivertConfiguration> recoverDivertConfigurations()
```
Specified by:

recoverDivertConfigurations in interface StorageManager

storeUser

public void storeUser(PersistedUser persistedUser)
               throws Exception

Specified by:: storeUser in interface StorageManager
Throws:: Exception

deleteUser

public void deleteUser(String username)
                throws Exception

Specified by:: deleteUser in interface StorageManager
Throws:: Exception

getPersistedUsers
```
public Map<String,PersistedUser> getPersistedUsers()
```
Specified by:

getPersistedUsers in interface StorageManager

storeRole

public void storeRole(PersistedRole persistedRole)
               throws Exception

Specified by:: storeRole in interface StorageManager
Throws:: Exception

deleteRole

public void deleteRole(String username)
                throws Exception

Specified by:: deleteRole in interface StorageManager
Throws:: Exception

getPersistedRoles
```
public Map<String,PersistedRole> getPersistedRoles()
```
Specified by:

getPersistedRoles in interface StorageManager

storeKeyValuePair

public void storeKeyValuePair(PersistedKeyValuePair persistedKeyValuePair)
                       throws Exception

Specified by:: storeKeyValuePair in interface StorageManager
Throws:: Exception

deleteKeyValuePair

public void deleteKeyValuePair(String mapId,
                               String key)
                        throws Exception

Specified by:: deleteKeyValuePair in interface StorageManager
Throws:: Exception

getPersistedKeyValuePairs

public Map<String,PersistedKeyValuePair> getPersistedKeyValuePairs(String mapId)

Specified by:: getPersistedKeyValuePairs in interface StorageManager

storeID
```
public void storeID(long journalID,
                    long id)
             throws Exception
```
Description copied from interface: StorageManager

Stores the id from IDManager.

Specified by:

storeID in interface StorageManager

Throws:

Exception

deleteID

public void deleteID(long journalD)
              throws Exception

Specified by:: deleteID in interface StorageManager
Throws:: Exception

deleteAddressSetting

public void deleteAddressSetting(SimpleString addressMatch)
                          throws Exception

Specified by:: deleteAddressSetting in interface StorageManager
Throws:: Exception

deleteSecuritySetting

public void deleteSecuritySetting(SimpleString addressMatch)
                           throws Exception

Specified by:: deleteSecuritySetting in interface StorageManager
Throws:: Exception

loadMessageJournal

public JournalLoadInformation loadMessageJournal(PostOffice postOffice,
                                                 PagingManager pagingManager,
                                                 ResourceManager resourceManager,
                                                 Map<Long,QueueBindingInfo> queueInfos,
                                                 Map<SimpleString,List<Pair<byte[],Long>>> duplicateIDMap,
                                                 Set<Pair<Long,Long>> pendingLargeMessages,
                                                 List<PageCountPending> pendingNonTXPageCounter,
                                                 JournalLoader journalLoader)
                                          throws Exception

Specified by:: loadMessageJournal in interface StorageManager
Throws:: Exception

checkInvalidPageTransactions

public void checkInvalidPageTransactions(PagingManager pagingManager,
                                         Set<PageTransactionInfo> invalidPageTransactions)

addGrouping

public void addGrouping(GroupBinding groupBinding)
                 throws Exception

Specified by:: addGrouping in interface StorageManager
Throws:: Exception

deleteGrouping

public void deleteGrouping(long tx,
                           GroupBinding groupBinding)
                    throws Exception

Specified by:: deleteGrouping in interface StorageManager
Throws:: Exception

updateQueueBinding

public void updateQueueBinding(long tx,
                               Binding binding)
                        throws Exception

Specified by:: updateQueueBinding in interface StorageManager
Throws:: Exception

addQueueBinding

public void addQueueBinding(long tx,
                            Binding binding)
                     throws Exception

Specified by:: addQueueBinding in interface StorageManager
Throws:: Exception

deleteQueueBinding

public void deleteQueueBinding(long tx,
                               long queueBindingID)
                        throws Exception

Specified by:: deleteQueueBinding in interface StorageManager
Throws:: Exception

storeQueueStatus
```
public long storeQueueStatus(long queueID,
                             AddressQueueStatus status)
                      throws Exception
```
Specified by:

storeQueueStatus in interface StorageManager

Parameters:

queueID - The id of the queue

status - The current status of the queue. (Reserved for future use, ATM we only use this record for PAUSED)

Returns:

the id of the journal

Throws:

Exception

deleteQueueStatus

public void deleteQueueStatus(long recordID)
                       throws Exception

Specified by:: deleteQueueStatus in interface StorageManager
Throws:: Exception

storeAddressStatus

public long storeAddressStatus(long addressID,
                               AddressQueueStatus status)
                        throws Exception

Specified by:: storeAddressStatus in interface StorageManager
Throws:: Exception

deleteAddressStatus

public void deleteAddressStatus(long recordID)
                         throws Exception

Specified by:: deleteAddressStatus in interface StorageManager
Throws:: Exception

addAddressBinding

public void addAddressBinding(long tx,
                              AddressInfo addressInfo)
                       throws Exception

Specified by:: addAddressBinding in interface StorageManager
Throws:: Exception

deleteAddressBinding

public void deleteAddressBinding(long tx,
                                 long addressBindingID)
                          throws Exception

Specified by:: deleteAddressBinding in interface StorageManager
Throws:: Exception

storePageCounterInc

public long storePageCounterInc(long txID,
                                long queueID,
                                int value,
                                long persistentSize)
                         throws Exception

Specified by:: storePageCounterInc in interface StorageManager
Returns:: the ID with the increment record
Throws:: Exception

storePageCounterInc

public long storePageCounterInc(long queueID,
                                int value,
                                long persistentSize)
                         throws Exception

Specified by:: storePageCounterInc in interface StorageManager
Returns:: the ID with the increment record
Throws:: Exception

storePageCounter

public long storePageCounter(long txID,
                             long queueID,
                             long value,
                             long persistentSize)
                      throws Exception

Specified by:: storePageCounter in interface StorageManager
Returns:: The ID with the stored counter
Throws:: Exception

storePendingCounter

public long storePendingCounter(long queueID,
                                long pageID)
                         throws Exception

Specified by:: storePendingCounter in interface StorageManager
Throws:: Exception

deleteIncrementRecord

public void deleteIncrementRecord(long txID,
                                  long recordID)
                           throws Exception

Specified by:: deleteIncrementRecord in interface StorageManager
Throws:: Exception

deletePageCounter

public void deletePageCounter(long txID,
                              long recordID)
                       throws Exception

Specified by:: deletePageCounter in interface StorageManager
Throws:: Exception

deletePendingPageCounter

public void deletePendingPageCounter(long txID,
                                     long recordID)
                              throws Exception

Specified by:: deletePendingPageCounter in interface StorageManager
Throws:: Exception

loadBindingJournal

public JournalLoadInformation loadBindingJournal(List<QueueBindingInfo> queueBindingInfos,
                                                 List<GroupingInfo> groupingInfos,
                                                 List<AddressBindingInfo> addressBindingInfos)
                                          throws Exception

Specified by:: loadBindingJournal in interface StorageManager
Throws:: Exception

lineUpContext
```
public void lineUpContext()
```
Specified by:

lineUpContext in interface StorageManager

beforeStart

protected abstract void beforeStart()
                             throws Exception

Throws:: Exception

start
```
public void start()
           throws Exception
```
Specified by:

start in interface ActiveMQComponent

Throws:

Exception

stop
```
public void stop()
          throws Exception
```
Specified by:

stop in interface ActiveMQComponent

Throws:

Exception

persistIdGenerator
```
public void persistIdGenerator()
```
Description copied from interface: StorageManager

Closes the IDGenerator persisting the current record ID.
Effectively a "pre-stop" method. Necessary due to the "stop"-order at ActiveMQServerImpl

Specified by:

persistIdGenerator in interface StorageManager

performCachedLargeMessageDeletes
```
protected abstract void performCachedLargeMessageDeletes()
```
Assumption is that this is only called with a writeLock on the StorageManager.

stop
```
public void stop(boolean ioCriticalError,
                 boolean sendFailover)
          throws Exception
```
Specified by:

stop in interface StorageManager

Parameters:

ioCriticalError - is the server being stopped due to an IO critical error.

sendFailover - this is to send the replication stopping in case of replication.

Throws:

Exception

beforeStop

protected abstract void beforeStop()
                            throws Exception

Throws:: Exception

isStarted
```
public boolean isStarted()
```
Specified by:

isStarted in interface ActiveMQComponent

loadInternalOnly

public JournalLoadInformation[] loadInternalOnly()
                                          throws Exception

TODO: Is this still being used ?

Throws:: Exception

getMessageJournal
```
public Journal getMessageJournal()
```
Specified by:

getMessageJournal in interface StorageManager

Returns:

the message journal

getBindingsJournal
```
public Journal getBindingsJournal()
```
Specified by:

getBindingsJournal in interface StorageManager

Returns:

the bindings journal

confirmLargeMessage

protected void confirmLargeMessage(LargeServerMessage largeServerMessage)

parseLargeMessage

protected abstract LargeServerMessage parseLargeMessage(ActiveMQBuffer buff)
                                                 throws Exception

Throws:: Exception

newSecurityRecord

protected static PersistedSecuritySetting newSecurityRecord(long id,
                                                            ActiveMQBuffer buffer)

Parameters:: id -; buffer -
Returns:

newQueueBindingEncoding

protected static PersistentQueueBindingEncoding newQueueBindingEncoding(long id,
                                                                        ActiveMQBuffer buffer)

Parameters:: id -; buffer -
Returns:

newQueueStatusEncoding

protected static QueueStatusEncoding newQueueStatusEncoding(long id,
                                                            ActiveMQBuffer buffer)

Parameters:: id -; buffer -
Returns:

newAddressBindingEncoding

protected static PersistentAddressBindingEncoding newAddressBindingEncoding(long id,
                                                                            ActiveMQBuffer buffer)

addToPage

public boolean addToPage(PagingStore store,
                         Message msg,
                         Transaction tx,
                         RouteContextList listCtx)
                  throws Exception

Description copied from interface: StorageManager

Write message to page if we are paging.

Specified by:: addToPage in interface StorageManager
Returns:: true if we are paging and have handled the data, false if the data needs to be sent to the journal
Throws:: Exception

Class AbstractJournalStorageManager

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.activemq.artemis.core.persistence.StorageManager

Field Summary

Constructor Summary

Method Summary

Methods inherited from class org.apache.activemq.artemis.utils.critical.CriticalComponentImpl

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.activemq.artemis.core.persistence.StorageManager

Field Detail

CRITICAL_PATHS

CRITICAL_STORE

CRITICAL_STOP

CRITICAL_STOP_2

idGenerator

ioExecutorFactory

scheduledExecutorService

storageManagerLock

unlockCloseable

dummyCloseable

messageJournal

bindingsJournal

started

executorFactory

journalLoaded

ioCriticalErrorListener

config

mapPersistedSecuritySettings

mapPersistedAddressSettings

mapPersistedDivertConfigurations

mapPersistedUsers

mapPersistedRoles

mapPersistedKeyValuePairs

largeMessagesToDelete

Constructor Detail

AbstractJournalStorageManager

AbstractJournalStorageManager

Method Detail

getConfig

getMaxRecordSize

init

criticalError

clearContext

getIDGenerator

waitOnOperations

waitOnOperations

getContext

setContext

newSingleThreadContext

newContext

afterCompleteOperations

afterStoreOperations

generateID

getCurrentID

confirmPendingLargeMessageTX

confirmPendingLargeMessage

storeMessage

storeReference

closeableReadLock

storeAcknowledge

storeCursorAcknowledge

deleteMessage

updateScheduledDeliveryTime

storeDuplicateID

deleteDuplicateID

storeMessageTransactional

storePageTransaction

updatePageTransaction

storeReferenceTransactional

storeAcknowledgeTransactional

storeCursorAcknowledgeTransactional

storePageCompleteTransactional

deletePageComplete

deleteCursorAcknowledgeTransactional

deleteCursorAcknowledge

storeHeuristicCompletion

deleteHeuristicCompletion

deletePageTransactional

updateScheduledDeliveryTimeTransactional