public interface WanReplicationService extends CoreService, StatisticsAwareService<LocalWanStats>
WanReplicationPublisher
instances to replicate
values to other clusters over the wide area network, so it has to deal
with long delays, slow uploads and higher latencies.Modifier and Type | Field and Description |
---|---|
static String |
SERVICE_NAME
Service name.
|
Modifier and Type | Method and Description |
---|---|
AddWanConfigResult |
addWanReplicationConfig(WanReplicationConfig wanConfig)
Adds a new
WanReplicationConfig to the cluster. |
void |
addWanReplicationConfigLocally(WanReplicationConfig wanConfig)
Adds a new
WanReplicationConfig to this member and creates the
WanReplicationPublisher s specified in the config. |
void |
checkWanReplicationQueues(String name) |
void |
clearQueues(String wanReplicationName,
String targetGroupName)
Clears WAN replication queues of the given wanReplicationName for the given target.
|
void |
consistencyCheck(String wanReplicationName,
String targetGroupName,
String mapName)
Initiate WAN consistency check for a specific map.
|
DistributedServiceWanEventCounters |
getReceivedEventCounters(String serviceName)
Returns a counter of received and processed WAN replication events.
|
DistributedServiceWanEventCounters |
getSentEventCounters(String wanReplicationName,
String targetGroupName,
String serviceName)
Returns a counter of sent and processed WAN replication events.
|
WanReplicationPublisher |
getWanReplicationPublisher(String name)
Creates a new
WanReplicationPublisher by the given name. |
WanSyncState |
getWanSyncState()
Returns current status of WAN sync operation or
null when there
is no status. |
void |
pause(String wanReplicationName,
String targetGroupName)
Pauses WAN replication for the given
wanReplicationName and
targetGroupName on this hazelcast instance. |
void |
removeWanEventCounters(String serviceName,
String dataStructureName)
Removes all WAN event counters for the given
serviceName and
dataStructureName . |
void |
resume(String wanReplicationName,
String targetGroupName)
Resumes WAN replication for the given
wanReplicationName and
targetGroupName on this hazelcast instance. |
void |
shutdown()
Starts the shutdown process of the WAN replication service.
|
void |
stop(String wanReplicationName,
String targetGroupName)
Stops WAN replication for the given
wanReplicationName and
targetGroupName on this hazelcast instance. |
void |
syncAllMaps(String wanReplicationName,
String targetGroupName)
Initiate wan sync for all maps.
|
void |
syncMap(String wanReplicationName,
String targetGroupName,
String mapName)
Initiate wan sync for a specific map.
|
getStats
static final String SERVICE_NAME
WanReplicationPublisher getWanReplicationPublisher(String name)
WanReplicationPublisher
by the given name. If
the name already exists, returns the previous instance.name
- name of the WAN replication configurationvoid shutdown()
void pause(String wanReplicationName, String targetGroupName)
wanReplicationName
and
targetGroupName
on this hazelcast instance.wanReplicationName
- name of WAN replication configurationtargetGroupName
- WAN target cluster group nameUnsupportedOperationException
- if called on an OS instancevoid stop(String wanReplicationName, String targetGroupName)
wanReplicationName
and
targetGroupName
on this hazelcast instance.wanReplicationName
- name of WAN replication configurationtargetGroupName
- WAN target cluster group nameUnsupportedOperationException
- if called on an OS instancevoid resume(String wanReplicationName, String targetGroupName)
wanReplicationName
and
targetGroupName
on this hazelcast instance.wanReplicationName
- name of WAN replication configurationtargetGroupName
- WAN target cluster group nameUnsupportedOperationException
- if called on an OS instancevoid checkWanReplicationQueues(String name)
void syncMap(String wanReplicationName, String targetGroupName, String mapName)
wanReplicationName
- the name of the wan replication configtargetGroupName
- the group name on the target clustermapName
- the map nameUnsupportedOperationException
- if the operation is not supported (not EE)InvalidConfigurationException
- if there is no WAN replication
config for wanReplicationName
SyncFailedException
- if there is a anti-entropy request in
progressvoid syncAllMaps(String wanReplicationName, String targetGroupName)
wanReplicationName
- the name of the wan replication configtargetGroupName
- the group name on the target clusterUnsupportedOperationException
- if the operation is not supported (not EE)InvalidConfigurationException
- if there is no WAN replication config for
wanReplicationName
SyncFailedException
- if there is a anti-entropy request in progressvoid consistencyCheck(String wanReplicationName, String targetGroupName, String mapName)
wanReplicationName
- the name of the wan replication configtargetGroupName
- the group name on the target clustermapName
- the map nameUnsupportedOperationException
- if the operation is not supported (not EE)InvalidConfigurationException
- if there is no WAN replication config for wanReplicationName
SyncFailedException
- if there is a anti-entropy request in progressvoid clearQueues(String wanReplicationName, String targetGroupName)
wanReplicationName
- the name of the wan replication configtargetGroupName
- the target cluster group nameUnsupportedOperationException
- if invoked on OSvoid addWanReplicationConfigLocally(WanReplicationConfig wanConfig)
WanReplicationConfig
to this member and creates the
WanReplicationPublisher
s specified in the config.
This method can also accept WAN configs with an existing WAN replication
name. Such configs will be merged into the existing WAN replication
config by adding publishers with publisher IDs which are not already part
of the existing configuration.UnsupportedOperationException
- if invoked on OSAddWanConfigResult addWanReplicationConfig(WanReplicationConfig wanConfig)
WanReplicationConfig
to the cluster.
This method can also accept WAN configs with an existing WAN replication
name. Such configs will be merged into the existing WAN replication
config by adding publishers with publisher IDs which are not already part
of the existing configuration.
The return value is a best-effort guess at the result of adding WAN
replication config based on the existing local WAN replication config.
An exact result is difficult to calculate since not all members might
have the same existing configuration and there might be a concurrent
request to add overlapping WAN replication config.wanConfig
- the WAN replication config to addUnsupportedOperationException
- if invoked on OSaddWanReplicationConfigLocally(WanReplicationConfig)
WanSyncState getWanSyncState()
null
when there
is no status.DistributedServiceWanEventCounters getReceivedEventCounters(String serviceName)
serviceName
- the name of the service for the WAN eventsDistributedServiceWanEventCounters getSentEventCounters(String wanReplicationName, String targetGroupName, String serviceName)
wanReplicationName
- the name of the wan replication configtargetGroupName
- the target cluster group nameserviceName
- the name of the service for the WAN eventsCopyright © 2019 Hazelcast, Inc.. All Rights Reserved.