org.gridgain.grid

Interface GridDr

public interface GridDr

Data center replication (DR) interface.

DR is a process of transferring updates from a cache located in one topology to a cache located in another topology. Usual use case for DR is synchronizing cache state between several geographically remote topologies through WAN.

DR operates on the following terms:

• Data center - particular GridGain topology with unique ID;
• Sender cache - cache from which data is being replicated;
• Receiver cache - cache which applies updates from remote data center;
• Sender hub - node which accumulates updates from sender data nodes and sends that to receiver hub in remote data center;
• Receiver hub - node which receives updates from remote data center sender hub and applies them to receiver data nodes.

Cache is considered as sender in case it has GridGainCacheConfiguration.getDrSenderConfiguration(), and it is considered as receiver cache in case GridGainCacheConfiguration.isDrReceiverEnabled() is true.

Node is considered as sender hub in case it has GridGainConfiguration.getDrSenderConfiguration(), and it is considered as receiver hub in case it has GridGainConfiguration.getDrReceiverConfiguration().

Particular cache can be both sender and receiver at the same time. Particular node can be both sender and receiver hub and host sender/receiver caches at the same time.

This API provides ability to manage DR process on sender cache node as well as get metrics for sender cache, receiver cache, sender hub and receiver hub.

Method Summary

Modifier and Type	Method and Description
IgniteFuture<?>	cancelStateTransfer(IgniteUuid taskUuid) Cancel state transfer operation with given uid.
IgniteFuture<?>	flush(String cacheName) Flushes DR updates.
IgniteFuture<?>	incrementalStateTransfer(String cacheName, long snapshotId, byte dataCenterId) Starts incremental state transfer for given cache.
boolean	isLocalSender() Checks whether current node is sender.
Collection<CacheDrStateTransfer>	listStateTransfers() List all currently active state transfers.
Collection<CacheDrStateTransfer>	listStateTransfers(String cacheName) List all currently active state transfer for the given sender cache.
DrSender	localSender() Gets sender facade for current node.
void	pause(String cacheName) Deprecated. This method actually works same way as stopReplication(String) and stops replication for given cache.
DrReceiverInMetrics	receiverAggregatedInMetrics() Gets receiver hub incoming data metrics aggregated across all remote data centers and cache names.
DrReceiverInMetrics	receiverAggregatedInMetrics(byte srcDataCenterId) Gets receiver hub incoming data metrics aggregated across all cache names for the given remote data center.
DrReceiverInMetrics	receiverAggregatedInMetrics(String cacheName) Gets receiver hub incoming data metrics aggregated across all remote data centers for the given cache name.
DrReceiverOutMetrics	receiverAggregatedOutMetrics() Gets receiver hub outgoing data metrics aggregated across all receiver caches.
CacheDrReceiverMetrics	receiverCacheMetrics(String cacheName) Gets receiver cache metrics.
DrReceiverInMetrics	receiverInMetrics(byte srcDataCenterId, String cacheName) Gets receiver hub incoming data metrics for the given remote data center and cache name.
DrReceiverOutMetrics	receiverOutMetrics(byte srcDataCenterId, String cacheName) Gets receiver hub outgoing data metrics for the given source data center id and cache name.
DrReceiverOutMetrics	receiverOutMetrics(String cacheName) Gets receiver hub outgoing data metrics for the given cache name.
void	resetMetrics() Reset all sender hub and receiver hub metrics on this node.
void	resume(String cacheName) Deprecated. This method actually works same way as startReplication(String) and starts replication for given cache.
DrSenderInMetrics	senderAggregatedInMetrics() Gets sender hub incoming data metrics aggregated across all caches.
DrSenderOutMetrics	senderAggregatedOutMetrics() Gets sender hub outgoing data metrics aggregated across all remote data centers and cache names.
DrSenderOutMetrics	senderAggregatedOutMetrics(byte destDataCenterId) Gets sender hub outgoing data metrics aggregated across all cache names for the given remote data center ID.
DrSenderOutMetrics	senderAggregatedOutMetrics(String cacheName) Gets sender hub outgoing data metrics aggregated across all remote data centers for the given cache name.
CacheDrSenderMetrics	senderCacheMetrics(String cacheName) Gets sender cache metrics.
CacheDrStatus	senderCacheStatus(String cacheName) Gets data center replication status for particular sender cache.
DrSenderInMetrics	senderInMetrics(String cacheName) Gets sender hub incoming data metrics for specified sender cache.
DrSenderOutMetrics	senderOutMetrics(byte destDataCenterId, String cacheName) Gets sender hub outgoing data metrics for the given remote data center ID and cache name.
void	startReplication(String cacheName) Starts data center replication for particular sender cache.
IgniteFuture<?>	stateTransfer(String cacheName, boolean sync, byte... dataCenterIds) Starts full state transfer for the given sender cache.
IgniteFuture<?>	stateTransfer(String cacheName, byte... dataCenterIds) Starts full state transfer for the given sender cache.
void	stopReplication(String cacheName) Stops data center replication for particular sender cache.

Method Detail

stateTransfer

IgniteFuture<?> stateTransfer(String cacheName,
                              byte... dataCenterIds)

Starts full state transfer for the given sender cache.

In case node doesn't have cache with the given name or this cache is not sender cache, an exception will be thrown.

Only one state transfer for particular cache and data center is allowed at a time. In case another state transfer for the given cache and data center had been already in progress when this method was called, then no new state transfer for this (cache name, data center) pair will be initiated and returned future will "join" existing state transfer.

Parameters:

cacheName - Sender cache name.

dataCenterIds - Remote data center IDs for which full state transfer was requested.

Returns:

Future that will be completed when all required data is transferred from sender caches to sender hubs.

Throws:

IllegalArgumentException - If node doesn't have cache with the given name.

IllegalArgumentException - if this cache is not sender cache or grid is stopping.

stateTransfer

IgniteFuture<?> stateTransfer(String cacheName,
                              boolean sync,
                              byte... dataCenterIds)

Starts full state transfer for the given sender cache.

In case node doesn't have cache with the given name or this cache is not sender cache, an exception will be thrown.

Only one state transfer for particular cache and data center is allowed at a time. In case another state transfer for the given cache and data center had been already in progress when this method was called, then no new state transfer for this (cache name, data center) pair will be initiated and returned future will "join" existing state transfer.

Synchronous state transfer future is completed when the remote data center confirms it has received all the data. Asynchronous state transfer future is completed when all data is delivered to the sender node (in the same DC).

In case node doesn't have cache with the given name then IllegalArgumentException will be thrown, and if this cache is not sender cache or grid is stopping then IllegalStateException will be thrown.

Parameters:

cacheName - Sender cache name.

sync - Sync mode flag. Setting this to True force synchronous state transfer mode, otherwise async mode will be used.

dataCenterIds - Remote data center IDs for which full state transfer was requested.

Returns:

Future that will be completed when all required data is transferred.

incrementalStateTransfer

IgniteFuture<?> incrementalStateTransfer(String cacheName,
                                         long snapshotId,
                                         byte dataCenterId)

Starts incremental state transfer for given cache. Has similar, but slightly less strict guarantees as synchronous state transfer. See stateTransfer(String, boolean, byte...) for details. The main differences are

• data that are already stored to snapshot with given 'snapshotId' will be skipped to save network resources.
• data that could be replicated via regular background DR process will be skipped to save network resources. So, some data that were in cache at a time state transfer was started, may be missed on remote DC at state transfer finish, but will be delivered a bit later.
• on the other hand synchronous state transfer guarantees all the data that were in a cache at a time the method was called will be available on the remote side after state transfer (future) completion.

Parameters:

cacheName - Cache name.

snapshotId - Snapshot ID for which incremental state transfer is requested.

dataCenterId - Remote data center ID for which incremental state transfer is requested.

Returns:

Future that will be completed when all required data is transferred.

cancelStateTransfer

IgniteFuture<?> cancelStateTransfer(IgniteUuid taskUuid)

Cancel state transfer operation with given uid.

Parameters:

taskUuid - State transfer operation uid. See CacheDrStateTransfer.id().

Returns:

Future that will be completed when dr will be cancelled.

listStateTransfers

Collection<CacheDrStateTransfer> listStateTransfers(String cacheName)

List all currently active state transfer for the given sender cache.

In case node doesn't have cache with the given name then IllegalArgumentException will be thrown, and if this cache is not sender cache or grid is stopping then IllegalStateException will be thrown.

Parameters:

cacheName - Cache name.

Returns:

All currently active state transfers.

listStateTransfers

Collection<CacheDrStateTransfer> listStateTransfers()

List all currently active state transfers.

Returns:

All currently active state transfers.

pause

@Deprecated
void pause(String cacheName)

Deprecated. This method actually works same way as stopReplication(String) and stops replication for given cache.

Stops data center replication for particular sender cache. Note: A full state transfer may be required after data center replication will be resumed.

In case node doesn't have cache with the given name then IllegalArgumentException will be thrown, and if this cache is not sender cache or grid is stopping then IllegalStateException will be thrown.

Parameters:

cacheName - Sender cache name.

stopReplication

void stopReplication(String cacheName)

Stops data center replication for particular sender cache. Note: A full state transfer may be required after data center replication will be resumed.

In case node doesn't have cache with the given name then IllegalArgumentException will be thrown, and if this cache is not sender cache or grid is stopping then IllegalStateException will be thrown.

Parameters:

cacheName - Sender cache name.

resume

@Deprecated
void resume(String cacheName)

Deprecated. This method actually works same way as startReplication(String) and starts replication for given cache.

Starts data center replication for particular sender cache. Note: A full state transfer may be required as some updates could be missed after replication has been stopped.

In case node doesn't have cache with the given name then IllegalArgumentException will be thrown, and if this cache is not sender cache or grid is stopping then IllegalStateException will be thrown.

Parameters:

cacheName - Sender cache name.

startReplication

void startReplication(String cacheName)

Starts data center replication for particular sender cache. Note: A full state transfer may be required as some updates could be missed after replication has been stopped.

In case node doesn't have cache with the given name then IllegalArgumentException will be thrown, and if this cache is not sender cache or grid is stopping then IllegalStateException will be thrown.

Parameters:

cacheName - Sender cache name.

senderCacheStatus

CacheDrStatus senderCacheStatus(String cacheName)

Gets data center replication status for particular sender cache.

In case node doesn't have cache with the given name then IllegalArgumentException will be thrown, and if this cache is not sender cache or grid is stopping then IllegalStateException will be thrown.

Parameters:

cacheName - Cache name.

Returns:

Data center replication status.

senderCacheMetrics

CacheDrSenderMetrics senderCacheMetrics(String cacheName)

Gets sender cache metrics.

In case node doesn't have cache with the given name then IllegalArgumentException will be thrown, and if this cache is not sender cache then IllegalStateException will be thrown.

Parameters:

cacheName - Sender cache name.

Returns:

Sender cache metrics.

receiverCacheMetrics

CacheDrReceiverMetrics receiverCacheMetrics(String cacheName)

Gets receiver cache metrics.

In case node doesn't have cache with the given name then IllegalArgumentException will be thrown, and if this cache is not receiver cache IllegalStateException will be thrown.

Parameters:

cacheName - Receiver cache name.

Returns:

Receiver cache metrics..

senderInMetrics

DrSenderInMetrics senderInMetrics(String cacheName)

Gets sender hub incoming data metrics for specified sender cache.

In case node is not sender hub then IllegalStateException will be thrown. If this sender hub does not work with the given cache IllegalArgumentException will be thrown.

Parameters:

cacheName - Sender cache name.

Returns:

Sender hub incoming data metrics.

senderAggregatedInMetrics

DrSenderInMetrics senderAggregatedInMetrics()

Gets sender hub incoming data metrics aggregated across all caches.

In case node is not sender hub then IllegalStateException will be thrown.

Returns:

Sender hub incoming data metrics.

senderOutMetrics

DrSenderOutMetrics senderOutMetrics(byte destDataCenterId,
                                    String cacheName)

Gets sender hub outgoing data metrics for the given remote data center ID and cache name.

In case node is not sender hub then IllegalStateException will be thrown. If this sender hub does not work with the given data center or cache IllegalArgumentException will be thrown.

Parameters:

destDataCenterId - Remote data center ID.

cacheName - Cache name.

Returns:

Sender hub outgoing data metrics.

senderAggregatedOutMetrics

DrSenderOutMetrics senderAggregatedOutMetrics(byte destDataCenterId)

Gets sender hub outgoing data metrics aggregated across all cache names for the given remote data center ID.

In case node is not sender hub then IllegalStateException will be thrown. If this sender hub does not work with the given data center IllegalArgumentException will be thrown.

Parameters:

destDataCenterId - Remote data center ID.

Returns:

Sender hub outgoing data metrics.

senderAggregatedOutMetrics

DrSenderOutMetrics senderAggregatedOutMetrics(String cacheName)

Gets sender hub outgoing data metrics aggregated across all remote data centers for the given cache name.

In case node is not sender hub then IllegalStateException will be thrown. If this sender hub does not work with the given cache IllegalArgumentException will be thrown.

Parameters:

cacheName - Cache name.

Returns:

Sender hub outgoing data metrics.

senderAggregatedOutMetrics

DrSenderOutMetrics senderAggregatedOutMetrics()

Gets sender hub outgoing data metrics aggregated across all remote data centers and cache names.

In case node is not sender hub then IllegalStateException will be thrown.

Returns:

Sender hub outgoing data metrics.

receiverInMetrics

DrReceiverInMetrics receiverInMetrics(byte srcDataCenterId,
                                      String cacheName)

Gets receiver hub incoming data metrics for the given remote data center and cache name.

In case node is not receiver hub then IllegalStateException will be thrown.

Parameters:

srcDataCenterId - Remote data center ID.

cacheName - Cache name.

Returns:

Receiver hub incoming data metrics.

receiverAggregatedInMetrics

DrReceiverInMetrics receiverAggregatedInMetrics(byte srcDataCenterId)

Gets receiver hub incoming data metrics aggregated across all cache names for the given remote data center.

In case node is not receiver hub then IllegalStateException will be thrown.

Parameters:

srcDataCenterId - Remote data center ID.

Returns:

Receiver hub incoming data metrics.

receiverAggregatedInMetrics

DrReceiverInMetrics receiverAggregatedInMetrics(String cacheName)

Gets receiver hub incoming data metrics aggregated across all remote data centers for the given cache name.

In case node is not receiver hub then IllegalStateException will be thrown.

Parameters:

cacheName - Cache name.

Returns:

Receiver hub incoming data metrics.

receiverAggregatedInMetrics

DrReceiverInMetrics receiverAggregatedInMetrics()

Gets receiver hub incoming data metrics aggregated across all remote data centers and cache names.

In case node is not receiver hub then IllegalStateException will be thrown.

Returns:

Receiver hub incoming data metrics.

receiverOutMetrics

DrReceiverOutMetrics receiverOutMetrics(String cacheName)

Gets receiver hub outgoing data metrics for the given cache name.

In case node is not receiver hub then IllegalStateException will be thrown.

Parameters:

cacheName - Cache name.

Returns:

Receiver hub outgoing data metrics.

receiverOutMetrics

DrReceiverOutMetrics receiverOutMetrics(byte srcDataCenterId,
                                        String cacheName)

Gets receiver hub outgoing data metrics for the given source data center id and cache name.

In case node is not receiver hub then IllegalStateException will be thrown.

Parameters:

srcDataCenterId - Remote data center ID.

cacheName - Cache name.

Returns:

Receiver hub outgoing data metrics.

receiverAggregatedOutMetrics

DrReceiverOutMetrics receiverAggregatedOutMetrics()

Gets receiver hub outgoing data metrics aggregated across all receiver caches.

In case node is not receiver hub then IllegalStateException will be thrown.

Returns:

Receiver hub outgoing data metrics.

resetMetrics

void resetMetrics()

Reset all sender hub and receiver hub metrics on this node. In case this node is neither sender hub, nor receiver hub, the method is no-op.

isLocalSender

boolean isLocalSender()

Checks whether current node is sender.

Returns:

True if sender.

localSender

DrSender localSender()
              throws IllegalStateException

Gets sender facade for current node.

Returns:

Sender facade.

Throws:

IllegalStateException - If current node is not sender.

flush

IgniteFuture<?> flush(String cacheName)

Flushes DR updates.

Parameters:

cacheName - Cache name.

Returns:

Future that will be completed when data is flushed.