ProcedureStoreTracker (Apache HBase - Procedure 2.2.4

java.lang.Object
- org.apache.hadoop.hbase.procedure2.store.ProcedureStoreTracker

```
@InterfaceAudience.Private
public class ProcedureStoreTracker
extends Object
```
Keeps track of live procedures. It can be used by the ProcedureStore to identify which procedures are already deleted/completed to avoid the deserialization step on restart

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class ProcedureStoreTracker.DeleteState

Nested Classes
Modifier and Type	Class and Description
`static class`	`ProcedureStoreTracker.DeleteState`

Constructor Summary

Constructors
Constructor and Description

ProcedureStoreTracker()

Constructors
Constructor and Description
`ProcedureStoreTracker()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`delete(long procId)`
`void`	`delete(long[] procIds)`
`void`	`dump()`
`long`	`getActiveMinProcId()`
`long[]`	`getAllActiveProcIds()` Will be used when there are too many proc wal files.
`long`	`getModifiedMaxProcId()`
`long`	`getModifiedMinProcId()`
`void`	`insert(long procId)`
`void`	`insert(long[] procIds)`
`void`	`insert(long procId, long[] subProcIds)`
`boolean`	`isAllModified()`
`ProcedureStoreTracker.DeleteState`	`isDeleted(long procId)` If `partial` is false, returns state from the bitmap.
`boolean`	`isEmpty()`
`boolean`	`isModified(long procId)`
`boolean`	`isPartial()`
`void`	`reset()`
`void`	`resetModified()` Clears the list of updated procedure ids.
`void`	`resetTo(ProcedureStoreTracker tracker)` Resets internal state to same as given `tracker`.
`void`	`resetTo(ProcedureStoreTracker tracker, boolean resetDelete)` Resets internal state to same as given `tracker`, and change the deleted flag according to the modified flag if `resetDelete` is true.
`void`	`resetToProto(ProcedureProtos.ProcedureStoreTracker trackerProtoBuf)`
`void`	`setDeleted(long procId, boolean isDeleted)` This method is used when restarting where we need to rebuild the ProcedureStoreTracker.
`void`	`setDeletedIfDeletedByThem(ProcedureStoreTracker tracker)` For the global tracker, we will use this method to build the holdingCleanupTracker, as the modified flags will be cleared after rolling so we only need to test the deleted flags.
`void`	`setDeletedIfModified(long... procId)` Set the given bit for the procId to delete if it was modified before.
`void`	`setDeletedIfModifiedInBoth(ProcedureStoreTracker tracker)` Similar with `setDeletedIfModified(long...)`, but here the `procId` are given by the `tracker`.
`void`	`setKeepDeletes(boolean keepDeletes)`
`void`	`setMinMaxModifiedProcIds(long min, long max)` Will be called when restarting where we need to rebuild the ProcedureStoreTracker.
`void`	`setPartialFlag(boolean isPartial)`
`ProcedureProtos.ProcedureStoreTracker`	`toProto()` Builds org.apache.hadoop.hbase.protobuf.generated.ProcedureProtos.ProcedureStoreTracker protocol buffer from current state.
`void`	`update(long procId)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ProcedureStoreTracker
```
public ProcedureStoreTracker()
```
- Method Detail
  - resetToProto
```
public void resetToProto(ProcedureProtos.ProcedureStoreTracker trackerProtoBuf)
```
  - resetTo
```
public void resetTo(ProcedureStoreTracker tracker)
```
    Resets internal state to same as given tracker. Does deep copy of the bitmap.
  - resetTo
```
public void resetTo(ProcedureStoreTracker tracker,
                    boolean resetDelete)
```
    Resets internal state to same as given tracker, and change the deleted flag according to the modified flag if resetDelete is true. Does deep copy of the bitmap.
    The resetDelete will be set to true when building cleanup tracker, please see the comments in BitSetNode.BitSetNode(BitSetNode, boolean) to learn how we change the deleted flag if resetDelete is true.
  - insert
```
public void insert(long procId)
```
  - insert
```
public void insert(long[] procIds)
```
  - insert
```
public void insert(long procId,
                   long[] subProcIds)
```
  - update
```
public void update(long procId)
```
  - delete
```
public void delete(long procId)
```
  - delete
```
public void delete(long[] procIds)
```
  - setMinMaxModifiedProcIds
```
public void setMinMaxModifiedProcIds(long min,
                                     long max)
```
    Will be called when restarting where we need to rebuild the ProcedureStoreTracker.
  - setDeleted
```
public void setDeleted(long procId,
                       boolean isDeleted)
```
    This method is used when restarting where we need to rebuild the ProcedureStoreTracker. The delete(long) method above assume that the BitSetNode exists, but when restart this is not true, as we will read the wal files in reverse order so a delete may come first.
  - setDeletedIfModified
```
public void setDeletedIfModified(long... procId)
```
    Set the given bit for the procId to delete if it was modified before.
    This method is used to test whether a procedure wal file can be safely deleted, as if all the procedures in the given procedure wal file has been modified in the new procedure wal files, then we can delete it.
  - setDeletedIfDeletedByThem
```
public void setDeletedIfDeletedByThem(ProcedureStoreTracker tracker)
```
    For the global tracker, we will use this method to build the holdingCleanupTracker, as the modified flags will be cleared after rolling so we only need to test the deleted flags.
    
    See Also:
    
    setDeletedIfModifiedInBoth(ProcedureStoreTracker)
  - setDeletedIfModifiedInBoth
```
public void setDeletedIfModifiedInBoth(ProcedureStoreTracker tracker)
```
    Similar with setDeletedIfModified(long...), but here the procId are given by the tracker. If a procedure is modified by us, and also by the given tracker, then we mark it as deleted.
    
    See Also:
    
    setDeletedIfModified(long...)
  - getModifiedMinProcId
```
public long getModifiedMinProcId()
```
  - getModifiedMaxProcId
```
public long getModifiedMaxProcId()
```
  - reset
```
public void reset()
```
  - isModified
```
public boolean isModified(long procId)
```
  - isDeleted
```
public ProcedureStoreTracker.DeleteState isDeleted(long procId)
```
    If partial is false, returns state from the bitmap. If no state is found for procId, returns YES. If partial is true, tracker doesn't have complete view of system state, so it returns MAYBE if there is no update for the procedure or if it doesn't have a state in bitmap. Otherwise, returns state from the bitmap.
  - getActiveMinProcId
```
public long getActiveMinProcId()
```
  - setKeepDeletes
```
public void setKeepDeletes(boolean keepDeletes)
```
  - isPartial
```
public boolean isPartial()
```
  - setPartialFlag
```
public void setPartialFlag(boolean isPartial)
```
  - isEmpty
```
public boolean isEmpty()
```
    Returns:
    
    true, if no procedure is active, else false.
  - isAllModified
```
public boolean isAllModified()
```
    Returns:
    
    true if all procedure was modified or deleted since last call to resetModified().
  - getAllActiveProcIds
```
public long[] getAllActiveProcIds()
```
    Will be used when there are too many proc wal files. We will rewrite the states of the active procedures in the oldest proc wal file so that we can delete it.
    
    Returns:
    
    all the active procedure ids in this tracker.
  - resetModified
```
public void resetModified()
```
    Clears the list of updated procedure ids. This doesn't affect global list of active procedure ids.
  - dump
```
public void dump()
```
  - toProto
```
public ProcedureProtos.ProcedureStoreTracker toProto()
                                              throws IOException
```
    Builds org.apache.hadoop.hbase.protobuf.generated.ProcedureProtos.ProcedureStoreTracker protocol buffer from current state.
    
    Throws:
    
    IOException

Class ProcedureStoreTracker

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ProcedureStoreTracker

Method Detail

resetToProto

resetTo

resetTo

insert

insert

insert

update

delete

delete

setMinMaxModifiedProcIds

setDeleted

setDeletedIfModified

setDeletedIfDeletedByThem

setDeletedIfModifiedInBoth

getModifiedMinProcId

getModifiedMaxProcId

reset

isModified

isDeleted

getActiveMinProcId

setKeepDeletes

isPartial

setPartialFlag

isEmpty

isAllModified

getAllActiveProcIds

resetModified

dump

toProto