com.hazelcast.cache.impl.operation

Class AbstractCacheOperation

java.lang.Object

com.hazelcast.spi.Operation

com.hazelcast.spi.impl.AbstractNamedOperation

com.hazelcast.cache.impl.operation.AbstractCacheOperation

All Implemented Interfaces:

DataSerializable, IdentifiedDataSerializable, NamedOperation, PartitionAwareOperation, ServiceNamespaceAware

Direct Known Subclasses:

AbstractMutatingCacheOperation, CacheBackupEntryProcessorOperation, CacheContainsKeyOperation, CacheEntryIteratorOperation, CacheGetOperation, CacheKeyIteratorOperation, CacheLegacyMergeOperation, CachePutBackupOperation, CacheRemoveBackupOperation

public abstract class AbstractCacheOperation
extends AbstractNamedOperation
implements PartitionAwareOperation, ServiceNamespaceAware, IdentifiedDataSerializable

Base Cache Operation. Cache operations are named operations. Key based operations are subclasses of this base class providing a cacheRecordStore access and partial backup support.

Field Summary

Fields

Modifier and Type	Field and Description
protected CacheRecord	backupRecord
protected ICacheRecordStore	cache
protected ICacheService	cacheService
protected Data	key
protected Object	response
protected CacheWanEventPublisher	wanEventPublisher

Fields inherited from class com.hazelcast.spi.impl.AbstractNamedOperation

name

Fields inherited from class com.hazelcast.spi.Operation

GENERIC_PARTITION_ID

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractCacheOperation()
protected	AbstractCacheOperation(String name, Data key)

Method Summary

Modifier and Type	Method and Description
void	beforeRun()
int	getAsyncBackupCount()
int	getFactoryId() Returns DataSerializableFactory factory ID for this class.
Object	getResponse() Called if and only if Operation.returnsResponse() returned true, shortly after Operation.run() returns.
String	getServiceName()
ObjectNamespace	getServiceNamespace() Returns the ServiceNamespace which this object belongs to.
int	getSyncBackupCount()
void	logError(Throwable e) Logs Exception/Error thrown during operation execution.
ExceptionAction	onInvocationException(Throwable throwable) Called when an Exception/Error is thrown during an invocation.
protected void	readInternal(ObjectDataInput in)
protected void	writeInternal(ObjectDataOutput out)

Methods inherited from class com.hazelcast.spi.impl.AbstractNamedOperation

getName, toString

Methods inherited from class com.hazelcast.spi.Operation

afterRun, call, executedLocally, getCallerAddress, getCallerUuid, getCallId, getCallTimeout, getConnection, getInvocationTime, getLogger, getNodeEngine, getOperationResponseHandler, getPartitionId, getReplicaIndex, getService, getWaitTimeout, isUrgent, onExecutionFailure, onSetCallId, readData, returnsResponse, run, sendResponse, setCallerUuid, setNodeEngine, setOperationResponseHandler, setPartitionId, setReplicaIndex, setService, setServiceName, setValidateTarget, setWaitTimeout, toString, validatesTarget, writeData

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.hazelcast.spi.PartitionAwareOperation

getPartitionId

Methods inherited from interface com.hazelcast.nio.serialization.IdentifiedDataSerializable

getId

Methods inherited from interface com.hazelcast.nio.serialization.DataSerializable

readData, writeData

Field Detail

key

protected Data key

response

protected Object response

cacheService

protected transient ICacheService cacheService

cache

protected transient ICacheRecordStore cache

wanEventPublisher

protected transient CacheWanEventPublisher wanEventPublisher

backupRecord

protected transient CacheRecord backupRecord

Constructor Detail

AbstractCacheOperation

protected AbstractCacheOperation()

AbstractCacheOperation

protected AbstractCacheOperation(String name,
                                 Data key)

Method Detail

getServiceName

public String getServiceName()

Overrides:

getServiceName in class Operation

beforeRun

public void beforeRun()
               throws Exception

Overrides:

beforeRun in class Operation

Throws:

Exception

getResponse

public final Object getResponse()

Description copied from class: Operation

Called if and only if Operation.returnsResponse() returned true, shortly after Operation.run() returns.

Overrides:

getResponse in class Operation

onInvocationException

public ExceptionAction onInvocationException(Throwable throwable)

Description copied from class: Operation

Called when an Exception/Error is thrown during an invocation. Invocation process will continue, retry or fail according to returned ExceptionAction result.

This method is called on caller side of the invocation.

Overrides:

onInvocationException in class Operation

Parameters:

throwable - Exception/Error thrown during invocation

Returns:

ExceptionAction

logError

public void logError(Throwable e)

Description copied from class: Operation

Logs Exception/Error thrown during operation execution. Operation implementations can override this behaviour due to their needs.

This method is called on node & thread that's executing the operation.

Overrides:

logError in class Operation

Parameters:

e - Exception/Error thrown during operation execution

getServiceNamespace

public ObjectNamespace getServiceNamespace()

Description copied from interface: ServiceNamespaceAware

Returns the ServiceNamespace which this object belongs to.

Specified by:

getServiceNamespace in interface ServiceNamespaceAware

Returns:

service namespace

writeInternal

protected void writeInternal(ObjectDataOutput out)
                      throws IOException

Overrides:

writeInternal in class AbstractNamedOperation

Throws:

IOException

readInternal

protected void readInternal(ObjectDataInput in)
                     throws IOException

Overrides:

readInternal in class AbstractNamedOperation

Throws:

IOException

getFactoryId

public int getFactoryId()

Description copied from interface: IdentifiedDataSerializable

Returns DataSerializableFactory factory ID for this class.

Specified by:

getFactoryId in interface IdentifiedDataSerializable

Returns:

factory ID

getSyncBackupCount

public final int getSyncBackupCount()

getAsyncBackupCount

public final int getAsyncBackupCount()