com.gigaspaces.internal.cluster.node.impl.backlog

Class AbstractSingleFileGroupBacklog<T extends IReplicationOrderedPacket,CType extends AbstractSingleFileConfirmationHolder>

java.lang.Object

com.gigaspaces.internal.cluster.node.impl.backlog.AbstractSingleFileGroupBacklog<T,CType>

All Implemented Interfaces:

IReplicationGroupBacklog, DynamicSourceGroupConfigHolder.IDynamicSourceGroupStateListener

Direct Known Subclasses:

AbstractGlobalOrderGroupBacklog, AbstractMultiBucketSingleFileGroupBacklog, AbstractMultiSourceSingleFileGroupBacklog

public abstract class AbstractSingleFileGroupBacklog<T extends IReplicationOrderedPacket,CType extends AbstractSingleFileConfirmationHolder>
extends Object
implements IReplicationGroupBacklog, DynamicSourceGroupConfigHolder.IDynamicSourceGroupStateListener

A base class for IReplicationGroupBacklog that contains a single IRedoLogFile and treat the order of packets in that file for the global order of the backlog

Since:

8.0

Author:

eitany

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	AbstractSingleFileGroupBacklog.CaluclateMinUnconfirmedKeyProcedure

Field Summary

Fields

Modifier and Type	Field and Description
protected IPacketFilteredHandler	_defaultFilteredHandler
protected Logger	_logger
protected static Logger	_loggerReplica
protected Set<String>	_outOfSyncDueToDeletionTargets
protected ReadWriteLock	_rwLock

Constructor Summary

Constructors

Constructor and Description
AbstractSingleFileGroupBacklog(DynamicSourceGroupConfigHolder groupConfigHolder, String name, IReplicationPacketDataProducer<?> dataProducer)

Method Summary

Modifier and Type	Method and Description
protected void	appendConfirmationStateString(StringBuilder dump)
void	beginSynchronizing(String memberName)
void	beginSynchronizing(String memberName, boolean isDirectPersistencySync)
protected SynchronizingData	checkSynchronizingDone(SynchronizingData synchronizingData, long currentKey, String memberName)
protected void	cleanPendingErrorStateIfNeeded(String memberName, long packetKeykey, AbstractSingleFileConfirmationHolder confirmationHolder)
protected void	clearConfirmedPackets()
void	clearReplicated()
void	close()
protected abstract T	createBacklogOverflowPacket(long globalLastConfirmedKey, long firstKeyInBacklog, String memberName)
protected abstract Map<String,CType>	createConfirmationMap(SourceGroupConfig groupConfig)
protected abstract CType	createNewConfirmationHolder()
void	decreaseWeight(String memberName, long lastConfirmedKey, long newlyConfirmedKey, AbstractSingleFileConfirmationHolder confirmationHolder)
protected void	decreaseWeightToAllMembersFromOldestPacket(long toKey)
protected abstract void	deleteBatchFromBacklog(long deletionBatchSize)
protected void	ensureLimit(IReplicationPacketData<?> data)
protected T	filterPacketForSynchronizing(SynchronizingData synchronizingData, T packet, IPacketFilteredHandler filteredHandler, IReplicationPacketDataProducer dataProducer, Logger logger, String memberName, PlatformLogicalVersion targetMemberVersion)
void	freeWriteLock()
protected Collection<CType>	getAllConfirmationHoldersUnsafe()
protected Set<Map.Entry<String,CType>>	getAllConfirmations()
protected Set<Map.Entry<String,CType>>	getAllConfirmations(String... filterMembers)
protected IRedoLogFile<T>	getBacklogFile()
protected CType	getConfirmationHolderUnsafe(String memberName)
IMarker	getCurrentMarker(String memberName) Returns a marker of the current last position of the backlog
IReplicationPacketDataProducer	getDataProducer()
protected IPacketFilteredHandler	getFilteredHandler()
protected long	getFirstKeyInBacklogInternal()
protected long	getFirstRequiredKeyUnsafe(String memberName)
protected <T extends SourceGroupConfig> T	getGroupConfigSnapshot()
String	getGroupName()
protected long	getInitialMaxAllowedDeleteUpTo()
protected abstract long	getLastConfirmedKeyUnsafe(String memberLookupName)
protected long	getLastInsertedKeyToBacklogUnsafe()
protected String	getLogPrefix()
IMarker	getMarker(IReplicationOrderedPacket packet, String membersGroupName)
protected Set<String>	getMembersToValidateAgainst()
protected abstract long	getMemberUnconfirmedKey(CType value)
protected long	getMinimumUnconfirmedKeyUnsafe()
String	getName()
IHandshakeIteration	getNextHandshakeIteration(String memberName, IHandshakeContext handshakeContext)
protected long	getNextKeyUnsafe()
List<IReplicationOrderedPacket>	getPackets(String memberName, int maxSize, IReplicationChannelDataFilter filter, PlatformLogicalVersion targetMemberVersion, Logger logger)
List<IReplicationOrderedPacket>	getPacketsUnsafe(String memberName, int maxWeight, long upToKey, IReplicationChannelDataFilter dataFilter, IPacketFilteredHandler filteredHandler, PlatformLogicalVersion targetMemberVersion, Logger logger)
protected List<IReplicationOrderedPacket>	getPacketsWithFullSerializedContent(long fromKey, long upToKey, int maxWeight)
T	getSpecificPacket(long packetKey) Gets a specific packet inside the backlog
protected List<T>	getSpecificPackets(long startPacketKey, long endPacketKey)
IRedoLogStatistics	getStatistics()
IMarker	getUnconfirmedMarker(String memberName) Returns a marker of the current unconfirmed packet of this given member
long	getWeight()
long	getWeight(String memberName)
long	getWeightUnsafe(String memberName)
protected void	handlePendingErrorBatchPackets(String memberName, List<IReplicationOrderedPacket> packets, Throwable error, long potentialLastUnprocessedKey)
protected void	handlePendingErrorSinglePacket(String memberName, IReplicationOrderedPacket packet, Throwable error)
protected boolean	hasExistingMember()
protected void	increaseAllMembersWeight(long weight, long key)
void	increaseWeight(String memberName, long weight, AbstractSingleFileConfirmationHolder confirmationHolder)
protected void	insertReplicationOrderedPacketToBacklog(T packet, ReplicationOutContext outContext)
protected boolean	isBacklogDroppedEntirely()
boolean	isMarkerReached(String memberName, long markedKey)
protected SynchronizingData	isSynchronizing(String memberName)
protected void	logPendingErrorResolved(String memberName, Throwable error)
void	makeMemberConfirmedOnAll(String memberName) Called once a new member addition is known to the available keepers
void	memberAdded(MemberAddedEvent memberAddedParam, SourceGroupConfig newConfig)
void	memberRemoved(String memberName, SourceGroupConfig newConfig)
void	monitor(OperationWeightInfo info)
protected abstract void	onBeginSynchronization(String memberName)
void	printRedoLog(String _name, String from)
void	registerWith(MetricRegistrator metricRegister)
protected void	removeSynchronizingState(long currentKey, String memberName)
void	setGroupHistory(IReplicationGroupHistory groupHistory)
protected void	setNextKeyUnsafe(long newNextKey)
protected void	setPacketWeight(IReplicationPacketData<?> data)
void	setPendingError(String memberName, Throwable error, IIdleStateData idleStateData)
void	setPendingError(String memberName, Throwable error, IReplicationOrderedPacket replicatedPacket)
void	setPendingError(String memberName, Throwable error, List<IReplicationOrderedPacket> replicatedPackets)
void	setStateListener(IReplicationBacklogStateListener stateListener)
protected boolean	shouldInsertPacket(IReplicationPacketData<?> data)
long	size()
long	size(String memberName)
void	stopSynchronization(String memberName)
void	synchronizationCopyStageDone(String memberName)
boolean	synchronizationDataGenerated(String memberName, String uid)
void	synchronizationDone(String memberName)
protected long	takeNextKeyUnsafe(ReplicationOutContext replicationOutContext)
String	toLogMessage(String memberName)
protected String	toString(List<IReplicationOrderedPacket> packets)
protected void	updateBacklogLimitations(SourceGroupConfig groupConfig)
protected void	validateIntegrity()
protected void	validateReliableAsyncUpdateTargetsMatch(IReliableAsyncState reliableAsyncState, String sourceMemberName)
void	writeLock()

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.backlog.IReplicationGroupBacklog

dumpState, fromWireForm, getConfirmed, getHandshakeRequest, getIdleStateData, getState, mergeWithDiscarded, processHandshakeResponse, processIdleStateDataResult, processResult, processResult, replaceWithDiscarded, supportDiscardMerge

Field Detail

_loggerReplica

protected static final Logger _loggerReplica

_logger

protected final Logger _logger

_outOfSyncDueToDeletionTargets

protected final Set<String> _outOfSyncDueToDeletionTargets

_defaultFilteredHandler

protected final IPacketFilteredHandler _defaultFilteredHandler

_rwLock

protected final ReadWriteLock _rwLock

Constructor Detail

AbstractSingleFileGroupBacklog

public AbstractSingleFileGroupBacklog(DynamicSourceGroupConfigHolder groupConfigHolder,
                                      String name,
                                      IReplicationPacketDataProducer<?> dataProducer)

Method Detail

updateBacklogLimitations

protected void updateBacklogLimitations(SourceGroupConfig groupConfig)

createConfirmationMap

protected abstract Map<String,CType> createConfirmationMap(SourceGroupConfig groupConfig)

hasExistingMember

protected boolean hasExistingMember()

memberAdded

public void memberAdded(MemberAddedEvent memberAddedParam,
                        SourceGroupConfig newConfig)

Specified by:

memberAdded in interface DynamicSourceGroupConfigHolder.IDynamicSourceGroupStateListener

makeMemberConfirmedOnAll

public void makeMemberConfirmedOnAll(String memberName)

Description copied from interface: IReplicationGroupBacklog

Called once a new member addition is known to the available keepers

Specified by:

makeMemberConfirmedOnAll in interface IReplicationGroupBacklog

Parameters:

memberName - new member name

memberRemoved

public void memberRemoved(String memberName,
                          SourceGroupConfig newConfig)

Specified by:

memberRemoved in interface DynamicSourceGroupConfigHolder.IDynamicSourceGroupStateListener

getConfirmationHolderUnsafe

protected CType getConfirmationHolderUnsafe(String memberName)

validateReliableAsyncUpdateTargetsMatch

protected void validateReliableAsyncUpdateTargetsMatch(IReliableAsyncState reliableAsyncState,
                                                       String sourceMemberName)
                                                throws NoSuchReplicationMemberException,
                                                       MissingReliableAsyncTargetStateException

Throws:

NoSuchReplicationMemberException

MissingReliableAsyncTargetStateException

getMembersToValidateAgainst

protected Set<String> getMembersToValidateAgainst()

getAllConfirmationHoldersUnsafe

protected Collection<CType> getAllConfirmationHoldersUnsafe()

getAllConfirmations

protected Set<Map.Entry<String,CType>> getAllConfirmations(String... filterMembers)

getAllConfirmations

protected Set<Map.Entry<String,CType>> getAllConfirmations()

createNewConfirmationHolder

protected abstract CType createNewConfirmationHolder()

getFirstKeyInBacklogInternal

protected long getFirstKeyInBacklogInternal()

monitor

public void monitor(OperationWeightInfo info)
             throws RedoLogCapacityExceededException

Specified by:

monitor in interface IReplicationGroupBacklog

Throws:

RedoLogCapacityExceededException

isBacklogDroppedEntirely

protected boolean isBacklogDroppedEntirely()

ensureLimit

protected void ensureLimit(IReplicationPacketData<?> data)

deleteBatchFromBacklog

protected abstract void deleteBatchFromBacklog(long deletionBatchSize)

getInitialMaxAllowedDeleteUpTo

protected long getInitialMaxAllowedDeleteUpTo()

getLastConfirmedKeyUnsafe

protected abstract long getLastConfirmedKeyUnsafe(String memberLookupName)

isSynchronizing

protected SynchronizingData isSynchronizing(String memberName)

checkSynchronizingDone

protected SynchronizingData checkSynchronizingDone(SynchronizingData synchronizingData,
                                                   long currentKey,
                                                   String memberName)

removeSynchronizingState

protected void removeSynchronizingState(long currentKey,
                                        String memberName)

beginSynchronizing

public void beginSynchronizing(String memberName)

Specified by:

beginSynchronizing in interface IReplicationGroupBacklog

beginSynchronizing

public void beginSynchronizing(String memberName,
                               boolean isDirectPersistencySync)

Specified by:

beginSynchronizing in interface IReplicationGroupBacklog

onBeginSynchronization

protected abstract void onBeginSynchronization(String memberName)

synchronizationDataGenerated

public boolean synchronizationDataGenerated(String memberName,
                                            String uid)

Specified by:

synchronizationDataGenerated in interface IReplicationGroupBacklog

synchronizationCopyStageDone

public void synchronizationCopyStageDone(String memberName)

Specified by:

synchronizationCopyStageDone in interface IReplicationGroupBacklog

synchronizationDone

public void synchronizationDone(String memberName)

Specified by:

synchronizationDone in interface IReplicationGroupBacklog

stopSynchronization

public void stopSynchronization(String memberName)

Specified by:

stopSynchronization in interface IReplicationGroupBacklog

getPackets

public List<IReplicationOrderedPacket> getPackets(String memberName,
                                                  int maxSize,
                                                  IReplicationChannelDataFilter filter,
                                                  PlatformLogicalVersion targetMemberVersion,
                                                  Logger logger)

Specified by:

getPackets in interface IReplicationGroupBacklog

getPacketsUnsafe

public List<IReplicationOrderedPacket> getPacketsUnsafe(String memberName,
                                                        int maxWeight,
                                                        long upToKey,
                                                        IReplicationChannelDataFilter dataFilter,
                                                        IPacketFilteredHandler filteredHandler,
                                                        PlatformLogicalVersion targetMemberVersion,
                                                        Logger logger)

getFirstRequiredKeyUnsafe

protected long getFirstRequiredKeyUnsafe(String memberName)

createBacklogOverflowPacket

protected abstract T createBacklogOverflowPacket(long globalLastConfirmedKey,
                                                 long firstKeyInBacklog,
                                                 String memberName)

getFilteredHandler

protected IPacketFilteredHandler getFilteredHandler()

filterPacketForSynchronizing

protected T filterPacketForSynchronizing(SynchronizingData synchronizingData,
                                         T packet,
                                         IPacketFilteredHandler filteredHandler,
                                         IReplicationPacketDataProducer dataProducer,
                                         Logger logger,
                                         String memberName,
                                         PlatformLogicalVersion targetMemberVersion)

clearReplicated

public void clearReplicated()

Specified by:

clearReplicated in interface IReplicationGroupBacklog

clearConfirmedPackets

protected void clearConfirmedPackets()

getMinimumUnconfirmedKeyUnsafe

protected long getMinimumUnconfirmedKeyUnsafe()

getMemberUnconfirmedKey

protected abstract long getMemberUnconfirmedKey(CType value)

size

public long size(String memberName)

Specified by:

size in interface IReplicationGroupBacklog

size

public long size()

Specified by:

size in interface IReplicationGroupBacklog

getCurrentMarker

public IMarker getCurrentMarker(String memberName)

Description copied from interface: IReplicationGroupBacklog

Returns a marker of the current last position of the backlog

Specified by:

getCurrentMarker in interface IReplicationGroupBacklog

Parameters:

memberName - the member we wish this marker will be attached to

getMarker

public IMarker getMarker(IReplicationOrderedPacket packet,
                         String membersGroupName)

Specified by:

getMarker in interface IReplicationGroupBacklog

getNextKeyUnsafe

protected long getNextKeyUnsafe()

getLastInsertedKeyToBacklogUnsafe

protected long getLastInsertedKeyToBacklogUnsafe()

takeNextKeyUnsafe

protected long takeNextKeyUnsafe(ReplicationOutContext replicationOutContext)

setNextKeyUnsafe

protected void setNextKeyUnsafe(long newNextKey)

getUnconfirmedMarker

public IMarker getUnconfirmedMarker(String memberName)

Description copied from interface: IReplicationGroupBacklog

Returns a marker of the current unconfirmed packet of this given member

Specified by:

getUnconfirmedMarker in interface IReplicationGroupBacklog

Parameters:

memberName - the member we wish this marker will be attached to

isMarkerReached

public boolean isMarkerReached(String memberName,
                               long markedKey)

toLogMessage

public String toLogMessage(String memberName)

Specified by:

toLogMessage in interface IReplicationGroupBacklog

validateIntegrity

protected void validateIntegrity()

getNextHandshakeIteration

public IHandshakeIteration getNextHandshakeIteration(String memberName,
                                                     IHandshakeContext handshakeContext)

Specified by:

getNextHandshakeIteration in interface IReplicationGroupBacklog

getStatistics

public IRedoLogStatistics getStatistics()

Specified by:

getStatistics in interface IReplicationGroupBacklog

registerWith

public void registerWith(MetricRegistrator metricRegister)

Specified by:

registerWith in interface IReplicationGroupBacklog

close

public void close()

Specified by:

close in interface IReplicationGroupBacklog

getName

public String getName()

getGroupName

public String getGroupName()

getBacklogFile

protected IRedoLogFile<T> getBacklogFile()

getDataProducer

public IReplicationPacketDataProducer getDataProducer()

Specified by:

getDataProducer in interface IReplicationGroupBacklog

Returns:

the data producer this group backlog is using to generate replication data

setGroupHistory

public void setGroupHistory(IReplicationGroupHistory groupHistory)

Specified by:

setGroupHistory in interface IReplicationGroupBacklog

setStateListener

public void setStateListener(IReplicationBacklogStateListener stateListener)

Specified by:

setStateListener in interface IReplicationGroupBacklog

setPendingError

public void setPendingError(String memberName,
                            Throwable error,
                            IIdleStateData idleStateData)

Specified by:

setPendingError in interface IReplicationGroupBacklog

setPendingError

public void setPendingError(String memberName,
                            Throwable error,
                            IReplicationOrderedPacket replicatedPacket)

Specified by:

setPendingError in interface IReplicationGroupBacklog

setPendingError

public void setPendingError(String memberName,
                            Throwable error,
                            List<IReplicationOrderedPacket> replicatedPackets)

Specified by:

setPendingError in interface IReplicationGroupBacklog

getLogPrefix

protected String getLogPrefix()

logPendingErrorResolved

protected void logPendingErrorResolved(String memberName,
                                       Throwable error)

handlePendingErrorBatchPackets

protected void handlePendingErrorBatchPackets(String memberName,
                                              List<IReplicationOrderedPacket> packets,
                                              Throwable error,
                                              long potentialLastUnprocessedKey)

toString

protected String toString(List<IReplicationOrderedPacket> packets)

handlePendingErrorSinglePacket

protected void handlePendingErrorSinglePacket(String memberName,
                                              IReplicationOrderedPacket packet,
                                              Throwable error)

cleanPendingErrorStateIfNeeded

protected void cleanPendingErrorStateIfNeeded(String memberName,
                                              long packetKeykey,
                                              AbstractSingleFileConfirmationHolder confirmationHolder)

setPacketWeight

protected void setPacketWeight(IReplicationPacketData<?> data)

shouldInsertPacket

protected boolean shouldInsertPacket(IReplicationPacketData<?> data)

getGroupConfigSnapshot

protected <T extends SourceGroupConfig> T getGroupConfigSnapshot()

appendConfirmationStateString

protected void appendConfirmationStateString(StringBuilder dump)

getSpecificPacket

public T getSpecificPacket(long packetKey)

Description copied from interface: IReplicationGroupBacklog

Gets a specific packet inside the backlog

Specified by:

getSpecificPacket in interface IReplicationGroupBacklog

getSpecificPackets

protected List<T> getSpecificPackets(long startPacketKey,
                                     long endPacketKey)

getPacketsWithFullSerializedContent

protected List<IReplicationOrderedPacket> getPacketsWithFullSerializedContent(long fromKey,
                                                                              long upToKey,
                                                                              int maxWeight)

insertReplicationOrderedPacketToBacklog

protected void insertReplicationOrderedPacketToBacklog(T packet,
                                                       ReplicationOutContext outContext)

writeLock

public void writeLock()

Specified by:

writeLock in interface IReplicationGroupBacklog

freeWriteLock

public void freeWriteLock()

Specified by:

freeWriteLock in interface IReplicationGroupBacklog

getWeight

public long getWeight()

Specified by:

getWeight in interface IReplicationGroupBacklog

getWeight

public long getWeight(String memberName)

Specified by:

getWeight in interface IReplicationGroupBacklog

getWeightUnsafe

public long getWeightUnsafe(String memberName)

increaseWeight

public void increaseWeight(String memberName,
                           long weight,
                           AbstractSingleFileConfirmationHolder confirmationHolder)

Specified by:

increaseWeight in interface IReplicationGroupBacklog

decreaseWeight

public void decreaseWeight(String memberName,
                           long lastConfirmedKey,
                           long newlyConfirmedKey,
                           AbstractSingleFileConfirmationHolder confirmationHolder)

Specified by:

decreaseWeight in interface IReplicationGroupBacklog

decreaseWeightToAllMembersFromOldestPacket

protected void decreaseWeightToAllMembersFromOldestPacket(long toKey)

increaseAllMembersWeight

protected void increaseAllMembersWeight(long weight,
                                        long key)

printRedoLog

public void printRedoLog(String _name,
                         String from)