@InterfaceAudience.Private public class EnableTableProcedure extends StateMachineProcedure<MasterProcedureEnv,MasterProcedureProtos.EnableTableState> implements TableProcedureInterface
StateMachineProcedure.Flow
TableProcedureInterface.TableOperationType
Constructor and Description |
---|
EnableTableProcedure() |
EnableTableProcedure(MasterProcedureEnv env,
TableName tableName,
boolean skipTableStateCheck)
Constructor
|
EnableTableProcedure(MasterProcedureEnv env,
TableName tableName,
boolean skipTableStateCheck,
ProcedurePrepareLatch syncLatch)
Constructor
|
Modifier and Type | Method and Description |
---|---|
boolean |
abort(MasterProcedureEnv env)
The abort() call is asynchronous and each procedure must decide how to deal
with that, if they want to be abortable.
|
protected boolean |
acquireLock(MasterProcedureEnv env)
The user should override this method, and try to take a lock if necessary.
|
void |
deserializeStateData(java.io.InputStream stream)
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 static void |
markRegionsOnline(MasterProcedureEnv env,
TableName tableName,
java.lang.Boolean retryRequired)
Mark offline regions of the table online with retry
|
protected void |
releaseLock(MasterProcedureEnv env)
The user should override this method, and release lock if necessary.
|
protected void |
rollbackState(MasterProcedureEnv env,
MasterProcedureProtos.EnableTableState state)
called to perform the rollback of the specified state
|
void |
serializeStateData(java.io.OutputStream stream)
The user-level code of the procedure may have some state to
persist (e.g.
|
protected void |
setNextState(MasterProcedureProtos.EnableTableState state)
Set the next state for the procedure.
|
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(java.lang.StringBuilder sb)
Extend the toString() information with the procedure details
e.g.
|
execute, rollback
addStackIndex, beforeReplay, childrenCountDown, compareTo, completionCleanup, convert, convert, createProcedureInfo, doExecute, doRollback, elapsedTime, getException, getLastUpdate, getNonceKey, 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, setNonceKey, setOwner, setParentProcId, setProcId, setResult, setStackIndexes, setStartTime, setState, setTimeout, setTimeoutFailure, toString, toStringClass, toStringDetails, toStringSimpleSB, updateTimestamp, validateClass, wasExecuted
public EnableTableProcedure()
public EnableTableProcedure(MasterProcedureEnv env, TableName tableName, boolean skipTableStateCheck) throws java.io.IOException
env
- MasterProcedureEnvtableName
- the table to operate onskipTableStateCheck
- whether to check table statejava.io.IOException
public EnableTableProcedure(MasterProcedureEnv env, TableName tableName, boolean skipTableStateCheck, ProcedurePrepareLatch syncLatch) throws java.io.IOException
env
- MasterProcedureEnvtableName
- the table to operate onskipTableStateCheck
- whether to check table statejava.io.IOException
protected StateMachineProcedure.Flow executeFromState(MasterProcedureEnv env, MasterProcedureProtos.EnableTableState state)
StateMachineProcedure
executeFromState
in class StateMachineProcedure<MasterProcedureEnv,MasterProcedureProtos.EnableTableState>
state
- state to executeprotected void rollbackState(MasterProcedureEnv env, MasterProcedureProtos.EnableTableState state) throws java.io.IOException
StateMachineProcedure
rollbackState
in class StateMachineProcedure<MasterProcedureEnv,MasterProcedureProtos.EnableTableState>
state
- state to rollbackjava.io.IOException
- temporary failure, the rollback will retry laterprotected MasterProcedureProtos.EnableTableState getState(int stateId)
StateMachineProcedure
getState
in class StateMachineProcedure<MasterProcedureEnv,MasterProcedureProtos.EnableTableState>
stateId
- the ordinal() of the state enum (or state id)protected int getStateId(MasterProcedureProtos.EnableTableState state)
StateMachineProcedure
getStateId
in class StateMachineProcedure<MasterProcedureEnv,MasterProcedureProtos.EnableTableState>
state
- the state enum objectprotected MasterProcedureProtos.EnableTableState getInitialState()
StateMachineProcedure
getInitialState
in class StateMachineProcedure<MasterProcedureEnv,MasterProcedureProtos.EnableTableState>
protected void setNextState(MasterProcedureProtos.EnableTableState state)
StateMachineProcedure
setNextState
in class StateMachineProcedure<MasterProcedureEnv,MasterProcedureProtos.EnableTableState>
state
- the state enum objectpublic boolean abort(MasterProcedureEnv env)
Procedure
abort
in class Procedure<MasterProcedureEnv>
env
- the environment passed to the ProcedureExecutorprotected boolean acquireLock(MasterProcedureEnv env)
Procedure
acquireLock
in class Procedure<MasterProcedureEnv>
env
- the environment passed to the ProcedureExecutorprotected void releaseLock(MasterProcedureEnv env)
Procedure
releaseLock
in class Procedure<MasterProcedureEnv>
env
- the environment passed to the ProcedureExecutorpublic void serializeStateData(java.io.OutputStream stream) throws java.io.IOException
Procedure
serializeStateData
in class StateMachineProcedure<MasterProcedureEnv,MasterProcedureProtos.EnableTableState>
stream
- the stream that will contain the user serialized datajava.io.IOException
- failure to stream datapublic void deserializeStateData(java.io.InputStream stream) throws java.io.IOException
Procedure
deserializeStateData
in class StateMachineProcedure<MasterProcedureEnv,MasterProcedureProtos.EnableTableState>
stream
- the stream that contains the user serialized datajava.io.IOException
public void toStringClassDetails(java.lang.StringBuilder sb)
Procedure
toStringClassDetails
in class Procedure<MasterProcedureEnv>
sb
- the string builder to use to append the proc specific informationpublic TableName getTableName()
getTableName
in interface TableProcedureInterface
public TableProcedureInterface.TableOperationType getTableOperationType()
TableProcedureInterface
getTableOperationType
in interface TableProcedureInterface
protected static void setTableStateToEnabling(MasterProcedureEnv env, TableName tableName) throws HBaseException, java.io.IOException
env
- MasterProcedureEnvtableName
- the target tablejava.io.IOException
HBaseException
protected static void markRegionsOnline(MasterProcedureEnv env, TableName tableName, java.lang.Boolean retryRequired) throws java.io.IOException
env
- MasterProcedureEnvtableName
- the target tableretryRequired
- whether to retry if the first run failedjava.io.IOException
protected static void setTableStateToEnabled(MasterProcedureEnv env, TableName tableName) throws HBaseException, java.io.IOException
env
- MasterProcedureEnvjava.io.IOException
HBaseException