@InterfaceAudience.Private public abstract class TakeSnapshotHandler extends EventHandler implements SnapshotSentinel, ForeignExceptionSnare
snapshotRegions(List)
call should get implemented for each snapshot flavor.EventHandler.EventHandlerListener
Modifier and Type | Field and Description |
---|---|
protected Configuration |
conf |
protected FileSystem |
fs |
protected HTableDescriptor |
htd |
protected MasterServices |
master |
protected MetricsSnapshot |
metricsSnapshot |
protected ForeignExceptionDispatcher |
monitor |
protected Path |
rootDir |
protected HBaseProtos.SnapshotDescription |
snapshot |
protected SnapshotManifest |
snapshotManifest |
protected TableName |
snapshotTable |
protected MonitoredTask |
status |
protected TableLockManager.TableLock |
tableLock |
protected TableLockManager |
tableLockManager |
protected Path |
workingDir |
eventType, seqids, server, waitingTimeForEvents
Constructor and Description |
---|
TakeSnapshotHandler(HBaseProtos.SnapshotDescription snapshot,
MasterServices masterServices) |
Modifier and Type | Method and Description |
---|---|
void |
cancel(java.lang.String why)
Actively cancel a running snapshot.
|
void |
completeSnapshot(Path snapshotDir,
Path workingDir,
FileSystem fs)
Reset the manager to allow another snapshot to proceed
|
long |
getCompletionTimestamp() |
ForeignException |
getException()
Get the value of the captured exception.
|
ForeignException |
getExceptionIfFailed()
Get the exception that caused the snapshot to fail, if the snapshot has failed.
|
HBaseProtos.SnapshotDescription |
getSnapshot() |
boolean |
hasException()
Non-exceptional form of
ForeignExceptionSnare.rethrowException() . |
boolean |
isFinished()
Check to see if the snapshot is finished, where finished may be success or failure.
|
TakeSnapshotHandler |
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.
|
void |
process()
Execute the core common portions of taking a snapshot.
|
protected void |
releaseTableLock() |
void |
rethrowException()
Rethrow an exception currently held by the
ForeignExceptionSnare . |
void |
rethrowExceptionIfFailed()
Rethrow the exception returned by
SnapshotSentinel.getExceptionIfFailed() . |
protected void |
snapshotDisabledRegion(HRegionInfo regionInfo)
Take a snapshot of the specified disabled region
|
protected abstract void |
snapshotRegions(java.util.List<Pair<HRegionInfo,ServerName>> regions)
Snapshot the specified regions
|
compareTo, getEventType, getInformativeName, getListener, getPriority, getSeqid, handleException, run, setListener, toString
protected final MasterServices master
protected final MetricsSnapshot metricsSnapshot
protected final HBaseProtos.SnapshotDescription snapshot
protected final Configuration conf
protected final FileSystem fs
protected final Path rootDir
protected final Path workingDir
protected final ForeignExceptionDispatcher monitor
protected final TableLockManager tableLockManager
protected final TableLockManager.TableLock tableLock
protected final MonitoredTask status
protected final TableName snapshotTable
protected final SnapshotManifest snapshotManifest
protected HTableDescriptor htd
public TakeSnapshotHandler(HBaseProtos.SnapshotDescription snapshot, MasterServices masterServices)
snapshot
- descriptor of the snapshot to takemasterServices
- master services providerpublic TakeSnapshotHandler prepare() throws java.lang.Exception
EventHandler
prepare
in class EventHandler
java.lang.Exception
- when something goes wrongpublic void process()
snapshotRegions(List)
call should get implemented for each snapshot flavor.process
in class EventHandler
protected void releaseTableLock()
public void completeSnapshot(Path snapshotDir, Path workingDir, FileSystem fs) throws SnapshotCreationException, java.io.IOException
snapshotDir
- final path of the snapshotworkingDir
- directory where the in progress snapshot was builtfs
- FileSystem
where the snapshot was builtSnapshotCreationException
- if the snapshot could not be movedjava.io.IOException
- the filesystem could not be reachedprotected abstract void snapshotRegions(java.util.List<Pair<HRegionInfo,ServerName>> regions) throws java.io.IOException, KeeperException
java.io.IOException
KeeperException
protected void snapshotDisabledRegion(HRegionInfo regionInfo) throws java.io.IOException
java.io.IOException
public void cancel(java.lang.String why)
SnapshotSentinel
cancel
in interface SnapshotSentinel
why
- Reason for cancellation.public boolean isFinished()
SnapshotSentinel
isFinished
in interface SnapshotSentinel
public long getCompletionTimestamp()
getCompletionTimestamp
in interface SnapshotSentinel
public HBaseProtos.SnapshotDescription getSnapshot()
getSnapshot
in interface SnapshotSentinel
public ForeignException getExceptionIfFailed()
SnapshotSentinel
getExceptionIfFailed
in interface SnapshotSentinel
ForeignException
that caused the snapshot to fail, or null if the
snapshot is still in progress or has succeededpublic void rethrowExceptionIfFailed() throws ForeignException
SnapshotSentinel
SnapshotSentinel.getExceptionIfFailed()
.
If there is no exception this is a no-op.rethrowExceptionIfFailed
in interface SnapshotSentinel
ForeignException
- all exceptions from remote sources are procedure exceptionspublic void rethrowException() throws ForeignException
ForeignExceptionSnare
ForeignExceptionSnare
. If there is
no exception this is a no-oprethrowException
in interface ForeignExceptionSnare
ForeignException
- all exceptions from remote sources are procedure exceptionspublic boolean hasException()
ForeignExceptionSnare
ForeignExceptionSnare.rethrowException()
. Checks to see if any
process to which the exception checkers is bound has created an error that
would cause a failure.hasException
in interface ForeignExceptionSnare
public ForeignException getException()
ForeignExceptionSnare
getException
in interface ForeignExceptionSnare