RootProcedureState (Apache HBase 2.5.0 API)

java.lang.Object
- org.apache.hadoop.hbase.procedure2.RootProcedureState<TEnvironment>

```
@InterfaceAudience.Private
 @InterfaceStability.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 and Description

private static class RootProcedureState.State

Nested Classes
Modifier and Type	Class and Description
`private static class`	`RootProcedureState.State`

Field Summary

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

Constructor Summary

Constructors
Constructor and Description

RootProcedureState()

Constructors
Constructor and Description
`RootProcedureState()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`abort()`
`protected boolean`	`acquire(Procedure<TEnvironment> proc)` Called by the ProcedureExecutor to mark the procedure step as running.
`protected void`	`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()`
`boolean`	`isFailed()`
`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`	`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 Detail
  - 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
```
- Constructor Detail
  - RootProcedureState
```
RootProcedureState()
```
- Method Detail
  - isFailed
```
public boolean isFailed()
```
  - isRollingback
```
public 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
  - getSubprocedureIds
```
protected long[] getSubprocedureIds()
```
  - 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 void 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)
  - 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.

Class RootProcedureState<TEnvironment>

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

LOG

subprocs

subprocStack

state

running

Constructor Detail

RootProcedureState

Method Detail

isFailed

isRollingback

setRollback

unsetRollback

getSubprocedureIds

getSubproceduresStack

getException

acquire

release

abort

addRollbackStep

addSubProcedure

loadStack

isValid