org.apache.hadoop.hbase.regionserver

Class RegionServerCoprocessorHost

java.lang.Object

org.apache.hadoop.hbase.coprocessor.CoprocessorHost<RegionServerCoprocessor,RegionServerCoprocessorEnvironment>

org.apache.hadoop.hbase.regionserver.RegionServerCoprocessorHost

@InterfaceAudience.Private
public class RegionServerCoprocessorHost
extends CoprocessorHost<RegionServerCoprocessor,RegionServerCoprocessorEnvironment>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	RegionServerCoprocessorHost.RegionServerEnvironment Coprocessor environment extension providing access to region server related services.
private static class	RegionServerCoprocessorHost.RegionServerEnvironmentForCoreCoprocessors Special version of RegionServerEnvironment that exposes RegionServerServices for Core Coprocessors only.
(package private) class	RegionServerCoprocessorHost.RegionServerObserverOperation

Nested classes/interfaces inherited from class org.apache.hadoop.hbase.coprocessor.CoprocessorHost

CoprocessorHost.ObserverGetter<C,O>, CoprocessorHost.ObserverOperationWithoutResult<O>, CoprocessorHost.ObserverOperationWithResult<O,R>

Field Summary

Fields

Modifier and Type	Field and Description
private static org.slf4j.Logger	LOG
private CoprocessorHost.ObserverGetter<RegionServerCoprocessor,RegionServerObserver>	rsObserverGetter
private RegionServerServices	rsServices

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

ABORT_ON_ERROR_KEY, abortable, conf, coprocEnvironments, COPROCESSORS_ENABLED_CONF_KEY, DEFAULT_ABORT_ON_ERROR, DEFAULT_COPROCESSORS_ENABLED, DEFAULT_USER_COPROCESSORS_ENABLED, loadSequence, MASTER_COPROCESSOR_CONF_KEY, pathPrefix, REGION_COPROCESSOR_CONF_KEY, REGIONSERVER_COPROCESSOR_CONF_KEY, USER_COPROCESSORS_ENABLED_CONF_KEY, USER_REGION_COPROCESSOR_CONF_KEY, WAL_COPROCESSOR_CONF_KEY

Constructor Summary

Constructors

Constructor and Description
RegionServerCoprocessorHost(RegionServerServices rsServices, org.apache.hadoop.conf.Configuration conf)

Method Summary

Modifier and Type	Method and Description
RegionServerCoprocessor	checkAndGetInstance(Class<?> implClass) Called when a new Coprocessor class needs to be loaded.
RegionServerCoprocessorHost.RegionServerEnvironment	createEnvironment(RegionServerCoprocessor instance, int priority, int sequence, org.apache.hadoop.conf.Configuration conf) Called when a new Coprocessor class is loaded
void	postClearCompactionQueues()
ReplicationEndpoint	postCreateReplicationEndPoint(ReplicationEndpoint endpoint)
void	postReplicateLogEntries()
void	postRollWALWriterRequest()
void	preClearCompactionQueues()
void	preReplicateLogEntries()
void	preRollWALWriterRequest()
void	preStop(String message, User user)

Methods inherited from class org.apache.hadoop.hbase.coprocessor.CoprocessorHost

abortServer, abortServer, checkAndLoadInstance, execOperation, execOperationWithResult, execShutdown, findCoprocessor, findCoprocessor, findCoprocessorEnvironment, findCoprocessors, getCoprocessors, getLoadedCoprocessors, handleCoprocessorThrowable, load, load, load, loadSystemCoprocessors, shutdown

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

rsServices

private RegionServerServices rsServices

rsObserverGetter

private CoprocessorHost.ObserverGetter<RegionServerCoprocessor,RegionServerObserver> rsObserverGetter

Constructor Detail

RegionServerCoprocessorHost

public RegionServerCoprocessorHost(RegionServerServices rsServices,
                                   org.apache.hadoop.conf.Configuration conf)

Method Detail

createEnvironment

public RegionServerCoprocessorHost.RegionServerEnvironment createEnvironment(RegionServerCoprocessor instance,
                                                                             int priority,
                                                                             int sequence,
                                                                             org.apache.hadoop.conf.Configuration conf)

Description copied from class: CoprocessorHost

Called when a new Coprocessor class is loaded

Specified by:

createEnvironment in class CoprocessorHost<RegionServerCoprocessor,RegionServerCoprocessorEnvironment>

checkAndGetInstance

public RegionServerCoprocessor checkAndGetInstance(Class<?> implClass)
                                            throws InstantiationException,
                                                   IllegalAccessException

Description copied from class: CoprocessorHost

Called when a new Coprocessor class needs to be loaded. Checks if type of the given class is what the corresponding host implementation expects. If it is of correct type, returns an instance of the coprocessor to be loaded. If not, returns null. If an exception occurs when trying to create instance of a coprocessor, it's passed up and eventually results into server aborting.

Specified by:

checkAndGetInstance in class CoprocessorHost<RegionServerCoprocessor,RegionServerCoprocessorEnvironment>

Throws:

InstantiationException

IllegalAccessException

preStop

public void preStop(String message,
                    User user)
             throws IOException

Throws:

IOException

preRollWALWriterRequest

public void preRollWALWriterRequest()
                             throws IOException

Throws:

IOException

postRollWALWriterRequest

public void postRollWALWriterRequest()
                              throws IOException

Throws:

IOException

preReplicateLogEntries

public void preReplicateLogEntries()
                            throws IOException

Throws:

IOException

postReplicateLogEntries

public void postReplicateLogEntries()
                             throws IOException

Throws:

IOException

postCreateReplicationEndPoint

public ReplicationEndpoint postCreateReplicationEndPoint(ReplicationEndpoint endpoint)
                                                  throws IOException

Throws:

IOException

preClearCompactionQueues

public void preClearCompactionQueues()
                              throws IOException

Throws:

IOException

postClearCompactionQueues

public void postClearCompactionQueues()
                               throws IOException

Throws:

IOException