com.hazelcast.enterprise.wan

Interface WanReplicationEndpoint

All Superinterfaces:

com.hazelcast.wan.WanReplicationPublisher

All Known Implementing Classes:

AbstractWanPublisher, AbstractWanReplication, WanBatchReplication

public interface WanReplicationEndpoint
extends com.hazelcast.wan.WanReplicationPublisher

Implementations of this interface represent a replication endpoint, normally another Hazelcast cluster only reachable over a Wide Area Network (WAN).

Method Summary

Modifier and Type	Method and Description
void	addCacheQueue(String key, int partitionId, WanReplicationEventQueue value)
void	addMapQueue(String key, int partitionId, WanReplicationEventQueue value)
void	checkWanReplicationQueues()
void	clearQueues()
void	collectAllServiceNamespaces(com.hazelcast.spi.PartitionReplicationEvent event, Set<com.hazelcast.spi.ServiceNamespace> namespaces) Collect the namespaces of all queues that should be replicated by the replication event.
void	collectReplicationData(String wanReplicationName, com.hazelcast.spi.PartitionReplicationEvent event, Collection<com.hazelcast.spi.ServiceNamespace> namespaces, EWRMigrationContainer migrationDataContainer) Collect all replication data for the specific replication event and collection of namespaces being replicated.
PublisherQueueContainer	getPublisherQueueContainer()
com.hazelcast.monitor.LocalWanPublisherStats	getStats() Gathers statistics of related WanReplicationEndpoint instance.
void	init(com.hazelcast.instance.Node node, com.hazelcast.config.WanReplicationConfig wanReplicationConfig, com.hazelcast.config.WanPublisherConfig wanPublisherConfig) Initializes the endpoint using the given arguments.
void	pause() Calls to this method will pause WAN event queue polling.
void	publishSyncEvent(WanSyncEvent syncRequest) Publishes a wan sync event for all or a specific map and for all or some partitions.
void	putBackup(com.hazelcast.wan.WanReplicationEvent wanReplicationEvent)
void	removeBackup(com.hazelcast.wan.WanReplicationEvent wanReplicationEvent) Remove the oldest replication event from the replication queue and decrease the backup event count.
void	resume() This method re-enables WAN event queue polling for a paused WanReplicationEndpoint instance.
void	shutdown() Closes the endpoint and its internal connections and shuts down other internal states.

Methods inherited from interface com.hazelcast.wan.WanReplicationPublisher

publishReplicationEvent, publishReplicationEvent, publishReplicationEventBackup

Method Detail

init

void init(com.hazelcast.instance.Node node,
          com.hazelcast.config.WanReplicationConfig wanReplicationConfig,
          com.hazelcast.config.WanPublisherConfig wanPublisherConfig)

Initializes the endpoint using the given arguments.

Parameters:

node - the current node that tries to connect

wanReplicationConfig - WanReplicationConfig config

wanPublisherConfig - this endpoint will be initialized using this WanPublisherConfig instance

shutdown

void shutdown()

Closes the endpoint and its internal connections and shuts down other internal states.

removeBackup

void removeBackup(com.hazelcast.wan.WanReplicationEvent wanReplicationEvent)

Remove the oldest replication event from the replication queue and decrease the backup event count. The replication queue chosen has the same map/cache name and partition ID as the provided wanReplicationEvent.

Parameters:

wanReplicationEvent - the completed wan event

putBackup

void putBackup(com.hazelcast.wan.WanReplicationEvent wanReplicationEvent)

getPublisherQueueContainer

PublisherQueueContainer getPublisherQueueContainer()

addMapQueue

void addMapQueue(String key,
                 int partitionId,
                 WanReplicationEventQueue value)

addCacheQueue

void addCacheQueue(String key,
                   int partitionId,
                   WanReplicationEventQueue value)

pause

void pause()

Calls to this method will pause WAN event queue polling. Effectively, pauses WAN replication for its WanReplicationEndpoint instance. WAN events will still be offered to WAN replication queues but they won't be polled. Calling this method on already paused WanReplicationEndpoint instances will have no effect.

resume

void resume()

This method re-enables WAN event queue polling for a paused WanReplicationEndpoint instance. Calling this method on already running WanReplicationEndpoint instances will have no effect.

See Also:

pause()

getStats

com.hazelcast.monitor.LocalWanPublisherStats getStats()

Gathers statistics of related WanReplicationEndpoint instance. This method will always return the same instance.

Returns:

LocalWanPublisherStats

checkWanReplicationQueues

void checkWanReplicationQueues()

Specified by:

checkWanReplicationQueues in interface com.hazelcast.wan.WanReplicationPublisher

publishSyncEvent

void publishSyncEvent(WanSyncEvent syncRequest)

Publishes a wan sync event for all or a specific map and for all or some partitions.

Parameters:

syncRequest - the wan sync request

clearQueues

void clearQueues()

collectReplicationData

void collectReplicationData(String wanReplicationName,
                            com.hazelcast.spi.PartitionReplicationEvent event,
                            Collection<com.hazelcast.spi.ServiceNamespace> namespaces,
                            EWRMigrationContainer migrationDataContainer)

Collect all replication data for the specific replication event and collection of namespaces being replicated.

Parameters:

wanReplicationName - the WAN replication name in the hazelcast configuration for this endpoint

event - the replication event

namespaces - the object namespaces which are being replicated

migrationDataContainer - the container for the migration data

collectAllServiceNamespaces

void collectAllServiceNamespaces(com.hazelcast.spi.PartitionReplicationEvent event,
                                 Set<com.hazelcast.spi.ServiceNamespace> namespaces)

Collect the namespaces of all queues that should be replicated by the replication event.

Parameters:

event - the replication event

namespaces - the set in which namespaces should be added