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

Interface Journal

  • All Superinterfaces:
    ActiveMQComponent
    All Known Subinterfaces:
    TestableJournal
    All Known Implementing Classes:
    FileWrapperJournal, JournalImpl
    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.

    • Method Detail

      • setRemoveExtraFilesOnLoad

        void setRemoveExtraFilesOnLoad​(boolean removeExtraFilesOnLoad)

      • isRemoveExtraFilesOnLoad

        boolean isRemoveExtraFilesOnLoad()

      • isHistory

        default boolean isHistory()

      • appendAddRecord

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

      • appendAddEvent

        void appendAddEvent​(long id,
                    byte recordType,
                    Persister persister,
                    Object record,
                    boolean sync,
                    IOCompletion completionCallback)
             throws Exception
        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.
        Throws:
        Exception

      • replaceableRecord

        default void replaceableRecord​(byte recordType)

      • appendUpdateRecord

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

      • tryAppendUpdateRecord

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

      • appendDeleteRecord

        void appendDeleteRecord​(long id,
                        boolean sync)
                 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)
                              throws Exception
        Throws:
        Exception

      • appendCommitRecord

        void appendCommitRecord​(long txID,
                        boolean sync)
                 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,
                         byte[] transactionData,
                         boolean sync)
                  throws Exception
        Throws:
        Exception

      • appendRollbackRecord

        void appendRollbackRecord​(long txID,
                          boolean sync)
                   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

      • lineUpContext

        void lineUpContext​(IOCompletion callback)

      • getNumberOfRecords

        int getNumberOfRecords()

      • getUserVersion

        int getUserVersion()

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

      • processBackup

        default void processBackup()
        It will rename temporary files and place them on the copy folder, by resotring the original file name.

      • processBackupCleanup

        default void processBackupCleanup()
        It will check max files and max days on files and remove extra files.

      • 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: