WALProcedureStore (Apache HBase 1.1.7 API)

java.lang.Object
- org.apache.hadoop.hbase.procedure2.store.wal.WALProcedureStore

All Implemented Interfaces:: ProcedureStore

@InterfaceAudience.Private
@InterfaceStability.Evolving
public class WALProcedureStore
extends Object
implements ProcedureStore

WAL implementation of the ProcedureStore.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface WALProcedureStore.LeaseRecovery
- Nested classes/interfaces inherited from interface org.apache.hadoop.hbase.procedure2.store.ProcedureStore
  ProcedureStore.ProcedureStoreListener

Nested Classes
Modifier and Type	Class and Description
`static interface`	`WALProcedureStore.LeaseRecovery`

Constructor Summary

Constructors
Constructor and Description
`WALProcedureStore(org.apache.hadoop.conf.Configuration conf, org.apache.hadoop.fs.FileSystem fs, org.apache.hadoop.fs.Path logDir, WALProcedureStore.LeaseRecovery leaseRecovery)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`delete(long procId)` The specified procId was removed from the executor, due to completion, abort or failure.
`ArrayList<ProcedureWALFile>`	`getActiveLogs()`
`Set<ProcedureWALFile>`	`getCorruptedLogs()`
`org.apache.hadoop.fs.FileSystem`	`getFileSystem()`
`org.apache.hadoop.fs.Path`	`getLogDir()`
`protected org.apache.hadoop.fs.Path`	`getLogFilePath(long logId)`
`int`	`getNumThreads()`
`ProcedureStoreTracker`	`getStoreTracker()`
`void`	`insert(Procedure proc, Procedure[] subprocs)` When a procedure is submitted to the executor insert(proc, null) will be called.
`boolean`	`isRunning()`
`Iterator<Procedure>`	`load()` Load the Procedures in the store.
`protected void`	`periodicRollForTesting()`
`void`	`recoverLease()` Acquire the lease for the procedure store.
`void`	`registerListener(ProcedureStore.ProcedureStoreListener listener)` Add the listener to the notification list.
`protected boolean`	`rollWriterForTesting()`
`protected void`	`sendPostSyncSignal()`
`void`	`start(int numSlots)` Start/Open the procedure store
`void`	`stop(boolean abort)` Stop/Close the procedure store
`protected long`	`syncSlots(org.apache.hadoop.fs.FSDataOutputStream stream, ByteSlot[] slots, int offset, int count)`
`boolean`	`unregisterListener(ProcedureStore.ProcedureStoreListener listener)` Remove the listener from the notification list.
`void`	`update(Procedure proc)` The specified procedure was executed, and the new state should be written to the store.

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

- Constructor Detail
  - WALProcedureStore
```
public WALProcedureStore(org.apache.hadoop.conf.Configuration conf,
                 org.apache.hadoop.fs.FileSystem fs,
                 org.apache.hadoop.fs.Path logDir,
                 WALProcedureStore.LeaseRecovery leaseRecovery)
```
- Method Detail
  - start
```
public void start(int numSlots)
           throws IOException
```
    Description copied from interface: ProcedureStore
    
    Start/Open the procedure store
    
    Specified by:
    
    start in interface ProcedureStore
    
    Throws:
    
    IOException
  - stop
```
public void stop(boolean abort)
```
    Description copied from interface: ProcedureStore
    
    Stop/Close the procedure store
    
    Specified by:
    
    stop in interface ProcedureStore
    
    Parameters:
    abort - true if the stop is an abort
  - isRunning
```
public boolean isRunning()
```
    Specified by:
    
    isRunning in interface ProcedureStore
    
    Returns:
    true if the store is running, otherwise false.
  - getNumThreads
```
public int getNumThreads()
```
    Specified by:
    
    getNumThreads in interface ProcedureStore
    
    Returns:
    the number of threads/slots passed to start()
  - getStoreTracker
```
public ProcedureStoreTracker getStoreTracker()
```
  - getActiveLogs
```
public ArrayList<ProcedureWALFile> getActiveLogs()
```
  - getCorruptedLogs
```
public Set<ProcedureWALFile> getCorruptedLogs()
```
  - registerListener
```
public void registerListener(ProcedureStore.ProcedureStoreListener listener)
```
    Description copied from interface: ProcedureStore
    
    Add the listener to the notification list.
    
    Specified by:
    
    registerListener in interface ProcedureStore
    
    Parameters:
    listener - The AssignmentListener to register
  - unregisterListener
```
public boolean unregisterListener(ProcedureStore.ProcedureStoreListener listener)
```
    Description copied from interface: ProcedureStore
    
    Remove the listener from the notification list.
    
    Specified by:
    
    unregisterListener in interface ProcedureStore
    
    Parameters:
    listener - The AssignmentListener to unregister
    
    Returns:
    true if the listner was in the list and it was removed, otherwise false.
  - recoverLease
```
public void recoverLease()
                  throws IOException
```
    Description copied from interface: ProcedureStore
    
    Acquire the lease for the procedure store.
    
    Specified by:
    
    recoverLease in interface ProcedureStore
    
    Throws:
    
    IOException
  - load
```
public Iterator<Procedure> load()
                         throws IOException
```
    Description copied from interface: ProcedureStore
    
    Load the Procedures in the store.
    
    Specified by:
    
    load in interface ProcedureStore
    
    Returns:
    the set of procedures present in the store
    
    Throws:
    
    IOException
  - insert
```
public void insert(Procedure proc,
          Procedure[] subprocs)
```
    Description copied from interface: ProcedureStore
    
    When a procedure is submitted to the executor insert(proc, null) will be called. 'proc' has a 'RUNNABLE' state and the initial information required to start up. When a procedure is executed and it returns children insert(proc, subprocs) will be called. 'proc' has a 'WAITING' state and an update state. 'subprocs' are the children in 'RUNNABLE' state with the initial information.
    
    Specified by:
    
    insert in interface ProcedureStore
    
    Parameters:
    proc - the procedure to serialize and write to the store.
    subprocs - the newly created child of the proc.
  - update
```
public void update(Procedure proc)
```
    Description copied from interface: ProcedureStore
    
    The specified procedure was executed, and the new state should be written to the store.
    
    Specified by:
    
    update in interface ProcedureStore
    
    Parameters:
    proc - the procedure to serialize and write to the store.
  - delete
```
public void delete(long procId)
```
    Description copied from interface: ProcedureStore
    
    The specified procId was removed from the executor, due to completion, abort or failure. The store implementor should remove all the information about the specified procId.
    
    Specified by:
    
    delete in interface ProcedureStore
    
    Parameters:
    procId - the ID of the procedure to remove.
  - syncSlots
```
protected long syncSlots(org.apache.hadoop.fs.FSDataOutputStream stream,
             ByteSlot[] slots,
             int offset,
             int count)
                  throws IOException
```
    Throws:
    
    IOException
  - sendPostSyncSignal
```
protected void sendPostSyncSignal()
```
  - periodicRollForTesting
```
protected void periodicRollForTesting()
                               throws IOException
```
    Throws:
    
    IOException
  - rollWriterForTesting
```
protected boolean rollWriterForTesting()
                                throws IOException
```
    Throws:
    
    IOException
  - getLogDir
```
public org.apache.hadoop.fs.Path getLogDir()
```
  - getFileSystem
```
public org.apache.hadoop.fs.FileSystem getFileSystem()
```
  - getLogFilePath
```
protected org.apache.hadoop.fs.Path getLogFilePath(long logId)
                                            throws IOException
```
    Throws:
    
    IOException

Class WALProcedureStore

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.hadoop.hbase.procedure2.store.ProcedureStore

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

WALProcedureStore

Method Detail

start

stop

isRunning

getNumThreads

getStoreTracker

getActiveLogs

getCorruptedLogs

registerListener

unregisterListener

recoverLease

load

insert

update

delete

syncSlots

sendPostSyncSignal

periodicRollForTesting

rollWriterForTesting

getLogDir

getFileSystem

getLogFilePath