org.apache.hadoop.hbase.master.procedure

Class DisableTableProcedure

java.lang.Object

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

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

org.apache.hadoop.hbase.master.procedure.DisableTableProcedure

All Implemented Interfaces:

Comparable<Procedure>, TableProcedureInterface

@InterfaceAudience.Private
public class DisableTableProcedure
extends StateMachineProcedure<MasterProcedureEnv,org.apache.hadoop.hbase.protobuf.generated.MasterProcedureProtos.DisableTableState>
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
DisableTableProcedure()
DisableTableProcedure(MasterProcedureEnv env, TableName tableName, boolean skipTableStateCheck) Constructor
DisableTableProcedure(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, org.apache.hadoop.hbase.protobuf.generated.MasterProcedureProtos.DisableTableState state)
protected org.apache.hadoop.hbase.protobuf.generated.MasterProcedureProtos.DisableTableState	getInitialState()
protected org.apache.hadoop.hbase.protobuf.generated.MasterProcedureProtos.DisableTableState	getState(int stateId)
protected int	getStateId(org.apache.hadoop.hbase.protobuf.generated.MasterProcedureProtos.DisableTableState state)
TableName	getTableName()
TableProcedureInterface.TableOperationType	getTableOperationType() Given an operation type we can take decisions about what to do with pending operations.
protected static org.apache.hadoop.hbase.master.procedure.DisableTableProcedure.MarkRegionOfflineOpResult	markRegionsOffline(MasterProcedureEnv env, TableName tableName, Boolean retryRequired) Mark regions of the table offline with retries
protected void	postDisable(MasterProcedureEnv env, org.apache.hadoop.hbase.protobuf.generated.MasterProcedureProtos.DisableTableState state) Action after disabling table.
protected void	preDisable(MasterProcedureEnv env, org.apache.hadoop.hbase.protobuf.generated.MasterProcedureProtos.DisableTableState state) Action before disabling table.
protected void	releaseLock(MasterProcedureEnv env)
protected void	rollbackState(MasterProcedureEnv env, org.apache.hadoop.hbase.protobuf.generated.MasterProcedureProtos.DisableTableState state)
void	serializeStateData(OutputStream stream)
protected void	setNextState(org.apache.hadoop.hbase.protobuf.generated.MasterProcedureProtos.DisableTableState state)
protected static void	setTableStateToDisabled(MasterProcedureEnv env, TableName tableName) Mark table state to Disabled
protected static void	setTableStateToDisabling(MasterProcedureEnv env, TableName tableName) Mark table state to Disabling
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

DisableTableProcedure

public DisableTableProcedure()

DisableTableProcedure

public DisableTableProcedure(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

DisableTableProcedure

public DisableTableProcedure(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,
                                          org.apache.hadoop.hbase.protobuf.generated.MasterProcedureProtos.DisableTableState state)

Specified by:

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

rollbackState

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

Specified by:

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

Throws:

IOException

getState

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

Specified by:

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

getStateId

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

Specified by:

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

getInitialState

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

Specified by:

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

setNextState

protected void setNextState(org.apache.hadoop.hbase.protobuf.generated.MasterProcedureProtos.DisableTableState state)

Overrides:

setNextState in class StateMachineProcedure<MasterProcedureEnv,org.apache.hadoop.hbase.protobuf.generated.MasterProcedureProtos.DisableTableState>

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,org.apache.hadoop.hbase.protobuf.generated.MasterProcedureProtos.DisableTableState>

Throws:

IOException

deserializeStateData

public void deserializeStateData(InputStream stream)
                          throws IOException

Overrides:

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

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.

preDisable

protected void preDisable(MasterProcedureEnv env,
              org.apache.hadoop.hbase.protobuf.generated.MasterProcedureProtos.DisableTableState state)
                   throws IOException,
                          InterruptedException

Action before disabling table.

Parameters:

env - MasterProcedureEnv

state - the procedure state

Throws:

IOException

InterruptedException

setTableStateToDisabling

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

Mark table state to Disabling

Parameters:

env - MasterProcedureEnv

Throws:

IOException

HBaseException

markRegionsOffline

protected static org.apache.hadoop.hbase.master.procedure.DisableTableProcedure.MarkRegionOfflineOpResult markRegionsOffline(MasterProcedureEnv env,
                                                                                                          TableName tableName,
                                                                                                          Boolean retryRequired)
                                                                                                                      throws IOException

Mark regions of the table offline with retries

Parameters:

env - MasterProcedureEnv

tableName - the target table

retryRequired - whether to retry if the first run failed

Returns:

whether the operation is fully completed or being interrupted.

Throws:

IOException

setTableStateToDisabled

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

Mark table state to Disabled

Parameters:

env - MasterProcedureEnv

Throws:

IOException

HBaseException

postDisable

protected void postDisable(MasterProcedureEnv env,
               org.apache.hadoop.hbase.protobuf.generated.MasterProcedureProtos.DisableTableState state)
                    throws IOException,
                           InterruptedException

Action after disabling table.

Parameters:

env - MasterProcedureEnv

state - the procedure state

Throws:

IOException

InterruptedException