RegionCoprocessorEnvironment (Apache HBase 1.4.11 API)

All Superinterfaces:: CoprocessorEnvironment

@InterfaceAudience.LimitedPrivate(value="Coprocesssor")
@InterfaceStability.Evolving
public interface RegionCoprocessorEnvironment
extends CoprocessorEnvironment

Method Summary

Methods
Modifier and Type	Method and Description
`MetricRegistry`	`getMetricRegistryForRegionServer()` Returns a MetricRegistry that can be used to track metrics at the region server level.
`Region`	`getRegion()`
`HRegionInfo`	`getRegionInfo()`
`RegionServerServices`	`getRegionServerServices()`
`ConcurrentMap<String,Object>`	`getSharedData()`

Methods inherited from interface org.apache.hadoop.hbase.CoprocessorEnvironment
getClassLoader, getConfiguration, getHBaseVersion, getInstance, getLoadSequence, getPriority, getTable, getTable, getVersion

- Method Detail
  - getRegion
```
Region getRegion()
```
    Returns:
    the region associated with this coprocessor
  - getRegionInfo
```
HRegionInfo getRegionInfo()
```
    Returns:
    region information for the region this coprocessor is running on
  - getRegionServerServices
```
RegionServerServices getRegionServerServices()
```
    Returns:
    reference to the region server services
  - getSharedData
```
ConcurrentMap<String,Object> getSharedData()
```
    Returns:
    shared data between all instances of this coprocessor
  - getMetricRegistryForRegionServer
```
MetricRegistry getMetricRegistryForRegionServer()
```
    Returns a MetricRegistry that can be used to track metrics at the region server level. All metrics tracked at this level will be shared by all the coprocessor instances of the same class in the same region server process. Note that there will be one region coprocessor environment per region in the server, but all of these instances will share the same MetricRegistry. The metric instances (like Counter, Timer, etc) will also be shared among all of the region coprocessor instances.
    See ExampleRegionObserverWithMetrics class in the hbase-examples modules to see examples of how metrics can be instantiated and used.
    
    Returns:
    A MetricRegistry for the coprocessor class to track and export metrics.

Interface RegionCoprocessorEnvironment

Method Summary

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

Method Detail

getRegion

getRegionInfo

getRegionServerServices

getSharedData

getMetricRegistryForRegionServer