org.apache.hadoop.hbase.regionserver

Interface RegionServerServices

All Superinterfaces:

Abortable, FavoredNodesForRegion, OnlineRegions, Server, Stoppable

All Known Implementing Classes:

HMaster, HMasterCommandLine.LocalHMaster, HRegionServer, MiniHBaseCluster.MiniHBaseClusterRegionServer, MockRegionServerServices, OOMERegionServer, TestAssignmentManagerOnCluster.MyMaster, TestAssignmentManagerOnCluster.MyRegionServer, TestMasterMetrics.MyMaster, TestMetaShutdownHandler.MyRegionServer, TestRegionServerReportForDuty.MyRegionServer, TestRSKilledWhenInitializing.MockedRegionServer

@InterfaceAudience.LimitedPrivate(value="Coprocesssor")
 @InterfaceStability.Evolving
public interface RegionServerServices
extends OnlineRegions, FavoredNodesForRegion

Services provided by HRegionServer

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	RegionServerServices.PostOpenDeployContext Context for postOpenDeployTasks().
static class	RegionServerServices.RegionStateTransitionContext

Method Summary

Modifier and Type	Method and Description
double	getCompactionPressure()
CompactionRequestor	getCompactionRequester()
ExecutorService	getExecutorService()
FileSystem	getFileSystem()
FlushRequester	getFlushRequester()
HeapMemoryManager	getHeapMemoryManager()
Leases	getLeases()
MetricsRegionServer	getMetrics()
ServerNonceManager	getNonceManager() Only required for "old" log replay; if it's removed, remove this.
java.util.Set<TableName>	getOnlineTables()
java.util.Map<java.lang.String,Region>	getRecoveringRegions()
RegionServerAccounting	getRegionServerAccounting()
RegionServerRpcQuotaManager	getRegionServerRpcQuotaManager()
RegionServerSpaceQuotaManager	getRegionServerSpaceQuotaManager()
java.util.concurrent.ConcurrentMap<byte[],java.lang.Boolean>	getRegionsInTransitionInRS() Get the regions that are currently being opened or closed in the RS
RpcServerInterface	getRpcServer() Returns a reference to the region server's RPC server
TableLockManager	getTableLockManager()
WAL	getWAL(HRegionInfo regionInfo)
boolean	isStopping()
void	postOpenDeployTasks(Region r) Deprecated. use postOpenDeployTasks(PostOpenDeployContext)
void	postOpenDeployTasks(RegionServerServices.PostOpenDeployContext context) Tasks to perform after region open to complete deploy of region on regionserver
boolean	registerService(Service service) Registers a new protocol buffer Service subclass as a coprocessor endpoint to be available for handling
boolean	reportRegionStateTransition(RegionServerServices.RegionStateTransitionContext context) Notify master that a handler requests to change a region state
boolean	reportRegionStateTransition(RegionServerStatusProtos.RegionStateTransition.TransitionCode code, HRegionInfo... hris) Deprecated. use reportRegionStateTransition(RegionStateTransitionContext)
boolean	reportRegionStateTransition(RegionServerStatusProtos.RegionStateTransition.TransitionCode code, long openSeqNum, HRegionInfo... hris) Deprecated. use reportRegionStateTransition(RegionStateTransitionContext)

Methods inherited from interface org.apache.hadoop.hbase.regionserver.OnlineRegions

addToOnlineRegions, getFromOnlineRegions, getOnlineRegions, removeFromOnlineRegions

Methods inherited from interface org.apache.hadoop.hbase.Server

getChoreService, getConfiguration, getConnection, getCoordinatedStateManager, getMetaTableLocator, getServerName, getZooKeeper

Methods inherited from interface org.apache.hadoop.hbase.Abortable

abort, isAborted

Methods inherited from interface org.apache.hadoop.hbase.Stoppable

isStopped, stop

Methods inherited from interface org.apache.hadoop.hbase.regionserver.FavoredNodesForRegion

getFavoredNodesForRegion, updateRegionFavoredNodesMapping

Method Detail

isStopping

boolean isStopping()

Returns:

True if this regionserver is stopping.

getWAL

WAL getWAL(HRegionInfo regionInfo)
    throws java.io.IOException

Returns:

the WAL for a particular region. Pass null for getting the default (common) WAL

Throws:

java.io.IOException

getCompactionRequester

CompactionRequestor getCompactionRequester()

Returns:

Implementation of CompactionRequestor or null.

getFlushRequester

FlushRequester getFlushRequester()

Returns:

Implementation of FlushRequester or null.

getRegionServerAccounting

RegionServerAccounting getRegionServerAccounting()

Returns:

the RegionServerAccounting for this Region Server

getTableLockManager

TableLockManager getTableLockManager()

Returns:

RegionServer's instance of TableLockManager

getRegionServerRpcQuotaManager

RegionServerRpcQuotaManager getRegionServerRpcQuotaManager()

Returns:

RegionServer's instance of RegionServerRpcQuotaManager

getRegionServerSpaceQuotaManager

RegionServerSpaceQuotaManager getRegionServerSpaceQuotaManager()

Returns:

RegionServer's instance of RegionServerSpaceQuotaManager

postOpenDeployTasks

void postOpenDeployTasks(RegionServerServices.PostOpenDeployContext context)
                  throws KeeperException,
                         java.io.IOException

Tasks to perform after region open to complete deploy of region on regionserver

Parameters:

context - the context

Throws:

KeeperException

java.io.IOException

postOpenDeployTasks

@Deprecated
void postOpenDeployTasks(Region r)
                              throws KeeperException,
                                     java.io.IOException

Deprecated. use postOpenDeployTasks(PostOpenDeployContext)

Tasks to perform after region open to complete deploy of region on regionserver

Parameters:

r - Region to open.

Throws:

KeeperException

java.io.IOException

reportRegionStateTransition

boolean reportRegionStateTransition(RegionServerServices.RegionStateTransitionContext context)

Notify master that a handler requests to change a region state

reportRegionStateTransition

@Deprecated
boolean reportRegionStateTransition(RegionServerStatusProtos.RegionStateTransition.TransitionCode code,
                                                long openSeqNum,
                                                HRegionInfo... hris)

Deprecated. use reportRegionStateTransition(RegionStateTransitionContext)

Notify master that a handler requests to change a region state

reportRegionStateTransition

@Deprecated
boolean reportRegionStateTransition(RegionServerStatusProtos.RegionStateTransition.TransitionCode code,
                                                HRegionInfo... hris)

Deprecated. use reportRegionStateTransition(RegionStateTransitionContext)

Notify master that a handler requests to change a region state

getRpcServer

RpcServerInterface getRpcServer()

Returns a reference to the region server's RPC server

getRegionsInTransitionInRS

java.util.concurrent.ConcurrentMap<byte[],java.lang.Boolean> getRegionsInTransitionInRS()

Get the regions that are currently being opened or closed in the RS

Returns:

map of regions in transition in this RS

getFileSystem

FileSystem getFileSystem()

Returns:

Return the FileSystem object used by the regionserver

getLeases

Leases getLeases()

Returns:

The RegionServer's "Leases" service

getExecutorService

ExecutorService getExecutorService()

Returns:

hbase executor service

getRecoveringRegions

java.util.Map<java.lang.String,Region> getRecoveringRegions()

Returns:

set of recovering regions on the hosting region server

getNonceManager

ServerNonceManager getNonceManager()

Only required for "old" log replay; if it's removed, remove this.

Returns:

The RegionServer's NonceManager

registerService

boolean registerService(Service service)

Registers a new protocol buffer Service subclass as a coprocessor endpoint to be available for handling

Parameters:

service - the Service subclass instance to expose as a coprocessor endpoint

Returns:

true if the registration was successful, false

getHeapMemoryManager

HeapMemoryManager getHeapMemoryManager()

Returns:

heap memory manager instance

getCompactionPressure

double getCompactionPressure()

Returns:

the max compaction pressure of all stores on this regionserver. The value should be greater than or equal to 0.0, and any value greater than 1.0 means we enter the emergency state that some stores have too many store files.

See Also:

Store.getCompactionPressure()

getOnlineTables

java.util.Set<TableName> getOnlineTables()

Returns:

all the online tables in this RS

getMetrics

MetricsRegionServer getMetrics()

Returns:

the metrics tracker for the region server