org.apache.hadoop.hbase.regionserver

Class RegionCoprocessorHost

java.lang.Object

org.apache.hadoop.hbase.coprocessor.CoprocessorHost<RegionCoprocessor,RegionCoprocessorEnvironment>

org.apache.hadoop.hbase.regionserver.RegionCoprocessorHost

@InterfaceAudience.Private
public class RegionCoprocessorHost
extends CoprocessorHost<RegionCoprocessor,RegionCoprocessorEnvironment>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
(package private) class	RegionCoprocessorHost.BulkLoadObserverOperation
private static class	RegionCoprocessorHost.RegionEnvironment Encapsulation of the environment of each coprocessor
private static class	RegionCoprocessorHost.RegionEnvironmentForCoreCoprocessors Special version of RegionEnvironment that exposes RegionServerServices for Core Coprocessors only.
(package private) class	RegionCoprocessorHost.RegionObserverOperationWithoutResult
(package private) static class	RegionCoprocessorHost.TableCoprocessorAttribute

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 CoprocessorHost.ObserverGetter<RegionCoprocessor,EndpointObserver>	endpointObserverGetter
private boolean	hasCustomPostScannerFilterRow
private static org.slf4j.Logger	LOG
(package private) HRegion	region The region
private CoprocessorHost.ObserverGetter<RegionCoprocessor,RegionObserver>	regionObserverGetter
(package private) RegionServerServices	rsServices The region server services
private static org.apache.hbase.thirdparty.org.apache.commons.collections4.map.ReferenceMap<String,ConcurrentMap<String,Object>>	SHARED_DATA_MAP

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_SKIP_LOAD_DUPLICATE_TABLE_COPROCESSOR, DEFAULT_USER_COPROCESSORS_ENABLED, loadSequence, MASTER_COPROCESSOR_CONF_KEY, pathPrefix, REGION_COPROCESSOR_CONF_KEY, REGIONSERVER_COPROCESSOR_CONF_KEY, SKIP_LOAD_DUPLICATE_TABLE_COPROCESSOR, USER_COPROCESSORS_ENABLED_CONF_KEY, USER_REGION_COPROCESSOR_CONF_KEY, WAL_COPROCESSOR_CONF_KEY

Constructor Summary

Constructors

Constructor and Description
RegionCoprocessorHost(HRegion region, RegionServerServices rsServices, org.apache.hadoop.conf.Configuration conf) Constructor

Method Summary

Modifier and Type	Method and Description
RegionCoprocessor	checkAndGetInstance(Class<?> implClass) Called when a new Coprocessor class needs to be loaded.
RegionCoprocessorHost.RegionEnvironment	createEnvironment(RegionCoprocessor instance, int priority, int seq, org.apache.hadoop.conf.Configuration conf) Called when a new Coprocessor class is loaded
(package private) static List<RegionCoprocessorHost.TableCoprocessorAttribute>	getTableCoprocessorAttrsFromSchema(org.apache.hadoop.conf.Configuration conf, TableDescriptor htd)
(package private) void	loadTableCoprocessors(org.apache.hadoop.conf.Configuration conf)
Result	postAppend(Append append, Result result)
List<Pair<Cell,Cell>>	postAppendBeforeWAL(Mutation mutation, List<Pair<Cell,Cell>> cellPairs)
void	postBatchMutate(MiniBatchOperationInProgress<Mutation> miniBatchOp)
void	postBatchMutateIndispensably(MiniBatchOperationInProgress<Mutation> miniBatchOp, boolean success)
void	postBulkLoadHFile(List<Pair<byte[],String>> familyPaths, Map<byte[],List<org.apache.hadoop.fs.Path>> map)
boolean	postCheckAndDelete(byte[] row, byte[] family, byte[] qualifier, CompareOperator op, ByteArrayComparable comparator, Delete delete, boolean result)
boolean	postCheckAndDelete(byte[] row, Filter filter, Delete delete, boolean result)
boolean	postCheckAndPut(byte[] row, byte[] family, byte[] qualifier, CompareOperator op, ByteArrayComparable comparator, Put put, boolean result)
boolean	postCheckAndPut(byte[] row, Filter filter, Put put, boolean result)
void	postClose(boolean abortRequested) Invoked after a region is closed
void	postCloseRegionOperation(Region.Operation op)
void	postCommitStoreFile(byte[] family, org.apache.hadoop.fs.Path srcPath, org.apache.hadoop.fs.Path dstPath)
void	postCompact(HStore store, HStoreFile resultFile, CompactionLifeCycleTracker tracker, CompactionRequest request, User user) Called after the store compaction has completed.
void	postCompactSelection(HStore store, List<HStoreFile> selected, CompactionLifeCycleTracker tracker, CompactionRequest request, User user) Called after the HStoreFiles to be compacted have been selected from the available candidates.
void	postDelete(Delete delete, WALEdit edit, Durability durability)
void	postEndpointInvocation(com.google.protobuf.Service service, String methodName, com.google.protobuf.Message request, com.google.protobuf.Message.Builder responseBuilder)
boolean	postExists(Get get, boolean result)
void	postFlush(FlushLifeCycleTracker tracker) Invoked after a memstore flush
void	postFlush(HStore store, HStoreFile storeFile, FlushLifeCycleTracker tracker) Invoked after a memstore flush
void	postGet(Get get, List<Cell> results)
Result	postIncrement(Increment increment, Result result)
List<Pair<Cell,Cell>>	postIncrementBeforeWAL(Mutation mutation, List<Pair<Cell,Cell>> cellPairs)
DeleteTracker	postInstantiateDeleteTracker(DeleteTracker result) Deprecated. Since 2.0 with out any replacement and will be removed in 3.0
void	postMemStoreCompaction(HStore store) Invoked after in memory compaction.
void	postOpen() Invoked after a region open
void	postPut(Put put, WALEdit edit, Durability durability)
void	postReplayWALs(RegionInfo info, org.apache.hadoop.fs.Path edits)
void	postScannerClose(InternalScanner s)
boolean	postScannerFilterRow(InternalScanner s, Cell curRowCell) This will be called by the scan flow when the current scanned row is being filtered out by the filter.
boolean	postScannerNext(InternalScanner s, List<Result> results, int limit, boolean hasMore)
RegionScanner	postScannerOpen(Scan scan, RegionScanner s)
void	postStartRegionOperation(Region.Operation op)
StoreFileReader	postStoreFileReaderOpen(org.apache.hadoop.fs.FileSystem fs, org.apache.hadoop.fs.Path p, FSDataInputStreamWrapper in, long size, CacheConfig cacheConf, Reference r, StoreFileReader reader)
void	postWALRestore(RegionInfo info, WALKey logKey, WALEdit logEdit) Deprecated. Since hbase-2.0.0. No replacement. To be removed in hbase-3.0.0 and replaced with something that doesn't expose IntefaceAudience.Private classes.
Result	preAppend(Append append) Supports Coprocessor 'bypass'.
Result	preAppendAfterRowLock(Append append) Supports Coprocessor 'bypass'.
void	preBatchMutate(MiniBatchOperationInProgress<Mutation> miniBatchOp)
void	preBulkLoadHFile(List<Pair<byte[],String>> familyPaths)
Boolean	preCheckAndDelete(byte[] row, byte[] family, byte[] qualifier, CompareOperator op, ByteArrayComparable comparator, Delete delete) Supports Coprocessor 'bypass'.
Boolean	preCheckAndDelete(byte[] row, Filter filter, Delete delete) Supports Coprocessor 'bypass'.
Boolean	preCheckAndDeleteAfterRowLock(byte[] row, byte[] family, byte[] qualifier, CompareOperator op, ByteArrayComparable comparator, Delete delete) Supports Coprocessor 'bypass'.
Boolean	preCheckAndDeleteAfterRowLock(byte[] row, Filter filter, Delete delete) Supports Coprocessor 'bypass'.
Boolean	preCheckAndPut(byte[] row, byte[] family, byte[] qualifier, CompareOperator op, ByteArrayComparable comparator, Put put) Supports Coprocessor 'bypass'.
Boolean	preCheckAndPut(byte[] row, Filter filter, Put put) Supports Coprocessor 'bypass'.
Boolean	preCheckAndPutAfterRowLock(byte[] row, byte[] family, byte[] qualifier, CompareOperator op, ByteArrayComparable comparator, Put put) Supports Coprocessor 'bypass'.
Boolean	preCheckAndPutAfterRowLock(byte[] row, Filter filter, Put put) Supports Coprocessor 'bypass'.
void	preCleanupBulkLoad(User user)
void	preClose(boolean abortRequested) Invoked before a region is closed
boolean	preCommitStoreFile(byte[] family, List<Pair<org.apache.hadoop.fs.Path,org.apache.hadoop.fs.Path>> pairs)
InternalScanner	preCompact(HStore store, InternalScanner scanner, ScanType scanType, CompactionLifeCycleTracker tracker, CompactionRequest request, User user) Called prior to rewriting the store files selected for compaction
ScanInfo	preCompactScannerOpen(HStore store, ScanType scanType, CompactionLifeCycleTracker tracker, CompactionRequest request, User user) Called prior to opening store scanner for compaction.
boolean	preCompactSelection(HStore store, List<HStoreFile> candidates, CompactionLifeCycleTracker tracker, User user) Called prior to selecting the HStoreFiles for compaction from the list of currently available candidates.
boolean	preDelete(Delete delete, WALEdit edit, Durability durability) Supports Coprocessor 'bypass'.
com.google.protobuf.Message	preEndpointInvocation(com.google.protobuf.Service service, String methodName, com.google.protobuf.Message request)
Boolean	preExists(Get get) Supports Coprocessor 'bypass'.
void	preFlush(FlushLifeCycleTracker tracker) Invoked before a memstore flush
InternalScanner	preFlush(HStore store, InternalScanner scanner, FlushLifeCycleTracker tracker) Invoked before a memstore flush
ScanInfo	preFlushScannerOpen(HStore store, FlushLifeCycleTracker tracker) Invoked before create StoreScanner for flush.
boolean	preGet(Get get, List<Cell> results) Supports Coprocessor 'bypass'.
Result	preIncrement(Increment increment) Supports Coprocessor 'bypass'.
Result	preIncrementAfterRowLock(Increment increment) Supports Coprocessor 'bypass'.
void	preMemStoreCompaction(HStore store) Invoked before in memory compaction.
InternalScanner	preMemStoreCompactionCompact(HStore store, InternalScanner scanner) Invoked before compacting memstore.
ScanInfo	preMemStoreCompactionCompactScannerOpen(HStore store) Invoked before create StoreScanner for in memory compaction.
void	preOpen() Invoked before a region open.
void	prePrepareBulkLoad(User user)
boolean	prePrepareTimeStampForDeleteVersion(Mutation mutation, Cell kv, byte[] byteNow, Get get) Deprecated. In hbase-2.0.0. Will be removed in hbase-3.0.0. Added explicitly for a single Coprocessor for its needs only. Will be removed.
boolean	prePut(Put put, WALEdit edit, Durability durability) Supports Coprocessor 'bypass'.
void	preReplayWALs(RegionInfo info, org.apache.hadoop.fs.Path edits)
boolean	preScannerClose(InternalScanner s) Supports Coprocessor 'bypass'.
Boolean	preScannerNext(InternalScanner s, List<Result> results, int limit)
void	preScannerOpen(Scan scan)
StoreFileReader	preStoreFileReaderOpen(org.apache.hadoop.fs.FileSystem fs, org.apache.hadoop.fs.Path p, FSDataInputStreamWrapper in, long size, CacheConfig cacheConf, Reference r)
ScanInfo	preStoreScannerOpen(HStore store, Scan scan) Called before open store scanner for user scan.
void	preWALAppend(WALKey key, WALEdit edit)
boolean	preWALRestore(RegionInfo info, WALKey logKey, WALEdit logEdit) Deprecated. Since hbase-2.0.0. No replacement. To be removed in hbase-3.0.0 and replaced with something that doesn't expose IntefaceAudience.Private classes.
static void	testTableCoprocessorAttrs(org.apache.hadoop.conf.Configuration conf, TableDescriptor htd) Sanity check the table coprocessor attributes of the supplied schema.

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

SHARED_DATA_MAP

private static final org.apache.hbase.thirdparty.org.apache.commons.collections4.map.ReferenceMap<String,ConcurrentMap<String,Object>> SHARED_DATA_MAP

hasCustomPostScannerFilterRow

private final boolean hasCustomPostScannerFilterRow

rsServices

RegionServerServices rsServices

The region server services

region

HRegion region

The region

regionObserverGetter

private CoprocessorHost.ObserverGetter<RegionCoprocessor,RegionObserver> regionObserverGetter

endpointObserverGetter

private CoprocessorHost.ObserverGetter<RegionCoprocessor,EndpointObserver> endpointObserverGetter

Constructor Detail

RegionCoprocessorHost

public RegionCoprocessorHost(HRegion region,
                             RegionServerServices rsServices,
                             org.apache.hadoop.conf.Configuration conf)

Constructor

Parameters:

region - the region

rsServices - interface to available region server functionality

conf - the configuration

Method Detail

getTableCoprocessorAttrsFromSchema

static List<RegionCoprocessorHost.TableCoprocessorAttribute> getTableCoprocessorAttrsFromSchema(org.apache.hadoop.conf.Configuration conf,
                                                                                                TableDescriptor htd)

testTableCoprocessorAttrs

public static void testTableCoprocessorAttrs(org.apache.hadoop.conf.Configuration conf,
                                             TableDescriptor htd)
                                      throws IOException

Sanity check the table coprocessor attributes of the supplied schema. Will throw an exception if there is a problem.

Parameters:

conf -

htd -

Throws:

IOException

loadTableCoprocessors

void loadTableCoprocessors(org.apache.hadoop.conf.Configuration conf)

createEnvironment

public RegionCoprocessorHost.RegionEnvironment createEnvironment(RegionCoprocessor 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<RegionCoprocessor,RegionCoprocessorEnvironment>

checkAndGetInstance

public RegionCoprocessor 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<RegionCoprocessor,RegionCoprocessorEnvironment>

Throws:

InstantiationException

IllegalAccessException

preOpen

public void preOpen()
             throws IOException

Invoked before a region open.

Throws:

IOException - Signals that an I/O exception has occurred.

postOpen

public void postOpen()

Invoked after a region open

preClose

public void preClose(boolean abortRequested)
              throws IOException

Invoked before a region is closed

Parameters:

abortRequested - true if the server is aborting

Throws:

IOException

postClose

public void postClose(boolean abortRequested)

Invoked after a region is closed

Parameters:

abortRequested - true if the server is aborting

preCompactSelection

public boolean preCompactSelection(HStore store,
                                   List<HStoreFile> candidates,
                                   CompactionLifeCycleTracker tracker,
                                   User user)
                            throws IOException

Called prior to selecting the HStoreFiles for compaction from the list of currently available candidates.

Supports Coprocessor 'bypass' -- 'bypass' is how this method indicates that it changed the passed in candidates.

Parameters:

store - The store where compaction is being requested

candidates - The currently available store files

tracker - used to track the life cycle of a compaction

user - the user

Throws:

IOException

postCompactSelection

public void postCompactSelection(HStore store,
                                 List<HStoreFile> selected,
                                 CompactionLifeCycleTracker tracker,
                                 CompactionRequest request,
                                 User user)
                          throws IOException

Called after the HStoreFiles to be compacted have been selected from the available candidates.

Parameters:

store - The store where compaction is being requested

selected - The store files selected to compact

tracker - used to track the life cycle of a compaction

request - the compaction request

user - the user

Throws:

IOException

preCompactScannerOpen

public ScanInfo preCompactScannerOpen(HStore store,
                                      ScanType scanType,
                                      CompactionLifeCycleTracker tracker,
                                      CompactionRequest request,
                                      User user)
                               throws IOException

Called prior to opening store scanner for compaction.

Throws:

IOException

preCompact

public InternalScanner preCompact(HStore store,
                                  InternalScanner scanner,
                                  ScanType scanType,
                                  CompactionLifeCycleTracker tracker,
                                  CompactionRequest request,
                                  User user)
                           throws IOException

Called prior to rewriting the store files selected for compaction

Parameters:

store - the store being compacted

scanner - the scanner used to read store data during compaction

scanType - type of Scan

tracker - used to track the life cycle of a compaction

request - the compaction request

user - the user

Returns:

Scanner to use (cannot be null!)

Throws:

IOException

postCompact

public void postCompact(HStore store,
                        HStoreFile resultFile,
                        CompactionLifeCycleTracker tracker,
                        CompactionRequest request,
                        User user)
                 throws IOException

Called after the store compaction has completed.

Parameters:

store - the store being compacted

resultFile - the new store file written during compaction

tracker - used to track the life cycle of a compaction

request - the compaction request

user - the user

Throws:

IOException

preFlushScannerOpen

public ScanInfo preFlushScannerOpen(HStore store,
                                    FlushLifeCycleTracker tracker)
                             throws IOException

Invoked before create StoreScanner for flush.

Throws:

IOException

preFlush

public InternalScanner preFlush(HStore store,
                                InternalScanner scanner,
                                FlushLifeCycleTracker tracker)
                         throws IOException

Invoked before a memstore flush

Returns:

Scanner to use (cannot be null!)

Throws:

IOException

preFlush

public void preFlush(FlushLifeCycleTracker tracker)
              throws IOException

Invoked before a memstore flush

Throws:

IOException

postFlush

public void postFlush(FlushLifeCycleTracker tracker)
               throws IOException

Invoked after a memstore flush

Throws:

IOException

preMemStoreCompaction

public void preMemStoreCompaction(HStore store)
                           throws IOException

Invoked before in memory compaction.

Throws:

IOException

preMemStoreCompactionCompactScannerOpen

public ScanInfo preMemStoreCompactionCompactScannerOpen(HStore store)
                                                 throws IOException

Invoked before create StoreScanner for in memory compaction.

Throws:

IOException

preMemStoreCompactionCompact

public InternalScanner preMemStoreCompactionCompact(HStore store,
                                                    InternalScanner scanner)
                                             throws IOException

Invoked before compacting memstore.

Throws:

IOException

postMemStoreCompaction

public void postMemStoreCompaction(HStore store)
                            throws IOException

Invoked after in memory compaction.

Throws:

IOException

postFlush

public void postFlush(HStore store,
                      HStoreFile storeFile,
                      FlushLifeCycleTracker tracker)
               throws IOException

Invoked after a memstore flush

Throws:

IOException

preGet

public boolean preGet(Get get,
                      List<Cell> results)
               throws IOException

Supports Coprocessor 'bypass'.

Parameters:

get - the Get request

results - What to return if return is true/'bypass'.

Returns:

true if default processing should be bypassed.

Throws:

IOException - Exception

postGet

public void postGet(Get get,
                    List<Cell> results)
             throws IOException

Parameters:

get - the Get request

results - the result set

Throws:

IOException - Exception

preExists

public Boolean preExists(Get get)
                  throws IOException

Supports Coprocessor 'bypass'.

Parameters:

get - the Get request

Returns:

true or false to return to client if bypassing normal operation, or null otherwise

Throws:

IOException - Exception

postExists

public boolean postExists(Get get,
                          boolean result)
                   throws IOException

Parameters:

get - the Get request

result - the result returned by the region server

Returns:

the result to return to the client

Throws:

IOException - Exception

prePut

public boolean prePut(Put put,
                      WALEdit edit,
                      Durability durability)
               throws IOException

Supports Coprocessor 'bypass'.

Parameters:

put - The Put object

edit - The WALEdit object.

durability - The durability used

Returns:

true if default processing should be bypassed

Throws:

IOException - Exception

prePrepareTimeStampForDeleteVersion

@Deprecated
public boolean prePrepareTimeStampForDeleteVersion(Mutation mutation,
                                                               Cell kv,
                                                               byte[] byteNow,
                                                               Get get)
                                                        throws IOException

Deprecated. In hbase-2.0.0. Will be removed in hbase-3.0.0. Added explicitly for a single Coprocessor for its needs only. Will be removed.

Supports Coprocessor 'bypass'.

Parameters:

mutation - - the current mutation

kv - - the current cell

byteNow - - current timestamp in bytes

get - - the get that could be used Note that the get only does not specify the family and qualifier that should be used

Returns:

true if default processing should be bypassed

Throws:

IOException

postPut

public void postPut(Put put,
                    WALEdit edit,
                    Durability durability)
             throws IOException

Parameters:

put - The Put object

edit - The WALEdit object.

durability - The durability used

Throws:

IOException - Exception

preDelete

public boolean preDelete(Delete delete,
                         WALEdit edit,
                         Durability durability)
                  throws IOException

Supports Coprocessor 'bypass'.

Parameters:

delete - The Delete object

edit - The WALEdit object.

durability - The durability used

Returns:

true if default processing should be bypassed

Throws:

IOException - Exception

postDelete

public void postDelete(Delete delete,
                       WALEdit edit,
                       Durability durability)
                throws IOException

Parameters:

delete - The Delete object

edit - The WALEdit object.

durability - The durability used

Throws:

IOException - Exception

preBatchMutate

public void preBatchMutate(MiniBatchOperationInProgress<Mutation> miniBatchOp)
                    throws IOException

Throws:

IOException

postBatchMutate

public void postBatchMutate(MiniBatchOperationInProgress<Mutation> miniBatchOp)
                     throws IOException

Throws:

IOException

postBatchMutateIndispensably

public void postBatchMutateIndispensably(MiniBatchOperationInProgress<Mutation> miniBatchOp,
                                         boolean success)
                                  throws IOException

Throws:

IOException

preCheckAndPut

public Boolean preCheckAndPut(byte[] row,
                              byte[] family,
                              byte[] qualifier,
                              CompareOperator op,
                              ByteArrayComparable comparator,
                              Put put)
                       throws IOException

Supports Coprocessor 'bypass'.

Parameters:

row - row to check

family - column family

qualifier - column qualifier

op - the comparison operation

comparator - the comparator

put - data to put if check succeeds

Returns:

true or false to return to client if default processing should be bypassed, or null otherwise

Throws:

IOException

preCheckAndPut

public Boolean preCheckAndPut(byte[] row,
                              Filter filter,
                              Put put)
                       throws IOException

Supports Coprocessor 'bypass'.

Parameters:

row - row to check

filter - filter

put - data to put if check succeeds

Returns:

true or false to return to client if default processing should be bypassed, or null otherwise

Throws:

IOException

preCheckAndPutAfterRowLock

public Boolean preCheckAndPutAfterRowLock(byte[] row,
                                          byte[] family,
                                          byte[] qualifier,
                                          CompareOperator op,
                                          ByteArrayComparable comparator,
                                          Put put)
                                   throws IOException

Supports Coprocessor 'bypass'.

Parameters:

row - row to check

family - column family

qualifier - column qualifier

op - the comparison operation

comparator - the comparator

put - data to put if check succeeds

Returns:

true or false to return to client if default processing should be bypassed, or null otherwise

Throws:

IOException

preCheckAndPutAfterRowLock

public Boolean preCheckAndPutAfterRowLock(byte[] row,
                                          Filter filter,
                                          Put put)
                                   throws IOException

Supports Coprocessor 'bypass'.

Parameters:

row - row to check

filter - filter

put - data to put if check succeeds

Returns:

true or false to return to client if default processing should be bypassed, or null otherwise

Throws:

IOException

postCheckAndPut

public boolean postCheckAndPut(byte[] row,
                               byte[] family,
                               byte[] qualifier,
                               CompareOperator op,
                               ByteArrayComparable comparator,
                               Put put,
                               boolean result)
                        throws IOException

Parameters:

row - row to check

family - column family

qualifier - column qualifier

op - the comparison operation

comparator - the comparator

put - data to put if check succeeds

Throws:

IOException - e

postCheckAndPut

public boolean postCheckAndPut(byte[] row,
                               Filter filter,
                               Put put,
                               boolean result)
                        throws IOException

Parameters:

row - row to check

filter - filter

put - data to put if check succeeds

Throws:

IOException - e

preCheckAndDelete

public Boolean preCheckAndDelete(byte[] row,
                                 byte[] family,
                                 byte[] qualifier,
                                 CompareOperator op,
                                 ByteArrayComparable comparator,
                                 Delete delete)
                          throws IOException

Supports Coprocessor 'bypass'.

Parameters:

row - row to check

family - column family

qualifier - column qualifier

op - the comparison operation

comparator - the comparator

delete - delete to commit if check succeeds

Returns:

true or false to return to client if default processing should be bypassed, or null otherwise

Throws:

IOException

preCheckAndDelete

public Boolean preCheckAndDelete(byte[] row,
                                 Filter filter,
                                 Delete delete)
                          throws IOException

Supports Coprocessor 'bypass'.

Parameters:

row - row to check

filter - filter

delete - delete to commit if check succeeds

Returns:

true or false to return to client if default processing should be bypassed, or null otherwise

Throws:

IOException

preCheckAndDeleteAfterRowLock

public Boolean preCheckAndDeleteAfterRowLock(byte[] row,
                                             byte[] family,
                                             byte[] qualifier,
                                             CompareOperator op,
                                             ByteArrayComparable comparator,
                                             Delete delete)
                                      throws IOException

Supports Coprocessor 'bypass'.

Parameters:

row - row to check

family - column family

qualifier - column qualifier

op - the comparison operation

comparator - the comparator

delete - delete to commit if check succeeds

Returns:

true or false to return to client if default processing should be bypassed, or null otherwise

Throws:

IOException

preCheckAndDeleteAfterRowLock

public Boolean preCheckAndDeleteAfterRowLock(byte[] row,
                                             Filter filter,
                                             Delete delete)
                                      throws IOException

Supports Coprocessor 'bypass'.

Parameters:

row - row to check

filter - filter

delete - delete to commit if check succeeds

Returns:

true or false to return to client if default processing should be bypassed, or null otherwise

Throws:

IOException

postCheckAndDelete

public boolean postCheckAndDelete(byte[] row,
                                  byte[] family,
                                  byte[] qualifier,
                                  CompareOperator op,
                                  ByteArrayComparable comparator,
                                  Delete delete,
                                  boolean result)
                           throws IOException

Parameters:

row - row to check

family - column family

qualifier - column qualifier

op - the comparison operation

comparator - the comparator

delete - delete to commit if check succeeds

Throws:

IOException - e

postCheckAndDelete

public boolean postCheckAndDelete(byte[] row,
                                  Filter filter,
                                  Delete delete,
                                  boolean result)
                           throws IOException

Parameters:

row - row to check

filter - filter

delete - delete to commit if check succeeds

Throws:

IOException - e

preAppend

public Result preAppend(Append append)
                 throws IOException

Supports Coprocessor 'bypass'.

Parameters:

append - append object

Returns:

result to return to client if default operation should be bypassed, null otherwise

Throws:

IOException - if an error occurred on the coprocessor

preAppendAfterRowLock

public Result preAppendAfterRowLock(Append append)
                             throws IOException

Supports Coprocessor 'bypass'.

Parameters:

append - append object

Returns:

result to return to client if default operation should be bypassed, null otherwise

Throws:

IOException - if an error occurred on the coprocessor

preIncrement

public Result preIncrement(Increment increment)
                    throws IOException

Supports Coprocessor 'bypass'.

Parameters:

increment - increment object

Returns:

result to return to client if default operation should be bypassed, null otherwise

Throws:

IOException - if an error occurred on the coprocessor

preIncrementAfterRowLock

public Result preIncrementAfterRowLock(Increment increment)
                                throws IOException

Supports Coprocessor 'bypass'.

Parameters:

increment - increment object

Returns:

result to return to client if default operation should be bypassed, null otherwise

Throws:

IOException - if an error occurred on the coprocessor

postAppend

public Result postAppend(Append append,
                         Result result)
                  throws IOException

Parameters:

append - Append object

result - the result returned by the append

Throws:

IOException - if an error occurred on the coprocessor

postIncrement

public Result postIncrement(Increment increment,
                            Result result)
                     throws IOException

Parameters:

increment - increment object

result - the result returned by postIncrement

Throws:

IOException - if an error occurred on the coprocessor

preScannerOpen

public void preScannerOpen(Scan scan)
                    throws IOException

Parameters:

scan - the Scan specification

Throws:

IOException - Exception

postScannerOpen

public RegionScanner postScannerOpen(Scan scan,
                                     RegionScanner s)
                              throws IOException

Parameters:

scan - the Scan specification

s - the scanner

Returns:

the scanner instance to use

Throws:

IOException - Exception

preScannerNext

public Boolean preScannerNext(InternalScanner s,
                              List<Result> results,
                              int limit)
                       throws IOException

Parameters:

s - the scanner

results - the result set returned by the region server

limit - the maximum number of results to return

Returns:

'has next' indication to client if bypassing default behavior, or null otherwise

Throws:

IOException - Exception

postScannerNext

public boolean postScannerNext(InternalScanner s,
                               List<Result> results,
                               int limit,
                               boolean hasMore)
                        throws IOException

Parameters:

s - the scanner

results - the result set returned by the region server

limit - the maximum number of results to return

hasMore -

Returns:

'has more' indication to give to client

Throws:

IOException - Exception

postScannerFilterRow

public boolean postScannerFilterRow(InternalScanner s,
                                    Cell curRowCell)
                             throws IOException

This will be called by the scan flow when the current scanned row is being filtered out by the filter.

Parameters:

s - the scanner

curRowCell - The cell in the current row which got filtered out

Returns:

whether more rows are available for the scanner or not

Throws:

IOException

preScannerClose

public boolean preScannerClose(InternalScanner s)
                        throws IOException

Supports Coprocessor 'bypass'.

Parameters:

s - the scanner

Returns:

true if default behavior should be bypassed, false otherwise

Throws:

IOException - Exception

postScannerClose

public void postScannerClose(InternalScanner s)
                      throws IOException

Throws:

IOException - Exception

preStoreScannerOpen

public ScanInfo preStoreScannerOpen(HStore store,
                                    Scan scan)
                             throws IOException

Called before open store scanner for user scan.

Throws:

IOException

preReplayWALs

public void preReplayWALs(RegionInfo info,
                          org.apache.hadoop.fs.Path edits)
                   throws IOException

Parameters:

info - the RegionInfo for this region

edits - the file of recovered edits

Throws:

IOException

postReplayWALs

public void postReplayWALs(RegionInfo info,
                           org.apache.hadoop.fs.Path edits)
                    throws IOException

Parameters:

info - the RegionInfo for this region

edits - the file of recovered edits

Throws:

IOException - Exception

preWALRestore

@Deprecated
public boolean preWALRestore(RegionInfo info,
                                         WALKey logKey,
                                         WALEdit logEdit)
                                  throws IOException

Deprecated. Since hbase-2.0.0. No replacement. To be removed in hbase-3.0.0 and replaced with something that doesn't expose IntefaceAudience.Private classes.

Supports Coprocessor 'bypass'.

Returns:

true if default behavior should be bypassed, false otherwise

Throws:

IOException

postWALRestore

@Deprecated
public void postWALRestore(RegionInfo info,
                                       WALKey logKey,
                                       WALEdit logEdit)
                                throws IOException

Deprecated. Since hbase-2.0.0. No replacement. To be removed in hbase-3.0.0 and replaced with something that doesn't expose IntefaceAudience.Private classes.

Throws:

IOException

preBulkLoadHFile

public void preBulkLoadHFile(List<Pair<byte[],String>> familyPaths)
                      throws IOException

Parameters:

familyPaths - pairs of { CF, file path } submitted for bulk load

Throws:

IOException

preCommitStoreFile

public boolean preCommitStoreFile(byte[] family,
                                  List<Pair<org.apache.hadoop.fs.Path,org.apache.hadoop.fs.Path>> pairs)
                           throws IOException

Throws:

IOException

postCommitStoreFile

public void postCommitStoreFile(byte[] family,
                                org.apache.hadoop.fs.Path srcPath,
                                org.apache.hadoop.fs.Path dstPath)
                         throws IOException

Throws:

IOException

postBulkLoadHFile

public void postBulkLoadHFile(List<Pair<byte[],String>> familyPaths,
                              Map<byte[],List<org.apache.hadoop.fs.Path>> map)
                       throws IOException

Parameters:

familyPaths - pairs of { CF, file path } submitted for bulk load

map - Map of CF to List of file paths for the final loaded files

Throws:

IOException

postStartRegionOperation

public void postStartRegionOperation(Region.Operation op)
                              throws IOException

Throws:

IOException

postCloseRegionOperation

public void postCloseRegionOperation(Region.Operation op)
                              throws IOException

Throws:

IOException

preStoreFileReaderOpen

public StoreFileReader preStoreFileReaderOpen(org.apache.hadoop.fs.FileSystem fs,
                                              org.apache.hadoop.fs.Path p,
                                              FSDataInputStreamWrapper in,
                                              long size,
                                              CacheConfig cacheConf,
                                              Reference r)
                                       throws IOException

Parameters:

fs - fileystem to read from

p - path to the file

in - FSDataInputStreamWrapper

size - Full size of the file

cacheConf -

r - original reference file. This will be not null only when reading a split file.

Returns:

a Reader instance to use instead of the base reader if overriding default behavior, null otherwise

Throws:

IOException

postStoreFileReaderOpen

public StoreFileReader postStoreFileReaderOpen(org.apache.hadoop.fs.FileSystem fs,
                                               org.apache.hadoop.fs.Path p,
                                               FSDataInputStreamWrapper in,
                                               long size,
                                               CacheConfig cacheConf,
                                               Reference r,
                                               StoreFileReader reader)
                                        throws IOException

Parameters:

fs - fileystem to read from

p - path to the file

in - FSDataInputStreamWrapper

size - Full size of the file

cacheConf -

r - original reference file. This will be not null only when reading a split file.

reader - the base reader instance

Returns:

The reader to use

Throws:

IOException

postIncrementBeforeWAL

public List<Pair<Cell,Cell>> postIncrementBeforeWAL(Mutation mutation,
                                                    List<Pair<Cell,Cell>> cellPairs)
                                             throws IOException

Throws:

IOException

postAppendBeforeWAL

public List<Pair<Cell,Cell>> postAppendBeforeWAL(Mutation mutation,
                                                 List<Pair<Cell,Cell>> cellPairs)
                                          throws IOException

Throws:

IOException

preWALAppend

public void preWALAppend(WALKey key,
                         WALEdit edit)
                  throws IOException

Throws:

IOException

preEndpointInvocation

public com.google.protobuf.Message preEndpointInvocation(com.google.protobuf.Service service,
                                                         String methodName,
                                                         com.google.protobuf.Message request)
                                                  throws IOException

Throws:

IOException

postEndpointInvocation

public void postEndpointInvocation(com.google.protobuf.Service service,
                                   String methodName,
                                   com.google.protobuf.Message request,
                                   com.google.protobuf.Message.Builder responseBuilder)
                            throws IOException

Throws:

IOException

postInstantiateDeleteTracker

@Deprecated
public DeleteTracker postInstantiateDeleteTracker(DeleteTracker result)
                                                       throws IOException

Deprecated. Since 2.0 with out any replacement and will be removed in 3.0

Throws:

IOException

prePrepareBulkLoad

public void prePrepareBulkLoad(User user)
                        throws IOException

Throws:

IOException

preCleanupBulkLoad

public void preCleanupBulkLoad(User user)
                        throws IOException

Throws:

IOException