com.hazelcast.spi.impl.operationservice.impl.operations

Class Backup

java.lang.Object

com.hazelcast.spi.Operation

com.hazelcast.spi.impl.operationservice.impl.operations.Backup

All Implemented Interfaces:

DataSerializable, IdentifiedDataSerializable, BackupOperation, AllowedDuringPassiveState, PartitionAwareOperation

public final class Backup
extends Operation
implements BackupOperation, AllowedDuringPassiveState, IdentifiedDataSerializable

Field Summary

Fields inherited from class com.hazelcast.spi.Operation

GENERIC_PARTITION_ID

Constructor Summary

Constructors

Constructor and Description
Backup()
Backup(Data backupOpData, Address originalCaller, long[] replicaVersions, boolean sync)
Backup(Operation backupOp, Address originalCaller, long[] replicaVersions, boolean sync)

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.
Operation	getBackupOp()
int	getFactoryId() Returns DataSerializableFactory factory ID for this class.
int	getId() Returns type identifier for this class.
void	logError(Throwable e) Logs Exception/Error thrown during operation execution.
void	onExecutionFailure(Throwable e) Called when an Exception/Error is thrown during operation execution.
protected void	readInternal(ObjectDataInput in)
boolean	returnsResponse() Method is intended to be subclassed.
void	run() Runs the operation.
protected void	toString(StringBuilder sb) A template method allows for additional information to be passed into the Operation.toString() method.
boolean	validatesTarget()
protected void	writeInternal(ObjectDataOutput out)

Methods inherited from class com.hazelcast.spi.Operation

call, executedLocally, getCallerAddress, getCallerUuid, getCallId, getCallTimeout, getConnection, getInvocationTime, getLogger, getNodeEngine, getOperationResponseHandler, getPartitionId, getReplicaIndex, getResponse, getService, getServiceName, getWaitTimeout, isUrgent, onInvocationException, onSetCallId, readData, requiresExplicitServiceName, sendResponse, setCallerUuid, setNodeEngine, setOperationResponseHandler, setPartitionId, setReplicaIndex, setService, setServiceName, setValidateTarget, setWaitTimeout, toString, 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

Backup

public Backup()

Backup

public Backup(Operation backupOp,
              Address originalCaller,
              long[] replicaVersions,
              boolean sync)

Backup

public Backup(Data backupOpData,
              Address originalCaller,
              long[] replicaVersions,
              boolean sync)

Method Detail

getBackupOp

public Operation getBackupOp()

beforeRun

public 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

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

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

returnsResponse

public boolean returnsResponse()

Description copied from class: Operation

Method is intended to be subclassed. If it returns true, Operation.getResponse() will be called right after Operation.run() method. If it returns false, Operation.sendResponse(Object) must be called later to finish the operation.

In other words, true is for synchronous operation and false is for asynchronous one.

Default implementation is synchronous operation (true).

Overrides:

returnsResponse in class Operation

validatesTarget

public boolean validatesTarget()

Overrides:

validatesTarget in class Operation

onExecutionFailure

public void onExecutionFailure(Throwable e)

Description copied from class: Operation

Called when an Exception/Error is thrown during operation execution.

By default this method does nothing. Operation implementations can override this behaviour according to their needs.

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

Overrides:

onExecutionFailure in class Operation

Parameters:

e - Exception/Error thrown during operation execution

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

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

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

writeInternal

protected void writeInternal(ObjectDataOutput out)
                      throws IOException

Overrides:

writeInternal in class Operation

Throws:

IOException

readInternal

protected void readInternal(ObjectDataInput in)
                     throws IOException

Overrides:

readInternal in class Operation

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 Operation

Parameters:

sb - the StringBuilder to add the debug info to.