com.gigaspaces.internal.cluster.node.impl.groups

Class AbstractReplicationSourceGroup<T extends SourceGroupConfig>

java.lang.Object

com.gigaspaces.internal.cluster.node.impl.groups.AbstractReplicationSourceGroup<T>

All Implemented Interfaces:

DynamicSourceGroupConfigHolder.IDynamicSourceGroupStateListener, IReplicationGroupHistory, IReplicationSourceGroup

Direct Known Subclasses:

AsyncReplicationSourceGroup, ReliableAsyncReplicationSourceGroup, SyncReplicationSourceGroup

public abstract class AbstractReplicationSourceGroup<T extends SourceGroupConfig>
extends Object
implements IReplicationSourceGroup, IReplicationGroupHistory, DynamicSourceGroupConfigHolder.IDynamicSourceGroupStateListener

Field Summary

Fields

Modifier and Type	Field and Description
protected Object	_channelCreationLock
protected Logger	_specificLogger

Constructor Summary

Constructors

Constructor and Description
AbstractReplicationSourceGroup(DynamicSourceGroupConfigHolder groupConfigHolder, IReplicationRouter replicationRouter, IReplicationGroupBacklog groupBacklog, String myLookupName, IReplicationOutFilter outFilter, IAsyncHandlerProvider asyncHandlerProvider, IReplicationSourceGroupStateListener stateListener)

Method Summary

Modifier and Type	Method and Description
void	beginSynchronizing(String synchronizingMemberLookupName, Object synchronizingSourceUniqueId) Signal this source group that one of its channel is now used for space synchronization replica
void	beginSynchronizing(String synchronizingMemberLookupName, Object synchronizingSourceUniqueId, boolean isDirectPersistencySync)
boolean	checkChannelConnected(String sourceMemberLookupName)
void	close() Close this replication group, once closed it can no longer be used
protected void	closeReplicationChannels()
void	closeTemporaryChannel(String sourceMemberName) Closes a temporary created channel
protected void	createChannel(String memberLookupName, boolean dynamicMember, SourceGroupConfig config, boolean connectSynchronously, Object customBacklogMetadata)
protected abstract AbstractReplicationSourceChannel	createChannel(String memberLookupName, IReplicationRouter replicationRouter, IReplicationMonitoredConnection connection, IReplicationChannelDataFilter dataFilter, IReplicationGroupHistory groupHistory, boolean dynamicMember, SourceGroupConfig groupConfig, Object customBacklogMetadata)
protected void	createReplicationChannels()
void	createTemporaryChannel(String memberName, Object customBacklogMetadata) Creates a temporary channel to an existing member of this group, if a channel is already created then this method does nothing This method should be called when there is a need to create a temporary channel from this group to the target group to perform some operation and should not be used for a persistent channel
String	dumpState()
int	execute(IReplicationGroupOutContext groupContext) Executes the replication specified by the provided group context
void	execute(IReplicationUnreliableOperation operation)
protected abstract int	executeImpl(IReplicationGroupOutContext groupContext)
boolean	flushPendingReplication(long timeout, TimeUnit units)
IAsyncHandlerProvider	getAsyncHandlerProvider()
protected AbstractReplicationSourceChannel	getChannel(String memberLookupName)
ReplicationEndpointDetails	getChannelEndpointDetails(String sourceMemberLookupName)
EventsTracer<String>	getChannelHistory(String memberName)
Map<String,AbstractReplicationSourceChannel>	getChannels()
protected AbstractReplicationSourceChannel	getChannelSafe(String synchronizingMemberLookupName)
Map<String,Boolean>	getChannelsStatus()
DynamicSourceGroupConfigHolder	getConfigHolder()
IReplicationGroupBacklog	getGroupBacklog()
String	getGroupName()
protected String	getLogPrefix()
String	getMyLookupName()
IReplicationOutFilter	getOutFilter()
protected String[]	getPotentialRemovedMembers(SourceGroupConfig config)
IReplicationSourceGroupStateListener	getStateListener()
IReplicationSourceGroupStatistics	getStatistics()
void	logEvent(String memberName, String event)
void	logGroupEvent(String event)
void	memberAdded(MemberAddedEvent memberAddedEvent, SourceGroupConfig newConfig)
void	memberRemoved(String memberName, SourceGroupConfig newConfig)
void	monitorConsistencyLevel() Monitors sla state of the replication group
protected void	onClose()
protected abstract void	onCloseTemporaryChannel(String sourceMemberName, AbstractReplicationSourceChannel channel)
protected void	onMemberAdded(MemberAddedEvent memberAddedEvent, SourceGroupConfig newConfig)
protected void	onMemberRemoved(String memberName, SourceGroupConfig newConfig)
String	outputDescendingEvents(String memberName)
void	registerWith(MetricRegistrator metricRegister)
void	sampleStatistics()
protected void	scanAndRemoveDroppedMembers()
void	setActive(MetricRegistrator metricRegistrator)
void	setPassive(boolean closeProxy)
void	stopSynchronization(String synchronizingMemberLookupName) Signal this source group that one of its channel synchronization state is aborted IReplicationSourceGroup.beginSynchronizing(String, Object)
void	synchronizationCopyStageDone(String synchronizingMemberLookupName) During synchronization process, notify the channel specified by the target name that the copy iteration process is done in order for the filtering mechanism to know that any following packets occurred completely after the synchronization copy stage.
boolean	synchronizationDataGenerated(String synchronizingMemberLookupName, String uid) During synchronization process, notify the channel specified by the target name, that a sync data was generated in order for it to know to filter older data when replicating to target
protected void	validateGroupConsistencyLevelPolicy(GroupConsistencyLevelPolicy groupConsistencyLevelPolicy, T sourceGroupConfig)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.gigaspaces.internal.cluster.node.impl.groups.IReplicationSourceGroup

beforeExecute, beforeExecuteGeneric, beforeTransactionExecute

Field Detail

_specificLogger

protected final Logger _specificLogger

_channelCreationLock

protected final Object _channelCreationLock

Constructor Detail

AbstractReplicationSourceGroup

public AbstractReplicationSourceGroup(DynamicSourceGroupConfigHolder groupConfigHolder,
                                      IReplicationRouter replicationRouter,
                                      IReplicationGroupBacklog groupBacklog,
                                      String myLookupName,
                                      IReplicationOutFilter outFilter,
                                      IAsyncHandlerProvider asyncHandlerProvider,
                                      IReplicationSourceGroupStateListener stateListener)

Method Detail

validateGroupConsistencyLevelPolicy

protected void validateGroupConsistencyLevelPolicy(GroupConsistencyLevelPolicy groupConsistencyLevelPolicy,
                                                   T sourceGroupConfig)

logEvent

public void logEvent(String memberName,
                     String event)

Specified by:

logEvent in interface IReplicationGroupHistory

logGroupEvent

public void logGroupEvent(String event)

Specified by:

logGroupEvent in interface IReplicationGroupHistory

outputDescendingEvents

public String outputDescendingEvents(String memberName)

Specified by:

outputDescendingEvents in interface IReplicationGroupHistory

getChannelHistory

public EventsTracer<String> getChannelHistory(String memberName)

getMyLookupName

public String getMyLookupName()

getOutFilter

public IReplicationOutFilter getOutFilter()

getStateListener

public IReplicationSourceGroupStateListener getStateListener()

getAsyncHandlerProvider

public IAsyncHandlerProvider getAsyncHandlerProvider()

createReplicationChannels

protected void createReplicationChannels()

closeReplicationChannels

protected void closeReplicationChannels()

memberAdded

public void memberAdded(MemberAddedEvent memberAddedEvent,
                        SourceGroupConfig newConfig)

Specified by:

memberAdded in interface DynamicSourceGroupConfigHolder.IDynamicSourceGroupStateListener

memberRemoved

public void memberRemoved(String memberName,
                          SourceGroupConfig newConfig)

Specified by:

memberRemoved in interface DynamicSourceGroupConfigHolder.IDynamicSourceGroupStateListener

onMemberRemoved

protected void onMemberRemoved(String memberName,
                               SourceGroupConfig newConfig)

onMemberAdded

protected void onMemberAdded(MemberAddedEvent memberAddedEvent,
                             SourceGroupConfig newConfig)

createTemporaryChannel

public void createTemporaryChannel(String memberName,
                                   Object customBacklogMetadata)

Description copied from interface: IReplicationSourceGroup

Creates a temporary channel to an existing member of this group, if a channel is already created then this method does nothing This method should be called when there is a need to create a temporary channel from this group to the target group to perform some operation and should not be used for a persistent channel

Specified by:

createTemporaryChannel in interface IReplicationSourceGroup

Parameters:

memberName - group member to create the channel to

closeTemporaryChannel

public void closeTemporaryChannel(String sourceMemberName)

Description copied from interface: IReplicationSourceGroup

Closes a temporary created channel

Specified by:

closeTemporaryChannel in interface IReplicationSourceGroup

See Also:

IReplicationSourceGroup.createTemporaryChannel(String, Object)

onCloseTemporaryChannel

protected abstract void onCloseTemporaryChannel(String sourceMemberName,
                                                AbstractReplicationSourceChannel channel)

createChannel

protected void createChannel(String memberLookupName,
                             boolean dynamicMember,
                             SourceGroupConfig config,
                             boolean connectSynchronously,
                             Object customBacklogMetadata)

execute

public int execute(IReplicationGroupOutContext groupContext)

Description copied from interface: IReplicationSourceGroup

Executes the replication specified by the provided group context

Specified by:

execute in interface IReplicationSourceGroup

Returns:

true iff the replication ended.

executeImpl

protected abstract int executeImpl(IReplicationGroupOutContext groupContext)

execute

public void execute(IReplicationUnreliableOperation operation)

Specified by:

execute in interface IReplicationSourceGroup

createChannel

protected abstract AbstractReplicationSourceChannel createChannel(String memberLookupName,
                                                                  IReplicationRouter replicationRouter,
                                                                  IReplicationMonitoredConnection connection,
                                                                  IReplicationChannelDataFilter dataFilter,
                                                                  IReplicationGroupHistory groupHistory,
                                                                  boolean dynamicMember,
                                                                  SourceGroupConfig groupConfig,
                                                                  Object customBacklogMetadata)

getGroupName

public String getGroupName()

Specified by:

getGroupName in interface IReplicationSourceGroup

Returns:

group name

getConfigHolder

public DynamicSourceGroupConfigHolder getConfigHolder()

Specified by:

getConfigHolder in interface IReplicationSourceGroup

getChannel

protected AbstractReplicationSourceChannel getChannel(String memberLookupName)

beginSynchronizing

public void beginSynchronizing(String synchronizingMemberLookupName,
                               Object synchronizingSourceUniqueId,
                               boolean isDirectPersistencySync)

Specified by:

beginSynchronizing in interface IReplicationSourceGroup

beginSynchronizing

public void beginSynchronizing(String synchronizingMemberLookupName,
                               Object synchronizingSourceUniqueId)

Description copied from interface: IReplicationSourceGroup

Signal this source group that one of its channel is now used for space synchronization replica

Specified by:

beginSynchronizing in interface IReplicationSourceGroup

Parameters:

synchronizingMemberLookupName - the channel target name that is used for synchronization

getChannelSafe

protected AbstractReplicationSourceChannel getChannelSafe(String synchronizingMemberLookupName)

synchronizationDataGenerated

public boolean synchronizationDataGenerated(String synchronizingMemberLookupName,
                                            String uid)

Description copied from interface: IReplicationSourceGroup

During synchronization process, notify the channel specified by the target name, that a sync data was generated in order for it to know to filter older data when replicating to target

Specified by:

synchronizationDataGenerated in interface IReplicationSourceGroup

synchronizationCopyStageDone

public void synchronizationCopyStageDone(String synchronizingMemberLookupName)

Description copied from interface: IReplicationSourceGroup

During synchronization process, notify the channel specified by the target name that the copy iteration process is done in order for the filtering mechanism to know that any following packets occurred completely after the synchronization copy stage.

Specified by:

synchronizationCopyStageDone in interface IReplicationSourceGroup

stopSynchronization

public void stopSynchronization(String synchronizingMemberLookupName)

Description copied from interface: IReplicationSourceGroup

Signal this source group that one of its channel synchronization state is aborted IReplicationSourceGroup.beginSynchronizing(String, Object)

Specified by:

stopSynchronization in interface IReplicationSourceGroup

checkChannelConnected

public boolean checkChannelConnected(String sourceMemberLookupName)

Specified by:

checkChannelConnected in interface IReplicationSourceGroup

Returns:

true is an underlying channel to the specified member is connected

getChannelEndpointDetails

public ReplicationEndpointDetails getChannelEndpointDetails(String sourceMemberLookupName)

Specified by:

getChannelEndpointDetails in interface IReplicationSourceGroup

getGroupBacklog

public IReplicationGroupBacklog getGroupBacklog()

Specified by:

getGroupBacklog in interface IReplicationSourceGroup

Returns:

underlying group backlog

close

public void close()

Description copied from interface: IReplicationSourceGroup

Close this replication group, once closed it can no longer be used

Specified by:

close in interface IReplicationSourceGroup

onClose

protected void onClose()

getChannelsStatus

public Map<String,Boolean> getChannelsStatus()

Specified by:

getChannelsStatus in interface IReplicationSourceGroup

getLogPrefix

protected String getLogPrefix()

setActive

public void setActive(MetricRegistrator metricRegistrator)

Specified by:

setActive in interface IReplicationSourceGroup

setPassive

public void setPassive(boolean closeProxy)

Specified by:

setPassive in interface IReplicationSourceGroup

Parameters:

closeProxy - - whether to close the stub proxy when it has no more references.

getChannels

public Map<String,AbstractReplicationSourceChannel> getChannels()

sampleStatistics

public void sampleStatistics()

Specified by:

sampleStatistics in interface IReplicationSourceGroup

getStatistics

public IReplicationSourceGroupStatistics getStatistics()

Specified by:

getStatistics in interface IReplicationSourceGroup

registerWith

public void registerWith(MetricRegistrator metricRegister)

Specified by:

registerWith in interface IReplicationSourceGroup

monitorConsistencyLevel

public void monitorConsistencyLevel()
                             throws ConsistencyLevelViolationException

Description copied from interface: IReplicationSourceGroup

Monitors sla state of the replication group

Specified by:

monitorConsistencyLevel in interface IReplicationSourceGroup

Throws:

ConsistencyLevelViolationException - if the sla is breached

flushPendingReplication

public boolean flushPendingReplication(long timeout,
                                       TimeUnit units)

Specified by:

flushPendingReplication in interface IReplicationSourceGroup

scanAndRemoveDroppedMembers

protected void scanAndRemoveDroppedMembers()

getPotentialRemovedMembers

protected String[] getPotentialRemovedMembers(SourceGroupConfig config)

dumpState

public String dumpState()

Specified by:

dumpState in interface IReplicationSourceGroup