com.hazelcast.internal.partition.operation

Class MigrationOperation

java.lang.Object

com.hazelcast.spi.Operation

com.hazelcast.internal.partition.operation.MigrationOperation

All Implemented Interfaces:

MigrationCycleOperation, DataSerializable, IdentifiedDataSerializable, AllowedDuringPassiveState, TargetAware, PartitionAwareOperation, UrgentSystemOperation

public class MigrationOperation
extends Operation
implements TargetAware

Migration operation used by Hazelcast version 3.9 It runs on the migration destination and applies the received fragments. Sent by the partition owner to the migration destination to start the migration process on the destination. Contains the operations which will be executed on the destination node to migrate the data and the replica versions to be set.

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
MigrationOperation()
MigrationOperation(MigrationInfo migrationInfo, int partitionStateVersion, ReplicaFragmentMigrationState fragmentMigrationState, boolean firstFragment, boolean lastFragment)

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.
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.
void	onExecutionFailure(Throwable e) Called when an Exception/Error is thrown during operation execution.
ExceptionAction	onInvocationException(Throwable throwable) Called when an Exception/Error is thrown during an invocation.
protected void	prepareOperation(Operation op)
protected void	readInternal(ObjectDataInput in)
void	run() Runs the operation.
void	setTarget(Address address) Provides the designated target member address to which the operation will be sent.
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, call, executedLocally, getCallerAddress, getCallerUuid, getCallId, getCallTimeout, getConnection, getInvocationTime, getLogger, getNodeEngine, getOperationResponseHandler, getPartitionId, getReplicaIndex, getService, getServiceName, getWaitTimeout, isUrgent, onSetCallId, readData, requiresExplicitServiceName, returnsResponse, 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

MigrationOperation

public MigrationOperation()

MigrationOperation

public MigrationOperation(MigrationInfo migrationInfo,
                          int partitionStateVersion,
                          ReplicaFragmentMigrationState fragmentMigrationState,
                          boolean firstFragment,
                          boolean lastFragment)

Method Detail

run

public void run()
         throws Exception

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 Sets the active migration and the migration flag for the partition, notifies MigrationAwareServices that the migration is starting and runs the sent replication operations. If the migration was successful, set the replica versions. If it failed, notify the sent migration tasks.

Overrides:

run in class Operation

Throws:

Exception

See Also:

Operation.call()

prepareOperation

protected void prepareOperation(Operation op)

getMigrationEvent

protected PartitionMigrationEvent getMigrationEvent()

Returns the event which will be forwarded to MigrationAwareServices.

getMigrationParticipantType

protected InternalMigrationListener.MigrationParticipant getMigrationParticipantType()

onExecutionFailure

public void onExecutionFailure(Throwable e)

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. Notifies all sent migration tasks that the migration failed.

Overrides:

onExecutionFailure in class Operation

Parameters:

e - Exception/Error thrown during operation execution

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

Throws:

IOException

readInternal

protected void readInternal(ObjectDataInput in)
                     throws IOException

Throws:

IOException

setTarget

public void setTarget(Address address)

Description copied from interface: TargetAware

Provides the designated target member address to which the operation will be sent.

• This method is invoked on the implementing object before the operation is serialized and sent over the network
• When an operation is retried, the target may be re-evaluated (eg a partition operation may target a different member after a topology change). setTarget will be invoked on each retry with the current target member's Address as argument
• When an operation is executed on the local member, the local member's address is provided as target address

Specified by:

setTarget in interface TargetAware

Parameters:

address - target member's address

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

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.

Overrides:

onInvocationException in class Operation

Parameters:

throwable - Exception/Error thrown during invocation

Returns:

ExceptionAction

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