org.apache.hadoop.hbase.procedure2

Class TestProcedureRecovery.TestStateMachineProcedure

java.lang.Object

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

org.apache.hadoop.hbase.procedure2.StateMachineProcedure<Void,org.apache.hadoop.hbase.procedure2.TestProcedureRecovery.TestStateMachineProcedure.State>

org.apache.hadoop.hbase.procedure2.TestProcedureRecovery.TestStateMachineProcedure

All Implemented Interfaces:

Comparable<Procedure>

Enclosing class:

TestProcedureRecovery

public static class TestProcedureRecovery.TestStateMachineProcedure
extends StateMachineProcedure<Void,org.apache.hadoop.hbase.procedure2.TestProcedureRecovery.TestStateMachineProcedure.State>

Nested Class Summary

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

StateMachineProcedure.Flow

Constructor Summary

Constructors

Constructor and Description
TestStateMachineProcedure()

Method Summary

Modifier and Type	Method and Description
protected boolean	abort(Void env) The abort() call is asynchronous and each procedure must decide how to deal with that, if they want to be abortable.
protected void	deserializeStateData(InputStream stream) Called on store load to allow the user to decode the previously serialized state.
protected StateMachineProcedure.Flow	executeFromState(Void env, org.apache.hadoop.hbase.procedure2.TestProcedureRecovery.TestStateMachineProcedure.State state) called to perform a single step of the specified 'state' of the procedure
protected org.apache.hadoop.hbase.procedure2.TestProcedureRecovery.TestStateMachineProcedure.State	getInitialState() Return the initial state object that will be used for the first call to executeFromState().
protected org.apache.hadoop.hbase.procedure2.TestProcedureRecovery.TestStateMachineProcedure.State	getState(int stateId) Convert an ordinal (or state id) to an Enum (or more descriptive) state object.
protected int	getStateId(org.apache.hadoop.hbase.procedure2.TestProcedureRecovery.TestStateMachineProcedure.State state) Convert the Enum (or more descriptive) state object to an ordinal (or state id).
protected void	rollbackState(Void env, org.apache.hadoop.hbase.procedure2.TestProcedureRecovery.TestStateMachineProcedure.State state) called to perform the rollback of the specified state
protected void	serializeStateData(OutputStream stream) The user-level code of the procedure may have some state to persist (e.g.

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

execute, rollback, setNextState

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

acquireLock, 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, releaseLock, removeStackIndex, setAbortFailure, setChildrenLatch, setFailure, setFailure, setNonceKey, setOwner, setParentProcId, setProcId, setResult, setStackIndexes, setStartTime, setState, setTimeout, setTimeoutFailure, toString, toStringClass, toStringClassDetails, toStringDetails, toStringSimpleSB, updateTimestamp, validateClass, wasExecuted

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

TestStateMachineProcedure

public TestStateMachineProcedure()

Method Detail

executeFromState

protected StateMachineProcedure.Flow executeFromState(Void env,
                                                      org.apache.hadoop.hbase.procedure2.TestProcedureRecovery.TestStateMachineProcedure.State state)

Description copied from class: StateMachineProcedure

called to perform a single step of the specified 'state' of the procedure

Specified by:

executeFromState in class StateMachineProcedure<Void,org.apache.hadoop.hbase.procedure2.TestProcedureRecovery.TestStateMachineProcedure.State>

state - state to execute

Returns:

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

rollbackState

protected void rollbackState(Void env,
                             org.apache.hadoop.hbase.procedure2.TestProcedureRecovery.TestStateMachineProcedure.State state)

Description copied from class: StateMachineProcedure

called to perform the rollback of the specified state

Specified by:

rollbackState in class StateMachineProcedure<Void,org.apache.hadoop.hbase.procedure2.TestProcedureRecovery.TestStateMachineProcedure.State>

state - state to rollback

getState

protected org.apache.hadoop.hbase.procedure2.TestProcedureRecovery.TestStateMachineProcedure.State 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<Void,org.apache.hadoop.hbase.procedure2.TestProcedureRecovery.TestStateMachineProcedure.State>

Parameters:

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

Returns:

the state enum object

getStateId

protected int getStateId(org.apache.hadoop.hbase.procedure2.TestProcedureRecovery.TestStateMachineProcedure.State 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<Void,org.apache.hadoop.hbase.procedure2.TestProcedureRecovery.TestStateMachineProcedure.State>

Parameters:

state - the state enum object

Returns:

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

getInitialState

protected org.apache.hadoop.hbase.procedure2.TestProcedureRecovery.TestStateMachineProcedure.State 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<Void,org.apache.hadoop.hbase.procedure2.TestProcedureRecovery.TestStateMachineProcedure.State>

Returns:

the initial state enum object

abort

protected boolean abort(Void env)

Description copied from class: Procedure

The abort() call is asynchronous and each procedure must decide how to deal with that, if they want to be abortable. The simplest implementation is to have an AtomicBoolean set in the abort() method and then the execute() will check if the abort flag is set or not. abort() may be called multiple times from the client, so the implementation must be idempotent. NOTE: abort() is not like Thread.interrupt() it is just a notification that allows the procedure implementor where to abort to avoid leak and have a better control on what was executed and what not.

Specified by:

abort in class Procedure<Void>

Parameters:

env - the environment passed to the ProcedureExecutor

serializeStateData

protected void serializeStateData(OutputStream stream)
                           throws IOException

Description copied from class: Procedure

The user-level code of the procedure may have some state to persist (e.g. input arguments) to be able to resume on failure.

Overrides:

serializeStateData in class StateMachineProcedure<Void,org.apache.hadoop.hbase.procedure2.TestProcedureRecovery.TestStateMachineProcedure.State>

Parameters:

stream - the stream that will contain the user serialized data

Throws:

IOException - failure to stream data

deserializeStateData

protected void deserializeStateData(InputStream stream)
                             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<Void,org.apache.hadoop.hbase.procedure2.TestProcedureRecovery.TestStateMachineProcedure.State>

Parameters:

stream - the stream that contains the user serialized data

Throws:

IOException