com.hazelcast.cp.internal.operation

Class RaftQueryOp

java.lang.Object

com.hazelcast.spi.Operation

com.hazelcast.cp.internal.operation.RaftQueryOp

All Implemented Interfaces:

ExecutionCallback, IndeterminateOperationStateAware, RaftSystemOperation, DataSerializable, IdentifiedDataSerializable, AllowedDuringPassiveState, ReadonlyOperation

public class RaftQueryOp
extends Operation
implements IndeterminateOperationStateAware, RaftSystemOperation, ExecutionCallback, IdentifiedDataSerializable

The operation that passes a query to leader or a follower of a Raft group. The given query can run locally on leader or a follower, or can be committed to the Raft group, depending on query policy.

Please note that the given query can be committed twice if the leader commits the query but fails before sending the response, therefore the query operation is expected to have no side-effect.

Field Summary

Fields inherited from class com.hazelcast.spi.Operation

GENERIC_PARTITION_ID

Constructor Summary

Constructors

Constructor and Description
RaftQueryOp()
RaftQueryOp(CPGroupId groupId, RaftOp raftOp, QueryPolicy queryPolicy)

Method Summary

Modifier and Type	Method and Description
int	getFactoryId() Returns DataSerializableFactory factory ID for this class.
int	getId() Returns type identifier for this class.
String	getServiceName()
boolean	isRetryableOnIndeterminateOperationState() Returns true if duplicate commit of the operation is equivalent to committing it only once.
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)
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.DataSerializable

readData, writeData

Constructor Detail

RaftQueryOp

public RaftQueryOp()

RaftQueryOp

public RaftQueryOp(CPGroupId groupId,
                   RaftOp raftOp,
                   QueryPolicy queryPolicy)

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

isRetryableOnIndeterminateOperationState

public boolean isRetryableOnIndeterminateOperationState()

Description copied from interface: IndeterminateOperationStateAware

Returns true if duplicate commit of the operation is equivalent to committing it only once.

Specified by:

isRetryableOnIndeterminateOperationState in interface IndeterminateOperationStateAware

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

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.