org.apache.hadoop.hbase.procedure2

Class SequentialProcedure<TEnvironment>

java.lang.Object

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

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

All Implemented Interfaces:

Comparable<Procedure>

Direct Known Subclasses:

TestProcedureExecution.TestFaultyRollback, TestProcedureExecution.TestSequentialProcedure, TestProcedureExecution.TestWaitingProcedure, TestProcedureExecution.TestWaitingProcedure.TestWaitChild, TestProcedureNonce.TestSingleStepProcedure, TestProcedureRecovery.BaseTestStepProcedure, TestProcedureRecovery.TestSingleStepProcedure, TestProcedureReplayOrder.TestSingleStepProcedure, TestProcedureReplayOrder.TestTwoStepProcedure, TestWALProcedureStore.TestSequentialProcedure

@InterfaceAudience.Private
 @InterfaceStability.Evolving
public abstract class SequentialProcedure<TEnvironment>
extends Procedure<TEnvironment>

A SequentialProcedure describes one step in a procedure chain. -> Step 1 -> Step 2 -> Step 3 The main difference from a base Procedure is that the execute() of a SequentialProcedure will be called only once, there will be no second execute() call once the child are finished. which means once the child of a SequentialProcedure are completed the SequentialProcedure is completed too.

Constructor Summary

Constructors

Constructor and Description
SequentialProcedure()

Method Summary

Modifier and Type	Method and Description
protected void	deserializeStateData(InputStream stream) Called on store load to allow the user to decode the previously serialized state.
protected Procedure[]	doExecute(TEnvironment env) Internal method called by the ProcedureExecutor that starts the user-level code execute().
protected void	doRollback(TEnvironment env) Internal method called by the ProcedureExecutor that starts the user-level code rollback().
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.Procedure

abort, acquireLock, addStackIndex, beforeReplay, childrenCountDown, compareTo, completionCleanup, convert, convert, createProcedureInfo, elapsedTime, execute, 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, rollback, 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

SequentialProcedure

public SequentialProcedure()

Method Detail

doExecute

protected Procedure[] doExecute(TEnvironment env)
                         throws ProcedureYieldException,
                                InterruptedException

Description copied from class: Procedure

Internal method called by the ProcedureExecutor that starts the user-level code execute().

Overrides:

doExecute in class Procedure<TEnvironment>

Parameters:

env - the environment passed to the ProcedureExecutor

Returns:

a set of sub-procedures or null if there is nothing else to execute.

Throws:

ProcedureYieldException - the procedure will be added back to the queue and retried later

InterruptedException

doRollback

protected void doRollback(TEnvironment env)
                   throws IOException

Description copied from class: Procedure

Internal method called by the ProcedureExecutor that starts the user-level code rollback().

Overrides:

doRollback in class Procedure<TEnvironment>

Parameters:

env - the environment passed to the ProcedureExecutor

Throws:

IOException

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.

Specified by:

serializeStateData in class Procedure<TEnvironment>

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.

Specified by:

deserializeStateData in class Procedure<TEnvironment>

Parameters:

stream - the stream that contains the user serialized data

Throws:

IOException