org.apache.hadoop.hbase

Interface CoprocessorEnvironment<C extends Coprocessor>

@InterfaceAudience.Private
public interface CoprocessorEnvironment<C extends Coprocessor>

Coprocessor environment state.

Method Summary

Modifier and Type	Method and Description
ClassLoader	getClassLoader()
org.apache.hadoop.conf.Configuration	getConfiguration()
String	getHBaseVersion()
C	getInstance()
int	getLoadSequence()
int	getPriority()
int	getVersion()
void	shutdown() Clean up the environment.
void	startup() After a coprocessor has been loaded in an encapsulation of an environment, CoprocessorHost calls this function to initialize the environment.

Method Detail

getVersion

int getVersion()

Returns:

the Coprocessor interface version

getHBaseVersion

String getHBaseVersion()

Returns:

the HBase version as a string (e.g. "0.21.0")

getInstance

C getInstance()

Returns:

the loaded coprocessor instance

getPriority

int getPriority()

Returns:

the priority assigned to the loaded coprocessor

getLoadSequence

int getLoadSequence()

Returns:

the load sequence number

getConfiguration

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

Returns:

the configuration

getClassLoader

ClassLoader getClassLoader()

Returns:

the classloader for the loaded coprocessor instance

startup

void startup()
      throws IOException

After a coprocessor has been loaded in an encapsulation of an environment, CoprocessorHost calls this function to initialize the environment.

Throws:

IOException

shutdown

void shutdown()

Clean up the environment. Called by CoprocessorHost when it itself is shutting down.