com.hazelcast.enterprise.wan.replication

Class AbstractWanPublisher

java.lang.Object

com.hazelcast.enterprise.wan.replication.AbstractWanPublisher

All Implemented Interfaces:

WanReplicationEndpoint, com.hazelcast.spi.LiveOperationsTracker, com.hazelcast.wan.WanReplicationPublisher

Direct Known Subclasses:

AbstractWanReplication

public abstract class AbstractWanPublisher
extends Object
implements com.hazelcast.wan.WanReplicationPublisher, WanReplicationEndpoint, com.hazelcast.spi.LiveOperationsTracker

Abstract WAN event publisher implementation. This implementation prepares the WAN events from the WAN queues and from WAN sync events for sending to the WAN endpoints.

Field Summary

Fields

Modifier and Type	Field and Description
protected WanConfigurationContext	configurationContext
protected PublisherQueueContainer	eventQueueContainer
protected long	lastQueueFullLogTimeMs
protected String	localGroupName
protected com.hazelcast.logging.ILogger	logger
protected com.hazelcast.instance.Node	node
protected boolean	paused
protected int	queueCapacity
protected com.hazelcast.config.WANQueueFullBehavior	queueFullBehavior
protected int	queueLoggerTimePeriodMs
protected boolean	running
protected BlockingQueue<com.hazelcast.wan.WanReplicationEvent>	stagingQueue Queue for multiplexed map/cache partition WAN events that are about to be transmitted to the target cluster
protected WanSyncManager	syncManager
protected BlockingQueue<WanSyncEvent>	syncRequests
protected String	targetGroupName
protected String	wanReplicationName

Constructor Summary

Constructors

Constructor and Description
AbstractWanPublisher()

Method Summary

Modifier and Type	Method and Description
void	addCacheQueue(String name, int partitionId, WanReplicationEventQueue eventQueue)
void	addMapQueue(String name, int partitionId, WanReplicationEventQueue eventQueue)
protected void	afterShutdown()
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.
protected void	decrementWANQueueSize(int delta)
int	getCurrentBackupElementCount()
int	getCurrentElementCount() Returns the count for the number of events currently in the WAN map/cache partition queues for partitions owned by this node.
protected int	getPartitionId(Object key)
PublisherQueueContainer	getPublisherQueueContainer()
int	getStagingQueueSize()
com.hazelcast.monitor.LocalWanPublisherStats	getStats() Gathers statistics of related WanReplicationEndpoint instance.
String	getTargetGroupName()
void	init(com.hazelcast.instance.Node node, com.hazelcast.config.WanReplicationConfig wanReplicationConfig, com.hazelcast.config.WanPublisherConfig publisherConfig) Initializes the endpoint using the given arguments.
abstract boolean	isConnected() Tests is there is at least one alive connection to a configured target cluster member over WAN.
void	pause() Calls to this method will pause WAN event queue polling.
void	populate(com.hazelcast.spi.LiveOperations liveOperations)
void	publishReplicationEvent(String serviceName, com.hazelcast.wan.ReplicationEventObject eventObject)
void	publishReplicationEvent(com.hazelcast.wan.WanReplicationEvent wanReplicationEvent) This implementation achieves ordering of keys in the same partition by sending EWRPutOperation to the partition owner.
void	publishReplicationEventBackup(String serviceName, com.hazelcast.wan.ReplicationEventObject eventObject)
void	publishSyncEvent(WanSyncEvent event) 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	removeReplicationEvent(com.hazelcast.wan.WanReplicationEvent wanReplicationEvent) Updates the WAN statistics (remaining map sync events, synced partitions, queued event count, latencies, sent events) and removes the backup events on the replicas.
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 class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

running

protected volatile boolean running

paused

protected volatile boolean paused

targetGroupName

protected String targetGroupName

localGroupName

protected String localGroupName

wanReplicationName

protected String wanReplicationName

node

protected com.hazelcast.instance.Node node

syncManager

protected WanSyncManager syncManager

queueCapacity

protected int queueCapacity

queueFullBehavior

protected com.hazelcast.config.WANQueueFullBehavior queueFullBehavior

lastQueueFullLogTimeMs

protected volatile long lastQueueFullLogTimeMs

queueLoggerTimePeriodMs

protected int queueLoggerTimePeriodMs

eventQueueContainer

protected PublisherQueueContainer eventQueueContainer

stagingQueue

protected BlockingQueue<com.hazelcast.wan.WanReplicationEvent> stagingQueue

Queue for multiplexed map/cache partition WAN events that are about to be transmitted to the target cluster

syncRequests

protected BlockingQueue<WanSyncEvent> syncRequests

configurationContext

protected WanConfigurationContext configurationContext

logger

protected com.hazelcast.logging.ILogger logger

Constructor Detail

AbstractWanPublisher

public AbstractWanPublisher()

Method Detail

init

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

Description copied from interface: WanReplicationEndpoint

Initializes the endpoint using the given arguments.

Specified by:

init in interface WanReplicationEndpoint

Parameters:

node - the current node that tries to connect

wanReplicationConfig - WanReplicationConfig config

publisherConfig - this endpoint will be initialized using this WanPublisherConfig instance

getStagingQueueSize

public int getStagingQueueSize()

getPartitionId

protected int getPartitionId(Object key)

publishReplicationEvent

public void publishReplicationEvent(String serviceName,
                                    com.hazelcast.wan.ReplicationEventObject eventObject)

Specified by:

publishReplicationEvent in interface com.hazelcast.wan.WanReplicationPublisher

publishReplicationEventBackup

public void publishReplicationEventBackup(String serviceName,
                                          com.hazelcast.wan.ReplicationEventObject eventObject)

Specified by:

publishReplicationEventBackup in interface com.hazelcast.wan.WanReplicationPublisher

removeReplicationEvent

public void removeReplicationEvent(com.hazelcast.wan.WanReplicationEvent wanReplicationEvent)

Updates the WAN statistics (remaining map sync events, synced partitions, queued event count, latencies, sent events) and removes the backup events on the replicas.

Parameters:

wanReplicationEvent - the completed replication event

Throws:

com.hazelcast.nio.serialization.HazelcastSerializationException - when the event fails to serialization

decrementWANQueueSize

protected void decrementWANQueueSize(int delta)

removeBackup

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

Description copied from interface: WanReplicationEndpoint

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.

Specified by:

removeBackup in interface WanReplicationEndpoint

Parameters:

wanReplicationEvent - the completed wan event

putBackup

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

Specified by:

putBackup in interface WanReplicationEndpoint

getPublisherQueueContainer

public PublisherQueueContainer getPublisherQueueContainer()

Specified by:

getPublisherQueueContainer in interface WanReplicationEndpoint

addMapQueue

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

Specified by:

addMapQueue in interface WanReplicationEndpoint

addCacheQueue

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

Specified by:

addCacheQueue in interface WanReplicationEndpoint

shutdown

public final void shutdown()

Description copied from interface: WanReplicationEndpoint

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

Specified by:

shutdown in interface WanReplicationEndpoint

afterShutdown

protected void afterShutdown()

pause

public void pause()

Description copied from interface: WanReplicationEndpoint

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.

Specified by:

pause in interface WanReplicationEndpoint

resume

public void resume()

Description copied from interface: WanReplicationEndpoint

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.

Specified by:

resume in interface WanReplicationEndpoint

See Also:

WanReplicationEndpoint.pause()

getStats

public com.hazelcast.monitor.LocalWanPublisherStats getStats()

Description copied from interface: WanReplicationEndpoint

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

Specified by:

getStats in interface WanReplicationEndpoint

Returns:

LocalWanPublisherStats

isConnected

public abstract boolean isConnected()

Tests is there is at least one alive connection to a configured target cluster member over WAN.

Returns:

true if there is at least one alive connection, false otherwise

checkWanReplicationQueues

public void checkWanReplicationQueues()

Specified by:

checkWanReplicationQueues in interface WanReplicationEndpoint

Specified by:

checkWanReplicationQueues in interface com.hazelcast.wan.WanReplicationPublisher

publishReplicationEvent

public void publishReplicationEvent(com.hazelcast.wan.WanReplicationEvent wanReplicationEvent)

This implementation achieves ordering of keys in the same partition by sending EWRPutOperation to the partition owner. The partition ID is equal to the partition for the key contained in the wanReplicationEvent.

Specified by:

publishReplicationEvent in interface com.hazelcast.wan.WanReplicationPublisher

Parameters:

wanReplicationEvent - the WAN event to publish

getTargetGroupName

public String getTargetGroupName()

populate

public void populate(com.hazelcast.spi.LiveOperations liveOperations)

Specified by:

populate in interface com.hazelcast.spi.LiveOperationsTracker

publishSyncEvent

public void publishSyncEvent(WanSyncEvent event)

Description copied from interface: WanReplicationEndpoint

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

Specified by:

publishSyncEvent in interface WanReplicationEndpoint

Parameters:

event - the wan sync request

clearQueues

public void clearQueues()

Specified by:

clearQueues in interface WanReplicationEndpoint

collectAllServiceNamespaces

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

Description copied from interface: WanReplicationEndpoint

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

Specified by:

collectAllServiceNamespaces in interface WanReplicationEndpoint

Parameters:

event - the replication event

namespaces - the set in which namespaces should be added

collectReplicationData

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

Description copied from interface: WanReplicationEndpoint

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

Specified by:

collectReplicationData in interface WanReplicationEndpoint

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

getCurrentElementCount

public int getCurrentElementCount()

Returns the count for the number of events currently in the WAN map/cache partition queues for partitions owned by this node.

getCurrentBackupElementCount

public int getCurrentBackupElementCount()