org.apache.hadoop.hbase.regionserver.wal

Class WALCoprocessorHost

java.lang.Object

org.apache.hadoop.hbase.coprocessor.CoprocessorHost<WALCoprocessor,WALCoprocessorEnvironment>

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

@InterfaceAudience.Private
public class WALCoprocessorHost
extends CoprocessorHost<WALCoprocessor,WALCoprocessorEnvironment>

Implements the coprocessor environment and runtime support for coprocessors loaded within a WAL.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
(package private) static class	WALCoprocessorHost.WALEnvironment Encapsulation of the environment of each coprocessor
(package private) class	WALCoprocessorHost.WALObserverOperation

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 WAL	wal
private CoprocessorHost.ObserverGetter<WALCoprocessor,WALObserver>	walObserverGetter

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
WALCoprocessorHost(WAL log, org.apache.hadoop.conf.Configuration conf) Constructor

Method Summary

Modifier and Type	Method and Description
WALCoprocessor	checkAndGetInstance(Class<?> implClass) Called when a new Coprocessor class needs to be loaded.
WALCoprocessorHost.WALEnvironment	createEnvironment(WALCoprocessor instance, int priority, int seq, org.apache.hadoop.conf.Configuration conf) Called when a new Coprocessor class is loaded
void	postWALRoll(org.apache.hadoop.fs.Path oldPath, org.apache.hadoop.fs.Path newPath) Called after rolling the current WAL
void	postWALWrite(RegionInfo info, WALKey logKey, WALEdit logEdit)
void	preWALRoll(org.apache.hadoop.fs.Path oldPath, org.apache.hadoop.fs.Path newPath) Called before rolling the current WAL
void	preWALWrite(RegionInfo info, WALKey logKey, WALEdit logEdit)

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

wal

private final WAL wal

walObserverGetter

private CoprocessorHost.ObserverGetter<WALCoprocessor,WALObserver> walObserverGetter

Constructor Detail

WALCoprocessorHost

public WALCoprocessorHost(WAL log,
                          org.apache.hadoop.conf.Configuration conf)

Constructor

Parameters:

log - the write ahead log

conf - the configuration

Method Detail

createEnvironment

public WALCoprocessorHost.WALEnvironment createEnvironment(WALCoprocessor instance,
                                                           int priority,
                                                           int seq,
                                                           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<WALCoprocessor,WALCoprocessorEnvironment>

checkAndGetInstance

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

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

Throws:

IllegalAccessException

InstantiationException

preWALWrite

public void preWALWrite(RegionInfo info,
                        WALKey logKey,
                        WALEdit logEdit)
                 throws IOException

Throws:

IOException

postWALWrite

public void postWALWrite(RegionInfo info,
                         WALKey logKey,
                         WALEdit logEdit)
                  throws IOException

Throws:

IOException

preWALRoll

public void preWALRoll(org.apache.hadoop.fs.Path oldPath,
                       org.apache.hadoop.fs.Path newPath)
                throws IOException

Called before rolling the current WAL

Parameters:

oldPath - the path of the current wal that we are replacing

newPath - the path of the wal we are going to create

Throws:

IOException

postWALRoll

public void postWALRoll(org.apache.hadoop.fs.Path oldPath,
                        org.apache.hadoop.fs.Path newPath)
                 throws IOException

Called after rolling the current WAL

Parameters:

oldPath - the path of the wal that we replaced

newPath - the path of the wal we have created and now is the current

Throws:

IOException