Package org.apache.activemq.artemis.jdbc.store.journal

Class JDBCJournalImpl

java.lang.Object

org.apache.activemq.artemis.jdbc.store.drivers.AbstractJDBCDriver

org.apache.activemq.artemis.jdbc.store.journal.JDBCJournalImpl

All Implemented Interfaces:

Journal, ActiveMQComponent

public class JDBCJournalImpl
extends AbstractJDBCDriver
implements Journal

Nested Class Summary

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

Journal.JournalState

Field Summary

Fields inherited from class org.apache.activemq.artemis.jdbc.store.drivers.AbstractJDBCDriver

connectionProvider, sqlProvider

Constructor Summary

Constructors

Constructor	Description
JDBCJournalImpl(JDBCConnectionProvider connectionProvider, SQLProvider provider, ScheduledExecutorService scheduledExecutorService, Executor completeExecutor, IOCriticalErrorListener criticalIOErrorListener, long syncDelay)

Method Summary

Modifier and Type	Method	Description
void	appendAddEvent(long id, byte recordType, Persister persister, Object record, boolean sync, IOCompletion completionCallback)	An event is data recorded on the journal, but it won't have any weight or deletes.
void	appendAddRecord(long id, byte recordType, byte[] record, boolean sync)
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)
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)
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 completionCallback)
void	appendUpdateRecordTransactional(long txID, long id, byte recordType, byte[] 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.
protected void	createSchema()
void	destroy()
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()
void	handleException(List<org.apache.activemq.artemis.jdbc.store.journal.JDBCJournalRecord> recordRef, Throwable e)	public for tests only, not through API
boolean	isRemoveExtraFilesOnLoad()
boolean	isStarted()
void	lineUpContext(IOCompletion callback)
JournalLoadInformation	load(List<RecordInfo> committedRecords, List<PreparedTransactionInfo> preparedTransactions, TransactionFailureCallback failureCallback, boolean fixBadTX)
JournalLoadInformation	load(LoaderCallback reloadManager)
JournalLoadInformation	load(SparseArrayLinkedList<RecordInfo> committedRecords, List<PreparedTransactionInfo> preparedTransactions, TransactionFailureCallback failureCallback, 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.
protected void	prepareStatements()
void	replicationSyncFinished()	Restarts file reclaim and compacting on the journal.
void	replicationSyncPreserveOldFiles()	Stops any operation that may delete or modify old (stale) data.
void	scheduleCompactAndBlock(int timeout)	This method will start compact using the compactorExecutor and block up to timeout seconds
void	setRemoveExtraFilesOnLoad(boolean removeExtraFilesOnLoad)
void	start()
void	stop()
void	stop(boolean sync)
int	sync()
void	synchronizationLock()	Write lock the Journal and write lock the compacting process.
void	synchronizationUnlock()	Unlock the Journal and the compacting process.
void	tryAppendDeleteRecord(long id, boolean sync, JournalUpdateCallback updateCallback, IOCompletion completionCallback)
void	tryAppendDeleteRecord(long id, JournalUpdateCallback updateCallback, boolean sync)
void	tryAppendUpdateRecord(long id, byte recordType, byte[] record, JournalUpdateCallback updateCallback, boolean sync, boolean replaceableRecord)
void	tryAppendUpdateRecord(long id, byte recordType, Persister persister, Object record, boolean sync, boolean replaceableUpdate, JournalUpdateCallback updateCallback, IOCompletion completionCallback)
void	tryAppendUpdateRecord(long id, byte recordType, Persister persister, Object record, JournalUpdateCallback updateCallback, boolean sync, boolean replaceableUpdate)

Methods inherited from class org.apache.activemq.artemis.jdbc.store.drivers.AbstractJDBCDriver

createTable, getJdbcConnectionProvider, setJdbcConnectionProvider, setSqlProvider

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.journal.Journal

appendAddRecord, appendAddRecord, appendAddRecordTransactional, appendUpdateRecord, appendUpdateRecord, appendUpdateRecordTransactional, forceBackup, getCriticalErrorListener, isHistory, load, load, processBackup, processBackupCleanup, replaceableRecord, setCriticalErrorListener, setHistoryFolder, tryAppendUpdateRecord, tryAppendUpdateRecord

Constructor Detail

JDBCJournalImpl

public JDBCJournalImpl(JDBCConnectionProvider connectionProvider,
                       SQLProvider provider,
                       ScheduledExecutorService scheduledExecutorService,
                       Executor completeExecutor,
                       IOCriticalErrorListener criticalIOErrorListener,
                       long syncDelay)

Method Detail

setRemoveExtraFilesOnLoad

public void setRemoveExtraFilesOnLoad(boolean removeExtraFilesOnLoad)

Specified by:

setRemoveExtraFilesOnLoad in interface Journal

isRemoveExtraFilesOnLoad

public boolean isRemoveExtraFilesOnLoad()

Specified by:

isRemoveExtraFilesOnLoad in interface Journal

appendAddEvent

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

Description copied from interface: Journal

An event is data recorded on the journal, but it won't have any weight or deletes. It's always ready to be removed. It is useful on recovery data while in use with backup history journal.

Specified by:

appendAddEvent in interface Journal

Throws:

Exception

start

public void start()
           throws SQLException

Specified by:

start in interface ActiveMQComponent

Overrides:

start in class AbstractJDBCDriver

Throws:

SQLException

flush

public void flush()
           throws Exception

Description copied from interface: Journal

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

Specified by:

flush in interface Journal

Throws:

Exception

getMaxRecordSize

public long getMaxRecordSize()

The max size record that can be stored in the journal

Specified by:

getMaxRecordSize in interface Journal

Returns:

createSchema

protected void createSchema()
                     throws SQLException

Specified by:

createSchema in class AbstractJDBCDriver

Throws:

SQLException

prepareStatements

protected void prepareStatements()

Specified by:

prepareStatements in class AbstractJDBCDriver

stop

public void stop()
          throws SQLException

Specified by:

stop in interface ActiveMQComponent

Overrides:

stop in class AbstractJDBCDriver

Throws:

SQLException

stop

public void stop(boolean sync)
          throws SQLException

Throws:

SQLException

destroy

public void destroy()
             throws Exception

Overrides:

destroy in class AbstractJDBCDriver

Throws:

Exception

sync

public int sync()

handleException

public void handleException(List<org.apache.activemq.artemis.jdbc.store.journal.JDBCJournalRecord> recordRef,
                            Throwable e)

public for tests only, not through API

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,
                            Persister persister,
                            Object record,
                            boolean sync)
                     throws Exception

Specified by:

appendAddRecord in interface Journal

Throws:

Exception

appendAddRecord

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

Specified by:

appendAddRecord 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

tryAppendUpdateRecord

public void tryAppendUpdateRecord(long id,
                                  byte recordType,
                                  byte[] record,
                                  JournalUpdateCallback updateCallback,
                                  boolean sync,
                                  boolean replaceableRecord)
                           throws Exception

Specified by:

tryAppendUpdateRecord in interface Journal

Throws:

Exception

appendUpdateRecord

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

Specified by:

appendUpdateRecord in interface Journal

Throws:

Exception

tryAppendUpdateRecord

public void tryAppendUpdateRecord(long id,
                                  byte recordType,
                                  Persister persister,
                                  Object record,
                                  JournalUpdateCallback updateCallback,
                                  boolean sync,
                                  boolean replaceableUpdate)
                           throws Exception

Specified by:

tryAppendUpdateRecord in interface Journal

Throws:

Exception

appendUpdateRecord

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

Specified by:

appendUpdateRecord in interface Journal

Throws:

Exception

tryAppendUpdateRecord

public void tryAppendUpdateRecord(long id,
                                  byte recordType,
                                  Persister persister,
                                  Object record,
                                  boolean sync,
                                  boolean replaceableUpdate,
                                  JournalUpdateCallback updateCallback,
                                  IOCompletion completionCallback)
                           throws Exception

Specified by:

tryAppendUpdateRecord in interface Journal

Throws:

Exception

appendDeleteRecord

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

Specified by:

appendDeleteRecord in interface Journal

Throws:

Exception

tryAppendDeleteRecord

public void tryAppendDeleteRecord(long id,
                                  JournalUpdateCallback updateCallback,
                                  boolean sync)
                           throws Exception

Specified by:

tryAppendDeleteRecord in interface Journal

Throws:

Exception

appendDeleteRecord

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

Specified by:

appendDeleteRecord in interface Journal

Throws:

Exception

tryAppendDeleteRecord

public void tryAppendDeleteRecord(long id,
                                  boolean sync,
                                  JournalUpdateCallback updateCallback,
                                  IOCompletion completionCallback)
                           throws Exception

Specified by:

tryAppendDeleteRecord 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

appendAddRecordTransactional

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

Specified by:

appendAddRecordTransactional 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

appendUpdateRecordTransactional

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

Specified by:

appendUpdateRecordTransactional in interface Journal

Throws:

Exception

appendDeleteRecordTransactional

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

Specified by:

appendDeleteRecordTransactional 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

appendDeleteRecordTransactional

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

Specified by:

appendDeleteRecordTransactional 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

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)
                         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

appendPrepareRecord

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

Specified by:

appendPrepareRecord 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

appendRollbackRecord

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

Specified by:

appendRollbackRecord in interface Journal

Throws:

Exception

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)

Specified by:

load in interface Journal

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.

Specified by:

loadInternalOnly in interface Journal

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.

Specified by:

loadSyncOnly in interface Journal

Parameters:

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

Throws:

Exception

lineUpContext

public void lineUpContext(IOCompletion callback)

Specified by:

lineUpContext in interface Journal

load

public JournalLoadInformation load(SparseArrayLinkedList<RecordInfo> committedRecords,
                                   List<PreparedTransactionInfo> preparedTransactions,
                                   TransactionFailureCallback failureCallback,
                                   boolean fixBadTX)
                            throws Exception

Specified by:

load in interface Journal

Throws:

Exception

load

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

Specified by:

load in interface Journal

Throws:

Exception

getAlignment

public int getAlignment()
                 throws Exception

Specified by:

getAlignment in interface Journal

Throws:

Exception

getNumberOfRecords

public int getNumberOfRecords()

Specified by:

getNumberOfRecords in interface Journal

getUserVersion

public int getUserVersion()

Specified by:

getUserVersion in interface Journal

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.

Specified by:

createFilesForBackupSync in interface Journal

Parameters:

fileIds - IDs to reserve for synchronization

Returns:

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

Throws:

Exception

synchronizationLock

public final void synchronizationLock()

Description copied from interface: Journal

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

Specified by:

synchronizationLock in interface Journal

synchronizationUnlock

public final void synchronizationUnlock()

Description copied from interface: Journal

Unlock the Journal and the compacting process.

Specified by:

synchronizationUnlock in interface Journal

See Also:

Journal.synchronizationLock()

forceMoveNextFile

public void forceMoveNextFile()
                       throws Exception

Description copied from interface: Journal

Force the usage of a new JournalFile.

Specified by:

forceMoveNextFile in interface Journal

Throws:

Exception

getDataFiles

public JournalFile[] getDataFiles()

Description copied from interface: Journal

Returns the JournalFiles in use.

Specified by:

getDataFiles in interface Journal

Returns:

array with all JournalFiles in use

getFileFactory

public SequentialFileFactory getFileFactory()

Specified by:

getFileFactory in interface Journal

getFileSize

public int getFileSize()

Specified by:

getFileSize in interface Journal

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

Specified by:

scheduleCompactAndBlock in interface Journal

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.

Specified by:

replicationSyncPreserveOldFiles in interface Journal

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.

Specified by:

replicationSyncFinished in interface Journal

isStarted

public boolean isStarted()

Specified by:

isStarted in interface ActiveMQComponent