@InterfaceAudience.Private public class ModifyColumnFamilyProcedure extends StateMachineProcedure<MasterProcedureEnv,MasterProcedureProtos.ModifyColumnFamilyState> implements TableProcedureInterface
StateMachineProcedure.Flow
TableProcedureInterface.TableOperationType
Constructor and Description |
---|
ModifyColumnFamilyProcedure() |
ModifyColumnFamilyProcedure(MasterProcedureEnv env,
TableName tableName,
HColumnDescriptor cfDescriptor) |
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.ModifyColumnFamilyState state)
called to perform a single step of the specified 'state' of the procedure
|
protected MasterProcedureProtos.ModifyColumnFamilyState |
getInitialState()
Return the initial state object that will be used for the first call to executeFromState().
|
protected MasterProcedureProtos.ModifyColumnFamilyState |
getState(int stateId)
Convert an ordinal (or state id) to an Enum (or more descriptive) state object.
|
protected int |
getStateId(MasterProcedureProtos.ModifyColumnFamilyState 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 void |
releaseLock(MasterProcedureEnv env)
The user should override this method, and release lock if necessary.
|
protected void |
rollbackState(MasterProcedureEnv env,
MasterProcedureProtos.ModifyColumnFamilyState 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.ModifyColumnFamilyState state)
Set the next state for the procedure.
|
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 ModifyColumnFamilyProcedure()
public ModifyColumnFamilyProcedure(MasterProcedureEnv env, TableName tableName, HColumnDescriptor cfDescriptor) throws java.io.IOException
java.io.IOException
protected StateMachineProcedure.Flow executeFromState(MasterProcedureEnv env, MasterProcedureProtos.ModifyColumnFamilyState state)
StateMachineProcedure
executeFromState
in class StateMachineProcedure<MasterProcedureEnv,MasterProcedureProtos.ModifyColumnFamilyState>
state
- state to executeprotected void rollbackState(MasterProcedureEnv env, MasterProcedureProtos.ModifyColumnFamilyState state) throws java.io.IOException
StateMachineProcedure
rollbackState
in class StateMachineProcedure<MasterProcedureEnv,MasterProcedureProtos.ModifyColumnFamilyState>
state
- state to rollbackjava.io.IOException
- temporary failure, the rollback will retry laterprotected MasterProcedureProtos.ModifyColumnFamilyState getState(int stateId)
StateMachineProcedure
getState
in class StateMachineProcedure<MasterProcedureEnv,MasterProcedureProtos.ModifyColumnFamilyState>
stateId
- the ordinal() of the state enum (or state id)protected int getStateId(MasterProcedureProtos.ModifyColumnFamilyState state)
StateMachineProcedure
getStateId
in class StateMachineProcedure<MasterProcedureEnv,MasterProcedureProtos.ModifyColumnFamilyState>
state
- the state enum objectprotected MasterProcedureProtos.ModifyColumnFamilyState getInitialState()
StateMachineProcedure
getInitialState
in class StateMachineProcedure<MasterProcedureEnv,MasterProcedureProtos.ModifyColumnFamilyState>
protected void setNextState(MasterProcedureProtos.ModifyColumnFamilyState state)
StateMachineProcedure
setNextState
in class StateMachineProcedure<MasterProcedureEnv,MasterProcedureProtos.ModifyColumnFamilyState>
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.ModifyColumnFamilyState>
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.ModifyColumnFamilyState>
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