CoprocessorHost.Environment (Apache HBase 1.2.12 API)

java.lang.Object
- org.apache.hadoop.hbase.coprocessor.CoprocessorHost.Environment

All Implemented Interfaces:

CoprocessorEnvironment

Direct Known Subclasses:

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

Enclosing class:

CoprocessorHost<E extends CoprocessorEnvironment>
```
public static class CoprocessorHost.Environment
extends Object
implements CoprocessorEnvironment
```
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`
`Coprocessor`	`impl` The coprocessor
`protected List<HTableInterface>`	`openTables` Accounting for tables opened by the coprocessor
`protected int`	`priority` Chaining priority
`private int`	`seq`
`(package private) Coprocessor.State`	`state` Current coprocessor state

Constructor Summary

Constructors
Constructor and Description
`CoprocessorHost.Environment(Coprocessor impl, int priority, int seq, org.apache.hadoop.conf.Configuration conf)` Constructor

Method Summary

Methods
Modifier and Type	Method and Description
`ClassLoader`	`getClassLoader()`
`org.apache.hadoop.conf.Configuration`	`getConfiguration()`
`String`	`getHBaseVersion()`
`Coprocessor`	`getInstance()`
`int`	`getLoadSequence()`
`int`	`getPriority()`
`HTableInterface`	`getTable(TableName tableName)` Open a table from within the Coprocessor environment
`HTableInterface`	`getTable(TableName tableName, ExecutorService pool)` Open a table from within the Coprocessor environment
`int`	`getVersion()`
`protected 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
  - impl
```
public Coprocessor impl
```
    The coprocessor
  - priority
```
protected int priority
```
    Chaining priority
  - state
```
Coprocessor.State state
```
    Current coprocessor state
  - openTables
```
protected List<HTableInterface> openTables
```
    Accounting for tables opened by the coprocessor
  - seq
```
private int seq
```
  - conf
```
private org.apache.hadoop.conf.Configuration conf
```
  - classLoader
```
private ClassLoader classLoader
```
- Constructor Detail
  - CoprocessorHost.Environment
```
public CoprocessorHost.Environment(Coprocessor 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
```
protected void shutdown()
```
    Clean up the environment
  - getInstance
```
public Coprocessor getInstance()
```
    Specified by:
    
    getInstance in interface CoprocessorEnvironment
    
    Returns:
    the loaded coprocessor instance
  - getClassLoader
```
public ClassLoader getClassLoader()
```
    Specified by:
    
    getClassLoader in interface CoprocessorEnvironment
    
    Returns:
    the classloader for the loaded coprocessor instance
  - getPriority
```
public int getPriority()
```
    Specified by:
    
    getPriority in interface CoprocessorEnvironment
    
    Returns:
    the priority assigned to the loaded coprocessor
  - getLoadSequence
```
public int getLoadSequence()
```
    Specified by:
    
    getLoadSequence in interface CoprocessorEnvironment
    
    Returns:
    the load sequence number
  - getVersion
```
public int getVersion()
```
    Specified by:
    
    getVersion in interface CoprocessorEnvironment
    
    Returns:
    the coprocessor environment version
  - getHBaseVersion
```
public String getHBaseVersion()
```
    Specified by:
    
    getHBaseVersion in interface CoprocessorEnvironment
    
    Returns:
    the HBase release
  - getConfiguration
```
public org.apache.hadoop.conf.Configuration getConfiguration()
```
    Specified by:
    
    getConfiguration in interface CoprocessorEnvironment
    
    Returns:
    the configuration
  - getTable
```
public HTableInterface getTable(TableName tableName)
                         throws IOException
```
    Open a table from within the Coprocessor environment
    
    Specified by:
    
    getTable in interface CoprocessorEnvironment
    
    Parameters:
    tableName - the table name
    
    Returns:
    an interface for manipulating the table
    
    Throws:
    
    IOException - Exception
  - getTable
```
public HTableInterface getTable(TableName tableName,
                       ExecutorService pool)
                         throws IOException
```
    Open a table from within the Coprocessor environment
    
    Specified by:
    
    getTable in interface CoprocessorEnvironment
    
    Parameters:
    tableName - the table name
    
    Returns:
    an interface for manipulating the table
    
    Throws:
    
    IOException - Exception

Class CoprocessorHost.Environment

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

impl

priority

state

openTables

seq

conf

classLoader

Constructor Detail

CoprocessorHost.Environment

Method Detail

startup

shutdown

getInstance

getClassLoader

getPriority

getLoadSequence

getVersion

getHBaseVersion

getConfiguration

getTable

getTable