Package org.apache.hadoop.hbase.master.replication

Class MigrateReplicationQueueFromZkToTableProcedure

java.lang.Object

org.apache.hadoop.hbase.procedure2.Procedure<TEnvironment>

org.apache.hadoop.hbase.procedure2.StateMachineProcedure<MasterProcedureEnv,org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProcedureProtos.MigrateReplicationQueueFromZkToTableState>

org.apache.hadoop.hbase.master.replication.MigrateReplicationQueueFromZkToTableProcedure

All Implemented Interfaces:

Comparable<Procedure<MasterProcedureEnv>>, GlobalProcedureInterface

@Private
public class MigrateReplicationQueueFromZkToTableProcedure
extends StateMachineProcedure<MasterProcedureEnv,org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProcedureProtos.MigrateReplicationQueueFromZkToTableState>
implements GlobalProcedureInterface

A procedure for migrating replication queue data from zookeeper to hbase:replication table.

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.hadoop.hbase.procedure2.StateMachineProcedure

StateMachineProcedure.Flow

Nested classes/interfaces inherited from class org.apache.hadoop.hbase.procedure2.Procedure

Procedure.LockState

Field Summary

Fields

Modifier and Type	Field	Description
private List<String>	disabledPeerIds
private ExecutorService	executor
private CompletableFuture<Void>	future
private static final org.slf4j.Logger	LOG
private static final int	MIN_MAJOR_VERSION
private RetryCounter	retryCounter

Fields inherited from class org.apache.hadoop.hbase.procedure2.StateMachineProcedure

stateCount

Fields inherited from class org.apache.hadoop.hbase.procedure2.Procedure

NO_PROC_ID, NO_TIMEOUT

Constructor Summary

Constructors

Constructor	Description
MigrateReplicationQueueFromZkToTableProcedure()

Method Summary

Modifier and Type	Method	Description
protected void	afterReplay(MasterProcedureEnv env)	Called when the procedure is ready to be added to the queue after the loading/replay operation.
private void	cleanup(MasterProcedureEnv env)
protected void	deserializeStateData(ProcedureStateSerializer serializer)	Called on store load to allow the user to decode the previously serialized state.
private void	disableReplicationLogCleaner(MasterProcedureEnv env)
private void	enableReplicationLogCleaner(MasterProcedureEnv env)
protected StateMachineProcedure.Flow	executeFromState(MasterProcedureEnv env, org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProcedureProtos.MigrateReplicationQueueFromZkToTableState state)	called to perform a single step of the specified 'state' of the procedure
private void	finishMigartion()
private ExecutorService	getExecutorService()
private CompletableFuture<Void>	getFuture()
String	getGlobalId()
protected org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProcedureProtos.MigrateReplicationQueueFromZkToTableState	getInitialState()	Return the initial state object that will be used for the first call to executeFromState().
protected org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProcedureProtos.MigrateReplicationQueueFromZkToTableState	getState(int stateId)	Convert an ordinal (or state id) to an Enum (or more descriptive) state object.
protected int	getStateId(org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProcedureProtos.MigrateReplicationQueueFromZkToTableState state)	Convert the Enum (or more descriptive) state object to an ordinal (or state id).
private void	resetRetry()
protected void	rollbackState(MasterProcedureEnv env, org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProcedureProtos.MigrateReplicationQueueFromZkToTableState state)	called to perform the rollback of the specified state
protected void	serializeStateData(ProcedureStateSerializer serializer)	The user-level code of the procedure may have some state to persist (e.g.
private void	setFuture(CompletableFuture<Void> f)
protected boolean	setTimeoutFailure(MasterProcedureEnv env)	Called by the ProcedureExecutor when the timeout set by setTimeout() is expired.
private void	shutdownExecutorService()
private ProcedureSuspendedException	suspend(org.apache.hadoop.conf.Configuration conf, LongConsumer backoffConsumer)
private void	waitUntilNoPeerProcedure(MasterProcedureEnv env)

Methods inherited from class org.apache.hadoop.hbase.procedure2.StateMachineProcedure

abort, addChildProcedure, execute, failIfAborted, getCurrentState, getCurrentStateId, getCycles, isEofState, isRollbackSupported, isRollbackSupported, isYieldAfterExecutionStep, isYieldBeforeExecuteFromState, rollback, setNextState, toStringState

Methods inherited from class org.apache.hadoop.hbase.procedure2.Procedure

acquireLock, addStackIndex, afterExec, beforeExec, beforeReplay, bypass, compareTo, completionCleanup, doExecute, doRollback, elapsedTime, getChildrenLatch, getException, getLastUpdate, getNonceKey, getOwner, getParentProcId, getProcedureMetrics, getProcId, getProcIdHashCode, getProcName, getResult, getRootProcedureId, getRootProcId, getStackIndexes, getState, getSubmittedTime, getTimeout, getTimeoutTimestamp, hasChildren, hasException, hasLock, hasOwner, hasParent, hasTimeout, haveSameParent, holdLock, incChildrenLatch, isBypass, isFailed, isFinished, isInitializing, isLockedWhenLoading, isRunnable, isSuccess, isWaiting, releaseLock, removeStackIndex, setAbortFailure, setChildrenLatch, setExecuted, setFailure, setFailure, setLastUpdate, setNonceKey, setOwner, setOwner, setParentProcId, setProcId, setResult, setRootProcId, setStackIndexes, setState, setSubmittedTime, setTimeout, shouldWaitClientAck, skipPersistence, suspend, toString, toStringClass, toStringClassDetails, toStringDetails, toStringSimpleSB, updateMetricsOnFinish, updateMetricsOnSubmit, updateTimestamp, waitInitialized, wasExecuted

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

LOG

private static final org.slf4j.Logger LOG

MIN_MAJOR_VERSION

private static final int MIN_MAJOR_VERSION

See Also:

• Constant Field Values

disabledPeerIds

private List<String> disabledPeerIds

future

private CompletableFuture<Void> future

executor

private ExecutorService executor

retryCounter

private RetryCounter retryCounter

Constructor Details

MigrateReplicationQueueFromZkToTableProcedure

public MigrateReplicationQueueFromZkToTableProcedure()

Method Details

getGlobalId

public String getGlobalId()

Specified by:

getGlobalId in interface GlobalProcedureInterface

getFuture

private CompletableFuture<Void> getFuture()

setFuture

private void setFuture(CompletableFuture<Void> f)

suspend

private ProcedureSuspendedException suspend(org.apache.hadoop.conf.Configuration conf,
 LongConsumer backoffConsumer)
                                     throws ProcedureSuspendedException

Throws:

ProcedureSuspendedException

resetRetry

private void resetRetry()

getExecutorService

private ExecutorService getExecutorService()

shutdownExecutorService

private void shutdownExecutorService()

disableReplicationLogCleaner

private void disableReplicationLogCleaner(MasterProcedureEnv env)
                                   throws ProcedureSuspendedException

Throws:

ProcedureSuspendedException

enableReplicationLogCleaner

private void enableReplicationLogCleaner(MasterProcedureEnv env)

waitUntilNoPeerProcedure

private void waitUntilNoPeerProcedure(MasterProcedureEnv env)
                               throws ProcedureSuspendedException

Throws:

ProcedureSuspendedException

finishMigartion

private void finishMigartion()

cleanup

private void cleanup(MasterProcedureEnv env)
              throws ProcedureSuspendedException

Throws:

ProcedureSuspendedException

executeFromState

protected StateMachineProcedure.Flow executeFromState(MasterProcedureEnv env,
 org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProcedureProtos.MigrateReplicationQueueFromZkToTableState state)
                                               throws ProcedureSuspendedException,
ProcedureYieldException,
InterruptedException

Description copied from class: StateMachineProcedure

called to perform a single step of the specified 'state' of the procedure

Specified by:

executeFromState in class StateMachineProcedure<MasterProcedureEnv,org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProcedureProtos.MigrateReplicationQueueFromZkToTableState>

state - state to execute

Returns:

Flow.NO_MORE_STATE if the procedure is completed, Flow.HAS_MORE_STATE if there is another step.

Throws:

ProcedureSuspendedException

ProcedureYieldException

InterruptedException

setTimeoutFailure

protected boolean setTimeoutFailure(MasterProcedureEnv env)

Description copied from class: Procedure

Called by the ProcedureExecutor when the timeout set by setTimeout() is expired.

Another usage for this method is to implement retrying. A procedure can set the state to WAITING_TIMEOUT by calling setState method, and throw a ProcedureSuspendedException to halt the execution of the procedure, and do not forget a call Procedure.setTimeout(int) method to set the timeout. And you should also override this method to wake up the procedure, and also return false to tell the ProcedureExecutor that the timeout event has been handled.

Overrides:

setTimeoutFailure in class Procedure<MasterProcedureEnv>

Returns:

true to let the framework handle the timeout as abort, false in case the procedure handled the timeout itself.

rollbackState

protected void rollbackState(MasterProcedureEnv env,
 org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProcedureProtos.MigrateReplicationQueueFromZkToTableState state)
                      throws IOException,
InterruptedException

Description copied from class: StateMachineProcedure

called to perform the rollback of the specified state

Specified by:

rollbackState in class StateMachineProcedure<MasterProcedureEnv,org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProcedureProtos.MigrateReplicationQueueFromZkToTableState>

state - state to rollback

Throws:

IOException - temporary failure, the rollback will retry later

InterruptedException

getState

protected org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProcedureProtos.MigrateReplicationQueueFromZkToTableState getState(int stateId)

Description copied from class: StateMachineProcedure

Convert an ordinal (or state id) to an Enum (or more descriptive) state object.

Specified by:

getState in class StateMachineProcedure<MasterProcedureEnv,org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProcedureProtos.MigrateReplicationQueueFromZkToTableState>

Parameters:

stateId - the ordinal() of the state enum (or state id)

Returns:

the state enum object

getStateId

protected int getStateId(org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProcedureProtos.MigrateReplicationQueueFromZkToTableState state)

Description copied from class: StateMachineProcedure

Convert the Enum (or more descriptive) state object to an ordinal (or state id).

Specified by:

getStateId in class StateMachineProcedure<MasterProcedureEnv,org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProcedureProtos.MigrateReplicationQueueFromZkToTableState>

Parameters:

state - the state enum object

Returns:

stateId the ordinal() of the state enum (or state id)

getInitialState

protected org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProcedureProtos.MigrateReplicationQueueFromZkToTableState getInitialState()

Description copied from class: StateMachineProcedure

Return the initial state object that will be used for the first call to executeFromState().

Specified by:

getInitialState in class StateMachineProcedure<MasterProcedureEnv,org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProcedureProtos.MigrateReplicationQueueFromZkToTableState>

Returns:

the initial state enum object

afterReplay

protected void afterReplay(MasterProcedureEnv env)

Description copied from class: Procedure

Called when the procedure is ready to be added to the queue after the loading/replay operation.

Overrides:

afterReplay in class Procedure<MasterProcedureEnv>

serializeStateData

protected void serializeStateData(ProcedureStateSerializer serializer)
                           throws IOException

Description copied from class: Procedure

The user-level code of the procedure may have some state to persist (e.g. input arguments or current position in the processing state) to be able to resume on failure.

Overrides:

serializeStateData in class StateMachineProcedure<MasterProcedureEnv,org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProcedureProtos.MigrateReplicationQueueFromZkToTableState>

Parameters:

serializer - stores the serializable state

Throws:

IOException

deserializeStateData

protected void deserializeStateData(ProcedureStateSerializer serializer)
                             throws IOException

Description copied from class: Procedure

Called on store load to allow the user to decode the previously serialized state.

Overrides:

deserializeStateData in class StateMachineProcedure<MasterProcedureEnv,org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProcedureProtos.MigrateReplicationQueueFromZkToTableState>

Parameters:

serializer - contains the serialized state

Throws:

IOException