com.hazelcast.cp.internal.operation

Class RaftReplicateOp

java.lang.Object

com.hazelcast.spi.Operation

com.hazelcast.cp.internal.operation.RaftReplicateOp

All Implemented Interfaces:

ExecutionCallback, RaftSystemOperation, DataSerializable, IdentifiedDataSerializable, AllowedDuringPassiveState, ReadonlyOperation

Direct Known Subclasses:

ChangeRaftGroupMembershipOp, DefaultRaftReplicateOp, DestroyRaftGroupOp

public abstract class RaftReplicateOp
extends Operation
implements IdentifiedDataSerializable, RaftSystemOperation, ExecutionCallback

The base class that replicates the given RaftOp to the target Raft group

Please note that this operation is not a RaftOp, so it is not handled via the Raft layer.

Field Summary

Fields inherited from class com.hazelcast.spi.Operation

GENERIC_PARTITION_ID

Method Summary

Modifier and Type	Method and Description
String	getServiceName()
void	onFailure(Throwable t) Called when an execution is completed with an error.
void	onResponse(Object response) Called when an execution is completed successfully.
protected void	readInternal(ObjectDataInput in)
protected abstract ICompletableFuture	replicate(RaftNode raftNode)
boolean	returnsResponse() Method is intended to be overridden.
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

afterRun, beforeRun, call, executedLocally, getCallerAddress, getCallerUuid, getCallId, getCallTimeout, getConnection, getInvocationTime, getLogger, getNodeEngine, getOperationResponseHandler, getPartitionId, getReplicaIndex, getResponse, getService, getWaitTimeout, isUrgent, logError, onExecutionFailure, 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.nio.serialization.IdentifiedDataSerializable

getFactoryId, getId

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

readData, writeData

Method Detail

run

public final void run()

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

See Also:

Operation.call()

replicate

protected abstract ICompletableFuture replicate(RaftNode raftNode)

onResponse

public void onResponse(Object response)

Description copied from interface: ExecutionCallback

Called when an execution is completed successfully.

Specified by:

onResponse in interface ExecutionCallback

Parameters:

response - the result of the successful execution

onFailure

public void onFailure(Throwable t)

Description copied from interface: ExecutionCallback

Called when an execution is completed with an error.

Specified by:

onFailure in interface ExecutionCallback

Parameters:

t - the exception that is thrown

returnsResponse

public final boolean returnsResponse()

Description copied from class: Operation

Method is intended to be overridden. 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 final boolean validatesTarget()

Overrides:

validatesTarget in class Operation

getServiceName

public final String getServiceName()

Overrides:

getServiceName in class Operation

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.