Package org.apache.activemq.artemis.core.replication

Class ReplicationManager

java.lang.Object

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

All Implemented Interfaces:

ActiveMQComponent

public final class ReplicationManager
extends Object
implements ActiveMQComponent

Manages replication tasks on the primary server (i.e. the active 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	Description
static enum	ReplicationManager.ADD_OPERATION_TYPE

Constructor Summary

Constructors

Constructor	Description
ReplicationManager(ActiveMQServer server, CoreRemotingConnection remotingConnection, long timeout, long initialReplicationSyncTimeout, ExecutorFactory ioExecutorFactory)

Method Summary

Modifier and Type	Method	Description
void	appendAddRecordTransactional(byte journalID, ReplicationManager.ADD_OPERATION_TYPE operation, long txID, long id, byte recordType, Persister persister, Object 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, EncodingSupport record)
void	appendPrepareRecord(byte journalID, long txID, EncodingSupport transactionData)
void	appendRollbackRecord(byte journalID, long txID)
void	appendUpdateRecord(byte journalID, ReplicationManager.ADD_OPERATION_TYPE operation, long id, byte recordType, Persister persister, Object record)
void	clearReplicationTokens()	Completes any pending operations.
Set<OperationContext>	getActiveTokens()	A list of tokens that are still waiting for replications to be completed
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	largeMessageClosed(Long messageId, JournalStorageManager storageManager)
void	largeMessageDelete(Long messageId, JournalStorageManager storageManager)
void	largeMessageWrite(long messageId, byte[] body)
void	pageClosed(SimpleString storeName, long pageNumber)
void	pageDeleted(SimpleString storeName, long pageNumber)
void	pageWrite(SimpleString address, PagedMessage message, long pageNumber, boolean lineup)
void	sendLargeMessageIdListMessage(Map<Long,Pair<String,Long>> largeMessages)	Reserves several LargeMessage IDs in the backup.
OperationContext	sendPrimaryIsStopping(ReplicationPrimaryIsStoppingMessage.PrimaryStopping finalMessage)	Notifies the backup that the primary server is stopping.
void	sendStartSyncMessage(JournalFile[] datafiles, AbstractJournalStorageManager.JournalContent contentType, String nodeID, boolean allowsAutoFailBack)	Reserve the following fileIDs in the backup server.
void	sendSynchronizationDone(String nodeID, long initialReplicationSyncTimeout, IOCriticalErrorListener criticalErrorListener)	Informs backup that data synchronization is done.
void	start()
void	stop()
void	stop(boolean clearTokens)
void	syncJournalFile(JournalFile jf, AbstractJournalStorageManager.JournalContent content)	Sends the whole content of the file to be duplicated.
void	syncLargeMessageFile(SequentialFile file, long size, long id)
void	syncPages(SequentialFile file, long id, SimpleString queueName)

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

Constructor Details

ReplicationManager

public ReplicationManager(ActiveMQServer server,
 CoreRemotingConnection remotingConnection,
 long timeout,
 long initialReplicationSyncTimeout,
 ExecutorFactory ioExecutorFactory)

Method Details

appendUpdateRecord

public void appendUpdateRecord(byte journalID,
 ReplicationManager.ADD_OPERATION_TYPE operation,
 long id,
 byte recordType,
 Persister persister,
 Object 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,
 Persister persister,
 Object 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,
 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,
 EncodingSupport transactionData)
                         throws Exception

Throws:

Exception

appendRollbackRecord

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

Throws:

Exception

pageClosed

public void pageClosed(SimpleString storeName,
 long pageNumber)

pageDeleted

public void pageDeleted(SimpleString storeName,
 long pageNumber)

pageWrite

public void pageWrite(SimpleString address,
 PagedMessage message,
 long pageNumber,
 boolean lineup)

largeMessageBegin

public void largeMessageBegin(long messageId)

largeMessageDelete

public void largeMessageDelete(Long messageId,
 JournalStorageManager storageManager)

largeMessageClosed

public void largeMessageClosed(Long messageId,
 JournalStorageManager storageManager)

largeMessageWrite

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

isStarted

public boolean isStarted()

Specified by:

isStarted in interface ActiveMQComponent

start

public void start()
           throws ActiveMQException

Specified by:

start in interface ActiveMQComponent

Throws:

ActiveMQException

stop

public void stop()
          throws Exception

Specified by:

stop in interface ActiveMQComponent

Throws:

Exception

stop

public void stop(boolean clearTokens)
          throws Exception

Throws:

Exception

clearReplicationTokens

public void clearReplicationTokens()

Completes any pending operations.

This can be necessary in case the primary loses the 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

syncJournalFile

public void syncJournalFile(JournalFile jf,
 AbstractJournalStorageManager.JournalContent content)
                     throws Exception

Sends the whole content of the file to be duplicated.

Throws:

Exception

syncLargeMessageFile

public void syncLargeMessageFile(SequentialFile file,
 long size,
 long id)
                          throws Exception

Throws:

Exception

syncPages

public void syncPages(SequentialFile file,
 long id,
 SimpleString queueName)
               throws Exception

Throws:

Exception

sendStartSyncMessage

public void sendStartSyncMessage(JournalFile[] datafiles,
 AbstractJournalStorageManager.JournalContent contentType,
 String nodeID,
 boolean allowsAutoFailBack)
                          throws ActiveMQException

Reserve the following fileIDs in the backup server.

Throws:

ActiveMQException

sendSynchronizationDone

public void sendSynchronizationDone(String nodeID,
 long initialReplicationSyncTimeout,
 IOCriticalErrorListener criticalErrorListener)
                             throws ActiveMQReplicationTimeooutException

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.

Throws:

ActiveMQReplicationTimeooutException

sendLargeMessageIdListMessage

public void sendLargeMessageIdListMessage(Map<Long,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.

sendPrimaryIsStopping

public OperationContext sendPrimaryIsStopping(ReplicationPrimaryIsStoppingMessage.PrimaryStopping finalMessage)

Notifies the backup that the primary 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.

getBackupTransportConnection

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