org.apache.hadoop.hbase.master.procedure

Class SnapshotRegionProcedure

java.lang.Object

org.apache.hadoop.hbase.procedure2.Procedure<MasterProcedureEnv>

org.apache.hadoop.hbase.master.procedure.SnapshotRegionProcedure

All Implemented Interfaces:

Comparable<Procedure<MasterProcedureEnv>>, TableProcedureInterface, RemoteProcedureDispatcher.RemoteProcedure<MasterProcedureEnv,ServerName>

@InterfaceAudience.Private
public class SnapshotRegionProcedure
extends Procedure<MasterProcedureEnv>
implements TableProcedureInterface, RemoteProcedureDispatcher.RemoteProcedure<MasterProcedureEnv,ServerName>

A remote procedure which is used to send region snapshot request to region server. The basic logic of SnapshotRegionProcedure is similar like ServerRemoteProcedure, only with a little difference, when FailedRemoteDispatchException was thrown, SnapshotRegionProcedure will sleep some time and continue retrying until success.

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.hadoop.hbase.procedure2.Procedure

Procedure.LockState

Nested classes/interfaces inherited from interface org.apache.hadoop.hbase.master.procedure.TableProcedureInterface

TableProcedureInterface.TableOperationType

Field Summary

Fields inherited from class org.apache.hadoop.hbase.procedure2.Procedure

NO_PROC_ID, NO_TIMEOUT

Constructor Summary

Constructors

Constructor and Description
SnapshotRegionProcedure()
SnapshotRegionProcedure(org.apache.hadoop.hbase.shaded.protobuf.generated.SnapshotProtos.SnapshotDescription snapshot, RegionInfo region)

Method Summary

Modifier and Type	Method and Description
protected boolean	abort(MasterProcedureEnv env)
protected Procedure.LockState	acquireLock(MasterProcedureEnv env)
protected void	deserializeStateData(ProcedureStateSerializer serializer)
protected Procedure<MasterProcedureEnv>[]	execute(MasterProcedureEnv env)
String	getProcName()
RegionInfo	getRegion()
TableName	getTableName() Returns the name of the table the procedure is operating on
TableProcedureInterface.TableOperationType	getTableOperationType() Given an operation type we can take decisions about what to do with pending operations.
protected boolean	holdLock(MasterProcedureEnv env)
protected void	releaseLock(MasterProcedureEnv env)
Optional<RemoteProcedureDispatcher.RemoteOperation>	remoteCallBuild(MasterProcedureEnv env, ServerName serverName)
void	remoteCallFailed(MasterProcedureEnv env, ServerName serverName, IOException e)
void	remoteOperationCompleted(MasterProcedureEnv env)
void	remoteOperationFailed(MasterProcedureEnv env, RemoteProcedureException e)
protected void	rollback(MasterProcedureEnv env)
protected void	serializeStateData(ProcedureStateSerializer serializer)
protected boolean	setTimeoutFailure(MasterProcedureEnv env)
protected void	toStringClassDetails(StringBuilder builder)
protected boolean	waitInitialized(MasterProcedureEnv env)

Methods inherited from class org.apache.hadoop.hbase.procedure2.Procedure

addStackIndex, afterReplay, beforeReplay, bypass, compareTo, completionCleanup, doExecute, doRollback, elapsedTime, getChildrenLatch, getException, getLastUpdate, getNonceKey, getOwner, getParentProcId, getProcedureMetrics, getProcId, getProcIdHashCode, getResult, getRootProcedureId, getRootProcId, getStackIndexes, getState, getSubmittedTime, getTimeout, getTimeoutTimestamp, hasChildren, hasException, hasLock, hasOwner, hasParent, hasTimeout, haveSameParent, incChildrenLatch, isBypass, isFailed, isFinished, isInitializing, isLockedWhenLoading, isRollbackSupported, isRunnable, isSuccess, isWaiting, isYieldAfterExecutionStep, removeStackIndex, setAbortFailure, setChildrenLatch, setExecuted, setFailure, setFailure, setLastUpdate, setNonceKey, setOwner, setOwner, setParentProcId, setProcId, setResult, setRootProcId, setStackIndexes, setState, setSubmittedTime, setTimeout, shouldWaitClientAck, skipPersistence, suspend, toString, toStringClass, toStringDetails, toStringSimpleSB, toStringState, updateMetricsOnFinish, updateMetricsOnSubmit, updateTimestamp, wasExecuted

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.hadoop.hbase.procedure2.RemoteProcedureDispatcher.RemoteProcedure

storeInDispatchedQueue

Constructor Detail

SnapshotRegionProcedure

public SnapshotRegionProcedure()

SnapshotRegionProcedure

public SnapshotRegionProcedure(org.apache.hadoop.hbase.shaded.protobuf.generated.SnapshotProtos.SnapshotDescription snapshot,
                               RegionInfo region)

Method Detail

acquireLock

protected Procedure.LockState acquireLock(MasterProcedureEnv env)

Overrides:

acquireLock in class Procedure<MasterProcedureEnv>

releaseLock

protected void releaseLock(MasterProcedureEnv env)

Overrides:

releaseLock in class Procedure<MasterProcedureEnv>

holdLock

protected boolean holdLock(MasterProcedureEnv env)

Overrides:

holdLock in class Procedure<MasterProcedureEnv>

remoteCallBuild

public Optional<RemoteProcedureDispatcher.RemoteOperation> remoteCallBuild(MasterProcedureEnv env,
                                                                           ServerName serverName)

Specified by:

remoteCallBuild in interface RemoteProcedureDispatcher.RemoteProcedure<MasterProcedureEnv,ServerName>

remoteCallFailed

public void remoteCallFailed(MasterProcedureEnv env,
                             ServerName serverName,
                             IOException e)

Specified by:

remoteCallFailed in interface RemoteProcedureDispatcher.RemoteProcedure<MasterProcedureEnv,ServerName>

remoteOperationCompleted

public void remoteOperationCompleted(MasterProcedureEnv env)

Specified by:

remoteOperationCompleted in interface RemoteProcedureDispatcher.RemoteProcedure<MasterProcedureEnv,ServerName>

remoteOperationFailed

public void remoteOperationFailed(MasterProcedureEnv env,
                                  RemoteProcedureException e)

Specified by:

remoteOperationFailed in interface RemoteProcedureDispatcher.RemoteProcedure<MasterProcedureEnv,ServerName>

getTableName

public TableName getTableName()

Description copied from interface: TableProcedureInterface

Returns the name of the table the procedure is operating on

Specified by:

getTableName in interface TableProcedureInterface

getTableOperationType

public TableProcedureInterface.TableOperationType getTableOperationType()

Description copied from interface: TableProcedureInterface

Given an operation type we can take decisions about what to do with pending operations. e.g. if we get a delete and we have some table operation pending (e.g. add column) we can abort those operations.

Specified by:

getTableOperationType in interface TableProcedureInterface

Returns:

the operation type that the procedure is executing.

execute

protected Procedure<MasterProcedureEnv>[] execute(MasterProcedureEnv env)
                                           throws ProcedureYieldException,
                                                  ProcedureSuspendedException,
                                                  InterruptedException

Specified by:

execute in class Procedure<MasterProcedureEnv>

Throws:

ProcedureYieldException

ProcedureSuspendedException

InterruptedException

rollback

protected void rollback(MasterProcedureEnv env)

Specified by:

rollback in class Procedure<MasterProcedureEnv>

setTimeoutFailure

protected boolean setTimeoutFailure(MasterProcedureEnv env)

Overrides:

setTimeoutFailure in class Procedure<MasterProcedureEnv>

abort

protected boolean abort(MasterProcedureEnv env)

Specified by:

abort in class Procedure<MasterProcedureEnv>

serializeStateData

protected void serializeStateData(ProcedureStateSerializer serializer)
                           throws IOException

Specified by:

serializeStateData in class Procedure<MasterProcedureEnv>

Throws:

IOException

deserializeStateData

protected void deserializeStateData(ProcedureStateSerializer serializer)
                             throws IOException

Specified by:

deserializeStateData in class Procedure<MasterProcedureEnv>

Throws:

IOException

getProcName

public String getProcName()

Overrides:

getProcName in class Procedure<MasterProcedureEnv>

toStringClassDetails

protected void toStringClassDetails(StringBuilder builder)

Overrides:

toStringClassDetails in class Procedure<MasterProcedureEnv>

waitInitialized

protected boolean waitInitialized(MasterProcedureEnv env)

Overrides:

waitInitialized in class Procedure<MasterProcedureEnv>

getRegion

public RegionInfo getRegion()