Package org.apache.hadoop.hbase.regionserver.wal

Class WALCoprocessorHost.WALEnvironment

java.lang.Object

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

org.apache.hadoop.hbase.regionserver.wal.WALCoprocessorHost.WALEnvironment

All Implemented Interfaces:

WALCoprocessorEnvironment, CoprocessorEnvironment<WALCoprocessor>

Enclosing class:

WALCoprocessorHost

static class WALCoprocessorHost.WALEnvironment
extends BaseEnvironment<WALCoprocessor>
implements WALCoprocessorEnvironment

Encapsulation of the environment of each coprocessor

Field Summary

Fields

Modifier and Type	Field	Description
private final MetricRegistry	metricRegistry
private final WAL	wal

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

impl, priority

Constructor Summary

Constructors

Modifier	Constructor	Description
private	WALEnvironment(WALCoprocessor impl, int priority, int seq, org.apache.hadoop.conf.Configuration conf, WAL wal)	Constructor

Method Summary

Modifier and Type	Method	Description
MetricRegistry	getMetricRegistryForRegionServer()	Returns a MetricRegistry that can be used to track metrics at the region server level.
WAL	getWAL()	Returns reference to the region server's WAL
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 Details

wal

private final WAL wal

metricRegistry

private final MetricRegistry metricRegistry

Constructor Details

WALEnvironment

private WALEnvironment(WALCoprocessor impl,
 int priority,
 int seq,
 org.apache.hadoop.conf.Configuration conf,
 WAL wal)

Constructor

Parameters:

impl - the coprocessor instance

priority - chaining priority

seq - load sequence

conf - configuration

wal - WAL

Method Details

getWAL

public WAL getWAL()

Description copied from interface: WALCoprocessorEnvironment

Returns reference to the region server's WAL

Specified by:

getWAL in interface WALCoprocessorEnvironment

getMetricRegistryForRegionServer

public MetricRegistry getMetricRegistryForRegionServer()

Description copied from interface: WALCoprocessorEnvironment

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

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

Specified by:

getMetricRegistryForRegionServer in interface WALCoprocessorEnvironment

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<WALCoprocessor>