org.gridgain.grid.dr

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 GridCacheConfiguration.getDrSenderConfiguration(), and it is considered as receiver cache in case it has GridCacheConfiguration.getDrReceiverConfiguration().

Node is considered as sender hub in case it has GridConfiguration.getDrSenderHubConfiguration(), and it is considered as receiver hub in case it has GridConfiguration.getDrReceiverHubConfiguration().

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

Methods

Modifier and Type	Method and Description
GridDrReceiverCacheMetrics	receiverCacheMetrics(String cacheName) Gets receiver cache metrics.
GridDrReceiverHubInMetrics	receiverHubAggregatedInMetrics() Gets receiver hub incoming data metrics aggregated across all remote data centers and cache names.
GridDrReceiverHubInMetrics	receiverHubAggregatedInMetrics(byte srcDataCenterId) Gets receiver hub incoming data metrics aggregated across all cache names for the given remote data center.
GridDrReceiverHubInMetrics	receiverHubAggregatedInMetrics(String cacheName) Gets receiver hub incoming data metrics aggregated across all remote data centers for the given cache name.
GridDrReceiverHubOutMetrics	receiverHubAggregatedOutMetrics() Gets receiver hub outgoing data metrics aggregated across all receiver caches.
GridDrReceiverHubInMetrics	receiverHubInMetrics(byte srcDataCenterId, String cacheName) Gets receiver hub incoming data metrics for the given remote data center and cache name.
GridDrReceiverHubOutMetrics	receiverHubOutMetrics(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.
Collection<GridDrStateTransferDescriptor>	senderCacheDrListStateTransfers(String cacheName) List all currently active state transfer for the given sender cache.
void	senderCacheDrPause(String cacheName) Pauses data center replication for particular sender cache.
void	senderCacheDrResume(String cacheName) Resumes data center replication for particular sender cache.
GridFuture<?>	senderCacheDrStateTransfer(String cacheName, byte... dataCenterId) Starts full state transfer for the given sender cache.
GridDrStatus	senderCacheDrStatus(String cacheName) Gets data center replication status for particular sender cache.
GridDrSenderCacheMetrics	senderCacheMetrics(String cacheName) Gets sender cache metrics.
GridDrSenderHubInMetrics	senderHubAggregatedInMetrics() Gets sender hub incoming data metrics aggregated across all caches.
GridDrSenderHubOutMetrics	senderHubAggregatedOutMetrics() Gets sender hub outgoing data metrics aggregated across all remote data centers and cache names.
GridDrSenderHubOutMetrics	senderHubAggregatedOutMetrics(byte destDataCenterId) Gets sender hub outgoing data metrics aggregated across all cache names for the given remote data center ID.
GridDrSenderHubOutMetrics	senderHubAggregatedOutMetrics(String cacheName) Gets sender hub outgoing data metrics aggregated across all remote data centers for the given cache name.
GridDrSenderHubInMetrics	senderHubInMetrics(String cacheName) Gets sender hub incoming data metrics for specified sender cache.
GridDrSenderHubOutMetrics	senderHubOutMetrics(byte destDataCenterId, String cacheName) Gets sender hub outgoing data metrics for the given remote data center ID and cache name.

Method Detail

senderCacheDrStateTransfer

GridFuture<?> senderCacheDrStateTransfer(String cacheName,
                                       byte... dataCenterId)

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.

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.

dataCenterId - 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.

senderCacheDrListStateTransfers

Collection<GridDrStateTransferDescriptor> senderCacheDrListStateTransfers(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.

senderCacheDrPause

void senderCacheDrPause(String cacheName)

Pauses data center replication 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 - Sender cache name.

senderCacheDrResume

void senderCacheDrResume(String cacheName)

Resumes data center replication 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.

senderCacheDrStatus

GridDrStatus senderCacheDrStatus(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

GridDrSenderCacheMetrics 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

GridDrReceiverCacheMetrics 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..

senderHubInMetrics

GridDrSenderHubInMetrics senderHubInMetrics(@Nullable
                                          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.

senderHubAggregatedInMetrics

GridDrSenderHubInMetrics senderHubAggregatedInMetrics()

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.

senderHubOutMetrics

GridDrSenderHubOutMetrics senderHubOutMetrics(byte destDataCenterId,
                                            @Nullable
                                            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.

senderHubAggregatedOutMetrics

GridDrSenderHubOutMetrics senderHubAggregatedOutMetrics(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.

senderHubAggregatedOutMetrics

GridDrSenderHubOutMetrics senderHubAggregatedOutMetrics(@Nullable
                                                      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.

senderHubAggregatedOutMetrics

GridDrSenderHubOutMetrics senderHubAggregatedOutMetrics()

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.

receiverHubInMetrics

GridDrReceiverHubInMetrics receiverHubInMetrics(byte srcDataCenterId,
                                              @Nullable
                                              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.

receiverHubAggregatedInMetrics

GridDrReceiverHubInMetrics receiverHubAggregatedInMetrics(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.

receiverHubAggregatedInMetrics

GridDrReceiverHubInMetrics receiverHubAggregatedInMetrics(@Nullable
                                                        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.

receiverHubAggregatedInMetrics

GridDrReceiverHubInMetrics receiverHubAggregatedInMetrics()

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.

receiverHubOutMetrics

GridDrReceiverHubOutMetrics receiverHubOutMetrics(@Nullable
                                                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.

receiverHubAggregatedOutMetrics

GridDrReceiverHubOutMetrics receiverHubAggregatedOutMetrics()

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.

Sender and receiver cache metrics must be reset through GridCache.resetMetrics().