org.apache.hadoop.hbase.regionserver

Class NoOpScanPolicyObserver

java.lang.Object

org.apache.hadoop.hbase.coprocessor.BaseRegionObserver

org.apache.hadoop.hbase.regionserver.NoOpScanPolicyObserver

All Implemented Interfaces:

Coprocessor, RegionObserver

public class NoOpScanPolicyObserver
extends BaseRegionObserver

RegionObserver that just reimplements the default behavior, in order to validate that all the necessary APIs for this are public This observer is also used in TestFromClientSideWithCoprocessor and TestCompactionWithCoprocessor to make sure that a wide range of functionality still behaves as expected.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.hadoop.hbase.coprocessor.RegionObserver

RegionObserver.MutationType

Nested classes/interfaces inherited from interface org.apache.hadoop.hbase.Coprocessor

Coprocessor.State

Field Summary

Fields inherited from interface org.apache.hadoop.hbase.Coprocessor

PRIORITY_HIGHEST, PRIORITY_LOWEST, PRIORITY_SYSTEM, PRIORITY_USER, VERSION

Constructor Summary

Constructors

Constructor and Description
NoOpScanPolicyObserver()

Method Summary

Modifier and Type	Method and Description
InternalScanner	preCompactScannerOpen(ObserverContext<RegionCoprocessorEnvironment> c, Store store, java.util.List<? extends KeyValueScanner> scanners, ScanType scanType, long earliestPutTs, InternalScanner s) Reimplement the default behavior
InternalScanner	preFlushScannerOpen(ObserverContext<RegionCoprocessorEnvironment> c, Store store, KeyValueScanner memstoreScanner, InternalScanner s) Reimplement the default behavior
KeyValueScanner	preStoreScannerOpen(ObserverContext<RegionCoprocessorEnvironment> c, Store store, Scan scan, java.util.NavigableSet<byte[]> targetCols, KeyValueScanner s) Called before a store opens a new scanner.

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

postAppend, postBatchMutate, postBatchMutateIndispensably, postBulkLoadHFile, postBulkLoadHFile, postCheckAndDelete, postCheckAndPut, postClose, postCloseRegionOperation, postCommitStoreFile, postCompact, postCompact, postCompactSelection, postCompactSelection, postCompleteSplit, postDelete, postExists, postFlush, postFlush, postGetClosestRowBefore, postGetOp, postIncrement, postIncrementColumnValue, postInstantiateDeleteTracker, postLogReplay, postMutationBeforeWAL, postOpen, postPut, postRollBackSplit, postScannerClose, postScannerFilterRow, postScannerNext, postScannerOpen, postSplit, postStartRegionOperation, postStoreFileReaderOpen, postWALRestore, postWALRestore, preAppend, preAppendAfterRowLock, preBatchMutate, preBulkLoadHFile, preCheckAndDelete, preCheckAndDeleteAfterRowLock, preCheckAndPut, preCheckAndPutAfterRowLock, preClose, preCommitStoreFile, preCompact, preCompact, preCompactScannerOpen, preCompactSelection, preCompactSelection, preDelete, preExists, preFlush, preFlush, preGetClosestRowBefore, preGetOp, preIncrement, preIncrementAfterRowLock, preIncrementColumnValue, preOpen, prePrepareTimeStampForDeleteVersion, prePut, preRollBackSplit, preScannerClose, preScannerNext, preScannerOpen, preSplit, preSplit, preSplitAfterPONR, preSplitBeforePONR, preStoreFileReaderOpen, preWALRestore, preWALRestore, start, stop

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

NoOpScanPolicyObserver

public NoOpScanPolicyObserver()

Method Detail

preFlushScannerOpen

public InternalScanner preFlushScannerOpen(ObserverContext<RegionCoprocessorEnvironment> c,
                                           Store store,
                                           KeyValueScanner memstoreScanner,
                                           InternalScanner s)
                                    throws java.io.IOException

Reimplement the default behavior

Specified by:

preFlushScannerOpen in interface RegionObserver

Overrides:

preFlushScannerOpen in class BaseRegionObserver

Parameters:

c - the environment provided by the region server

store - the store being flushed

memstoreScanner - the scanner for the memstore that is flushed

s - the base scanner, if not null, from previous RegionObserver in the chain

Returns:

the scanner to use during the flush. null if the default implementation is to be used.

Throws:

java.io.IOException - if an error occurred on the coprocessor

preCompactScannerOpen

public InternalScanner preCompactScannerOpen(ObserverContext<RegionCoprocessorEnvironment> c,
                                             Store store,
                                             java.util.List<? extends KeyValueScanner> scanners,
                                             ScanType scanType,
                                             long earliestPutTs,
                                             InternalScanner s)
                                      throws java.io.IOException

Reimplement the default behavior

Specified by:

preCompactScannerOpen in interface RegionObserver

Overrides:

preCompactScannerOpen in class BaseRegionObserver

Parameters:

c - the environment provided by the region server

store - the store being compacted

scanners - the list StoreFileScanners to be read from

scanType - the ScanType indicating whether this is a major or minor compaction

earliestPutTs - timestamp of the earliest put that was found in any of the involved store files

s - the base scanner, if not null, from previous RegionObserver in the chain

Returns:

the scanner to use during compaction. null if the default implementation is to be used.

Throws:

java.io.IOException - if an error occurred on the coprocessor

preStoreScannerOpen

public KeyValueScanner preStoreScannerOpen(ObserverContext<RegionCoprocessorEnvironment> c,
                                           Store store,
                                           Scan scan,
                                           java.util.NavigableSet<byte[]> targetCols,
                                           KeyValueScanner s)
                                    throws java.io.IOException

Description copied from interface: RegionObserver

Called before a store opens a new scanner. This hook is called when a "user" scanner is opened.

See RegionObserver.preFlushScannerOpen(ObserverContext, Store, KeyValueScanner, InternalScanner) and RegionObserver.preCompactScannerOpen(ObserverContext, Store, List, ScanType, long, InternalScanner) to override scanners created for flushes or compactions, resp.

Call CoprocessorEnvironment#complete to skip any subsequent chained coprocessors. Calling ObserverContext.bypass() has no effect in this hook.

Specified by:

preStoreScannerOpen in interface RegionObserver

Overrides:

preStoreScannerOpen in class BaseRegionObserver

Parameters:

c - the environment provided by the region server

store - the store being scanned

scan - the Scan specification

targetCols - columns to be used in the scanner

s - the base scanner, if not null, from previous RegionObserver in the chain

Returns:

a KeyValueScanner instance to use or null to use the default implementation

Throws:

java.io.IOException - if an error occurred on the coprocessor