com.hazelcast.cache.impl.operation

Class CacheOperation

java.lang.Object

com.hazelcast.spi.Operation

com.hazelcast.spi.impl.AbstractNamedOperation

com.hazelcast.cache.impl.operation.CacheOperation

All Implemented Interfaces:

DataSerializable, IdentifiedDataSerializable, NamedOperation, PartitionAwareOperation, ServiceNamespaceAware

Direct Known Subclasses:

CacheExpireBatchBackupOperation, CacheMergeOperation, CachePutAllBackupOperation, CachePutAllOperation, CacheSetExpiryPolicyBackupOperation, CacheSetExpiryPolicyOperation, KeyBasedCacheOperation

public abstract class CacheOperation
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 ICacheService	cacheService
protected boolean	dontCreateCacheRecordStoreIfNotExist
protected ICacheRecordStore	recordStore
protected Closeable	tenantContext
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	CacheOperation()
protected	CacheOperation(String name)
protected	CacheOperation(String name, boolean dontCreateCacheRecordStoreIfNotExist)

Method Summary

Modifier and Type	Method and Description
void	afterRun() Is executed called after Operation.run() or Operation.call() method completes normally and the operation is not blocked, see CallStatus.WAIT.
void	beforeRun() The beforeRun is called before either the Operation.run() or the Operation.call() method is called.
protected void	beforeRunInternal() Implementers can override this method to make a specific execution.
protected void	dispose() Implementers can override to release associated resources upon a successful execution or failure.
int	getAsyncBackupCount()
int	getFactoryId() Returns DataSerializableFactory factory ID for this class.
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	publishWanRemove(Data dataKey)
protected void	publishWanUpdate(Data dataKey, CacheRecord record)
protected void	publishWanUpdate(Data dataKey, Data dataValue, CacheRecord record)
protected void	publishWanUpdate(Data dataKey, Data dataValue, Data dataExpiryPolicy, CacheRecord record)

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

getName, readInternal, toString, writeInternal

Methods inherited from class com.hazelcast.spi.Operation

call, executedLocally, getCallerAddress, getCallerUuid, getCallId, getCallTimeout, getConnection, getInvocationTime, getLogger, getNodeEngine, getOperationResponseHandler, getPartitionId, getReplicaIndex, getResponse, getService, getWaitTimeout, isUrgent, onExecutionFailure, onSetCallId, readData, requiresExplicitServiceName, 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

dontCreateCacheRecordStoreIfNotExist

protected transient boolean dontCreateCacheRecordStoreIfNotExist

cacheService

protected transient ICacheService cacheService

recordStore

protected transient ICacheRecordStore recordStore

wanEventPublisher

protected transient CacheWanEventPublisher wanEventPublisher

tenantContext

protected transient Closeable tenantContext

Constructor Detail

CacheOperation

protected CacheOperation()

CacheOperation

protected CacheOperation(String name)

CacheOperation

protected CacheOperation(String name,
                         boolean dontCreateCacheRecordStoreIfNotExist)

Method Detail

getServiceName

public final String getServiceName()

Overrides:

getServiceName in class Operation

beforeRun

public final void beforeRun()
                     throws Exception

Description copied from class: Operation

The beforeRun is called before either the Operation.run() or the Operation.call() method is called. runs before wait-support

Overrides:

beforeRun in class Operation

Throws:

Exception

afterRun

public void afterRun()
              throws Exception

Description copied from class: Operation

Is executed called after Operation.run() or Operation.call() method completes normally and the operation is not blocked, see CallStatus.WAIT. Runs after backups, before wait-notify.

Overrides:

afterRun in class Operation

Throws:

Exception

dispose

protected void dispose()

Implementers can override to release associated resources upon a successful execution or failure.

beforeRunInternal

protected void beforeRunInternal()

Implementers can override this method to make a specific execution.

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, it will retry or fail according to returned ExceptionAction.

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 according 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 final ObjectNamespace getServiceNamespace()

Description copied from interface: ServiceNamespaceAware

Returns the ServiceNamespace which this object belongs to.

Specified by:

getServiceNamespace in interface ServiceNamespaceAware

Returns:

service namespace

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()

publishWanUpdate

protected final void publishWanUpdate(Data dataKey,
                                      CacheRecord record)

publishWanUpdate

protected final void publishWanUpdate(Data dataKey,
                                      Data dataValue,
                                      CacheRecord record)

publishWanUpdate

protected final void publishWanUpdate(Data dataKey,
                                      Data dataValue,
                                      Data dataExpiryPolicy,
                                      CacheRecord record)

publishWanRemove

protected final void publishWanRemove(Data dataKey)