AbstractReplicationSourceChannel (GigaSpaces XAP 12.1.0 API)

java.lang.Object
- com.gigaspaces.internal.cluster.node.impl.groups.AbstractReplicationSourceChannel

All Implemented Interfaces:

IReplicationSourceChannel, IConnectionStateListener

Direct Known Subclasses:

AsyncReplicationSourceChannel, SyncReplicationSourceChannel
```
public abstract class AbstractReplicationSourceChannel
extends Object
implements IReplicationSourceChannel, IConnectionStateListener
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class AbstractReplicationSourceChannel.ChannelState

Nested Classes
Modifier and Type	Class and Description
`static class`	`AbstractReplicationSourceChannel.ChannelState`

Field Summary

Fields
Modifier and Type	Field and Description
`protected ThreadLocalPool<ReplicatedDataPacketResource>`	`_packetsPool`
`protected Logger`	`_specificLogger`
`protected Logger`	`_specificVerboseLogger`
`protected SegmentedAtomicInteger`	`_statisticsCounter`

Constructor Summary

Constructors
Constructor and Description
AbstractReplicationSourceChannel(DynamicSourceGroupConfigHolder groupConfig, String groupName, String memberName, IReplicationRouter replicationRouter, IReplicationMonitoredConnection connection, IReplicationGroupBacklog groupBacklog, IReplicationOutFilter outFilter, IAsyncHandlerProvider asyncHandlerProvider, IReplicationChannelDataFilter dataFilter, IReplicationSourceGroupStateListener stateListener, IReplicationGroupHistory groupHistory, ReplicationStatistics.ReplicationMode channelType, Object customBacklogMetadata)

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`beginSynchronizing()`
`void`	`beginSynchronizing(boolean isDirectPersistencySync)`
`void`	`close()`
`protected abstract void`	`closeImpl()`
`protected void`	`dispatchBacklogDropped(IBacklogMemberState memberState)`
`String`	`dumpState()`
`abstract void`	`flushPendingReplication()`
`abstract ReplicationStatistics.ReplicationOperatingMode`	`getChannelOpertingMode()`
`AbstractReplicationSourceChannel.ChannelState`	`getChannelState()`
`IReplicationMonitoredConnection`	`getConnection()`
`IReplicationChannelDataFilter`	`getDataFilter()`
`IReplicationGroupBacklog`	`getGroupBacklog()`
`String`	`getGroupName()`
`protected Throwable`	`getInconsistencyReason()`
`protected int`	`getLastSampledTP()`
`String`	`getMemberName()`
`String`	`getMyLookupName()`
`protected List<IReplicationOrderedPacket>`	`getPendingPackets(int batchSize)` Get a list of packets that are waiting to be replicated
`protected int`	`getSampleTPBefore(long timeBefore, TimeUnit unit)`
`IReplicationSourceChannelStatistics`	`getStatistics()`
`protected PlatformLogicalVersion`	`getTargetLogicalVersion()`
`ReplicationEndpointDetails`	`getTargetReplicationEndpointDetails()`
`boolean`	`isActive()`
`boolean`	`isClosed()`
`boolean`	`isDataFiltered()`
`boolean`	`isInconsistent()`
`boolean`	`isSynchronizing()`
`protected void`	`logEventInHistory(String event)`
`protected abstract void`	`onActiveImpl()`
`protected abstract void`	`onAsyncReplicateErrorResult(Throwable t, IReplicationOrderedPacket finalPacket)`
`protected abstract void`	`onAsyncReplicateErrorResult(Throwable t, List<IReplicationOrderedPacket> finalPackets)`
`void`	`onConnected(boolean newTarget)`
`void`	`onDisconnected()`
`protected abstract void`	`onDisconnectedImpl()`
`protected String`	`onDumpState()`
`boolean`	`pingTarget()`
`void`	`registerWith(MetricRegistrator metricRegister)`
`protected int`	`replicate(IReplicationOrderedPacket packet)`
`void`	`replicate(IReplicationUnreliableOperation operation)`
`protected Future`	`replicateAsync(IReplicationOrderedPacket packet)`
`protected Future`	`replicateAsync(List<IReplicationOrderedPacket> packets)`
`protected int`	`replicateBatch(List<IReplicationOrderedPacket> packets)` Replicate given packets
`protected void`	`replicateBatchDelayed(List<IReplicationOrderedPacket> packets)` This method should be called when replicating packets that were generated at a considerable time before the actual replication (i.e async replication), this will replicate only packets that are not obsolete (i.e `equals true`)
`protected void`	`replicateBatchDelayedAsync(List<IReplicationOrderedPacket> packets, IAsyncReplicationListener listener)`
`void`	`sampleStatistics()` Samples the channel through put, TP is measured between sample calls.
`void`	`signalSynchronizingDone()`
`protected void`	`start()`
`void`	`stopSynchronization()`
`void`	`synchronizationCopyStageDone()`
`boolean`	`synchronizationDataGenerated(String uid)`
`protected void`	`wrapConnection()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

_specificLogger
```
protected final Logger _specificLogger
```

_specificVerboseLogger

protected final Logger _specificVerboseLogger

_statisticsCounter

protected final SegmentedAtomicInteger _statisticsCounter

_packetsPool

protected final ThreadLocalPool<ReplicatedDataPacketResource> _packetsPool

Constructor Detail

AbstractReplicationSourceChannel

public AbstractReplicationSourceChannel(DynamicSourceGroupConfigHolder groupConfig,
                                        String groupName,
                                        String memberName,
                                        IReplicationRouter replicationRouter,
                                        IReplicationMonitoredConnection connection,
                                        IReplicationGroupBacklog groupBacklog,
                                        IReplicationOutFilter outFilter,
                                        IAsyncHandlerProvider asyncHandlerProvider,
                                        IReplicationChannelDataFilter dataFilter,
                                        IReplicationSourceGroupStateListener stateListener,
                                        IReplicationGroupHistory groupHistory,
                                        ReplicationStatistics.ReplicationMode channelType,
                                        Object customBacklogMetadata)

Method Detail

start
```
protected void start()
```

getGroupName
```
public String getGroupName()
```

getMemberName
```
public String getMemberName()
```

getMyLookupName
```
public String getMyLookupName()
```

getGroupBacklog

public IReplicationGroupBacklog getGroupBacklog()

getConnection

public IReplicationMonitoredConnection getConnection()

isDataFiltered
```
public boolean isDataFiltered()
```

getDataFilter

public IReplicationChannelDataFilter getDataFilter()

logEventInHistory

protected void logEventInHistory(String event)

wrapConnection
```
protected void wrapConnection()
```

onConnected
```
public void onConnected(boolean newTarget)
```
Specified by:

onConnected in interface IConnectionStateListener

onDisconnected
```
public void onDisconnected()
```
Specified by:

onDisconnected in interface IConnectionStateListener

dispatchBacklogDropped

protected void dispatchBacklogDropped(IBacklogMemberState memberState)
                               throws RemoteException

Throws:: RemoteException

onActiveImpl

protected abstract void onActiveImpl()

onDisconnectedImpl

protected abstract void onDisconnectedImpl()

isActive
```
public boolean isActive()
```

getChannelState

public AbstractReplicationSourceChannel.ChannelState getChannelState()

pingTarget
```
public boolean pingTarget()
```

isClosed
```
public boolean isClosed()
```

close
```
public void close()
```

closeImpl
```
protected abstract void closeImpl()
```

beginSynchronizing

public void beginSynchronizing(boolean isDirectPersistencySync)
                        throws CannotExecuteSynchronizeReplicaException

Throws:: CannotExecuteSynchronizeReplicaException

beginSynchronizing

public void beginSynchronizing()
                        throws CannotExecuteSynchronizeReplicaException

Throws:: CannotExecuteSynchronizeReplicaException

stopSynchronization
```
public void stopSynchronization()
```

isSynchronizing
```
public boolean isSynchronizing()
```

synchronizationDataGenerated

public boolean synchronizationDataGenerated(String uid)

synchronizationCopyStageDone

public void synchronizationCopyStageDone()

signalSynchronizingDone

public void signalSynchronizingDone()
                             throws RemoteException

Throws:: RemoteException

replicateBatch

protected int replicateBatch(List<IReplicationOrderedPacket> packets)
                      throws RemoteException,
                             ReplicationException

Replicate given packets

Returns:: number of completed replications
Throws:: RemoteException; ReplicationException

replicate

protected int replicate(IReplicationOrderedPacket packet)
                 throws RemoteException,
                        ReplicationException

Throws:: RemoteException; ReplicationException

replicateAsync

protected Future replicateAsync(List<IReplicationOrderedPacket> packets)
                         throws RemoteException

Throws:: RemoteException

replicateAsync

protected Future replicateAsync(IReplicationOrderedPacket packet)
                         throws RemoteException

Throws:: RemoteException

onAsyncReplicateErrorResult

protected abstract void onAsyncReplicateErrorResult(Throwable t,
                                                    List<IReplicationOrderedPacket> finalPackets)

onAsyncReplicateErrorResult

protected abstract void onAsyncReplicateErrorResult(Throwable t,
                                                    IReplicationOrderedPacket finalPacket)

replicateBatchDelayed
```
protected void replicateBatchDelayed(List<IReplicationOrderedPacket> packets)
                              throws RemoteException,
                                     ReplicationException
```
This method should be called when replicating packets that were generated at a considerable time before the actual replication (i.e async replication), this will replicate only packets that are not obsolete (i.e equals true)

Throws:

RemoteException

ReplicationException

replicateBatchDelayedAsync

protected void replicateBatchDelayedAsync(List<IReplicationOrderedPacket> packets,
                                          IAsyncReplicationListener listener)
                                   throws RemoteException

Throws:: RemoteException

getPendingPackets

protected List<IReplicationOrderedPacket> getPendingPackets(int batchSize)

Get a list of packets that are waiting to be replicated

sampleStatistics
```
public void sampleStatistics()
```
Samples the channel through put, TP is measured between sample calls.

getLastSampledTP
```
protected int getLastSampledTP()
```

getSampleTPBefore

protected int getSampleTPBefore(long timeBefore,
                                TimeUnit unit)

isInconsistent
```
public boolean isInconsistent()
```

getInconsistencyReason

protected Throwable getInconsistencyReason()

getStatistics

public IReplicationSourceChannelStatistics getStatistics()

registerWith

public void registerWith(MetricRegistrator metricRegister)

getChannelOpertingMode

public abstract ReplicationStatistics.ReplicationOperatingMode getChannelOpertingMode()

flushPendingReplication

public abstract void flushPendingReplication()

replicate

public void replicate(IReplicationUnreliableOperation operation)

dumpState
```
public String dumpState()
```

onDumpState
```
protected String onDumpState()
```

getTargetReplicationEndpointDetails

public ReplicationEndpointDetails getTargetReplicationEndpointDetails()

getTargetLogicalVersion

protected PlatformLogicalVersion getTargetLogicalVersion()

Class AbstractReplicationSourceChannel

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

_specificLogger

_specificVerboseLogger

_statisticsCounter

_packetsPool

Constructor Detail

AbstractReplicationSourceChannel

Method Detail

start

getGroupName

getMemberName

getMyLookupName

getGroupBacklog

getConnection

isDataFiltered

getDataFilter

logEventInHistory

wrapConnection

onConnected

onDisconnected

dispatchBacklogDropped

onActiveImpl

onDisconnectedImpl

isActive

getChannelState

pingTarget

isClosed

close

closeImpl

beginSynchronizing

beginSynchronizing

stopSynchronization

isSynchronizing

synchronizationDataGenerated

synchronizationCopyStageDone

signalSynchronizingDone

replicateBatch

replicate

replicateAsync

replicateAsync

onAsyncReplicateErrorResult

onAsyncReplicateErrorResult

replicateBatchDelayed

replicateBatchDelayedAsync

getPendingPackets

sampleStatistics

getLastSampledTP

getSampleTPBefore

isInconsistent

getInconsistencyReason

getStatistics

registerWith

getChannelOpertingMode

flushPendingReplication

replicate

dumpState

onDumpState

getTargetReplicationEndpointDetails

getTargetLogicalVersion