EnabledTableSnapshotHandler (Apache HBase 1.2.12 API)

java.lang.Object
- org.apache.hadoop.hbase.executor.EventHandler
- - org.apache.hadoop.hbase.master.snapshot.TakeSnapshotHandler
  - - org.apache.hadoop.hbase.master.snapshot.EnabledTableSnapshotHandler

All Implemented Interfaces:

Comparable<Runnable>, Runnable, ForeignExceptionSnare, SnapshotSentinel
```
@InterfaceAudience.Private
public class EnabledTableSnapshotHandler
extends TakeSnapshotHandler
```
Handle the master side of taking a snapshot of an online table, regardless of snapshot type. Uses a Procedure to run the snapshot across all the involved region servers.

See Also:
ProcedureCoordinator

Nested Class Summary
- Nested classes/interfaces inherited from class org.apache.hadoop.hbase.executor.EventHandler
  EventHandler.EventHandlerListener

Field Summary

Fields
Modifier and Type Field and Description

private ProcedureCoordinator coordinator

private static org.apache.commons.logging.Log LOG
- Fields inherited from class org.apache.hadoop.hbase.master.snapshot.TakeSnapshotHandler
  conf, fs, htd, master, metricsSnapshot, monitor, rootDir, snapshot, snapshotManager, snapshotManifest, snapshotTable, status, tableLock, tableLockManager, workingDir
- Fields inherited from class org.apache.hadoop.hbase.executor.EventHandler
  eventType, seqids, server, waitingTimeForEvents

Fields
Modifier and Type	Field and Description
`private ProcedureCoordinator`	`coordinator`
`private static org.apache.commons.logging.Log`	`LOG`

Constructor Summary

Constructors
Constructor and Description
`EnabledTableSnapshotHandler(org.apache.hadoop.hbase.protobuf.generated.HBaseProtos.SnapshotDescription snapshot, MasterServices master, SnapshotManager manager)`

Method Summary

Methods
Modifier and Type	Method and Description
`EnabledTableSnapshotHandler`	`prepare()` Event handlers should do all the necessary checks in this method (rather than in the constructor, or in process()) so that the caller, which is mostly executed in the ipc context can fail fast.
`protected void`	`snapshotRegions(List<Pair<HRegionInfo,ServerName>> regions)` This method kicks off a snapshot procedure.

Methods inherited from class org.apache.hadoop.hbase.master.snapshot.TakeSnapshotHandler
cancel, completeSnapshot, getCompletionTimestamp, getException, getExceptionIfFailed, getSnapshot, hasException, isFinished, process, releaseTableLock, rethrowException, rethrowExceptionIfFailed, snapshotDisabledRegion

Methods inherited from class org.apache.hadoop.hbase.executor.EventHandler
compareTo, getEventType, getInformativeName, getListener, getPriority, getSeqid, handleException, run, setListener, toString

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

- Field Detail
  - LOG
```
private static final org.apache.commons.logging.Log LOG
```
  - coordinator
```
private final ProcedureCoordinator coordinator
```
- Constructor Detail
  - EnabledTableSnapshotHandler
```
public EnabledTableSnapshotHandler(org.apache.hadoop.hbase.protobuf.generated.HBaseProtos.SnapshotDescription snapshot,
                           MasterServices master,
                           SnapshotManager manager)
```
- Method Detail
  - prepare
```
public EnabledTableSnapshotHandler prepare()
                                    throws Exception
```
    Description copied from class: EventHandler
    
    Event handlers should do all the necessary checks in this method (rather than in the constructor, or in process()) so that the caller, which is mostly executed in the ipc context can fail fast. Process is executed async from the client ipc, so this method gives a quick chance to do some basic checks. Should be called after constructing the EventHandler, and before process().
    
    Overrides:
    
    prepare in class TakeSnapshotHandler
    
    Returns:
    the instance of this class
    
    Throws:
    
    Exception - when something goes wrong
  - snapshotRegions
```
protected void snapshotRegions(List<Pair<HRegionInfo,ServerName>> regions)
                        throws HBaseSnapshotException,
                               IOException
```
    This method kicks off a snapshot procedure. Other than that it hangs around for various phases to complete.
    
    Specified by:
    
    snapshotRegions in class TakeSnapshotHandler
    
    Throws:
    
    HBaseSnapshotException
    
    IOException

Class EnabledTableSnapshotHandler

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.hadoop.hbase.executor.EventHandler

Field Summary

Fields inherited from class org.apache.hadoop.hbase.master.snapshot.TakeSnapshotHandler

Fields inherited from class org.apache.hadoop.hbase.executor.EventHandler

Constructor Summary

Method Summary

Methods inherited from class org.apache.hadoop.hbase.master.snapshot.TakeSnapshotHandler

Methods inherited from class org.apache.hadoop.hbase.executor.EventHandler

Methods inherited from class java.lang.Object

Field Detail

LOG

coordinator

Constructor Detail

EnabledTableSnapshotHandler

Method Detail

prepare

snapshotRegions