org.apache.hadoop.hbase.regionserver

Interface RegionServerServices

All Superinterfaces:

Abortable, FavoredNodesForRegion, MutableOnlineRegions, OnlineRegions, Server, Stoppable

All Known Implementing Classes:

HMaster, HMasterCommandLine.LocalHMaster, HRegionServer

@InterfaceAudience.Private
public interface RegionServerServices
extends Server, MutableOnlineRegions, FavoredNodesForRegion

A curated subset of services provided by HRegionServer. For use internally only. Passed to Managers, Services and Chores so can pass less-than-a full-on HRegionServer at test-time. Be judicious adding API. Changes cause ripples through the code base.

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
AccessChecker	getAccessChecker() Returns the AccessChecker
Optional<BlockCache>	getBlockCache() Returns The block cache instance.
double	getCompactionPressure()
CompactionRequester	getCompactionRequestor()
ExecutorService	getExecutorService() Returns hbase executor service
double	getFlushPressure() Deprecated.
FlushRequester	getFlushRequester()
ThroughputController	getFlushThroughputController() Returns the controller to avoid flush too fast
HeapMemoryManager	getHeapMemoryManager() Returns heap memory manager instance
LeaseManager	getLeaseManager() Returns The RegionServer's "Leases" service
MetricsRegionServer	getMetrics() Returns the metrics tracker for the region server
Optional<MobFileCache>	getMobFileCache() Returns The cache for mob files.
ServerNonceManager	getNonceManager() Only required for "old" log replay; if it's removed, remove this.
RegionServerAccounting	getRegionServerAccounting() Returns the RegionServerAccounting for this Region Server
RegionServerRpcQuotaManager	getRegionServerRpcQuotaManager() Returns RegionServer's instance of RegionServerRpcQuotaManager
RegionServerSpaceQuotaManager	getRegionServerSpaceQuotaManager() Returns RegionServer's instance of RegionServerSpaceQuotaManager
ConcurrentMap<byte[],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
SecureBulkLoadManager	getSecureBulkLoadManager() Returns RegionServer's instance of SecureBulkLoadManager
TableDescriptors	getTableDescriptors() Returns Return table descriptors implementation.
WAL	getWAL(RegionInfo regionInfo) Returns the WAL for a particular region.
List<WAL>	getWALs() Returns the List of WALs that are used by this server Doesn't include the meta WAL
ZKPermissionWatcher	getZKPermissionWatcher() Returns ZKPermissionWatcher
boolean	isClusterUp() Returns True if cluster is up; false if cluster is not up (we are shutting down).
void	postOpenDeployTasks(RegionServerServices.PostOpenDeployContext context) Tasks to perform after region open to complete deploy of region on regionserver
EntityLock	regionLock(List<RegionInfo> regionInfos, String description, Abortable abort) Master based locks on namespaces/tables/regions.
boolean	registerService(com.google.protobuf.Service service) Registers a new protocol buffer Service subclass as a coprocessor endpoint to be available for handling
boolean	reportFileArchivalForQuotas(TableName tableName, Collection<Map.Entry<String,Long>> archivedFiles) Reports a collection of files, and their sizes, that belonged to the given table were just moved to the archive directory.
boolean	reportRegionSizesForQuotas(RegionSizeStore sizeStore) Reports the provided Region sizes hosted by this RegionServer to the active Master.
boolean	reportRegionStateTransition(RegionServerServices.RegionStateTransitionContext context) Notify master that a handler requests to change a region state
void	unassign(byte[] regionName) Unassign the given region from the current regionserver and assign it randomly.

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

createConnection, getChoreService, getClusterConnection, getConfiguration, getConnection, getCoordinatedStateManager, getFileSystem, getServerName, getZooKeeper, isStopping

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

abort, abort, isAborted

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

isStopped, stop

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

addRegion, removeRegion

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

getRegion, getRegions, getRegions

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

getFavoredNodesForRegion, updateRegionFavoredNodesMapping

Method Detail

getWAL

WAL getWAL(RegionInfo regionInfo)
    throws IOException

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

Throws:

IOException

getWALs

List<WAL> getWALs()
           throws IOException

Returns the List of WALs that are used by this server Doesn't include the meta WAL

Throws:

IOException

getFlushRequester

FlushRequester getFlushRequester()

Returns:

Implementation of FlushRequester or null. Usually it will not be null unless during intialization.

getCompactionRequestor

CompactionRequester getCompactionRequestor()

Returns:

Implementation of CompactionRequester or null. Usually it will not be null unless during intialization.

getRegionServerAccounting

RegionServerAccounting getRegionServerAccounting()

Returns the RegionServerAccounting for this Region Server

getRegionServerRpcQuotaManager

RegionServerRpcQuotaManager getRegionServerRpcQuotaManager()

Returns RegionServer's instance of RegionServerRpcQuotaManager

getSecureBulkLoadManager

SecureBulkLoadManager getSecureBulkLoadManager()

Returns RegionServer's instance of SecureBulkLoadManager

getRegionServerSpaceQuotaManager

RegionServerSpaceQuotaManager getRegionServerSpaceQuotaManager()

Returns RegionServer's instance of RegionServerSpaceQuotaManager

postOpenDeployTasks

void postOpenDeployTasks(RegionServerServices.PostOpenDeployContext context)
                  throws IOException

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

Parameters:

context - the context

Throws:

IOException

reportRegionStateTransition

boolean reportRegionStateTransition(RegionServerServices.RegionStateTransitionContext context)

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

ConcurrentMap<byte[],Boolean> getRegionsInTransitionInRS()

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

Returns:

map of regions in transition in this RS

getLeaseManager

LeaseManager getLeaseManager()

Returns The RegionServer's "Leases" service

getExecutorService

ExecutorService getExecutorService()

Returns hbase executor service

getNonceManager

ServerNonceManager getNonceManager()

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

Returns:

The RegionServer's NonceManager

registerService

boolean registerService(com.google.protobuf.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()

getFlushThroughputController

ThroughputController getFlushThroughputController()

Returns the controller to avoid flush too fast

getFlushPressure

@Deprecated
double getFlushPressure()

Deprecated.

Returns:

the flush 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 global memstore size already exceeds lower limit.

getMetrics

MetricsRegionServer getMetrics()

Returns the metrics tracker for the region server

regionLock

EntityLock regionLock(List<RegionInfo> regionInfos,
                      String description,
                      Abortable abort)
               throws IOException

Master based locks on namespaces/tables/regions.

Throws:

IOException

unassign

void unassign(byte[] regionName)
       throws IOException

Unassign the given region from the current regionserver and assign it randomly. Could still be assigned to us. This is used to solve some tough problems for which you need to reset the state of a region. For example, if you hit FileNotFound exception and want to refresh the store file list.

See HBASE-17712 for more details.

Throws:

IOException

isClusterUp

boolean isClusterUp()

Returns True if cluster is up; false if cluster is not up (we are shutting down).

getTableDescriptors

TableDescriptors getTableDescriptors()

Returns Return table descriptors implementation.

getBlockCache

Optional<BlockCache> getBlockCache()

Returns The block cache instance.

getMobFileCache

Optional<MobFileCache> getMobFileCache()

Returns The cache for mob files.

getAccessChecker

AccessChecker getAccessChecker()

Returns the AccessChecker

getZKPermissionWatcher

ZKPermissionWatcher getZKPermissionWatcher()

Returns ZKPermissionWatcher

reportRegionSizesForQuotas

boolean reportRegionSizesForQuotas(RegionSizeStore sizeStore)

Reports the provided Region sizes hosted by this RegionServer to the active Master.

Parameters:

sizeStore - The sizes for Regions locally hosted.

Returns:

false if reporting should be temporarily paused, true otherwise.

reportFileArchivalForQuotas

boolean reportFileArchivalForQuotas(TableName tableName,
                                    Collection<Map.Entry<String,Long>> archivedFiles)

Reports a collection of files, and their sizes, that belonged to the given table were just moved to the archive directory.

Parameters:

tableName - The name of the table that files previously belonged to

archivedFiles - Files and their sizes that were moved to archive

Returns:

true if the files were successfully reported, false otherwise.