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

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

All Implemented Interfaces:

Comparable<Procedure>, TableProcedureInterface

@InterfaceAudience.Private
public class EnableTableProcedure
extends StateMachineProcedure<MasterProcedureEnv,MasterProcedureProtos.EnableTableState>
implements TableProcedureInterface

Nested Class Summary

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

StateMachineProcedure.Flow

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

TableProcedureInterface.TableOperationType

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

Methods

Modifier and Type	Method and Description
boolean	abort(MasterProcedureEnv env)
protected boolean	acquireLock(MasterProcedureEnv env)
void	deserializeStateData(InputStream stream)
protected StateMachineProcedure.Flow	executeFromState(MasterProcedureEnv env, MasterProcedureProtos.EnableTableState state)
protected MasterProcedureProtos.EnableTableState	getInitialState()
protected MasterProcedureProtos.EnableTableState	getState(int stateId)
protected int	getStateId(MasterProcedureProtos.EnableTableState state)
TableName	getTableName()
TableProcedureInterface.TableOperationType	getTableOperationType() Given an operation type we can take decisions about what to do with pending operations.
protected static void	markRegionsOnline(MasterProcedureEnv env, TableName tableName, Boolean retryRequired) Mark offline regions of the table online with retry
protected void	releaseLock(MasterProcedureEnv env)
protected void	rollbackState(MasterProcedureEnv env, MasterProcedureProtos.EnableTableState state)
void	serializeStateData(OutputStream stream)
protected void	setNextState(MasterProcedureProtos.EnableTableState state)
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
void	toStringClassDetails(StringBuilder sb)

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

execute, rollback

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

addStackIndex, beforeReplay, childrenCountDown, compareTo, completionCleanup, convert, convert, doExecute, doRollback, elapsedTime, getException, getLastUpdate, getOwner, getParentProcId, getProcId, getResult, getRootProcedureId, getStackIndexes, getStartTime, getState, getTimeout, getTimeRemaining, hasException, hasOwner, hasParent, hasTimeout, incChildrenLatch, isFailed, isFinished, isSuccess, isWaiting, newInstance, removeStackIndex, setAbortFailure, setChildrenLatch, setFailure, setFailure, setOwner, setParentProcId, setProcId, setResult, setStackIndexes, setStartTime, setState, setTimeout, setTimeoutFailure, toString, updateTimestamp, validateClass, 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)
                     throws IOException

Constructor

Parameters:

env - MasterProcedureEnv

tableName - the table to operate on

skipTableStateCheck - whether to check table state

Throws:

IOException

EnableTableProcedure

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

Constructor

Parameters:

env - MasterProcedureEnv

tableName - the table to operate on

skipTableStateCheck - whether to check table state

Throws:

IOException

Method Detail

executeFromState

protected StateMachineProcedure.Flow executeFromState(MasterProcedureEnv env,
                                          MasterProcedureProtos.EnableTableState state)

Specified by:

executeFromState in class StateMachineProcedure<MasterProcedureEnv,MasterProcedureProtos.EnableTableState>

rollbackState

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

Specified by:

rollbackState in class StateMachineProcedure<MasterProcedureEnv,MasterProcedureProtos.EnableTableState>

Throws:

IOException

getState

protected MasterProcedureProtos.EnableTableState getState(int stateId)

Specified by:

getState in class StateMachineProcedure<MasterProcedureEnv,MasterProcedureProtos.EnableTableState>

getStateId

protected int getStateId(MasterProcedureProtos.EnableTableState state)

Specified by:

getStateId in class StateMachineProcedure<MasterProcedureEnv,MasterProcedureProtos.EnableTableState>

getInitialState

protected MasterProcedureProtos.EnableTableState getInitialState()

Specified by:

getInitialState in class StateMachineProcedure<MasterProcedureEnv,MasterProcedureProtos.EnableTableState>

setNextState

protected void setNextState(MasterProcedureProtos.EnableTableState state)

Overrides:

setNextState in class StateMachineProcedure<MasterProcedureEnv,MasterProcedureProtos.EnableTableState>

abort

public boolean abort(MasterProcedureEnv env)

Specified by:

abort in class Procedure<MasterProcedureEnv>

acquireLock

protected boolean acquireLock(MasterProcedureEnv env)

Overrides:

acquireLock in class Procedure<MasterProcedureEnv>

releaseLock

protected void releaseLock(MasterProcedureEnv env)

Overrides:

releaseLock in class Procedure<MasterProcedureEnv>

serializeStateData

public void serializeStateData(OutputStream stream)
                        throws IOException

Overrides:

serializeStateData in class StateMachineProcedure<MasterProcedureEnv,MasterProcedureProtos.EnableTableState>

Throws:

IOException

deserializeStateData

public void deserializeStateData(InputStream stream)
                          throws IOException

Overrides:

deserializeStateData in class StateMachineProcedure<MasterProcedureEnv,MasterProcedureProtos.EnableTableState>

Throws:

IOException

toStringClassDetails

public void toStringClassDetails(StringBuilder sb)

Overrides:

toStringClassDetails in class Procedure<MasterProcedureEnv>

getTableName

public TableName getTableName()

Specified by:

getTableName in interface TableProcedureInterface

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

Returns:

the operation type that the procedure is executing.

setTableStateToEnabling

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

Mark table state to Enabling

Parameters:

env - MasterProcedureEnv

tableName - the target table

Throws:

IOException

HBaseException

markRegionsOnline

protected static void markRegionsOnline(MasterProcedureEnv env,
                     TableName tableName,
                     Boolean retryRequired)
                                 throws IOException

Mark offline regions of the table online with retry

Parameters:

env - MasterProcedureEnv

tableName - the target table

retryRequired - whether to retry if the first run failed

Throws:

IOException

setTableStateToEnabled

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

Mark table state to Enabled

Parameters:

env - MasterProcedureEnv

Throws:

IOException

HBaseException