org.apache.activemq.artemis.core.replication

Class ReplicationManager

java.lang.Object

org.apache.activemq.artemis.core.replication.ReplicationManager

All Implemented Interfaces:

org.apache.activemq.artemis.core.server.ActiveMQComponent, org.apache.activemq.artemis.spi.core.remoting.ReadyListener

public final class ReplicationManager
extends Object
implements org.apache.activemq.artemis.core.server.ActiveMQComponent, org.apache.activemq.artemis.spi.core.remoting.ReadyListener

Manages replication tasks on the live server (that is the live server side of a "remote backup" use case).

Its equivalent in the backup server is ReplicationEndpoint.

See Also:

ReplicationEndpoint

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ReplicationManager.ADD_OPERATION_TYPE

Constructor Summary

Constructors

Constructor and Description
ReplicationManager(org.apache.activemq.artemis.core.protocol.core.CoreRemotingConnection remotingConnection, long timeout, org.apache.activemq.artemis.utils.ExecutorFactory executorFactory)

Method Summary

Modifier and Type	Method and Description
void	appendAddRecordTransactional(byte journalID, ReplicationManager.ADD_OPERATION_TYPE operation, long txID, long id, byte recordType, org.apache.activemq.artemis.core.journal.EncodingSupport record)
void	appendCommitRecord(byte journalID, long txID, boolean sync, boolean lineUp)
void	appendDeleteRecord(byte journalID, long id)
void	appendDeleteRecordTransactional(byte journalID, long txID, long id)
void	appendDeleteRecordTransactional(byte journalID, long txID, long id, org.apache.activemq.artemis.core.journal.EncodingSupport record)
void	appendPrepareRecord(byte journalID, long txID, org.apache.activemq.artemis.core.journal.EncodingSupport transactionData)
void	appendRollbackRecord(byte journalID, long txID)
void	appendUpdateRecord(byte journalID, ReplicationManager.ADD_OPERATION_TYPE operation, long id, byte recordType, org.apache.activemq.artemis.core.journal.EncodingSupport record)
void	clearReplicationTokens() Completes any pending operations.
Set<OperationContext>	getActiveTokens() A list of tokens that are still waiting for replications to be completed
org.apache.activemq.artemis.core.protocol.core.CoreRemotingConnection	getBackupTransportConnection() Used while stopping the server to ensure that we freeze communications with the backup.
boolean	isStarted()
boolean	isSynchronizing()
void	largeMessageBegin(long messageId)
void	largeMessageDelete(Long messageId)
void	largeMessageWrite(long messageId, byte[] body)
void	pageClosed(org.apache.activemq.artemis.api.core.SimpleString storeName, int pageNumber)
void	pageDeleted(org.apache.activemq.artemis.api.core.SimpleString storeName, int pageNumber)
void	pageWrite(PagedMessage message, int pageNumber)
void	readyForWriting()
void	sendLargeMessageIdListMessage(Map<Long,org.apache.activemq.artemis.api.core.Pair<String,Long>> largeMessages) Reserves several LargeMessage IDs in the backup.
OperationContext	sendLiveIsStopping(ReplicationLiveIsStoppingMessage.LiveStopping finalMessage) Notifies the backup that the live server is stopping.
void	sendStartSyncMessage(org.apache.activemq.artemis.core.journal.impl.JournalFile[] datafiles, AbstractJournalStorageManager.JournalContent contentType, String nodeID, boolean allowsAutoFailBack) Reserve the following fileIDs in the backup server.
void	sendSynchronizationDone(String nodeID, long initialReplicationSyncTimeout) Informs backup that data synchronization is done.
void	start()
void	stop()
void	syncJournalFile(org.apache.activemq.artemis.core.journal.impl.JournalFile jf, AbstractJournalStorageManager.JournalContent content) Sends the whole content of the file to be duplicated.
void	syncLargeMessageFile(org.apache.activemq.artemis.core.io.SequentialFile file, long size, long id)
void	syncPages(org.apache.activemq.artemis.core.io.SequentialFile file, long id, org.apache.activemq.artemis.api.core.SimpleString queueName)

Methods inherited from class java.lang.Object

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

Constructor Detail

ReplicationManager

public ReplicationManager(org.apache.activemq.artemis.core.protocol.core.CoreRemotingConnection remotingConnection,
                          long timeout,
                          org.apache.activemq.artemis.utils.ExecutorFactory executorFactory)

Parameters:

remotingConnection -

Method Detail

appendUpdateRecord

public void appendUpdateRecord(byte journalID,
                               ReplicationManager.ADD_OPERATION_TYPE operation,
                               long id,
                               byte recordType,
                               org.apache.activemq.artemis.core.journal.EncodingSupport record)
                        throws Exception

Throws:

Exception

appendDeleteRecord

public void appendDeleteRecord(byte journalID,
                               long id)
                        throws Exception

Throws:

Exception

appendAddRecordTransactional

public void appendAddRecordTransactional(byte journalID,
                                         ReplicationManager.ADD_OPERATION_TYPE operation,
                                         long txID,
                                         long id,
                                         byte recordType,
                                         org.apache.activemq.artemis.core.journal.EncodingSupport record)
                                  throws Exception

Throws:

Exception

appendCommitRecord

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

Throws:

Exception

appendDeleteRecordTransactional

public void appendDeleteRecordTransactional(byte journalID,
                                            long txID,
                                            long id,
                                            org.apache.activemq.artemis.core.journal.EncodingSupport record)
                                     throws Exception

Throws:

Exception

appendDeleteRecordTransactional

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

Throws:

Exception

appendPrepareRecord

public void appendPrepareRecord(byte journalID,
                                long txID,
                                org.apache.activemq.artemis.core.journal.EncodingSupport transactionData)
                         throws Exception

Throws:

Exception

appendRollbackRecord

public void appendRollbackRecord(byte journalID,
                                 long txID)
                          throws Exception

Throws:

Exception

pageClosed

public void pageClosed(org.apache.activemq.artemis.api.core.SimpleString storeName,
                       int pageNumber)

Parameters:

storeName -

pageNumber -

pageDeleted

public void pageDeleted(org.apache.activemq.artemis.api.core.SimpleString storeName,
                        int pageNumber)

pageWrite

public void pageWrite(PagedMessage message,
                      int pageNumber)

largeMessageBegin

public void largeMessageBegin(long messageId)

largeMessageDelete

public void largeMessageDelete(Long messageId)

largeMessageWrite

public void largeMessageWrite(long messageId,
                              byte[] body)

isStarted

public boolean isStarted()

Specified by:

isStarted in interface org.apache.activemq.artemis.core.server.ActiveMQComponent

start

public void start()
           throws org.apache.activemq.artemis.api.core.ActiveMQException

Specified by:

start in interface org.apache.activemq.artemis.core.server.ActiveMQComponent

Throws:

org.apache.activemq.artemis.api.core.ActiveMQException

stop

public void stop()
          throws Exception

Specified by:

stop in interface org.apache.activemq.artemis.core.server.ActiveMQComponent

Throws:

Exception

clearReplicationTokens

public void clearReplicationTokens()

Completes any pending operations.

This can be necessary in case the live loses connection to the backup (network failure, or backup crashing).

getActiveTokens

public Set<OperationContext> getActiveTokens()

A list of tokens that are still waiting for replications to be completed

readyForWriting

public void readyForWriting()

Specified by:

readyForWriting in interface org.apache.activemq.artemis.spi.core.remoting.ReadyListener

syncJournalFile

public void syncJournalFile(org.apache.activemq.artemis.core.journal.impl.JournalFile jf,
                            AbstractJournalStorageManager.JournalContent content)
                     throws Exception

Sends the whole content of the file to be duplicated.

Throws:

org.apache.activemq.artemis.api.core.ActiveMQException

Exception

syncLargeMessageFile

public void syncLargeMessageFile(org.apache.activemq.artemis.core.io.SequentialFile file,
                                 long size,
                                 long id)
                          throws Exception

Throws:

Exception

syncPages

public void syncPages(org.apache.activemq.artemis.core.io.SequentialFile file,
                      long id,
                      org.apache.activemq.artemis.api.core.SimpleString queueName)
               throws Exception

Throws:

Exception

sendStartSyncMessage

public void sendStartSyncMessage(org.apache.activemq.artemis.core.journal.impl.JournalFile[] datafiles,
                                 AbstractJournalStorageManager.JournalContent contentType,
                                 String nodeID,
                                 boolean allowsAutoFailBack)
                          throws org.apache.activemq.artemis.api.core.ActiveMQException

Reserve the following fileIDs in the backup server.

Parameters:

datafiles -

contentType -

Throws:

org.apache.activemq.artemis.api.core.ActiveMQException

sendSynchronizationDone

public void sendSynchronizationDone(String nodeID,
                                    long initialReplicationSyncTimeout)

Informs backup that data synchronization is done.

So if 'live' fails, the (up-to-date) backup now may take over its duties. To do so, it must know which is the live's nodeID.

Parameters:

nodeID -

sendLargeMessageIdListMessage

public void sendLargeMessageIdListMessage(Map<Long,org.apache.activemq.artemis.api.core.Pair<String,Long>> largeMessages)

Reserves several LargeMessage IDs in the backup.

Doing this before hand removes the need of synchronizing large-message deletes with the largeMessageSyncList.

Parameters:

largeMessages -

sendLiveIsStopping

public OperationContext sendLiveIsStopping(ReplicationLiveIsStoppingMessage.LiveStopping finalMessage)

Notifies the backup that the live server is stopping.

This notification allows the backup to skip quorum voting (or any other measure to avoid 'split-brain') and do a faster fail-over.

Returns:

getBackupTransportConnection

public org.apache.activemq.artemis.core.protocol.core.CoreRemotingConnection getBackupTransportConnection()

Used while stopping the server to ensure that we freeze communications with the backup.

Returns:

remoting connection with the backup

isSynchronizing

public boolean isSynchronizing()

Returns: