org.apache.hadoop.hbase.regionserver

Class RegionServerCoprocessorHost.RegionServerEnvironment

java.lang.Object

org.apache.hadoop.hbase.coprocessor.BaseEnvironment<RegionServerCoprocessor>

org.apache.hadoop.hbase.regionserver.RegionServerCoprocessorHost.RegionServerEnvironment

All Implemented Interfaces:

RegionServerCoprocessorEnvironment, CoprocessorEnvironment<RegionServerCoprocessor>

Direct Known Subclasses:

RegionServerCoprocessorHost.RegionServerEnvironmentForCoreCoprocessors

Enclosing class:

RegionServerCoprocessorHost

private static class RegionServerCoprocessorHost.RegionServerEnvironment
extends BaseEnvironment<RegionServerCoprocessor>
implements RegionServerCoprocessorEnvironment

Coprocessor environment extension providing access to region server related services.

Field Summary

Fields

Modifier and Type	Field and Description
private MetricRegistry	metricRegistry
private RegionServerServices	services

Fields inherited from class org.apache.hadoop.hbase.coprocessor.BaseEnvironment

impl, priority

Constructor Summary

Constructors

Constructor and Description
RegionServerEnvironment(RegionServerCoprocessor impl, int priority, int seq, org.apache.hadoop.conf.Configuration conf, RegionServerServices services)

Method Summary

Modifier and Type	Method and Description
Connection	createConnection(org.apache.hadoop.conf.Configuration conf) Creates a cluster connection using the passed Configuration.
Connection	getConnection() Returns the hosts' Connection to the Cluster.
MetricRegistry	getMetricRegistryForRegionServer() Returns a MetricRegistry that can be used to track metrics at the region server level.
OnlineRegions	getOnlineRegions() Returns Interface to Map of regions online on this RegionServer RegionServerCoprocessorEnvironment.getServerName()}.
ServerName	getServerName() Returns Hosting Server's ServerName
void	shutdown() Clean up the environment

Methods inherited from class org.apache.hadoop.hbase.coprocessor.BaseEnvironment

getClassLoader, getConfiguration, getHBaseVersion, getInstance, getLoadSequence, getPriority, getVersion, startup

Methods inherited from class java.lang.Object

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

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

getClassLoader, getConfiguration, getHBaseVersion, getInstance, getLoadSequence, getPriority, getVersion

Field Detail

metricRegistry

private final MetricRegistry metricRegistry

services

private final RegionServerServices services

Constructor Detail

RegionServerEnvironment

public RegionServerEnvironment(RegionServerCoprocessor impl,
                               int priority,
                               int seq,
                               org.apache.hadoop.conf.Configuration conf,
                               RegionServerServices services)

Method Detail

getOnlineRegions

public OnlineRegions getOnlineRegions()

Description copied from interface: RegionServerCoprocessorEnvironment

Returns Interface to Map of regions online on this RegionServer RegionServerCoprocessorEnvironment.getServerName()}.

Specified by:

getOnlineRegions in interface RegionServerCoprocessorEnvironment

getServerName

public ServerName getServerName()

Description copied from interface: RegionServerCoprocessorEnvironment

Returns Hosting Server's ServerName

Specified by:

getServerName in interface RegionServerCoprocessorEnvironment

getConnection

public Connection getConnection()

Description copied from interface: RegionServerCoprocessorEnvironment

Returns the hosts' Connection to the Cluster. Do not close! This is a shared connection with the hosting server. Throws UnsupportedOperationException if you try to close or abort it. For light-weight usage only. Heavy-duty usage will pull down the hosting RegionServer responsiveness as well as that of other Coprocessors making use of this Connection. Use to create table on start or to do administrative operations. Coprocessors should create their own Connections if heavy usage to avoid impinging on hosting Server operation. To create a Connection or if a Coprocessor requires a region with a particular Configuration, use ConnectionFactory or RegionServerCoprocessorEnvironment.createConnection(Configuration)}.

Be aware that operations that make use of this Connection are executed as the RegionServer User, the hbase super user that started this server process. Exercise caution running operations as this User (See RegionServerCoprocessorEnvironment.createConnection(Configuration)} to run as other than the RegionServer User).

Be careful RPC'ing from a Coprocessor context. RPC's will fail, stall, retry, and/or crawl because the remote side is not online, is struggling or it is on the other side of a network partition. Any use of Connection from inside a Coprocessor must be able to handle all such hiccups.

Specified by:

getConnection in interface RegionServerCoprocessorEnvironment

Returns:

The host's Connection to the Cluster.

See Also:

RegionServerCoprocessorEnvironment.createConnection(Configuration)

createConnection

public Connection createConnection(org.apache.hadoop.conf.Configuration conf)
                            throws IOException

Description copied from interface: RegionServerCoprocessorEnvironment

Creates a cluster connection using the passed Configuration. Creating a Connection is a heavy-weight operation. The resultant Connection's cache of region locations will be empty. Therefore you should cache and reuse Connections rather than create a Connection on demand. Create on start of your Coprocessor. You will have to cast the CoprocessorEnvironment appropriately to get at this API at start time because Coprocessor start method is passed a subclass of this CoprocessorEnvironment or fetch Connection using a synchronized accessor initializing the Connection on first access. Close the returned Connection when done to free resources. Using this API rather than ConnectionFactory.createConnection(Configuration) returns a Connection that will short-circuit RPC if the target is a local resource. Use ConnectionFactory if you don't need this ability.

Be careful RPC'ing from a Coprocessor context. RPC's will fail, stall, retry, and/or crawl because the remote side is not online, is struggling or it is on the other side of a network partition. Any use of Connection from inside a Coprocessor must be able to handle all such hiccups.

Specified by:

createConnection in interface RegionServerCoprocessorEnvironment

Returns:

Connection created using the passed conf.

Throws:

IOException

getMetricRegistryForRegionServer

public MetricRegistry getMetricRegistryForRegionServer()

Description copied from interface: RegionServerCoprocessorEnvironment

Returns a MetricRegistry that can be used to track metrics at the region server level.

See ExampleMasterObserverWithMetrics class in the hbase-examples modules for examples of how metrics can be instantiated and used.

Specified by:

getMetricRegistryForRegionServer in interface RegionServerCoprocessorEnvironment

Returns:

A MetricRegistry for the coprocessor class to track and export metrics.

shutdown

public void shutdown()

Description copied from class: BaseEnvironment

Clean up the environment

Overrides:

shutdown in class BaseEnvironment<RegionServerCoprocessor>