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

Class FileWrapperJournal

java.lang.Object

org.apache.activemq.artemis.core.journal.impl.FileWrapperJournal

All Implemented Interfaces:

Journal, ActiveMQComponent

public final class FileWrapperJournal
extends Object

Journal used at a replicating backup server during the synchronization of data with the 'live' server. It just wraps a single JournalFile. Its main purpose is to store the data as a Journal would, but without verifying records.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.activemq.artemis.core.journal.Journal

Journal.JournalState

Field Summary

Fields

Modifier and Type	Field and Description
protected JournalFile	currentFile
protected int	fileSize

Constructor Summary

Constructors

Constructor and Description
FileWrapperJournal(Journal journal)

Method Summary

Modifier and Type	Method and Description
void	appendAddRecord(long id, byte recordType, byte[] record, boolean sync)
void	appendAddRecord(long id, byte recordType, EncodingSupport record, boolean sync)
void	appendAddRecord(long id, byte recordType, EncodingSupport record, boolean sync, IOCompletion callback)
void	appendAddRecordTransactional(long txID, long id, byte recordType, byte[] record)
void	appendAddRecordTransactional(long txID, long id, byte recordType, EncodingSupport 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 callback)
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)
void	appendUpdateRecord(long id, byte recordType, EncodingSupport record, boolean sync)
void	appendUpdateRecord(long id, byte recordType, EncodingSupport record, boolean sync, IOCompletion callback)
void	appendUpdateRecordTransactional(long txID, long id, byte recordType, byte[] record)
void	appendUpdateRecordTransactional(long txID, long id, byte recordType, EncodingSupport 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()
int	getNumberOfRecords()
protected SyncIOCompletion	getSyncCallback(boolean sync)
int	getUserVersion()
boolean	isStarted()
void	lineUpContext(IOCompletion callback)
JournalLoadInformation	load(List<RecordInfo> committedRecords, List<PreparedTransactionInfo> preparedTransactions, TransactionFailureCallback transactionFailure)
JournalLoadInformation	load(LoaderCallback reloadManager)
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.
void	perfBlast(int pages)
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	start()
void	stop()
void	synchronizationLock() Write lock the Journal and write lock the compacting process.
void	synchronizationUnlock() Unlock the Journal and the compacting process.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

currentFile

protected volatile JournalFile currentFile

fileSize

protected final int fileSize

Constructor Detail

FileWrapperJournal

public FileWrapperJournal(Journal journal)
                   throws Exception

Parameters:

journal -

Throws:

Exception

Method Detail

start

public void start()
           throws Exception

Throws:

Exception

stop

public void stop()
          throws Exception

Throws:

Exception

isStarted

public boolean isStarted()

appendAddRecord

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

Specified by:

appendAddRecord in interface Journal

Throws:

Exception

flush

public void flush()
           throws Exception

Description copied from interface: Journal

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

Throws:

Exception

appendDeleteRecord

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

Specified by:

appendDeleteRecord in interface Journal

Throws:

Exception

appendDeleteRecordTransactional

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

Specified by:

appendDeleteRecordTransactional in interface Journal

Throws:

Exception

appendAddRecordTransactional

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

Specified by:

appendAddRecordTransactional in interface Journal

Throws:

Exception

appendUpdateRecord

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

Specified by:

appendUpdateRecord in interface Journal

Throws:

Exception

appendUpdateRecordTransactional

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

Specified by:

appendUpdateRecordTransactional in interface Journal

Throws:

Exception

appendCommitRecord

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

Specified by:

appendCommitRecord in interface Journal

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

Throws:

Exception

appendPrepareRecord

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

Specified by:

appendPrepareRecord in interface Journal

Throws:

Exception

toString

public String toString()

Overrides:

toString in class Object

appendRollbackRecord

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

Specified by:

appendRollbackRecord in interface Journal

Throws:

Exception

load

public JournalLoadInformation load(LoaderCallback reloadManager)
                            throws Exception

Throws:

Exception

loadInternalOnly

public JournalLoadInformation loadInternalOnly()
                                        throws Exception

Description copied from interface: Journal

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

lineUpContext

public void lineUpContext(IOCompletion callback)

load

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

Throws:

Exception

getAlignment

public int getAlignment()
                 throws Exception

Throws:

Exception

getNumberOfRecords

public int getNumberOfRecords()

getUserVersion

public int getUserVersion()

perfBlast

public void perfBlast(int pages)

runDirectJournalBlast

public void runDirectJournalBlast()
                           throws Exception

Throws:

Exception

loadSyncOnly

public JournalLoadInformation loadSyncOnly(Journal.JournalState state)
                                    throws Exception

Description copied from interface: Journal

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

createFilesForBackupSync

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

Description copied from interface: Journal

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

public void synchronizationLock()

Description copied from interface: Journal

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

synchronizationUnlock

public void synchronizationUnlock()

Description copied from interface: Journal

Unlock the Journal and the compacting process.

See Also:

Journal.synchronizationLock()

forceMoveNextFile

public void forceMoveNextFile()

Description copied from interface: Journal

Force the usage of a new JournalFile.

getDataFiles

public JournalFile[] getDataFiles()

Description copied from interface: Journal

Returns the JournalFiles in use.

Returns:

array with all JournalFiles in use

getFileFactory

public SequentialFileFactory getFileFactory()

scheduleCompactAndBlock

public void scheduleCompactAndBlock(int timeout)
                             throws Exception

Description copied from interface: Journal

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

public void replicationSyncPreserveOldFiles()

Description copied from interface: Journal

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

public void replicationSyncFinished()

Description copied from interface: Journal

Restarts file reclaim and compacting on the journal.

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

appendAddRecord

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

Specified by:

appendAddRecord in interface Journal

Throws:

Exception

appendAddRecord

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

Specified by:

appendAddRecord in interface Journal

Throws:

Exception

appendCommitRecord

public void appendCommitRecord(long txID,
                               boolean sync)
                        throws Exception

Specified by:

appendCommitRecord in interface Journal

Throws:

Exception

appendCommitRecord

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

Specified by:

appendCommitRecord in interface Journal

Throws:

Exception

appendUpdateRecord

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

Specified by:

appendUpdateRecord in interface Journal

Throws:

Exception

appendUpdateRecordTransactional

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

Specified by:

appendUpdateRecordTransactional in interface Journal

Throws:

Exception

appendAddRecordTransactional

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

Specified by:

appendAddRecordTransactional in interface Journal

Throws:

Exception

appendDeleteRecordTransactional

public void appendDeleteRecordTransactional(long txID,
                                            long id)
                                     throws Exception

Specified by:

appendDeleteRecordTransactional in interface Journal

Throws:

Exception

appendPrepareRecord

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

Specified by:

appendPrepareRecord in interface Journal

Throws:

Exception

appendPrepareRecord

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

Description copied from interface: Journal

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

Specified by:

appendPrepareRecord in interface Journal

transactionData - - extra user data for the prepare

Throws:

Exception

appendDeleteRecordTransactional

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

Specified by:

appendDeleteRecordTransactional in interface Journal

Throws:

Exception

appendUpdateRecord

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

Specified by:

appendUpdateRecord in interface Journal

Throws:

Exception

appendRollbackRecord

public void appendRollbackRecord(long txID,
                                 boolean sync)
                          throws Exception

Specified by:

appendRollbackRecord in interface Journal

Throws:

Exception

appendDeleteRecord

public void appendDeleteRecord(long id,
                               boolean sync)
                        throws Exception

Specified by:

appendDeleteRecord in interface Journal

Throws:

Exception

getSyncCallback

protected SyncIOCompletion getSyncCallback(boolean sync)

getFileSize

public int getFileSize()

Specified by:

getFileSize in interface Journal