Package com.gigaspaces.internal.cluster.node.impl.gateway.sink

Class AbstractLocalClusterOperationData

java.lang.Object

com.gigaspaces.internal.cluster.node.impl.gateway.sink.AbstractLocalClusterOperationData

All Implemented Interfaces:

DataConflictOperation, DataSyncOperation

Direct Known Subclasses:

AbstractLocalClusterWriteOperationData, LocalClusterChangeOperationData, LocalClusterRemoveByUIDOperationData

public abstract class AbstractLocalClusterOperationData
extends Object
implements DataConflictOperation

A base class for Local Cluster operations data. Operation data instances are created after a gateway Sink component receives a replication batch of operations to execute and each operation is translated to a local cluster operation, which eventually uses an ISpaceProxy instance for executing the operations against the local cluster. Batch supported operations will merged together in order to gain better performance by using writeMultiple etc..

Since:

8.0.3

Author:

idan

Nested Class Summary

Nested classes/interfaces inherited from interface com.gigaspaces.cluster.replication.gateway.conflict.DataConflictOperation

DataConflictOperation.OperationType

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	_aborted
protected ConflictCause	_conflictCause
protected List<AbstractLocalClusterOperationData>	_pendingOperations
protected ConflictCause	_previousConflictCause	After each execution the execution result is reset.
protected int	_retriesCount
protected final ISpaceProxy	_spaceProxy

Constructor Summary

Constructors

Constructor	Description
AbstractLocalClusterOperationData(ISpaceProxy spaceProxy, ITypeDesc typeDescriptor)

Method Summary

Modifier and Type	Method	Description
void	abort()	Determines that the operation will be aborted.
void	addPendingOperation(AbstractLocalClusterOperationData operationData)	Add an AbstractLocalClusterOperationData to the current instance (merge for execution).
protected ConflictCause	convertExceptionToConflict(Throwable error)
abstract boolean	execute(Transaction transaction)	Executes the operation against the provided ISpaceProxy with the provided Transaction instance.
ConflictCause	getConflictCause()
String	getResolutionDescription()
int	getResolveAttempt()
protected int	getRetriesCount()
SpaceTypeDescriptor	getTypeDescriptor()
boolean	hasConflict()
protected void	incrementResolveAttempt()
protected void	incrementRetriesCounter()
boolean	isAborted()
protected boolean	isOverriden()
protected boolean	isRetryable(int maximumRetries)
boolean	isSameOperationType(AbstractLocalClusterOperationData operationData)
void	override()	Determines that the operation will be overridden.
protected void	overrideImpl()
void	reset()
void	setConflictCause(ConflictCause conflictCause)
boolean	supportsAbort()
abstract boolean	supportsBatching()
boolean	supportsGetTypeDescriptor()
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.gigaspaces.cluster.replication.gateway.conflict.DataConflictOperation

getOperationEntry, getOperationType, supportsOverride

Methods inherited from interface com.gigaspaces.sync.DataSyncOperation

getDataAsDocument, getDataAsObject, getDataSyncOperationType, getSpaceId, getUid, supportsDataAsDocument, supportsDataAsObject, supportsGetSpaceId

Field Details

_pendingOperations

protected List<AbstractLocalClusterOperationData> _pendingOperations

_conflictCause

protected ConflictCause _conflictCause

_aborted

protected boolean _aborted

_spaceProxy

protected final ISpaceProxy _spaceProxy

_retriesCount

protected int _retriesCount

_previousConflictCause

protected ConflictCause _previousConflictCause

After each execution the execution result is reset. We need the conflict cause to be kept for the next execution.

Constructor Details

AbstractLocalClusterOperationData

public AbstractLocalClusterOperationData(ISpaceProxy spaceProxy,
 ITypeDesc typeDescriptor)

Method Details

isSameOperationType

public boolean isSameOperationType(AbstractLocalClusterOperationData operationData)

Returns:

true if the provided AbstractLocalClusterOperationData is of the same class type.

addPendingOperation

public void addPendingOperation(AbstractLocalClusterOperationData operationData)

Add an AbstractLocalClusterOperationData to the current instance (merge for execution).

Parameters:

operationData - The AbstractLocalClusterOperationData to add.

execute

public abstract boolean execute(Transaction transaction)
                         throws Exception

Executes the operation against the provided ISpaceProxy with the provided Transaction instance.

Parameters:

transaction - The Transaction to with the operations.

Throws:

Exception

supportsBatching

public abstract boolean supportsBatching()

Returns:

true if the operation supports batching.

reset

public void reset()

overrideImpl

protected void overrideImpl()

override

public void override()

Description copied from interface: DataConflictOperation

Determines that the operation will be overridden. This can only be used if the DataConflictOperation.supportsOverride() returns true.

It is possible to change the operation's entry data using the DataSyncOperation.getDataAsObject() or DataSyncOperation.getDataAsDocument() methods.

• Write operation with an EntryAlreadyInSpaceConflict will turn to an update operation.
• Update operation with an EntryNotInSpaceConflict will turn to a write operation.
• Update operation with an EntryVersionConflict will overwrite the entry in the target space.
• Update operation with an EntryLockedUnderTransactionConflict will be retried.

Specified by:

override in interface DataConflictOperation

hasConflict

public boolean hasConflict()

Specified by:

hasConflict in interface DataConflictOperation

Returns:

true if that operation had a conflict, otherwise false.

abort

public void abort()

Description copied from interface: DataConflictOperation

Determines that the operation will be aborted. This can only be used if the DataConflictOperation.supportsAbort() returns true.

Specified by:

abort in interface DataConflictOperation

isAborted

public boolean isAborted()

isOverriden

protected boolean isOverriden()

toString

public String toString()

Overrides:

toString in class Object

isRetryable

protected boolean isRetryable(int maximumRetries)

incrementRetriesCounter

protected void incrementRetriesCounter()

getRetriesCount

protected int getRetriesCount()

getResolveAttempt

public int getResolveAttempt()

Specified by:

getResolveAttempt in interface DataConflictOperation

Returns:

The current resolve attempt number for the operation.

incrementResolveAttempt

protected void incrementResolveAttempt()

getConflictCause

public ConflictCause getConflictCause()

Specified by:

getConflictCause in interface DataConflictOperation

Returns:

The ConflictCause instance representing the conflict.

setConflictCause

public void setConflictCause(ConflictCause conflictCause)

convertExceptionToConflict

protected ConflictCause convertExceptionToConflict(Throwable error)

supportsAbort

public boolean supportsAbort()

Specified by:

supportsAbort in interface DataConflictOperation

Returns:

true of aborting the operation is supported, otherwise false.

getResolutionDescription

public String getResolutionDescription()

getTypeDescriptor

public SpaceTypeDescriptor getTypeDescriptor()

Specified by:

getTypeDescriptor in interface DataSyncOperation

Returns:

the type descriptor of the data type. this can only be used if DataSyncOperation.supportsGetTypeDescriptor() return true, otherwise an exception will be thrown.

supportsGetTypeDescriptor

public boolean supportsGetTypeDescriptor()

Specified by:

supportsGetTypeDescriptor in interface DataSyncOperation

Returns:

whether this data operation support the DataSyncOperation.getTypeDescriptor() operation.