org.apache.hadoop.hbase.master.procedure

Class EnableTableProcedure

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<MasterProcedureProtos.EnableTableState>

org.apache.hadoop.hbase.master.procedure.EnableTableProcedure

All Implemented Interfaces:

Comparable<Procedure<MasterProcedureEnv>>, TableProcedureInterface

@InterfaceAudience.Private
public class EnableTableProcedure
extends AbstractStateMachineTableProcedure<MasterProcedureProtos.EnableTableState>

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.StateMachineProcedure

stateCount

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

NO_PROC_ID, NO_TIMEOUT

Constructor Summary

Constructors

Constructor and Description
EnableTableProcedure()
EnableTableProcedure(MasterProcedureEnv env, TableName tableName, boolean skipTableStateCheck) Constructor
EnableTableProcedure(MasterProcedureEnv env, TableName tableName, boolean skipTableStateCheck, ProcedurePrepareLatch syncLatch) Constructor

Method Summary

Modifier and Type	Method and Description
protected void	deserializeStateData(ProcedureStateSerializer serializer) Called on store load to allow the user to decode the previously serialized state.
protected StateMachineProcedure.Flow	executeFromState(MasterProcedureEnv env, MasterProcedureProtos.EnableTableState state) called to perform a single step of the specified 'state' of the procedure
protected MasterProcedureProtos.EnableTableState	getInitialState() Return the initial state object that will be used for the first call to executeFromState().
protected MasterProcedureProtos.EnableTableState	getState(int stateId) Convert an ordinal (or state id) to an Enum (or more descriptive) state object.
protected int	getStateId(MasterProcedureProtos.EnableTableState state) Convert the Enum (or more descriptive) state object to an ordinal (or state id).
TableName	getTableName()
TableProcedureInterface.TableOperationType	getTableOperationType() Given an operation type we can take decisions about what to do with pending operations.
protected boolean	isRollbackSupported(MasterProcedureProtos.EnableTableState state) Used by the default implementation of abort() to know if the current state can be aborted and rollback can be triggered.
protected void	rollbackState(MasterProcedureEnv env, MasterProcedureProtos.EnableTableState 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.
protected static void	setTableStateToEnabled(MasterProcedureEnv env, TableName tableName) Mark table state to Enabled
protected static void	setTableStateToEnabling(MasterProcedureEnv env, TableName tableName) Mark table state to Enabling

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

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

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

abort, addChildProcedure, execute, failIfAborted, getCurrentState, getCurrentStateId, getCycles, isEofState, isYieldAfterExecutionStep, isYieldBeforeExecuteFromState, rollback, 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, setFailure, setFailure, setLastUpdate, setNonceKey, setOwner, setOwner, setParentProcId, setProcId, setResult, setRootProcId, setStackIndexes, setState, setSubmittedTime, setTimeout, setTimeoutFailure, shouldWaitClientAck, skipPersistence, 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

EnableTableProcedure

public EnableTableProcedure()

EnableTableProcedure

public EnableTableProcedure(MasterProcedureEnv env,
                            TableName tableName,
                            boolean skipTableStateCheck)

Constructor

Parameters:

env - MasterProcedureEnv

tableName - the table to operate on

skipTableStateCheck - whether to check table state

EnableTableProcedure

public EnableTableProcedure(MasterProcedureEnv env,
                            TableName tableName,
                            boolean skipTableStateCheck,
                            ProcedurePrepareLatch syncLatch)

Constructor

Parameters:

env - MasterProcedureEnv

tableName - the table to operate on

skipTableStateCheck - whether to check table state

Method Detail

executeFromState

protected StateMachineProcedure.Flow executeFromState(MasterProcedureEnv env,
                                                      MasterProcedureProtos.EnableTableState state)
                                               throws 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,MasterProcedureProtos.EnableTableState>

state - state to execute

Returns:

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

Throws:

InterruptedException

rollbackState

protected void rollbackState(MasterProcedureEnv env,
                             MasterProcedureProtos.EnableTableState state)
                      throws IOException

Description copied from class: StateMachineProcedure

called to perform the rollback of the specified state

Specified by:

rollbackState in class StateMachineProcedure<MasterProcedureEnv,MasterProcedureProtos.EnableTableState>

state - state to rollback

Throws:

IOException - temporary failure, the rollback will retry later

isRollbackSupported

protected boolean isRollbackSupported(MasterProcedureProtos.EnableTableState state)

Description copied from class: StateMachineProcedure

Used by the default implementation of abort() to know if the current state can be aborted and rollback can be triggered.

Overrides:

isRollbackSupported in class StateMachineProcedure<MasterProcedureEnv,MasterProcedureProtos.EnableTableState>

getState

protected MasterProcedureProtos.EnableTableState 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,MasterProcedureProtos.EnableTableState>

Parameters:

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

Returns:

the state enum object

getStateId

protected int getStateId(MasterProcedureProtos.EnableTableState 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,MasterProcedureProtos.EnableTableState>

Parameters:

state - the state enum object

Returns:

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

getInitialState

protected MasterProcedureProtos.EnableTableState 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,MasterProcedureProtos.EnableTableState>

Returns:

the initial state enum object

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,MasterProcedureProtos.EnableTableState>

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,MasterProcedureProtos.EnableTableState>

Parameters:

serializer - contains the serialized state

Throws:

IOException

getTableName

public TableName getTableName()

Specified by:

getTableName in interface TableProcedureInterface

Specified by:

getTableName in class AbstractStateMachineTableProcedure<MasterProcedureProtos.EnableTableState>

Returns:

the name of the table the procedure is operating on

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<MasterProcedureProtos.EnableTableState>

Returns:

the operation type that the procedure is executing.

setTableStateToEnabling

protected static void setTableStateToEnabling(MasterProcedureEnv env,
                                              TableName tableName)
                                       throws IOException

Mark table state to Enabling

Parameters:

env - MasterProcedureEnv

tableName - the target table

Throws:

IOException

setTableStateToEnabled

protected static void setTableStateToEnabled(MasterProcedureEnv env,
                                             TableName tableName)
                                      throws IOException

Mark table state to Enabled

Parameters:

env - MasterProcedureEnv

Throws:

IOException