org.apache.hadoop.hbase.regionserver

Class RSRpcServices

java.lang.Object

org.apache.hadoop.hbase.regionserver.RSRpcServices

All Implemented Interfaces:

ConfigurationObserver, HBaseRPCErrorHandler, PriorityFunction

Direct Known Subclasses:

MasterRpcServices

public class RSRpcServices
extends java.lang.Object
implements HBaseRPCErrorHandler, PriorityFunction, ConfigurationObserver

Implements the regionserver RPC services.

Field Summary

Fields

Modifier and Type	Field and Description
protected AccessChecker	accessChecker
protected static Logger	LOG
static java.lang.String	REGION_SERVER_RPC_SCHEDULER_FACTORY_CLASS RPC scheduler to use for the region server.
static java.lang.String	REGIONSERVER_ADMIN_SERVICE_CONFIG Services launched in RSRpcServices.
static java.lang.String	REGIONSERVER_CLIENT_SERVICE_CONFIG
protected static java.lang.String	RESERVOIR_ENABLED_KEY

Constructor Summary

Constructors

Constructor and Description
RSRpcServices(HRegionServer rs)

Method Summary

Modifier and Type	Method and Description
BulkLoadHFileResponse	bulkLoadHFile(RpcController controller, BulkLoadHFileRequest request) Atomically bulk load several HFiles into an open region
boolean	checkOOME(java.lang.Throwable e) Take actions on the event of an OutOfMemoryError.
protected void	checkOpen() Called to verify that this server is up and running.
CleanupBulkLoadResponse	cleanupBulkLoad(RpcController controller, CleanupBulkLoadRequest request)
ClearCompactionQueuesResponse	clearCompactionQueues(RpcController controller, ClearCompactionQueuesRequest request)
ClearRegionBlockCacheResponse	clearRegionBlockCache(RpcController controller, ClearRegionBlockCacheRequest request)
CloseRegionResponse	closeRegion(RpcController controller, CloseRegionRequest request) Close a region on the region server.
CompactRegionResponse	compactRegion(RpcController controller, CompactRegionRequest request) Compact a region on the region server.
protected PriorityFunction	createPriority()
protected RpcServerInterface	createRpcServer(Server server, Configuration conf, RpcSchedulerFactory rpcSchedulerFactory, java.net.InetSocketAddress bindAddress, java.lang.String name)
CoprocessorServiceResponse	execRegionServerService(RpcController controller, CoprocessorServiceRequest request)
CoprocessorServiceResponse	execService(RpcController controller, CoprocessorServiceRequest request)
ExecuteProceduresResponse	executeProcedures(RpcController controller, ExecuteProceduresRequest request)
static boolean	exitIfOOME(java.lang.Throwable e)
FlushRegionResponse	flushRegion(RpcController controller, FlushRegionRequest request) Flush a region on the region server.
GetResponse	get(RpcController controller, GetRequest request) Get data from a table.
Configuration	getConfiguration()
long	getDeadline(RequestHeader header, Message param) Returns the deadline of the specified request.
static java.lang.String	getHostname(Configuration conf, boolean isMaster)
GetOnlineRegionResponse	getOnlineRegion(RpcController controller, GetOnlineRegionRequest request)
PriorityFunction	getPriority()
int	getPriority(RequestHeader header, Message param, User user) Returns the 'priority type' of the specified request.
HRegion	getRegion(RegionSpecifier regionSpecifier) Find the HRegion based on a region specifier
GetRegionInfoResponse	getRegionInfo(RpcController controller, GetRegionInfoRequest request)
GetRegionLoadResponse	getRegionLoad(RpcController controller, GetRegionLoadRequest request)
java.lang.String	getScanDetailsWithId(long scannerId)
RegionScanner	getScanner(long scannerId)
int	getScannersCount()
GetServerInfoResponse	getServerInfo(RpcController controller, GetServerInfoRequest request) Get some information of the region server.
protected java.util.List<RpcServer.BlockingServiceAndInterface>	getServices() By default, put up an Admin and a Client Service.
java.net.InetSocketAddress	getSocketAddress()
GetSpaceQuotaSnapshotsResponse	getSpaceQuotaSnapshots(RpcController controller, GetSpaceQuotaSnapshotsRequest request)
GetStoreFileResponse	getStoreFile(RpcController controller, GetStoreFileRequest request)
MultiResponse	multi(RpcController rpcc, MultiRequest request) Execute multiple actions on a table: get, mutate, and/or execCoprocessor
MutateResponse	mutate(RpcController rpcc, MutateRequest request) Mutate data in a table.
void	onConfigurationChange(Configuration newConf) This method would be called by the ConfigurationManager object when the Configuration object is reloaded from disk.
OpenRegionResponse	openRegion(RpcController controller, OpenRegionRequest request) Open asynchronously a region or a set of regions on the region server.
PrepareBulkLoadResponse	prepareBulkLoad(RpcController controller, PrepareBulkLoadRequest request)
ReplicateWALEntryResponse	replay(RpcController controller, ReplicateWALEntryRequest request) Replay the given changes when distributedLogReplay WAL edits from a failed RS.
ReplicateWALEntryResponse	replicateWALEntry(RpcController controller, ReplicateWALEntryRequest request) Replicate WAL entries on the region server.
protected void	requirePermission(java.lang.String request, Permission.Action perm)
RollWALWriterResponse	rollWALWriter(RpcController controller, RollWALWriterRequest request) Roll the WAL writer of the region server.
ScanResponse	scan(RpcController controller, ScanRequest request) Scan data in a table.
StopServerResponse	stopServer(RpcController controller, StopServerRequest request) Stop the region server.
UpdateConfigurationResponse	updateConfiguration(RpcController controller, UpdateConfigurationRequest request)
UpdateFavoredNodesResponse	updateFavoredNodes(RpcController controller, UpdateFavoredNodesRequest request)
WarmupRegionResponse	warmupRegion(RpcController controller, WarmupRegionRequest request) Wamrmup a region on this server.

Methods inherited from class java.lang.Object

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

Field Detail

LOG

protected static final Logger LOG

REGION_SERVER_RPC_SCHEDULER_FACTORY_CLASS

public static final java.lang.String REGION_SERVER_RPC_SCHEDULER_FACTORY_CLASS

RPC scheduler to use for the region server.

See Also:

Constant Field Values

RESERVOIR_ENABLED_KEY

protected static final java.lang.String RESERVOIR_ENABLED_KEY

See Also:

Constant Field Values

accessChecker

protected AccessChecker accessChecker

REGIONSERVER_ADMIN_SERVICE_CONFIG

public static final java.lang.String REGIONSERVER_ADMIN_SERVICE_CONFIG

Services launched in RSRpcServices. By default they are on but you can use the below booleans to selectively enable/disable either Admin or Client Service (Rare is the case where you would ever turn off one or the other).

See Also:

Constant Field Values

REGIONSERVER_CLIENT_SERVICE_CONFIG

public static final java.lang.String REGIONSERVER_CLIENT_SERVICE_CONFIG

See Also:

Constant Field Values

Constructor Detail

RSRpcServices

public RSRpcServices(HRegionServer rs)
              throws java.io.IOException

Throws:

java.io.IOException

Method Detail

createRpcServer

protected RpcServerInterface createRpcServer(Server server,
                                             Configuration conf,
                                             RpcSchedulerFactory rpcSchedulerFactory,
                                             java.net.InetSocketAddress bindAddress,
                                             java.lang.String name)
                                      throws java.io.IOException

Throws:

java.io.IOException

onConfigurationChange

public void onConfigurationChange(Configuration newConf)

Description copied from interface: ConfigurationObserver

This method would be called by the ConfigurationManager object when the Configuration object is reloaded from disk.

Specified by:

onConfigurationChange in interface ConfigurationObserver

createPriority

protected PriorityFunction createPriority()

requirePermission

protected void requirePermission(java.lang.String request,
                                 Permission.Action perm)
                          throws java.io.IOException

Throws:

java.io.IOException

getHostname

public static java.lang.String getHostname(Configuration conf,
                                           boolean isMaster)
                                    throws java.net.UnknownHostException

Throws:

java.net.UnknownHostException

getScannersCount

public int getScannersCount()

getScanner

public RegionScanner getScanner(long scannerId)

getScanDetailsWithId

public java.lang.String getScanDetailsWithId(long scannerId)

getRegion

public HRegion getRegion(RegionSpecifier regionSpecifier)
                  throws java.io.IOException

Find the HRegion based on a region specifier

Parameters:

regionSpecifier - the region specifier

Returns:

the corresponding region

Throws:

java.io.IOException - if the specifier is not null, but failed to find the region

getPriority

public PriorityFunction getPriority()

getConfiguration

public Configuration getConfiguration()

checkOpen

protected void checkOpen()
                  throws java.io.IOException

Called to verify that this server is up and running.

Throws:

java.io.IOException

getServices

protected java.util.List<RpcServer.BlockingServiceAndInterface> getServices()

By default, put up an Admin and a Client Service. Set booleans hbase.regionserver.admin.executorService and hbase.regionserver.client.executorService if you want to enable/disable services. Default is that both are enabled.

Returns:

immutable list of blocking services and the security info classes that this server supports

getSocketAddress

public java.net.InetSocketAddress getSocketAddress()

getPriority

public int getPriority(RequestHeader header,
                       Message param,
                       User user)

Description copied from interface: PriorityFunction

Returns the 'priority type' of the specified request. The returned value is mainly used to select the dispatch queue.

Specified by:

getPriority in interface PriorityFunction

Returns:

Priority of this request.

getDeadline

public long getDeadline(RequestHeader header,
                        Message param)

Description copied from interface: PriorityFunction

Returns the deadline of the specified request. The returned value is used to sort the dispatch queue.

Specified by:

getDeadline in interface PriorityFunction

Returns:

Deadline of this request. 0 now, otherwise msec of 'delay'

checkOOME

public boolean checkOOME(java.lang.Throwable e)

Description copied from interface: HBaseRPCErrorHandler

Take actions on the event of an OutOfMemoryError.

Specified by:

checkOOME in interface HBaseRPCErrorHandler

Parameters:

e - the throwable

Returns:

if the server should be shut down

exitIfOOME

public static boolean exitIfOOME(java.lang.Throwable e)

closeRegion

public CloseRegionResponse closeRegion(RpcController controller,
                                       CloseRegionRequest request)
                                throws ServiceException

Close a region on the region server.

Parameters:

controller - the RPC controller

request - the request

Throws:

ServiceException

compactRegion

public CompactRegionResponse compactRegion(RpcController controller,
                                           CompactRegionRequest request)
                                    throws ServiceException

Compact a region on the region server.

Parameters:

controller - the RPC controller

request - the request

Throws:

ServiceException

flushRegion

public FlushRegionResponse flushRegion(RpcController controller,
                                       FlushRegionRequest request)
                                throws ServiceException

Flush a region on the region server.

Parameters:

controller - the RPC controller

request - the request

Throws:

ServiceException

getOnlineRegion

public GetOnlineRegionResponse getOnlineRegion(RpcController controller,
                                               GetOnlineRegionRequest request)
                                        throws ServiceException

Throws:

ServiceException

getRegionInfo

public GetRegionInfoResponse getRegionInfo(RpcController controller,
                                           GetRegionInfoRequest request)
                                    throws ServiceException

Throws:

ServiceException

getRegionLoad

public GetRegionLoadResponse getRegionLoad(RpcController controller,
                                           GetRegionLoadRequest request)
                                    throws ServiceException

Throws:

ServiceException

clearCompactionQueues

public ClearCompactionQueuesResponse clearCompactionQueues(RpcController controller,
                                                           ClearCompactionQueuesRequest request)
                                                    throws ServiceException

Throws:

ServiceException

getServerInfo

public GetServerInfoResponse getServerInfo(RpcController controller,
                                           GetServerInfoRequest request)
                                    throws ServiceException

Get some information of the region server.

Parameters:

controller - the RPC controller

request - the request

Throws:

ServiceException

getStoreFile

public GetStoreFileResponse getStoreFile(RpcController controller,
                                         GetStoreFileRequest request)
                                  throws ServiceException

Throws:

ServiceException

openRegion

public OpenRegionResponse openRegion(RpcController controller,
                                     OpenRegionRequest request)
                              throws ServiceException

Open asynchronously a region or a set of regions on the region server. The opening is coordinated by ZooKeeper, and this method requires the znode to be created before being called. As a consequence, this method should be called only from the master.

Different manages states for the region are:

• region not opened: the region opening will start asynchronously.
• a close is already in progress: this is considered as an error.
• an open is already in progress: this new open request will be ignored. This is important because the Master can do multiple requests if it crashes.
• the region is already opened: this new open request will be ignored.

Bulk assign: If there are more than 1 region to open, it will be considered as a bulk assign. For a single region opening, errors are sent through a ServiceException. For bulk assign, errors are put in the response as FAILED_OPENING.

Parameters:

controller - the RPC controller

request - the request

Throws:

ServiceException

warmupRegion

public WarmupRegionResponse warmupRegion(RpcController controller,
                                         WarmupRegionRequest request)
                                  throws ServiceException

Wamrmup a region on this server. This method should only be called by Master. It synchrnously opens the region and closes the region bringing the most important pages in cache.

Parameters:

controller - the RPC controller

request - the request

Throws:

ServiceException

replay

public ReplicateWALEntryResponse replay(RpcController controller,
                                        ReplicateWALEntryRequest request)
                                 throws ServiceException

Replay the given changes when distributedLogReplay WAL edits from a failed RS. The guarantee is that the given mutations will be durable on the receiving RS if this method returns without any exception.

Parameters:

controller - the RPC controller

request - the request

Throws:

ServiceException

replicateWALEntry

public ReplicateWALEntryResponse replicateWALEntry(RpcController controller,
                                                   ReplicateWALEntryRequest request)
                                            throws ServiceException

Replicate WAL entries on the region server.

Parameters:

controller - the RPC controller

request - the request

Throws:

ServiceException

rollWALWriter

public RollWALWriterResponse rollWALWriter(RpcController controller,
                                           RollWALWriterRequest request)
                                    throws ServiceException

Roll the WAL writer of the region server.

Parameters:

controller - the RPC controller

request - the request

Throws:

ServiceException

stopServer

public StopServerResponse stopServer(RpcController controller,
                                     StopServerRequest request)
                              throws ServiceException

Stop the region server.

Parameters:

controller - the RPC controller

request - the request

Throws:

ServiceException

updateFavoredNodes

public UpdateFavoredNodesResponse updateFavoredNodes(RpcController controller,
                                                     UpdateFavoredNodesRequest request)
                                              throws ServiceException

Throws:

ServiceException

bulkLoadHFile

public BulkLoadHFileResponse bulkLoadHFile(RpcController controller,
                                           BulkLoadHFileRequest request)
                                    throws ServiceException

Atomically bulk load several HFiles into an open region

Returns:

true if successful, false is failed but recoverably (no action)

Throws:

ServiceException - if failed unrecoverably

prepareBulkLoad

public PrepareBulkLoadResponse prepareBulkLoad(RpcController controller,
                                               PrepareBulkLoadRequest request)
                                        throws ServiceException

Throws:

ServiceException

cleanupBulkLoad

public CleanupBulkLoadResponse cleanupBulkLoad(RpcController controller,
                                               CleanupBulkLoadRequest request)
                                        throws ServiceException

Throws:

ServiceException

execService

public CoprocessorServiceResponse execService(RpcController controller,
                                              CoprocessorServiceRequest request)
                                       throws ServiceException

Throws:

ServiceException

get

public GetResponse get(RpcController controller,
                       GetRequest request)
                throws ServiceException

Get data from a table.

Parameters:

controller - the RPC controller

request - the get request

Throws:

ServiceException

multi

public MultiResponse multi(RpcController rpcc,
                           MultiRequest request)
                    throws ServiceException

Execute multiple actions on a table: get, mutate, and/or execCoprocessor

Parameters:

rpcc - the RPC controller

request - the multi request

Throws:

ServiceException

mutate

public MutateResponse mutate(RpcController rpcc,
                             MutateRequest request)
                      throws ServiceException

Mutate data in a table.

Parameters:

rpcc - the RPC controller

request - the mutate request

Throws:

ServiceException

scan

public ScanResponse scan(RpcController controller,
                         ScanRequest request)
                  throws ServiceException

Scan data in a table.

Parameters:

controller - the RPC controller

request - the scan request

Throws:

ServiceException

execRegionServerService

public CoprocessorServiceResponse execRegionServerService(RpcController controller,
                                                          CoprocessorServiceRequest request)
                                                   throws ServiceException

Throws:

ServiceException

updateConfiguration

public UpdateConfigurationResponse updateConfiguration(RpcController controller,
                                                       UpdateConfigurationRequest request)
                                                throws ServiceException

Throws:

ServiceException

getSpaceQuotaSnapshots

public GetSpaceQuotaSnapshotsResponse getSpaceQuotaSnapshots(RpcController controller,
                                                             GetSpaceQuotaSnapshotsRequest request)
                                                      throws ServiceException

Throws:

ServiceException

executeProcedures

public ExecuteProceduresResponse executeProcedures(RpcController controller,
                                                   ExecuteProceduresRequest request)
                                            throws ServiceException

Throws:

ServiceException

clearRegionBlockCache

public ClearRegionBlockCacheResponse clearRegionBlockCache(RpcController controller,
                                                           ClearRegionBlockCacheRequest request)