org.apache.hadoop.hbase.master.procedure

Class AbstractStateMachineRegionProcedure<TState>

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.AbstractStateMachineRegionProcedure<TState>

All Implemented Interfaces:

Comparable<Procedure<MasterProcedureEnv>>, TableProcedureInterface

Direct Known Subclasses:

GCRegionProcedure, MoveRegionProcedure, SplitTableRegionProcedure

@InterfaceAudience.Private
public abstract class AbstractStateMachineRegionProcedure<TState>
extends AbstractStateMachineTableProcedure<TState>

Base class for all the Region procedures that want to use a StateMachine. It provides some basic helpers like basic locking, sync latch, and toStringClassDetails(). Defaults to holding the lock for the life of the procedure.

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 inherited from class org.apache.hadoop.hbase.procedure2.Procedure

NO_PROC_ID, NO_TIMEOUT

Constructor Summary

Constructors

Constructor and Description
AbstractStateMachineRegionProcedure()
AbstractStateMachineRegionProcedure(MasterProcedureEnv env, RegionInfo hri)

Method Summary

Modifier and Type	Method and Description
protected Procedure.LockState	acquireLock(MasterProcedureEnv env)
protected void	checkTableModifiable(MasterProcedureEnv env) Check whether a table is modifiable - exists and either offline or online with config set
protected void	deserializeStateData(ProcedureStateSerializer serializer)
protected RegionInfo	getRegion()
TableName	getTableName()
abstract TableProcedureInterface.TableOperationType	getTableOperationType() Given an operation type we can take decisions about what to do with pending operations.
protected boolean	hasLock(MasterProcedureEnv env)
protected boolean	holdLock(MasterProcedureEnv env)
protected void	releaseLock(MasterProcedureEnv env)
protected void	serializeStateData(ProcedureStateSerializer serializer)
protected void	setFailure(Throwable cause)
protected void	setRegion(RegionInfo hri) Used when deserializing.
void	toStringClassDetails(StringBuilder sb)

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

checkOnline, getRegionDir, getUser, preflightChecks, releaseSyncLatch, setUser

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

abort, addChildProcedure, execute, executeFromState, failIfAborted, getCurrentState, getCurrentStateId, getCycles, getInitialState, getState, getStateId, isRollbackSupported, isYieldAfterExecutionStep, isYieldBeforeExecuteFromState, rollback, rollbackState, setNextState, toStringState

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

addStackIndex, afterReplay, beforeReplay, compareTo, completionCleanup, doAcquireLock, doExecute, doReleaseLock, doRollback, elapsedTime, getChildrenLatch, getException, getLastUpdate, getNonceKey, getOwner, getParentProcId, getProcedureMetrics, getProcId, getProcIdHashCode, getProcName, getResult, getRootProcedureId, getRootProcId, getStackIndexes, getState, getSubmittedTime, getTimeout, getTimeoutTimestamp, hasChildren, hasException, hasOwner, hasParent, hasTimeout, haveSameParent, incChildrenLatch, isFailed, isFinished, isInitializing, isRunnable, isSuccess, isWaiting, removeStackIndex, setAbortFailure, setChildrenLatch, setFailure, setFailure, setLastUpdate, setNonceKey, setOwner, setOwner, setParentProcId, setProcId, setResult, setRootProcId, setStackIndexes, setState, setSubmittedTime, setTimeout, setTimeoutFailure, shouldWaitClientAck, 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

Constructor Detail

AbstractStateMachineRegionProcedure

public AbstractStateMachineRegionProcedure(MasterProcedureEnv env,
                                           RegionInfo hri)

AbstractStateMachineRegionProcedure

public AbstractStateMachineRegionProcedure()

Method Detail

getRegion

protected RegionInfo getRegion()

Returns:

The RegionInfo of the region we are operating on.

setRegion

protected void setRegion(RegionInfo hri)

Used when deserializing. Otherwise, DON'T TOUCH IT!

getTableName

public TableName getTableName()

Specified by:

getTableName in interface TableProcedureInterface

Specified by:

getTableName in class AbstractStateMachineTableProcedure<TState>

Returns:

the name of the table the procedure is operating on

getTableOperationType

public abstract 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>

Returns:

the operation type that the procedure is executing.

toStringClassDetails

public void toStringClassDetails(StringBuilder sb)

Overrides:

toStringClassDetails in class AbstractStateMachineTableProcedure<TState>

checkTableModifiable

protected void checkTableModifiable(MasterProcedureEnv env)
                             throws IOException

Check whether a table is modifiable - exists and either offline or online with config set

Overrides:

checkTableModifiable in class AbstractStateMachineTableProcedure<TState>

Parameters:

env - MasterProcedureEnv

Throws:

IOException

holdLock

protected boolean holdLock(MasterProcedureEnv env)

Overrides:

holdLock in class Procedure<MasterProcedureEnv>

acquireLock

protected Procedure.LockState acquireLock(MasterProcedureEnv env)

Overrides:

acquireLock in class AbstractStateMachineTableProcedure<TState>

releaseLock

protected void releaseLock(MasterProcedureEnv env)

Overrides:

releaseLock in class AbstractStateMachineTableProcedure<TState>

hasLock

protected boolean hasLock(MasterProcedureEnv env)

Overrides:

hasLock in class Procedure<MasterProcedureEnv>

setFailure

protected void setFailure(Throwable cause)

serializeStateData

protected void serializeStateData(ProcedureStateSerializer serializer)
                           throws IOException

Overrides:

serializeStateData in class StateMachineProcedure<MasterProcedureEnv,TState>

Throws:

IOException

deserializeStateData

protected void deserializeStateData(ProcedureStateSerializer serializer)
                             throws IOException

Overrides:

deserializeStateData in class StateMachineProcedure<MasterProcedureEnv,TState>

Throws:

IOException