WALCoprocessorHost (Apache HBase 1.4.11 API)

java.lang.Object
- org.apache.hadoop.hbase.coprocessor.CoprocessorHost<org.apache.hadoop.hbase.regionserver.wal.WALCoprocessorHost.WALEnvironment>
- - org.apache.hadoop.hbase.regionserver.wal.WALCoprocessorHost

@InterfaceAudience.Private
public class WALCoprocessorHost
extends CoprocessorHost<org.apache.hadoop.hbase.regionserver.wal.WALCoprocessorHost.WALEnvironment>

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

Nested Class Summary
- Nested classes/interfaces inherited from class org.apache.hadoop.hbase.coprocessor.CoprocessorHost
  CoprocessorHost.Environment

Field Summary
- Fields inherited from class org.apache.hadoop.hbase.coprocessor.CoprocessorHost
  ABORT_ON_ERROR_KEY, abortable, conf, coprocessors, 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

Constructors
Constructor and Description
`WALCoprocessorHost(WAL log, org.apache.hadoop.conf.Configuration conf)` Constructor

Method Summary

Methods
Modifier and Type	Method and Description
`org.apache.hadoop.hbase.regionserver.wal.WALCoprocessorHost.WALEnvironment`	`createEnvironment(Class<?> implClass, Coprocessor 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(HRegionInfo 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
`boolean`	`preWALWrite(HRegionInfo info, WALKey logKey, WALEdit logEdit)`

Methods inherited from class org.apache.hadoop.hbase.coprocessor.CoprocessorHost
abortServer, abortServer, findCoprocessor, findCoprocessorEnvironment, findCoprocessors, getCoprocessors, getLoadedCoprocessors, handleCoprocessorThrowable, legacyWarning, load, load, load, loadInstance, loadSystemCoprocessors, shutdown, useLegacyMethod

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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 org.apache.hadoop.hbase.regionserver.wal.WALCoprocessorHost.WALEnvironment createEnvironment(Class<?> implClass,
                                                                                           Coprocessor 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<org.apache.hadoop.hbase.regionserver.wal.WALCoprocessorHost.WALEnvironment>

preWALWrite

public boolean preWALWrite(HRegionInfo info,
                  WALKey logKey,
                  WALEdit logEdit)
                    throws IOException

Parameters:: info -; logKey -; logEdit -
Returns:: true if default behavior should be bypassed, false otherwise
Throws:: IOException

postWALWrite

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

Parameters:: info -; logKey -; logEdit -
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

Class WALCoprocessorHost

Nested Class Summary

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

Field Summary

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

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Constructor Detail

WALCoprocessorHost

Method Detail

createEnvironment

preWALWrite

postWALWrite

preWALRoll

postWALRoll