org.apache.hadoop.hbase.coprocessor

Class BaseEnvironment<C extends Coprocessor>

java.lang.Object

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

All Implemented Interfaces:

CoprocessorEnvironment<C>

Direct Known Subclasses:

MasterCoprocessorHost.MasterEnvironment, RegionCoprocessorHost.RegionEnvironment, RegionServerCoprocessorHost.RegionServerEnvironment, WALCoprocessorHost.WALEnvironment

@InterfaceAudience.Private
public class BaseEnvironment<C extends Coprocessor>
extends Object
implements CoprocessorEnvironment<C>

Encapsulation of the environment of each coprocessor

Field Summary

Fields

Modifier and Type	Field and Description
private ClassLoader	classLoader
private org.apache.hadoop.conf.Configuration	conf
C	impl The coprocessor
private static org.slf4j.Logger	LOG
protected int	priority Chaining priority
private int	seq
(package private) Coprocessor.State	state Current coprocessor state

Constructor Summary

Constructors

Constructor and Description
BaseEnvironment(C impl, int priority, int seq, org.apache.hadoop.conf.Configuration conf) Constructor

Method Summary

Modifier and Type	Method and Description
ClassLoader	getClassLoader() Returns the classloader for the loaded coprocessor instance
org.apache.hadoop.conf.Configuration	getConfiguration() Returns a Read-only Configuration; throws UnsupportedOperationException if you try to set a configuration.
String	getHBaseVersion() Returns the HBase release
C	getInstance() Returns the loaded coprocessor instance
int	getLoadSequence() Returns the load sequence number
int	getPriority() Returns the priority assigned to the loaded coprocessor
int	getVersion() Returns the coprocessor environment version
void	shutdown() Clean up the environment
void	startup() Initialize the environment

Methods inherited from class java.lang.Object

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

Field Detail

LOG

private static final org.slf4j.Logger LOG

impl

public C extends Coprocessor impl

The coprocessor

priority

protected int priority

Chaining priority

state

Coprocessor.State state

Current coprocessor state

seq

private int seq

conf

private org.apache.hadoop.conf.Configuration conf

classLoader

private ClassLoader classLoader

Constructor Detail

BaseEnvironment

public BaseEnvironment(C impl,
                       int priority,
                       int seq,
                       org.apache.hadoop.conf.Configuration conf)

Constructor

Parameters:

impl - the coprocessor instance

priority - chaining priority

Method Detail

startup

public void startup()
             throws IOException

Initialize the environment

Throws:

IOException

shutdown

public void shutdown()

Clean up the environment

getInstance

public C getInstance()

Description copied from interface: CoprocessorEnvironment

Returns the loaded coprocessor instance

Specified by:

getInstance in interface CoprocessorEnvironment<C extends Coprocessor>

getClassLoader

public ClassLoader getClassLoader()

Description copied from interface: CoprocessorEnvironment

Returns the classloader for the loaded coprocessor instance

Specified by:

getClassLoader in interface CoprocessorEnvironment<C extends Coprocessor>

getPriority

public int getPriority()

Description copied from interface: CoprocessorEnvironment

Returns the priority assigned to the loaded coprocessor

Specified by:

getPriority in interface CoprocessorEnvironment<C extends Coprocessor>

getLoadSequence

public int getLoadSequence()

Description copied from interface: CoprocessorEnvironment

Returns the load sequence number

Specified by:

getLoadSequence in interface CoprocessorEnvironment<C extends Coprocessor>

getVersion

public int getVersion()

Returns the coprocessor environment version

Specified by:

getVersion in interface CoprocessorEnvironment<C extends Coprocessor>

getHBaseVersion

public String getHBaseVersion()

Returns the HBase release

Specified by:

getHBaseVersion in interface CoprocessorEnvironment<C extends Coprocessor>

getConfiguration

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

Description copied from interface: CoprocessorEnvironment

Returns a Read-only Configuration; throws UnsupportedOperationException if you try to set a configuration.

Specified by:

getConfiguration in interface CoprocessorEnvironment<C extends Coprocessor>