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 name, int partitionId, WanReplicationEventQueue eventQueue) Publishes all events from the eventQueue to the WAN queue for the given partition ID and cache name.
void	addMapQueue(String name, int partitionId, WanReplicationEventQueue eventQueue) Publishes all events from the eventQueue to the WAN queue for the given partition ID and map name.
void	clearQueues() Clears the WAN queues and recalculates the WAN queue sizes.
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() Returns the WAN event queue container for this publisher.
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) Puts the given wanReplicationEvent in the corresponding WAN backup queue.
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 or stopped WanReplicationEndpoint instance.
void	shutdown() Signals the publisher to shut down and clean up its resources.
void	stop() Calls to this method will stop WAN replication.

Methods inherited from interface com.hazelcast.wan.WanReplicationPublisher

checkWanReplicationQueues, 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 - the replication config

wanPublisherConfig - this endpoint will be initialized using this WanPublisherConfig instance

shutdown

void shutdown()

Signals the publisher to shut down and clean up its resources. The method does not necessarily block until the endpoint has shut down.

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)

Puts the given wanReplicationEvent in the corresponding WAN backup queue.

Parameters:

wanReplicationEvent - the WAN event

getPublisherQueueContainer

PublisherQueueContainer getPublisherQueueContainer()

Returns the WAN event queue container for this publisher.

addMapQueue

void addMapQueue(String name,
                 int partitionId,
                 WanReplicationEventQueue eventQueue)

Publishes all events from the eventQueue to the WAN queue for the given partition ID and map name.

Parameters:

name - the name of the map to which to publish to

partitionId - the partition to which to publish to

eventQueue - the event queue from which events are published

addCacheQueue

void addCacheQueue(String name,
                   int partitionId,
                   WanReplicationEventQueue eventQueue)

Publishes all events from the eventQueue to the WAN queue for the given partition ID and cache name.

Parameters:

name - the name of the cache to which to publish to

partitionId - the partition to which to publish to

eventQueue - the event queue from which events are published

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. This means that the queues might eventually fill up and start dropping events.

Calling this method on already paused WanReplicationEndpoint instances will have no effect.

There is no synchronization with the thread polling the WAN queues and trasmitting the events to the target cluster. This means that the queues may be polled even after this method returns.

See Also:

resume()

stop

void stop()

Calls to this method will stop WAN replication. In addition to not polling events as in the pause() method, an endpoint which is stopped will not enqueue events. This method will not clear the WAN queues, though. This means that once this method returns, there might still be some WAN events enqueued but these events will not be replicated until the publisher is resumed.

Calling this method on already stopped WanReplicationEndpoint instances will have no effect.

See Also:

resume()

resume

void resume()

This method re-enables WAN event queue polling for a paused or stopped WanReplicationEndpoint instance.

Calling this method on already running WanReplicationEndpoint instances will have no effect.

See Also:

pause(), stop()

getStats

com.hazelcast.monitor.LocalWanPublisherStats getStats()

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

Returns:

LocalWanPublisherStats

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

Clears the WAN queues and recalculates the WAN queue sizes.

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