org.apache.activemq.artemis.core.journal

Interface Journal

All Superinterfaces:

ActiveMQComponent

All Known Subinterfaces:

TestableJournal

All Known Implementing Classes:

FileWrapperJournal, JDBCJournalImpl, JournalImpl, ReplicatedJournal

public interface Journal
extends ActiveMQComponent

Most methods on the journal provide a blocking version where you select the sync mode and a non blocking mode where you pass a completion callback as a parameter.

Notice also that even on the callback methods it's possible to pass the sync mode. That will only make sense on the NIO operations.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Journal.JournalState

Method Summary

Modifier and Type	Method and Description
void	appendAddRecord(long id, byte recordType, byte[] record, boolean sync)
default void	appendAddRecord(long id, byte recordType, EncodingSupport record, boolean sync)
default void	appendAddRecord(long id, byte recordType, EncodingSupport record, boolean sync, IOCompletion completionCallback)
void	appendAddRecord(long id, byte recordType, Persister persister, Object record, boolean sync)
void	appendAddRecord(long id, byte recordType, Persister persister, Object record, boolean sync, IOCompletion completionCallback)
void	appendAddRecordTransactional(long txID, long id, byte recordType, byte[] record)
default void	appendAddRecordTransactional(long txID, long id, byte recordType, EncodingSupport record)
void	appendAddRecordTransactional(long txID, long id, byte recordType, Persister persister, Object record)
void	appendCommitRecord(long txID, boolean sync)
void	appendCommitRecord(long txID, boolean sync, IOCompletion callback)
void	appendCommitRecord(long txID, boolean sync, IOCompletion callback, boolean lineUpContext)
void	appendDeleteRecord(long id, boolean sync)
void	appendDeleteRecord(long id, boolean sync, IOCompletion completionCallback)
void	appendDeleteRecordTransactional(long txID, long id)
void	appendDeleteRecordTransactional(long txID, long id, byte[] record)
void	appendDeleteRecordTransactional(long txID, long id, EncodingSupport record)
void	appendPrepareRecord(long txID, byte[] transactionData, boolean sync)
void	appendPrepareRecord(long txID, EncodingSupport transactionData, boolean sync) If the system crashed after a prepare was called, it should store information that is required to bring the transaction back to a state it could be committed.
void	appendPrepareRecord(long txID, EncodingSupport transactionData, boolean sync, IOCompletion callback)
void	appendRollbackRecord(long txID, boolean sync)
void	appendRollbackRecord(long txID, boolean sync, IOCompletion callback)
void	appendUpdateRecord(long id, byte recordType, byte[] record, boolean sync)
default void	appendUpdateRecord(long id, byte recordType, EncodingSupport record, boolean sync)
default void	appendUpdateRecord(long id, byte recordType, EncodingSupport record, boolean sync, IOCompletion completionCallback)
void	appendUpdateRecord(long id, byte recordType, Persister persister, Object record, boolean sync)
void	appendUpdateRecord(long id, byte recordType, Persister persister, Object record, boolean sync, IOCompletion callback)
void	appendUpdateRecordTransactional(long txID, long id, byte recordType, byte[] record)
default void	appendUpdateRecordTransactional(long txID, long id, byte recordType, EncodingSupport record)
void	appendUpdateRecordTransactional(long txID, long id, byte recordType, Persister persister, Object record)
Map<Long,JournalFile>	createFilesForBackupSync(long[] fileIds) Reserves journal file IDs, creates the necessary files for synchronization, and places references to these (reserved for sync) files in the map.
void	flush() It will make sure there are no more pending operations on the Executors.
void	forceMoveNextFile() Force the usage of a new JournalFile.
int	getAlignment()
JournalFile[]	getDataFiles() Returns the JournalFiles in use.
SequentialFileFactory	getFileFactory()
int	getFileSize()
long	getMaxRecordSize() The max size record that can be stored in the journal
int	getNumberOfRecords()
int	getUserVersion()
boolean	isRemoveExtraFilesOnLoad()
void	lineUpContext(IOCompletion callback)
default JournalLoadInformation	load(List<RecordInfo> committedRecords, List<PreparedTransactionInfo> preparedTransactions, TransactionFailureCallback transactionFailure)
JournalLoadInformation	load(List<RecordInfo> committedRecords, List<PreparedTransactionInfo> preparedTransactions, TransactionFailureCallback transactionFailure, boolean fixBadTx)
JournalLoadInformation	load(LoaderCallback reloadManager)
default JournalLoadInformation	load(SparseArrayLinkedList<RecordInfo> committedRecords, List<PreparedTransactionInfo> preparedTransactions, TransactionFailureCallback transactionFailure)
JournalLoadInformation	load(SparseArrayLinkedList<RecordInfo> committedRecords, List<PreparedTransactionInfo> preparedTransactions, TransactionFailureCallback transactionFailure, boolean fixBadTx)
JournalLoadInformation	loadInternalOnly() Load internal data structures and not expose any data.
JournalLoadInformation	loadSyncOnly(Journal.JournalState state) Load internal data structures, and remain waiting for synchronization to complete.
default void	replaceableRecord(byte recordType)
void	replicationSyncFinished() Restarts file reclaim and compacting on the journal.
void	replicationSyncPreserveOldFiles() Stops any operation that may delete or modify old (stale) data.
void	runDirectJournalBlast()
void	scheduleCompactAndBlock(int timeout) This method will start compact using the compactorExecutor and block up to timeout seconds
void	setRemoveExtraFilesOnLoad(boolean removeExtraFilesOnLoad)
void	synchronizationLock() Write lock the Journal and write lock the compacting process.
void	synchronizationUnlock() Unlock the Journal and the compacting process.
boolean	tryAppendDeleteRecord(long id, boolean sync)
boolean	tryAppendDeleteRecord(long id, boolean sync, IOCompletion completionCallback)
boolean	tryAppendUpdateRecord(long id, byte recordType, byte[] record, boolean sync)
default boolean	tryAppendUpdateRecord(long id, byte recordType, EncodingSupport record, boolean sync)
default boolean	tryAppendUpdateRecord(long id, byte recordType, EncodingSupport record, boolean sync, IOCompletion completionCallback)
boolean	tryAppendUpdateRecord(long id, byte recordType, Persister persister, Object record, boolean sync)
boolean	tryAppendUpdateRecord(long id, byte recordType, Persister persister, Object record, boolean sync, IOCompletion callback)

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

asyncStop, isStarted, start, stop

Method Detail

setRemoveExtraFilesOnLoad

void setRemoveExtraFilesOnLoad(boolean removeExtraFilesOnLoad)

isRemoveExtraFilesOnLoad

boolean isRemoveExtraFilesOnLoad()

appendAddRecord

void appendAddRecord(long id,
                     byte recordType,
                     byte[] record,
                     boolean sync)
              throws Exception

Throws:

Exception

appendAddRecord

default void appendAddRecord(long id,
                             byte recordType,
                             EncodingSupport record,
                             boolean sync)
                      throws Exception

Throws:

Exception

appendAddRecord

void appendAddRecord(long id,
                     byte recordType,
                     Persister persister,
                     Object record,
                     boolean sync)
              throws Exception

Throws:

Exception

appendAddRecord

void appendAddRecord(long id,
                     byte recordType,
                     Persister persister,
                     Object record,
                     boolean sync,
                     IOCompletion completionCallback)
              throws Exception

Throws:

Exception

appendAddRecord

default void appendAddRecord(long id,
                             byte recordType,
                             EncodingSupport record,
                             boolean sync,
                             IOCompletion completionCallback)
                      throws Exception

Throws:

Exception

replaceableRecord

default void replaceableRecord(byte recordType)

appendUpdateRecord

void appendUpdateRecord(long id,
                        byte recordType,
                        byte[] record,
                        boolean sync)
                 throws Exception

Throws:

Exception

tryAppendUpdateRecord

boolean tryAppendUpdateRecord(long id,
                              byte recordType,
                              byte[] record,
                              boolean sync)
                       throws Exception

Throws:

Exception

appendUpdateRecord

default void appendUpdateRecord(long id,
                                byte recordType,
                                EncodingSupport record,
                                boolean sync)
                         throws Exception

Throws:

Exception

tryAppendUpdateRecord

default boolean tryAppendUpdateRecord(long id,
                                      byte recordType,
                                      EncodingSupport record,
                                      boolean sync)
                               throws Exception

Throws:

Exception

appendUpdateRecord

void appendUpdateRecord(long id,
                        byte recordType,
                        Persister persister,
                        Object record,
                        boolean sync)
                 throws Exception

Throws:

Exception

tryAppendUpdateRecord

boolean tryAppendUpdateRecord(long id,
                              byte recordType,
                              Persister persister,
                              Object record,
                              boolean sync)
                       throws Exception

Throws:

Exception

appendUpdateRecord

default void appendUpdateRecord(long id,
                                byte recordType,
                                EncodingSupport record,
                                boolean sync,
                                IOCompletion completionCallback)
                         throws Exception

Throws:

Exception

tryAppendUpdateRecord

default boolean tryAppendUpdateRecord(long id,
                                      byte recordType,
                                      EncodingSupport record,
                                      boolean sync,
                                      IOCompletion completionCallback)
                               throws Exception

Throws:

Exception

appendUpdateRecord

void appendUpdateRecord(long id,
                        byte recordType,
                        Persister persister,
                        Object record,
                        boolean sync,
                        IOCompletion callback)
                 throws Exception

Throws:

Exception

tryAppendUpdateRecord

boolean tryAppendUpdateRecord(long id,
                              byte recordType,
                              Persister persister,
                              Object record,
                              boolean sync,
                              IOCompletion callback)
                       throws Exception

Throws:

Exception

appendDeleteRecord

void appendDeleteRecord(long id,
                        boolean sync)
                 throws Exception

Throws:

Exception

tryAppendDeleteRecord

boolean tryAppendDeleteRecord(long id,
                              boolean sync)
                       throws Exception

Throws:

Exception

appendDeleteRecord

void appendDeleteRecord(long id,
                        boolean sync,
                        IOCompletion completionCallback)
                 throws Exception

Throws:

Exception

tryAppendDeleteRecord

boolean tryAppendDeleteRecord(long id,
                              boolean sync,
                              IOCompletion completionCallback)
                       throws Exception

Throws:

Exception

appendAddRecordTransactional

void appendAddRecordTransactional(long txID,
                                  long id,
                                  byte recordType,
                                  byte[] record)
                           throws Exception

Throws:

Exception

appendAddRecordTransactional

default void appendAddRecordTransactional(long txID,
                                          long id,
                                          byte recordType,
                                          EncodingSupport record)
                                   throws Exception

Throws:

Exception

appendAddRecordTransactional

void appendAddRecordTransactional(long txID,
                                  long id,
                                  byte recordType,
                                  Persister persister,
                                  Object record)
                           throws Exception

Throws:

Exception

appendUpdateRecordTransactional

void appendUpdateRecordTransactional(long txID,
                                     long id,
                                     byte recordType,
                                     byte[] record)
                              throws Exception

Throws:

Exception

appendUpdateRecordTransactional

default void appendUpdateRecordTransactional(long txID,
                                             long id,
                                             byte recordType,
                                             EncodingSupport record)
                                      throws Exception

Throws:

Exception

appendUpdateRecordTransactional

void appendUpdateRecordTransactional(long txID,
                                     long id,
                                     byte recordType,
                                     Persister persister,
                                     Object record)
                              throws Exception

Throws:

Exception

appendDeleteRecordTransactional

void appendDeleteRecordTransactional(long txID,
                                     long id,
                                     byte[] record)
                              throws Exception

Throws:

Exception

appendDeleteRecordTransactional

void appendDeleteRecordTransactional(long txID,
                                     long id,
                                     EncodingSupport record)
                              throws Exception

Throws:

Exception

appendDeleteRecordTransactional

void appendDeleteRecordTransactional(long txID,
                                     long id)
                              throws Exception

Throws:

Exception

appendCommitRecord

void appendCommitRecord(long txID,
                        boolean sync)
                 throws Exception

Throws:

Exception

appendCommitRecord

void appendCommitRecord(long txID,
                        boolean sync,
                        IOCompletion callback)
                 throws Exception

Throws:

Exception

appendCommitRecord

void appendCommitRecord(long txID,
                        boolean sync,
                        IOCompletion callback,
                        boolean lineUpContext)
                 throws Exception

Parameters:

txID -

sync -

callback -

lineUpContext - if appendCommitRecord should call a storeLineUp. This is because the caller may have already taken into account

Throws:

Exception

appendPrepareRecord

void appendPrepareRecord(long txID,
                         EncodingSupport transactionData,
                         boolean sync)
                  throws Exception

If the system crashed after a prepare was called, it should store information that is required to bring the transaction back to a state it could be committed.

transactionData allows you to store any other supporting user-data related to the transaction

Parameters:

txID -

transactionData - - extra user data for the prepare

Throws:

Exception

appendPrepareRecord

void appendPrepareRecord(long txID,
                         EncodingSupport transactionData,
                         boolean sync,
                         IOCompletion callback)
                  throws Exception

Throws:

Exception

appendPrepareRecord

void appendPrepareRecord(long txID,
                         byte[] transactionData,
                         boolean sync)
                  throws Exception

Throws:

Exception

appendRollbackRecord

void appendRollbackRecord(long txID,
                          boolean sync)
                   throws Exception

Throws:

Exception

appendRollbackRecord

void appendRollbackRecord(long txID,
                          boolean sync,
                          IOCompletion callback)
                   throws Exception

Throws:

Exception

load

JournalLoadInformation load(LoaderCallback reloadManager)
                     throws Exception

Throws:

Exception

loadInternalOnly

JournalLoadInformation loadInternalOnly()
                                 throws Exception

Load internal data structures and not expose any data. This is only useful if you're using the journal but not interested on the current data. Useful in situations where the journal is being replicated, copied... etc.

Throws:

Exception

loadSyncOnly

JournalLoadInformation loadSyncOnly(Journal.JournalState state)
                             throws Exception

Load internal data structures, and remain waiting for synchronization to complete.

Parameters:

state - the current state of the journal, this parameter ensures consistency.

Throws:

Exception

lineUpContext

void lineUpContext(IOCompletion callback)

load

default JournalLoadInformation load(List<RecordInfo> committedRecords,
                                    List<PreparedTransactionInfo> preparedTransactions,
                                    TransactionFailureCallback transactionFailure)
                             throws Exception

Throws:

Exception

load

JournalLoadInformation load(List<RecordInfo> committedRecords,
                            List<PreparedTransactionInfo> preparedTransactions,
                            TransactionFailureCallback transactionFailure,
                            boolean fixBadTx)
                     throws Exception

Throws:

Exception

load

default JournalLoadInformation load(SparseArrayLinkedList<RecordInfo> committedRecords,
                                    List<PreparedTransactionInfo> preparedTransactions,
                                    TransactionFailureCallback transactionFailure)
                             throws Exception

Throws:

Exception

load

JournalLoadInformation load(SparseArrayLinkedList<RecordInfo> committedRecords,
                            List<PreparedTransactionInfo> preparedTransactions,
                            TransactionFailureCallback transactionFailure,
                            boolean fixBadTx)
                     throws Exception

Throws:

Exception

getAlignment

int getAlignment()
          throws Exception

Throws:

Exception

getNumberOfRecords

int getNumberOfRecords()

getUserVersion

int getUserVersion()

runDirectJournalBlast

void runDirectJournalBlast()
                    throws Exception

Throws:

Exception

createFilesForBackupSync

Map<Long,JournalFile> createFilesForBackupSync(long[] fileIds)
                                        throws Exception

Reserves journal file IDs, creates the necessary files for synchronization, and places references to these (reserved for sync) files in the map.

During the synchronization between a live server and backup, we reserve in the backup the journal file IDs used in the live server. This call also makes sure the files are created empty without any kind of headers added.

Parameters:

fileIds - IDs to reserve for synchronization

Returns:

map to be filled with id and journal file pairs for synchronization.

Throws:

Exception

synchronizationLock

void synchronizationLock()

Write lock the Journal and write lock the compacting process. Necessary only during replication for backup synchronization.

synchronizationUnlock

void synchronizationUnlock()

Unlock the Journal and the compacting process.

See Also:

synchronizationLock()

forceMoveNextFile

void forceMoveNextFile()
                throws Exception

Force the usage of a new JournalFile.

Throws:

Exception

getDataFiles

JournalFile[] getDataFiles()

Returns the JournalFiles in use.

Returns:

array with all JournalFiles in use

getFileFactory

SequentialFileFactory getFileFactory()

getFileSize

int getFileSize()

scheduleCompactAndBlock

void scheduleCompactAndBlock(int timeout)
                      throws Exception

This method will start compact using the compactorExecutor and block up to timeout seconds

Parameters:

timeout - the timeout in seconds or block forever if <= 0

Throws:

Exception

replicationSyncPreserveOldFiles

void replicationSyncPreserveOldFiles()

Stops any operation that may delete or modify old (stale) data.

Meant to be used during synchronization of data between a live server and its replicating (remote) backup. Old files must not be compacted or deleted during synchronization.

replicationSyncFinished

void replicationSyncFinished()

Restarts file reclaim and compacting on the journal.

Meant to be used to revert the effect of replicationSyncPreserveOldFiles(). it should only be called once the synchronization of the backup and live servers is completed.

flush

void flush()
    throws Exception

It will make sure there are no more pending operations on the Executors.

Throws:

Exception

getMaxRecordSize

long getMaxRecordSize()

The max size record that can be stored in the journal

Returns: