com.hazelcast.internal.partition.operation

Class MigrationRequestOperation

java.lang.Object

com.hazelcast.spi.Operation

com.hazelcast.internal.partition.operation.MigrationRequestOperation

All Implemented Interfaces:

MigrationCycleOperation, DataSerializable, IdentifiedDataSerializable, AllowedDuringPassiveState, PartitionAwareOperation, UrgentSystemOperation

public class MigrationRequestOperation
extends Operation

Migration request operation used by Hazelcast version 3.9 Sent from the master node to the partition owner. It will perform the migration by preparing the migration operations and sending them to the destination. A response with a value equal to Boolean.TRUE indicates a successful migration. It runs on the migration source and transfers the partition with multiple shots. It divides the partition data into fragments and send a group of fragments within each shot.

Field Summary

Fields

Modifier and Type	Field and Description
protected MigrationInfo	migrationInfo
protected int	partitionStateVersion
protected boolean	success

Fields inherited from class com.hazelcast.spi.Operation

GENERIC_PARTITION_ID

Constructor Summary

Constructors

Constructor and Description
MigrationRequestOperation()
MigrationRequestOperation(MigrationInfo migrationInfo, int partitionStateVersion, boolean fragmentedMigrationEnabled)

Method Summary

Modifier and Type	Method and Description
void	beforeRun() The beforeRun is called before either the Operation.run() or the Operation.call() method is called.
CallStatus	call() Call the operation and returns the CallStatus.
int	getFactoryId() Returns DataSerializableFactory factory ID for this class.
int	getId() Returns type identifier for this class.
protected PartitionMigrationEvent	getMigrationEvent() Returns the event which will be forwarded to MigrationAwareServices.
MigrationInfo	getMigrationInfo()
protected InternalMigrationListener.MigrationParticipant	getMigrationParticipantType()
Object	getResponse() Called if and only if Operation.returnsResponse() returned true, shortly after Operation.run() returns.
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	readInternal(ObjectDataInput in)
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, executedLocally, getCallerAddress, getCallerUuid, getCallId, getCallTimeout, getConnection, getInvocationTime, getLogger, getNodeEngine, getOperationResponseHandler, getPartitionId, getReplicaIndex, getService, getServiceName, getWaitTimeout, isUrgent, onExecutionFailure, onSetCallId, readData, requiresExplicitServiceName, returnsResponse, run, 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

Field Detail

migrationInfo

protected MigrationInfo migrationInfo

success

protected boolean success

partitionStateVersion

protected int partitionStateVersion

Constructor Detail

MigrationRequestOperation

public MigrationRequestOperation()

MigrationRequestOperation

public MigrationRequestOperation(MigrationInfo migrationInfo,
                                 int partitionStateVersion,
                                 boolean fragmentedMigrationEnabled)

Method Detail

call

public CallStatus call()
                throws Exception

Description copied from class: Operation

Call the operation and returns the CallStatus. An Operation should either implement call or run; not both. If run is implemented, then the system remains backwards compatible to prevent making massive code changes while adding this feature. In the future all Operation.run() methods will be replaced by call methods. The call method looks very much like the Operation.run() method and it is very close to Runnable.run() and Callable.call(). The main difference between a run and call, is that the returned CallStatus from the call can tell something about the actual execution. For example it could tell that some waiting is required in case of a BlockingOperation. Or that the actual execution work is offloaded to some executor in case of an Offloadable EntryOperation. In the future new types of CallStatus are expected to be added, e.g. for interleaving. In the future it is very likely that for regular Operation that want to return a concrete response, the actual response can be returned directly. In this case we'll change the return type to Object to prevent forcing the response to be wrapped in a CallStatus.DONE_RESPONSE monad since that would force additional litter to be created.

Overrides:

call in class Operation

Returns:

the CallStatus.

Throws:

Exception - if something failed while executing 'call'.

See Also:

Operation.run()

getMigrationEvent

protected PartitionMigrationEvent getMigrationEvent()

Returns the event which will be forwarded to MigrationAwareServices.

getMigrationParticipantType

protected InternalMigrationListener.MigrationParticipant getMigrationParticipantType()

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.

Parameters:

throwable - Exception/Error thrown during invocation

Returns:

ExceptionAction

getId

public int getId()

Description copied from interface: IdentifiedDataSerializable

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

Returns:

type ID

writeInternal

protected void writeInternal(ObjectDataOutput out)
                      throws IOException

Throws:

IOException

readInternal

protected void readInternal(ObjectDataInput in)
                     throws IOException

Throws:

IOException

beforeRun

public final void beforeRun()
                     throws Exception

The beforeRun is called before either the Operation.run() or the Operation.call() method is called. runs before wait-support Validates the migration operation: the UUIDs of the node should match the one in the migrationInfo, the cluster should be in ClusterState.ACTIVE and the node started and the partition state version from the sender should match the local partition state version.

Overrides:

beforeRun in class Operation

Throws:

IllegalStateException - if the UUIDs don't match or if the cluster and node state are not

PartitionStateVersionMismatchException - if the partition versions don't match and this node is not the master node

Exception

getMigrationInfo

public MigrationInfo getMigrationInfo()

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

validatesTarget

public final boolean validatesTarget()

Overrides:

validatesTarget in class Operation

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

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.

getFactoryId

public final int getFactoryId()

Description copied from interface: IdentifiedDataSerializable

Returns DataSerializableFactory factory ID for this class.

Specified by:

getFactoryId in interface IdentifiedDataSerializable

Returns:

factory ID