Package org.apache.hadoop.hbase.procedure2

Class RootProcedureState<TEnvironment>

java.lang.Object

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

@Private
@Evolving
class RootProcedureState<TEnvironment>
extends Object

Internal state of the ProcedureExecutor that describes the state of a "Root Procedure". A "Root Procedure" is a Procedure without parent, each subprocedure will be added to the "Root Procedure" stack (or rollback-stack). RootProcedureState is used and managed only by the ProcedureExecutor.

   Long rootProcId = getRootProcedureId(proc);
   rollbackStack.get(rootProcId).acquire(proc)
   rollbackStack.get(rootProcId).release(proc)
   ...
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static enum	RootProcedureState.State

Field Summary

Fields

Modifier and Type	Field	Description
private static final org.slf4j.Logger	LOG
private boolean	rollbackSupported
private int	running
private RootProcedureState.State	state
private Set<Procedure<TEnvironment>>	subprocs
private ArrayList<Procedure<TEnvironment>>	subprocStack

Constructor Summary

Constructors

Constructor	Description
RootProcedureState()

Method Summary

Modifier and Type	Method	Description
protected void	abort()
protected boolean	acquire(Procedure<TEnvironment> proc)	Called by the ProcedureExecutor to mark the procedure step as running.
protected boolean	addRollbackStep(Procedure<TEnvironment> proc)	Called by the ProcedureExecutor after the procedure step is completed, to add the step to the rollback list (or procedure stack).
protected void	addSubProcedure(Procedure<TEnvironment> proc)
protected RemoteProcedureException	getException()
protected long[]	getSubprocedureIds()
protected List<Procedure<TEnvironment>>	getSubproceduresStack()
protected Collection<Procedure<TEnvironment>>	getSubprocs()
protected boolean	isFailed()
protected boolean	isRollbackSupported()
protected boolean	isRollingback()
protected boolean	isValid()	Called on store load by the ProcedureExecutor to validate the procedure stack.
protected void	loadStack(Procedure<TEnvironment> proc)	Called on store load by the ProcedureExecutor to load part of the stack.
protected void	release(Procedure<TEnvironment> proc)	Called by the ProcedureExecutor to mark the procedure step as finished.
protected boolean	setRollback()	Called by the ProcedureExecutor to mark rollback execution
protected void	setRollbackSupported(boolean rollbackSupported)
protected void	unsetRollback()	Called by the ProcedureExecutor to mark rollback execution

Methods inherited from class java.lang.Object

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

Field Details

LOG

private static final org.slf4j.Logger LOG

subprocs

private Set<Procedure<TEnvironment>> subprocs

subprocStack

private ArrayList<Procedure<TEnvironment>> subprocStack

state

private RootProcedureState.State state

running

private int running

rollbackSupported

private boolean rollbackSupported

Constructor Details

RootProcedureState

RootProcedureState()

Method Details

isFailed

protected boolean isFailed()

isRollingback

protected boolean isRollingback()

setRollback

protected boolean setRollback()

Called by the ProcedureExecutor to mark rollback execution

unsetRollback

protected void unsetRollback()

Called by the ProcedureExecutor to mark rollback execution

setRollbackSupported

protected void setRollbackSupported(boolean rollbackSupported)

isRollbackSupported

protected boolean isRollbackSupported()

getSubprocedureIds

protected long[] getSubprocedureIds()

getSubprocs

protected Collection<Procedure<TEnvironment>> getSubprocs()

getSubproceduresStack

protected List<Procedure<TEnvironment>> getSubproceduresStack()

getException

protected RemoteProcedureException getException()

acquire

protected boolean acquire(Procedure<TEnvironment> proc)

Called by the ProcedureExecutor to mark the procedure step as running.

release

protected void release(Procedure<TEnvironment> proc)

Called by the ProcedureExecutor to mark the procedure step as finished.

abort

protected void abort()

addRollbackStep

protected boolean addRollbackStep(Procedure<TEnvironment> proc)

Called by the ProcedureExecutor after the procedure step is completed, to add the step to the rollback list (or procedure stack).

Return whether we successfully added the rollback step. If the root procedure has already crossed the PONR, we do not need to maintain the rollback step,

addSubProcedure

protected void addSubProcedure(Procedure<TEnvironment> proc)

loadStack

protected void loadStack(Procedure<TEnvironment> proc)

Called on store load by the ProcedureExecutor to load part of the stack. Each procedure has its own stack-positions. Which means we have to write to the store only the Procedure we executed, and nothing else. on load we recreate the full stack by aggregating each procedure stack-positions.

isValid

protected boolean isValid()

Called on store load by the ProcedureExecutor to validate the procedure stack.