Package org.apache.activemq.artemis.core.persistence.impl.journal

Class JournalStorageManager

java.lang.Object

org.apache.activemq.artemis.utils.critical.CriticalComponentImpl

org.apache.activemq.artemis.core.persistence.impl.journal.AbstractJournalStorageManager

org.apache.activemq.artemis.core.persistence.impl.journal.JournalStorageManager

All Implemented Interfaces:

StorageManager, ActiveMQComponent, CriticalComponent, IDGenerator

Direct Known Subclasses:

JDBCJournalStorageManager

public class JournalStorageManager
extends AbstractJournalStorageManager

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.activemq.artemis.core.persistence.impl.journal.AbstractJournalStorageManager

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
static String	ACTIVEMQ_DATA
protected SequentialFileFactory	bindingsFF
protected SequentialFileFactory	journalFF
protected String	largeMessagesDirectory
protected SequentialFileFactory	largeMessagesFactory
protected Journal	originalBindingsJournal
protected Journal	originalMessageJournal
protected ReplicationManager	replicator

Fields inherited from class org.apache.activemq.artemis.core.persistence.impl.journal.AbstractJournalStorageManager

bindingsJournal, config, CRITICAL_PATHS, CRITICAL_STOP, CRITICAL_STOP_2, CRITICAL_STORE, dummyCloseable, executorFactory, idGenerator, ioCriticalErrorListener, ioExecutorFactory, journalLoaded, largeMessagesToDelete, mapPersistedAddressSettings, mapPersistedBridgeConfigurations, mapPersistedConnectors, mapPersistedDivertConfigurations, mapPersistedKeyValuePairs, mapPersistedRoles, mapPersistedSecuritySettings, mapPersistedUsers, messageJournal, scheduledExecutorService, started, storageManagerLock, unlockCloseable

Constructor Summary

Constructors

Constructor	Description
JournalStorageManager(Configuration config, CriticalAnalyzer analyzer, ExecutorFactory executorFactory, ScheduledExecutorService scheduledExecutorService, ExecutorFactory ioExecutors)
JournalStorageManager(Configuration config, CriticalAnalyzer analyzer, ExecutorFactory executorFactory, ScheduledExecutorService scheduledExecutorService, ExecutorFactory ioExecutors, IOCriticalErrorListener criticalErrorListener)
JournalStorageManager(Configuration config, CriticalAnalyzer analyzer, ExecutorFactory executorFactory, ExecutorFactory ioExecutors)
JournalStorageManager(Configuration config, CriticalAnalyzer analyzer, ExecutorFactory executorFactory, ExecutorFactory ioExecutors, IOCriticalErrorListener criticalErrorListener)

Method Summary

Modifier and Type	Method	Description
void	addBytesToLargeMessage(SequentialFile file, long messageId, byte[] bytes)
void	addBytesToLargeMessage(SequentialFile file, long messageId, ActiveMQBuffer bytes)
ByteBuffer	allocateDirectBuffer(int size)	AIO has an optimized buffer which has a method to release it instead of the way NIO will release data based on GC.
protected void	beforeStart()
protected void	beforeStop()
SequentialFile	createFileForLargeMessage(long messageID, StorageManager.LargeMessageExtension extension)	Instantiates a SequentialFile to be used for storing a LargeServerMessage.
LargeServerMessage	createLargeMessage()
LargeServerMessage	createLargeMessage(long id, Message message)	Creates a new LargeMessage with the given id.
protected Journal	createMessageJournal(Configuration config, IOCriticalErrorListener criticalErrorListener, int fileSize)
void	deleteLargeMessageBody(LargeServerMessage largeServerMessage)
protected int	fixJournalFileSize(int fileSize, int alignment)	We need to correct the file size if its not a multiple of the alignement
void	freeDirectBuffer(ByteBuffer buffer)	AIO has an optimized buffer which has a method to release it instead of the way NIO will release data based on GC.
SequentialFileFactory	getJournalSequentialFileFactory()
protected void	init(Configuration config, IOCriticalErrorListener criticalErrorListener)	Called during initialization.
void	injectMonitor(FileStoreMonitor monitor)
boolean	isReplicated()
void	largeMessageClosed(LargeServerMessage largeServerMessage)
LargeServerMessage	largeMessageCreated(long id, LargeServerMessage largeMessage)
void	pageClosed(SimpleString storeName, long pageNumber)
void	pageDeleted(SimpleString storeName, long pageNumber)
void	pageWrite(PagedMessage message, long pageNumber)
protected LargeServerMessage	parseLargeMessage(ActiveMQBuffer buff)
protected void	performCachedLargeMessageDeletes()	Assumption is that this is only called with a writeLock on the StorageManager.
void	recoverLargeMessagesOnFolder(Set<Long> storedLargeMessages)
void	startReplication(ReplicationManager replicationManager, PagingManager pagingManager, String nodeID, boolean autoFailBack, long initialReplicationSyncTimeout)
void	stop()
void	stop(boolean ioCriticalError, boolean sendFailover)
void	stopReplication()	Stops replication by resetting replication-related fields to their 'unreplicated' state.

Methods inherited from class org.apache.activemq.artemis.core.persistence.impl.journal.AbstractJournalStorageManager

addAddressBinding, addGrouping, addQueueBinding, addToPage, afterCompleteOperations, afterStoreOperations, checkInvalidPageTransactions, clearContext, closeableReadLock, commit, commit, commitBindings, confirmPendingLargeMessage, confirmPendingLargeMessageTX, criticalError, deleteAddressBinding, deleteAddressSetting, deleteAddressStatus, deleteBridgeConfiguration, deleteConnector, deleteCursorAcknowledge, deleteCursorAcknowledgeTransactional, deleteDivertConfiguration, deleteDuplicateID, deleteDuplicateIDTransactional, deleteGrouping, deleteHeuristicCompletion, deleteID, deleteIncrementRecord, deleteKeyValuePair, deleteMessage, deletePageComplete, deletePageCounter, deletePageTransactional, deletePendingPageCounter, deleteQueueBinding, deleteQueueStatus, deleteRole, deleteSecuritySetting, deleteUser, generateID, getBindingsJournal, getConfig, getContext, getCurrentID, getIDGenerator, getMaxRecordSize, getMessageJournal, getPersistedKeyValuePairs, getPersistedRoles, getPersistedUsers, isStarted, lineUpContext, loadBindingJournal, loadInternalOnly, loadMessageJournal, newAddressBindingEncoding, newContext, newQueueBindingEncoding, newQueueStatusEncoding, newSecurityRecord, newSingleThreadContext, persistIdGenerator, prepare, recoverAddressSettings, recoverBridgeConfigurations, recoverConnectors, recoverDivertConfigurations, recoverSecuritySettings, rollback, rollbackBindings, setContext, start, storeAcknowledge, storeAcknowledgeTransactional, storeAddressSetting, storeAddressStatus, storeBridgeConfiguration, storeConnector, storeCursorAcknowledge, storeCursorAcknowledgeTransactional, storeDivertConfiguration, storeDuplicateID, storeDuplicateIDTransactional, storeHeuristicCompletion, storeID, storeKeyValuePair, storeMessage, storeMessageTransactional, storePageCompleteTransactional, storePageCounter, storePageCounterInc, storePageCounterInc, storePageTransaction, storePendingCounter, storeQueueStatus, storeReference, storeReferenceTransactional, storeRole, storeSecuritySetting, storeUser, updateDeliveryCount, updateDuplicateIDTransactional, updatePageTransaction, updateQueueBinding, updateScheduledDeliveryTime, updateScheduledDeliveryTimeTransactional, waitOnOperations, waitOnOperations

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

createFileForLargeMessage, loadMessageJournal

Field Detail

ACTIVEMQ_DATA

public static final String ACTIVEMQ_DATA

See Also:

Constant Field Values

journalFF

protected SequentialFileFactory journalFF

bindingsFF

protected SequentialFileFactory bindingsFF

largeMessagesFactory

protected SequentialFileFactory largeMessagesFactory

originalMessageJournal

protected Journal originalMessageJournal

originalBindingsJournal

protected Journal originalBindingsJournal

largeMessagesDirectory

protected String largeMessagesDirectory

replicator

protected ReplicationManager replicator

Constructor Detail

JournalStorageManager

public JournalStorageManager(Configuration config,
                             CriticalAnalyzer analyzer,
                             ExecutorFactory executorFactory,
                             ScheduledExecutorService scheduledExecutorService,
                             ExecutorFactory ioExecutors)

JournalStorageManager

public JournalStorageManager(Configuration config,
                             CriticalAnalyzer analyzer,
                             ExecutorFactory executorFactory,
                             ExecutorFactory ioExecutors)

JournalStorageManager

public JournalStorageManager(Configuration config,
                             CriticalAnalyzer analyzer,
                             ExecutorFactory executorFactory,
                             ScheduledExecutorService scheduledExecutorService,
                             ExecutorFactory ioExecutors,
                             IOCriticalErrorListener criticalErrorListener)

JournalStorageManager

public JournalStorageManager(Configuration config,
                             CriticalAnalyzer analyzer,
                             ExecutorFactory executorFactory,
                             ExecutorFactory ioExecutors,
                             IOCriticalErrorListener criticalErrorListener)

Method Detail

getJournalSequentialFileFactory

public SequentialFileFactory getJournalSequentialFileFactory()

init

protected void init(Configuration config,
                    IOCriticalErrorListener criticalErrorListener)

Description copied from class: AbstractJournalStorageManager

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

Specified by:

init in class AbstractJournalStorageManager

fixJournalFileSize

protected int fixJournalFileSize(int fileSize,
                                 int alignment)

We need to correct the file size if its not a multiple of the alignement

Parameters:

fileSize - : the configured file size.

alignment - : the alignment.

Returns:

the fixed file size.

createMessageJournal

protected Journal createMessageJournal(Configuration config,
                                       IOCriticalErrorListener criticalErrorListener,
                                       int fileSize)

beforeStart

protected void beforeStart()
                    throws Exception

Specified by:

beforeStart in class AbstractJournalStorageManager

Throws:

Exception

beforeStop

protected void beforeStop()
                   throws Exception

Specified by:

beforeStop in class AbstractJournalStorageManager

Throws:

Exception

stop

public void stop()
          throws Exception

Specified by:

stop in interface ActiveMQComponent

Overrides:

stop in class AbstractJournalStorageManager

Throws:

Exception

isReplicated

public boolean isReplicated()

stop

public void stop(boolean ioCriticalError,
                 boolean sendFailover)
          throws Exception

Specified by:

stop in interface StorageManager

Overrides:

stop in class AbstractJournalStorageManager

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

performCachedLargeMessageDeletes

protected void performCachedLargeMessageDeletes()

Assumption is that this is only called with a writeLock on the StorageManager.

Specified by:

performCachedLargeMessageDeletes in class AbstractJournalStorageManager

parseLargeMessage

protected LargeServerMessage parseLargeMessage(ActiveMQBuffer buff)
                                        throws Exception

Specified by:

parseLargeMessage in class AbstractJournalStorageManager

Throws:

Exception

pageClosed

public void pageClosed(SimpleString storeName,
                       long pageNumber)

pageDeleted

public void pageDeleted(SimpleString storeName,
                        long pageNumber)

pageWrite

public void pageWrite(PagedMessage message,
                      long pageNumber)

allocateDirectBuffer

public ByteBuffer allocateDirectBuffer(int size)

Description copied from interface: StorageManager

AIO has an optimized buffer which has a method to release it instead of the way NIO will release data based on GC. These methods will use that buffer if the inner method supports it

freeDirectBuffer

public void freeDirectBuffer(ByteBuffer buffer)

Description copied from interface: StorageManager

AIO has an optimized buffer which has a method to release it instead of the way NIO will release data based on GC. These methods will use that buffer if the inner method supports it

largeMessageClosed

public void largeMessageClosed(LargeServerMessage largeServerMessage)
                        throws ActiveMQException

Throws:

ActiveMQException

deleteLargeMessageBody

public void deleteLargeMessageBody(LargeServerMessage largeServerMessage)
                            throws ActiveMQException

Throws:

ActiveMQException

createLargeMessage

public LargeServerMessage createLargeMessage()

createLargeMessage

public LargeServerMessage createLargeMessage(long id,
                                             Message message)
                                      throws Exception

Description copied from interface: StorageManager

Creates a new LargeMessage with the given id.

message - This is a temporary message that holds the parsed properties. The remoting layer can't create a ServerMessage directly, then this will be replaced.

Returns:

a large message object

Throws:

Exception

largeMessageCreated

public LargeServerMessage largeMessageCreated(long id,
                                              LargeServerMessage largeMessage)
                                       throws Exception

Throws:

Exception

createFileForLargeMessage

public SequentialFile createFileForLargeMessage(long messageID,
                                                StorageManager.LargeMessageExtension extension)

Description copied from interface: StorageManager

Instantiates a SequentialFile to be used for storing a LargeServerMessage.

Parameters:

messageID - the id of the message

extension - the extension to add to the file

Returns:

startReplication

public void startReplication(ReplicationManager replicationManager,
                             PagingManager pagingManager,
                             String nodeID,
                             boolean autoFailBack,
                             long initialReplicationSyncTimeout)
                      throws Exception

Throws:

Exception

See Also:

startReplication(org.apache.activemq.artemis.core.replication.ReplicationManager, org.apache.activemq.artemis.core.paging.PagingManager, String, boolean, long)

recoverLargeMessagesOnFolder

public void recoverLargeMessagesOnFolder(Set<Long> storedLargeMessages)
                                  throws Exception

Throws:

Exception

stopReplication

public void stopReplication()

Stops replication by resetting replication-related fields to their 'unreplicated' state.

addBytesToLargeMessage

public final void addBytesToLargeMessage(SequentialFile file,
                                         long messageId,
                                         ActiveMQBuffer bytes)
                                  throws Exception

Throws:

Exception

addBytesToLargeMessage

public final void addBytesToLargeMessage(SequentialFile file,
                                         long messageId,
                                         byte[] bytes)
                                  throws Exception

Throws:

Exception

injectMonitor

public void injectMonitor(FileStoreMonitor monitor)
                   throws Exception

Throws:

Exception