org.apache.hadoop.hbase.master.assignment

Class RegionRemoteProcedureBase

java.lang.Object

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

org.apache.hadoop.hbase.master.assignment.RegionRemoteProcedureBase

All Implemented Interfaces:

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

Direct Known Subclasses:

CloseRegionProcedure, OpenRegionProcedure

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

The base class for the remote procedures used to open/close a region.

Notice that here we do not care about the result of the remote call, if the remote call is finished, either succeeded or not, we will always finish the procedure. The parent procedure should take care of the result and try to reschedule if the result is not good.

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

Modifier and Type	Field and Description
protected RegionInfo	region
protected ServerName	targetServer

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

NO_PROC_ID, NO_TIMEOUT

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	RegionRemoteProcedureBase()
protected	RegionRemoteProcedureBase(TransitRegionStateProcedure parent, RegionInfo region, ServerName targetServer)

Method Summary

Modifier and Type	Method and Description
protected boolean	abort(MasterProcedureEnv env)
protected void	afterReplay(MasterProcedureEnv env)
protected abstract void	checkTransition(RegionStateNode regionNode, org.apache.hadoop.hbase.shaded.protobuf.generated.RegionServerStatusProtos.RegionStateTransition.TransitionCode transitionCode, long seqId)
protected void	deserializeStateData(ProcedureStateSerializer serializer)
protected Procedure<MasterProcedureEnv>[]	execute(MasterProcedureEnv env)
TableName	getTableName()
protected abstract RemoteProcedureDispatcher.RemoteOperation	newRemoteOperation()
Optional<RemoteProcedureDispatcher.RemoteOperation>	remoteCallBuild(MasterProcedureEnv env, ServerName remote)
void	remoteCallFailed(MasterProcedureEnv env, ServerName remote, IOException exception)
void	remoteOperationCompleted(MasterProcedureEnv env)
void	remoteOperationFailed(MasterProcedureEnv env, RemoteProcedureException error)
protected abstract void	restoreSucceedState(AssignmentManager am, RegionStateNode regionNode, long seqId)
protected void	rollback(MasterProcedureEnv env)
protected void	serializeStateData(ProcedureStateSerializer serializer)
protected boolean	setTimeoutFailure(MasterProcedureEnv env)
boolean	storeInDispatchedQueue()
protected abstract void	updateTransitionWithoutPersistingToMeta(MasterProcedureEnv env, RegionStateNode regionNode, org.apache.hadoop.hbase.shaded.protobuf.generated.RegionServerStatusProtos.RegionStateTransition.TransitionCode transitionCode, long seqId)
protected boolean	waitInitialized(MasterProcedureEnv env)

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

acquireLock, addStackIndex, beforeReplay, bypass, compareTo, completionCleanup, doExecute, doRollback, elapsedTime, getChildrenLatch, getException, getLastUpdate, getNonceKey, getOwner, getParentProcId, getProcedureMetrics, getProcId, getProcIdHashCode, getProcName, getResult, getRootProcedureId, getRootProcId, getStackIndexes, getState, getSubmittedTime, getTimeout, getTimeoutTimestamp, hasChildren, hasException, hasLock, hasOwner, hasParent, hasTimeout, haveSameParent, holdLock, incChildrenLatch, isBypass, isFailed, isFinished, isInitializing, isLockedWhenLoading, isRunnable, isSuccess, isWaiting, isYieldAfterExecutionStep, releaseLock, removeStackIndex, setAbortFailure, setChildrenLatch, setFailure, setFailure, setLastUpdate, setNonceKey, setOwner, setOwner, setParentProcId, setProcId, setResult, setRootProcId, setStackIndexes, setState, setSubmittedTime, setTimeout, shouldWaitClientAck, skipPersistence, toString, toStringClass, toStringClassDetails, 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.master.procedure.TableProcedureInterface

getTableOperationType

Field Detail

region

protected RegionInfo region

targetServer

protected ServerName targetServer

Constructor Detail

RegionRemoteProcedureBase

protected RegionRemoteProcedureBase()

RegionRemoteProcedureBase

protected RegionRemoteProcedureBase(TransitRegionStateProcedure parent,
                                    RegionInfo region,
                                    ServerName targetServer)

Method Detail

remoteCallBuild

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

Specified by:

remoteCallBuild in interface RemoteProcedureDispatcher.RemoteProcedure<MasterProcedureEnv,ServerName>

newRemoteOperation

protected abstract RemoteProcedureDispatcher.RemoteOperation newRemoteOperation()

remoteOperationCompleted

public void remoteOperationCompleted(MasterProcedureEnv env)

Specified by:

remoteOperationCompleted in interface RemoteProcedureDispatcher.RemoteProcedure<MasterProcedureEnv,ServerName>

remoteOperationFailed

public void remoteOperationFailed(MasterProcedureEnv env,
                                  RemoteProcedureException error)

Specified by:

remoteOperationFailed in interface RemoteProcedureDispatcher.RemoteProcedure<MasterProcedureEnv,ServerName>

remoteCallFailed

public void remoteCallFailed(MasterProcedureEnv env,
                             ServerName remote,
                             IOException exception)

Specified by:

remoteCallFailed in interface RemoteProcedureDispatcher.RemoteProcedure<MasterProcedureEnv,ServerName>

getTableName

public TableName getTableName()

Specified by:

getTableName in interface TableProcedureInterface

Returns:

the name of the table the procedure is operating on

waitInitialized

protected boolean waitInitialized(MasterProcedureEnv env)

Overrides:

waitInitialized in class Procedure<MasterProcedureEnv>

rollback

protected void rollback(MasterProcedureEnv env)
                 throws IOException,
                        InterruptedException

Specified by:

rollback in class Procedure<MasterProcedureEnv>

Throws:

IOException

InterruptedException

abort

protected boolean abort(MasterProcedureEnv env)

Specified by:

abort in class Procedure<MasterProcedureEnv>

checkTransition

protected abstract void checkTransition(RegionStateNode regionNode,
                                        org.apache.hadoop.hbase.shaded.protobuf.generated.RegionServerStatusProtos.RegionStateTransition.TransitionCode transitionCode,
                                        long seqId)
                                 throws UnexpectedStateException

Throws:

UnexpectedStateException

updateTransitionWithoutPersistingToMeta

protected abstract void updateTransitionWithoutPersistingToMeta(MasterProcedureEnv env,
                                                                RegionStateNode regionNode,
                                                                org.apache.hadoop.hbase.shaded.protobuf.generated.RegionServerStatusProtos.RegionStateTransition.TransitionCode transitionCode,
                                                                long seqId)
                                                         throws IOException

Throws:

IOException

restoreSucceedState

protected abstract void restoreSucceedState(AssignmentManager am,
                                            RegionStateNode regionNode,
                                            long seqId)
                                     throws IOException

Throws:

IOException

execute

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

Specified by:

execute in class Procedure<MasterProcedureEnv>

Throws:

ProcedureYieldException

ProcedureSuspendedException

InterruptedException

setTimeoutFailure

protected boolean setTimeoutFailure(MasterProcedureEnv env)

Overrides:

setTimeoutFailure in class Procedure<MasterProcedureEnv>

storeInDispatchedQueue

public boolean storeInDispatchedQueue()

Specified by:

storeInDispatchedQueue in interface RemoteProcedureDispatcher.RemoteProcedure<MasterProcedureEnv,ServerName>

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

afterReplay

protected void afterReplay(MasterProcedureEnv env)

Overrides:

afterReplay in class Procedure<MasterProcedureEnv>