com.hazelcast.map.impl.tx

Class TxnPrepareOperation

java.lang.Object

com.hazelcast.spi.Operation

com.hazelcast.spi.impl.AbstractNamedOperation

com.hazelcast.map.impl.operation.MapOperation

com.hazelcast.map.impl.operation.KeyBasedMapOperation

com.hazelcast.map.impl.tx.TxnPrepareOperation

All Implemented Interfaces:

DataSerializable, IdentifiedDataSerializable, Versioned, BackupAwareOperation, MutatingOperation, NamedOperation, PartitionAwareOperation, ServiceNamespaceAware

public class TxnPrepareOperation
extends KeyBasedMapOperation
implements BackupAwareOperation, MutatingOperation

An operation to prepare transaction by locking the key on the key owner.

Field Summary

Fields inherited from class com.hazelcast.map.impl.operation.KeyBasedMapOperation

dataKey, dataValue, maxIdle, threadId, ttl

Fields inherited from class com.hazelcast.map.impl.operation.MapOperation

createRecordStoreOnDemand, disableWanReplicationEvent, mapContainer, mapEventPublisher, mapService, mapServiceContext, recordStore

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
	TxnPrepareOperation()
protected	TxnPrepareOperation(int partitionId, String name, Data dataKey, String ownerUuid)

Method Summary

Modifier and Type	Method and Description
int	getAsyncBackupCount() The asynchronous backup count.
Operation	getBackupOperation() Creates the BackupOperation responsible for making the backup.
int	getId() Returns type identifier for this class.
Object	getResponse() Called if and only if Operation.returnsResponse() returned true, shortly after Operation.run() returns.
int	getSyncBackupCount() The synchronous backup count.
void	logError(Throwable e) Logs Exception/Error thrown during operation execution.
protected void	readInternal(ObjectDataInput in)
void	run() Runs the operation.
boolean	shouldBackup() Checks if a backup needs to be made.
protected void	toString(StringBuilder sb) A template method allows for additional information to be passed into the Operation.toString() method.
protected void	writeInternal(ObjectDataOutput out)

Methods inherited from class com.hazelcast.map.impl.operation.KeyBasedMapOperation

getKey, getThreadId, getTtl, getValue, setThreadId

Methods inherited from class com.hazelcast.map.impl.operation.MapOperation

beforeRun, canThisOpGenerateWANEvent, evict, getCallerProvenance, getFactoryId, getServiceName, getServiceNamespace, innerBeforeRun, invalidateAllKeysInNearCaches, invalidateNearCache, invalidateNearCache, isPostProcessing, publishLoadAsWanUpdate, publishWanRemove, publishWanUpdate, setMapContainer, setMapService

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

getName

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, onInvocationException, onSetCallId, readData, requiresExplicitServiceName, returnsResponse, 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.DataSerializable

readData, writeData

Constructor Detail

TxnPrepareOperation

protected TxnPrepareOperation(int partitionId,
                              String name,
                              Data dataKey,
                              String ownerUuid)

TxnPrepareOperation

public TxnPrepareOperation()

Method Detail

run

public void run()
         throws Exception

Description copied from class: Operation

Runs the operation. Either the Operation.run() or Operation.call() method should be implemented; not both. Runs after wait-support, supposed to do actual operation

Overrides:

run in class Operation

Throws:

Exception

See Also:

Operation.call()

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

getResponse

public 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

shouldBackup

public boolean shouldBackup()

Description copied from interface: BackupAwareOperation

Checks if a backup needs to be made.

If a call has not made any change, e.g. an AtomicLong increment with 0, no backup needs to be made.

Specified by:

shouldBackup in interface BackupAwareOperation

Returns:

true if a backup needs to be made, false otherwise.

getBackupOperation

public final Operation getBackupOperation()

Description copied from interface: BackupAwareOperation

Creates the BackupOperation responsible for making the backup.

Specified by:

getBackupOperation in interface BackupAwareOperation

Returns:

the created BackupOperation responsible for making the backup.

getAsyncBackupCount

public final int getAsyncBackupCount()

Description copied from interface: BackupAwareOperation

The asynchronous backup count. If no asynchronous backups need to be made, 0 is returned.

Specified by:

getAsyncBackupCount in interface BackupAwareOperation

Returns:

the asynchronous backup count.

getSyncBackupCount

public final int getSyncBackupCount()

Description copied from interface: BackupAwareOperation

The synchronous backup count. If no backups need to be made, 0 is returned.

Specified by:

getSyncBackupCount in interface BackupAwareOperation

Returns:

the synchronous backup count.

writeInternal

protected void writeInternal(ObjectDataOutput out)
                      throws IOException

Overrides:

writeInternal in class KeyBasedMapOperation

Throws:

IOException

readInternal

protected void readInternal(ObjectDataInput in)
                     throws IOException

Overrides:

readInternal in class KeyBasedMapOperation

Throws:

IOException

toString

protected void toString(StringBuilder sb)

Description copied from class: Operation

A template method allows for additional information to be passed into the Operation.toString() method. So an Operation subclass can override this method and add additional debugging content. The default implementation does nothing so one is not forced to provide an empty implementation. It is a good practice to always call the super.toString(stringBuffer) when implementing this method to make sure that the super class can inject content if needed.

Overrides:

toString in class AbstractNamedOperation

Parameters:

sb - the StringBuilder to add the debug info to.

getId

public int getId()

Description copied from interface: IdentifiedDataSerializable

Returns type identifier for this class. It should be unique per DataSerializableFactory.

Specified by:

getId in interface IdentifiedDataSerializable

Returns:

type ID