Package org.apache.hadoop.hbase.master.procedure

Class AbstractCloseTableRegionsProcedure<TState extends Enum<?>>

java.lang.Object

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

org.apache.hadoop.hbase.procedure2.StateMachineProcedure<MasterProcedureEnv,TState>

org.apache.hadoop.hbase.master.procedure.AbstractStateMachineTableProcedure<TState>

org.apache.hadoop.hbase.master.procedure.AbstractCloseTableRegionsProcedure<TState>

All Implemented Interfaces:

Comparable<Procedure<MasterProcedureEnv>>, TableProcedureInterface

Direct Known Subclasses:

CloseExcessRegionReplicasProcedure, CloseTableRegionsProcedure

@Private
public abstract class AbstractCloseTableRegionsProcedure<TState extends Enum<?>>
extends AbstractStateMachineTableProcedure<TState>

Base class for unassigning table regions.

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

Nested classes/interfaces inherited from interface org.apache.hadoop.hbase.master.procedure.TableProcedureInterface

TableProcedureInterface.TableOperationType

Field Summary

Fields

Modifier and Type	Field	Description
private static final org.slf4j.Logger	LOG
private RetryCounter	retryCounter
protected TableName	tableName

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

Fields inherited from interface org.apache.hadoop.hbase.master.procedure.TableProcedureInterface

DUMMY_NAMESPACE_TABLE_NAME

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractCloseTableRegionsProcedure()
protected	AbstractCloseTableRegionsProcedure(TableName tableName)

Method Summary

Modifier and Type	Method	Description
private StateMachineProcedure.Flow	confirm(MasterProcedureEnv env)
protected StateMachineProcedure.Flow	executeFromState(MasterProcedureEnv env, TState state)	called to perform a single step of the specified 'state' of the procedure
protected abstract TState	getConfirmState()	We have two state for this type of procedures, the initial state for scheduling unassign procedures, and the confirm state for checking whether we have unassigned all the regions.
TableName	getTableName()	Returns the name of the table the procedure is operating on
TableProcedureInterface.TableOperationType	getTableOperationType()	Given an operation type we can take decisions about what to do with pending operations.
protected abstract int	numberOfUnclosedRegions(MasterProcedureEnv env)	Return the number of uncloses regions.
protected void	rollbackState(MasterProcedureEnv env, TState state)	called to perform the rollback of the specified state
private StateMachineProcedure.Flow	schedule(MasterProcedureEnv env)
protected boolean	setTimeoutFailure(MasterProcedureEnv env)	Called by the ProcedureExecutor when the timeout set by setTimeout() is expired.
protected abstract int	submitUnassignProcedure(MasterProcedureEnv env, Consumer<TransitRegionStateProcedure> submit)	Submit TRSP for unassigning regions.

Methods inherited from class org.apache.hadoop.hbase.master.procedure.AbstractStateMachineTableProcedure

acquireLock, checkOnline, checkTableModifiable, getUser, getWALRegionDir, isTableEnabled, preflightChecks, releaseLock, releaseSyncLatch, setUser, toStringClassDetails, waitInitialized

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

abort, addChildProcedure, deserializeStateData, execute, failIfAborted, getCurrentState, getCurrentStateId, getCycles, getInitialState, getState, getStateId, isEofState, isRollbackSupported, isRollbackSupported, isYieldAfterExecutionStep, isYieldBeforeExecuteFromState, rollback, serializeStateData, setNextState, toStringState

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

addStackIndex, afterReplay, 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, removeStackIndex, setAbortFailure, setChildrenLatch, setExecuted, setFailure, setFailure, setLastUpdate, setNonceKey, setOwner, setOwner, setParentProcId, setProcId, setResult, setRootProcId, setStackIndexes, setState, setSubmittedTime, setTimeout, shouldWaitClientAck, skipPersistence, suspend, toString, toStringClass, toStringDetails, toStringSimpleSB, updateMetricsOnFinish, updateMetricsOnSubmit, updateTimestamp, 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

tableName

protected TableName tableName

retryCounter

private RetryCounter retryCounter

Constructor Details

AbstractCloseTableRegionsProcedure

protected AbstractCloseTableRegionsProcedure()

AbstractCloseTableRegionsProcedure

protected AbstractCloseTableRegionsProcedure(TableName tableName)

Method Details

getTableName

public TableName getTableName()

Description copied from interface: TableProcedureInterface

Returns the name of the table the procedure is operating on

Specified by:

getTableName in interface TableProcedureInterface

Specified by:

getTableName in class AbstractStateMachineTableProcedure<TState extends Enum<?>>

getTableOperationType

public TableProcedureInterface.TableOperationType getTableOperationType()

Description copied from interface: TableProcedureInterface

Given an operation type we can take decisions about what to do with pending operations. e.g. if we get a delete and we have some table operation pending (e.g. add column) we can abort those operations.

Specified by:

getTableOperationType in interface TableProcedureInterface

Specified by:

getTableOperationType in class AbstractStateMachineTableProcedure<TState extends Enum<?>>

Returns:

the operation type that the procedure is executing.

schedule

private StateMachineProcedure.Flow schedule(MasterProcedureEnv env)
                                     throws ProcedureSuspendedException

Throws:

ProcedureSuspendedException

confirm

private StateMachineProcedure.Flow confirm(MasterProcedureEnv env)

executeFromState

protected StateMachineProcedure.Flow executeFromState(MasterProcedureEnv env,
 TState 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,TState extends Enum<?>>

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

rollbackState

protected void rollbackState(MasterProcedureEnv env,
 TState 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,TState extends Enum<?>>

state - state to rollback

Throws:

IOException - temporary failure, the rollback will retry later

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.

getConfirmState

protected abstract TState getConfirmState()

We have two state for this type of procedures, the initial state for scheduling unassign procedures, and the confirm state for checking whether we have unassigned all the regions.

Returns:

the confirm state

submitUnassignProcedure

protected abstract int submitUnassignProcedure(MasterProcedureEnv env,
 Consumer<TransitRegionStateProcedure> submit)

Submit TRSP for unassigning regions. Return the number of regions in RIT state that we can not schedule TRSP for them.

numberOfUnclosedRegions

protected abstract int numberOfUnclosedRegions(MasterProcedureEnv env)

Return the number of uncloses regions. Returning 0 means we are done.