org.apache.hadoop.hbase.regionserver

Class RSRpcServices

java.lang.Object

org.apache.hadoop.hbase.regionserver.RSRpcServices

All Implemented Interfaces:

ConfigurationObserver, HBaseRPCErrorHandler, PriorityFunction, AdminProtos.AdminService.BlockingInterface, ClientProtos.ClientService.BlockingInterface

Direct Known Subclasses:

MasterRpcServices

@InterfaceAudience.Private
public class RSRpcServices
extends Object
implements HBaseRPCErrorHandler, AdminProtos.AdminService.BlockingInterface, ClientProtos.ClientService.BlockingInterface, PriorityFunction, ConfigurationObserver

Implements the regionserver RPC services.

Field Summary

Fields

Modifier and Type	Field and Description
protected static org.apache.commons.logging.Log	LOG
static String	REGION_SERVER_RPC_SCHEDULER_FACTORY_CLASS RPC scheduler to use for the region server.

Constructor Summary

Constructors

Constructor and Description
RSRpcServices(HRegionServer rs)

Method Summary

Methods

Modifier and Type	Method and Description
ClientProtos.BulkLoadHFileResponse	bulkLoadHFile(com.google.protobuf.RpcController controller, ClientProtos.BulkLoadHFileRequest request) Atomically bulk load several HFiles into an open region
boolean	checkOOME(Throwable e) Take actions on the event of an OutOfMemoryError.
protected void	checkOpen() Called to verify that this server is up and running.
AdminProtos.CloseRegionResponse	closeRegion(com.google.protobuf.RpcController controller, AdminProtos.CloseRegionRequest request) Close a region on the region server.
AdminProtos.CompactRegionResponse	compactRegion(com.google.protobuf.RpcController controller, AdminProtos.CompactRegionRequest request) Compact a region on the region server.
protected PriorityFunction	createPriority()
ClientProtos.CoprocessorServiceResponse	execRegionServerService(com.google.protobuf.RpcController controller, ClientProtos.CoprocessorServiceRequest request)
ClientProtos.CoprocessorServiceResponse	execService(com.google.protobuf.RpcController controller, ClientProtos.CoprocessorServiceRequest request)
AdminProtos.FlushRegionResponse	flushRegion(com.google.protobuf.RpcController controller, AdminProtos.FlushRegionRequest request) Flush a region on the region server.
ClientProtos.GetResponse	get(com.google.protobuf.RpcController controller, ClientProtos.GetRequest request) Get data from a table.
org.apache.hadoop.conf.Configuration	getConfiguration()
long	getDeadline(RPCProtos.RequestHeader header, com.google.protobuf.Message param) Returns the deadline of the specified request.
static String	getHostname(org.apache.hadoop.conf.Configuration conf, boolean isMaster)
AdminProtos.GetOnlineRegionResponse	getOnlineRegion(com.google.protobuf.RpcController controller, AdminProtos.GetOnlineRegionRequest request)
PriorityFunction	getPriority()
int	getPriority(RPCProtos.RequestHeader header, com.google.protobuf.Message param, User user) Returns the 'priority type' of the specified request.
AdminProtos.GetRegionInfoResponse	getRegionInfo(com.google.protobuf.RpcController controller, AdminProtos.GetRegionInfoRequest request)
AdminProtos.GetServerInfoResponse	getServerInfo(com.google.protobuf.RpcController controller, AdminProtos.GetServerInfoRequest request) Get some information of the region server.
protected List<RpcServer.BlockingServiceAndInterface>	getServices()
InetSocketAddress	getSocketAddress()
AdminProtos.GetStoreFileResponse	getStoreFile(com.google.protobuf.RpcController controller, AdminProtos.GetStoreFileRequest request)
AdminProtos.MergeRegionsResponse	mergeRegions(com.google.protobuf.RpcController controller, AdminProtos.MergeRegionsRequest request) Merge regions on the region server.
ClientProtos.MultiResponse	multi(com.google.protobuf.RpcController rpcc, ClientProtos.MultiRequest request) Execute multiple actions on a table: get, mutate, and/or execCoprocessor
ClientProtos.MutateResponse	mutate(com.google.protobuf.RpcController rpcc, ClientProtos.MutateRequest request) Mutate data in a table.
void	onConfigurationChange(org.apache.hadoop.conf.Configuration newConf) This method would be called by the ConfigurationManager object when the Configuration object is reloaded from disk.
AdminProtos.OpenRegionResponse	openRegion(com.google.protobuf.RpcController controller, AdminProtos.OpenRegionRequest request) Open asynchronously a region or a set of regions on the region server.
AdminProtos.ReplicateWALEntryResponse	replay(com.google.protobuf.RpcController controller, AdminProtos.ReplicateWALEntryRequest request) Replay the given changes when distributedLogReplay WAL edits from a failed RS.
AdminProtos.ReplicateWALEntryResponse	replicateWALEntry(com.google.protobuf.RpcController controller, AdminProtos.ReplicateWALEntryRequest request) Replicate WAL entries on the region server.
AdminProtos.RollWALWriterResponse	rollWALWriter(com.google.protobuf.RpcController controller, AdminProtos.RollWALWriterRequest request) Roll the WAL writer of the region server.
ClientProtos.ScanResponse	scan(com.google.protobuf.RpcController controller, ClientProtos.ScanRequest request) Scan data in a table.
AdminProtos.SplitRegionResponse	splitRegion(com.google.protobuf.RpcController controller, AdminProtos.SplitRegionRequest request) Split a region on the region server.
AdminProtos.StopServerResponse	stopServer(com.google.protobuf.RpcController controller, AdminProtos.StopServerRequest request) Stop the region server.
AdminProtos.UpdateConfigurationResponse	updateConfiguration(com.google.protobuf.RpcController controller, AdminProtos.UpdateConfigurationRequest request)
AdminProtos.UpdateFavoredNodesResponse	updateFavoredNodes(com.google.protobuf.RpcController controller, AdminProtos.UpdateFavoredNodesRequest request)
AdminProtos.WarmupRegionResponse	warmupRegion(com.google.protobuf.RpcController controller, AdminProtos.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 org.apache.commons.logging.Log LOG

REGION_SERVER_RPC_SCHEDULER_FACTORY_CLASS

public static final String REGION_SERVER_RPC_SCHEDULER_FACTORY_CLASS

RPC scheduler to use for the region server.

See Also:

Constant Field Values

Constructor Detail

RSRpcServices

public RSRpcServices(HRegionServer rs)
              throws IOException

Throws:

IOException

Method Detail

onConfigurationChange

public void onConfigurationChange(org.apache.hadoop.conf.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()

getHostname

public static String getHostname(org.apache.hadoop.conf.Configuration conf,
                 boolean isMaster)
                          throws UnknownHostException

Throws:

UnknownHostException

getPriority

public PriorityFunction getPriority()

getConfiguration

public org.apache.hadoop.conf.Configuration getConfiguration()

checkOpen

protected void checkOpen()
                  throws IOException

Called to verify that this server is up and running.

Throws:

IOException

getServices

protected List<RpcServer.BlockingServiceAndInterface> getServices()

Returns:

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

getSocketAddress

public InetSocketAddress getSocketAddress()

getPriority

public int getPriority(RPCProtos.RequestHeader header,
              com.google.protobuf.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(RPCProtos.RequestHeader header,
               com.google.protobuf.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(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

closeRegion

public AdminProtos.CloseRegionResponse closeRegion(com.google.protobuf.RpcController controller,
                                          AdminProtos.CloseRegionRequest request)
                                            throws com.google.protobuf.ServiceException

Close a region on the region server.

Specified by:

closeRegion in interface AdminProtos.AdminService.BlockingInterface

Parameters:

controller - the RPC controller

request - the request

Throws:

com.google.protobuf.ServiceException

compactRegion

public AdminProtos.CompactRegionResponse compactRegion(com.google.protobuf.RpcController controller,
                                              AdminProtos.CompactRegionRequest request)
                                                throws com.google.protobuf.ServiceException

Compact a region on the region server.

Specified by:

compactRegion in interface AdminProtos.AdminService.BlockingInterface

Parameters:

controller - the RPC controller

request - the request

Throws:

com.google.protobuf.ServiceException

flushRegion

public AdminProtos.FlushRegionResponse flushRegion(com.google.protobuf.RpcController controller,
                                          AdminProtos.FlushRegionRequest request)
                                            throws com.google.protobuf.ServiceException

Flush a region on the region server.

Specified by:

flushRegion in interface AdminProtos.AdminService.BlockingInterface

Parameters:

controller - the RPC controller

request - the request

Throws:

com.google.protobuf.ServiceException

getOnlineRegion

public AdminProtos.GetOnlineRegionResponse getOnlineRegion(com.google.protobuf.RpcController controller,
                                                  AdminProtos.GetOnlineRegionRequest request)
                                                    throws com.google.protobuf.ServiceException

Specified by:

getOnlineRegion in interface AdminProtos.AdminService.BlockingInterface

Throws:

com.google.protobuf.ServiceException

getRegionInfo

public AdminProtos.GetRegionInfoResponse getRegionInfo(com.google.protobuf.RpcController controller,
                                              AdminProtos.GetRegionInfoRequest request)
                                                throws com.google.protobuf.ServiceException

Specified by:

getRegionInfo in interface AdminProtos.AdminService.BlockingInterface

Throws:

com.google.protobuf.ServiceException

getServerInfo

public AdminProtos.GetServerInfoResponse getServerInfo(com.google.protobuf.RpcController controller,
                                              AdminProtos.GetServerInfoRequest request)
                                                throws com.google.protobuf.ServiceException

Get some information of the region server.

Specified by:

getServerInfo in interface AdminProtos.AdminService.BlockingInterface

Parameters:

controller - the RPC controller

request - the request

Throws:

com.google.protobuf.ServiceException

getStoreFile

public AdminProtos.GetStoreFileResponse getStoreFile(com.google.protobuf.RpcController controller,
                                            AdminProtos.GetStoreFileRequest request)
                                              throws com.google.protobuf.ServiceException

Specified by:

getStoreFile in interface AdminProtos.AdminService.BlockingInterface

Throws:

com.google.protobuf.ServiceException

mergeRegions

public AdminProtos.MergeRegionsResponse mergeRegions(com.google.protobuf.RpcController controller,
                                            AdminProtos.MergeRegionsRequest request)
                                              throws com.google.protobuf.ServiceException

Merge regions on the region server.

Specified by:

mergeRegions in interface AdminProtos.AdminService.BlockingInterface

Parameters:

controller - the RPC controller

request - the request

Returns:

merge regions response

Throws:

com.google.protobuf.ServiceException

openRegion

public AdminProtos.OpenRegionResponse openRegion(com.google.protobuf.RpcController controller,
                                        AdminProtos.OpenRegionRequest request)
                                          throws com.google.protobuf.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.

Specified by:

openRegion in interface AdminProtos.AdminService.BlockingInterface

Parameters:

controller - the RPC controller

request - the request

Throws:

com.google.protobuf.ServiceException

warmupRegion

public AdminProtos.WarmupRegionResponse warmupRegion(com.google.protobuf.RpcController controller,
                                            AdminProtos.WarmupRegionRequest request)
                                              throws com.google.protobuf.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.

Specified by:

warmupRegion in interface AdminProtos.AdminService.BlockingInterface

Parameters:

controller - the RPC controller

request - the request

Throws:

com.google.protobuf.ServiceException

replay

public AdminProtos.ReplicateWALEntryResponse replay(com.google.protobuf.RpcController controller,
                                           AdminProtos.ReplicateWALEntryRequest request)
                                             throws com.google.protobuf.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.

Specified by:

replay in interface AdminProtos.AdminService.BlockingInterface

Parameters:

controller - the RPC controller

request - the request

Throws:

com.google.protobuf.ServiceException

replicateWALEntry

public AdminProtos.ReplicateWALEntryResponse replicateWALEntry(com.google.protobuf.RpcController controller,
                                                      AdminProtos.ReplicateWALEntryRequest request)
                                                        throws com.google.protobuf.ServiceException

Replicate WAL entries on the region server.

Specified by:

replicateWALEntry in interface AdminProtos.AdminService.BlockingInterface

Parameters:

controller - the RPC controller

request - the request

Throws:

com.google.protobuf.ServiceException

rollWALWriter

public AdminProtos.RollWALWriterResponse rollWALWriter(com.google.protobuf.RpcController controller,
                                              AdminProtos.RollWALWriterRequest request)
                                                throws com.google.protobuf.ServiceException

Roll the WAL writer of the region server.

Specified by:

rollWALWriter in interface AdminProtos.AdminService.BlockingInterface

Parameters:

controller - the RPC controller

request - the request

Throws:

com.google.protobuf.ServiceException

splitRegion

public AdminProtos.SplitRegionResponse splitRegion(com.google.protobuf.RpcController controller,
                                          AdminProtos.SplitRegionRequest request)
                                            throws com.google.protobuf.ServiceException

Split a region on the region server.

Specified by:

splitRegion in interface AdminProtos.AdminService.BlockingInterface

Parameters:

controller - the RPC controller

request - the request

Throws:

com.google.protobuf.ServiceException

stopServer

public AdminProtos.StopServerResponse stopServer(com.google.protobuf.RpcController controller,
                                        AdminProtos.StopServerRequest request)
                                          throws com.google.protobuf.ServiceException

Stop the region server.

Specified by:

stopServer in interface AdminProtos.AdminService.BlockingInterface

Parameters:

controller - the RPC controller

request - the request

Throws:

com.google.protobuf.ServiceException

updateFavoredNodes

public AdminProtos.UpdateFavoredNodesResponse updateFavoredNodes(com.google.protobuf.RpcController controller,
                                                        AdminProtos.UpdateFavoredNodesRequest request)
                                                          throws com.google.protobuf.ServiceException

Specified by:

updateFavoredNodes in interface AdminProtos.AdminService.BlockingInterface

Throws:

com.google.protobuf.ServiceException

bulkLoadHFile

public ClientProtos.BulkLoadHFileResponse bulkLoadHFile(com.google.protobuf.RpcController controller,
                                               ClientProtos.BulkLoadHFileRequest request)
                                                 throws com.google.protobuf.ServiceException

Atomically bulk load several HFiles into an open region

Specified by:

bulkLoadHFile in interface ClientProtos.ClientService.BlockingInterface

Returns:

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

Throws:

com.google.protobuf.ServiceException - if failed unrecoverably

execService

public ClientProtos.CoprocessorServiceResponse execService(com.google.protobuf.RpcController controller,
                                                  ClientProtos.CoprocessorServiceRequest request)
                                                    throws com.google.protobuf.ServiceException

Specified by:

execService in interface ClientProtos.ClientService.BlockingInterface

Throws:

com.google.protobuf.ServiceException

get

public ClientProtos.GetResponse get(com.google.protobuf.RpcController controller,
                           ClientProtos.GetRequest request)
                             throws com.google.protobuf.ServiceException

Get data from a table.

Specified by:

get in interface ClientProtos.ClientService.BlockingInterface

Parameters:

controller - the RPC controller

request - the get request

Throws:

com.google.protobuf.ServiceException

multi

public ClientProtos.MultiResponse multi(com.google.protobuf.RpcController rpcc,
                               ClientProtos.MultiRequest request)
                                 throws com.google.protobuf.ServiceException

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

Specified by:

multi in interface ClientProtos.ClientService.BlockingInterface

Parameters:

rpcc - the RPC controller

request - the multi request

Throws:

com.google.protobuf.ServiceException

mutate

public ClientProtos.MutateResponse mutate(com.google.protobuf.RpcController rpcc,
                                 ClientProtos.MutateRequest request)
                                   throws com.google.protobuf.ServiceException

Mutate data in a table.

Specified by:

mutate in interface ClientProtos.ClientService.BlockingInterface

Parameters:

rpcc - the RPC controller

request - the mutate request

Throws:

com.google.protobuf.ServiceException

scan

public ClientProtos.ScanResponse scan(com.google.protobuf.RpcController controller,
                             ClientProtos.ScanRequest request)
                               throws com.google.protobuf.ServiceException

Scan data in a table.

Specified by:

scan in interface ClientProtos.ClientService.BlockingInterface

Parameters:

controller - the RPC controller

request - the scan request

Throws:

com.google.protobuf.ServiceException

execRegionServerService

public ClientProtos.CoprocessorServiceResponse execRegionServerService(com.google.protobuf.RpcController controller,
                                                              ClientProtos.CoprocessorServiceRequest request)
                                                                throws com.google.protobuf.ServiceException

Specified by:

execRegionServerService in interface ClientProtos.ClientService.BlockingInterface

Throws:

com.google.protobuf.ServiceException

updateConfiguration

public AdminProtos.UpdateConfigurationResponse updateConfiguration(com.google.protobuf.RpcController controller,
                                                          AdminProtos.UpdateConfigurationRequest request)
                                                            throws com.google.protobuf.ServiceException

Specified by:

updateConfiguration in interface AdminProtos.AdminService.BlockingInterface

Throws:

com.google.protobuf.ServiceException