org.apache.hadoop.hbase.coprocessor

Class SampleRegionWALObserver

java.lang.Object

org.apache.hadoop.hbase.coprocessor.BaseRegionObserver

org.apache.hadoop.hbase.coprocessor.SampleRegionWALObserver

All Implemented Interfaces:

Coprocessor, RegionObserver, WALObserver

public class SampleRegionWALObserver
extends BaseRegionObserver
implements WALObserver

Class for testing WALObserver coprocessor. It will monitor WAL writing and restoring, and modify passed-in WALEdit, i.e, ignore specified columns when writing, or add a KeyValue. On the other side, it checks whether the ignored column is still in WAL when Restoreed at region reconstruct.

Nested Class Summary

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

Coprocessor.State

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

RegionObserver.MutationType

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
SampleRegionWALObserver()

Method Summary

Modifier and Type	Method and Description
boolean	isPostWALRestoreCalled()
boolean	isPostWALRestoreDeprecatedCalled()
boolean	isPostWALWriteCalled()
boolean	isPostWALWriteDeprecatedCalled()
boolean	isPreWALRestoreCalled()
boolean	isPreWALRestoreDeprecatedCalled()
boolean	isPreWALWriteCalled()
boolean	isPreWALWriteDeprecatedCalled()
void	postWALRestore(ObserverContext<? extends RegionCoprocessorEnvironment> env, HRegionInfo info, WALKey logKey, WALEdit logEdit) Triggered after HRegion when WAL is Restoreed.
void	postWALRestore(ObserverContext<RegionCoprocessorEnvironment> env, HRegionInfo info, HLogKey logKey, WALEdit logEdit) Called after a WALEdit replayed for this region.
void	postWALWrite(ObserverContext<? extends WALCoprocessorEnvironment> env, HRegionInfo info, WALKey logKey, WALEdit logEdit) Called after a WALEdit is writen to WAL.
void	postWALWrite(ObserverContext<WALCoprocessorEnvironment> env, HRegionInfo info, HLogKey logKey, WALEdit logEdit) Called after a WALEdit is writen to WAL.
void	preWALRestore(ObserverContext<? extends RegionCoprocessorEnvironment> env, HRegionInfo info, WALKey logKey, WALEdit logEdit) Triggered before HRegion when WAL is Restoreed.
void	preWALRestore(ObserverContext<RegionCoprocessorEnvironment> env, HRegionInfo info, HLogKey logKey, WALEdit logEdit) Called before a WALEdit replayed for this region.
boolean	preWALWrite(ObserverContext<? extends WALCoprocessorEnvironment> env, HRegionInfo info, WALKey logKey, WALEdit logEdit) Called before a WALEdit is writen to WAL.
boolean	preWALWrite(ObserverContext<WALCoprocessorEnvironment> env, HRegionInfo info, HLogKey logKey, WALEdit logEdit) Called before a WALEdit is writen to WAL.
void	setTestValues(byte[] tableName, byte[] row, byte[] igf, byte[] igq, byte[] chf, byte[] chq, byte[] addf, byte[] addq) Set values: with a table name, a column name which will be ignored, and a column name which will be added to WAL.

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, preAppend, preAppendAfterRowLock, preBatchMutate, preBulkLoadHFile, preCheckAndDelete, preCheckAndDeleteAfterRowLock, preCheckAndPut, preCheckAndPutAfterRowLock, preClose, preCommitStoreFile, preCompact, preCompact, preCompactScannerOpen, preCompactScannerOpen, preCompactSelection, preCompactSelection, preDelete, preExists, preFlush, preFlush, preFlushScannerOpen, preGetClosestRowBefore, preGetOp, preIncrement, preIncrementAfterRowLock, preIncrementColumnValue, preOpen, prePrepareTimeStampForDeleteVersion, prePut, preRollBackSplit, preScannerClose, preScannerNext, preScannerOpen, preSplit, preSplit, preSplitAfterPONR, preSplitBeforePONR, preStoreFileReaderOpen, preStoreScannerOpen, start, stop

Methods inherited from class java.lang.Object

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

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

start, stop

Constructor Detail

SampleRegionWALObserver

public SampleRegionWALObserver()

Method Detail

setTestValues

public void setTestValues(byte[] tableName,
                          byte[] row,
                          byte[] igf,
                          byte[] igq,
                          byte[] chf,
                          byte[] chq,
                          byte[] addf,
                          byte[] addq)

Set values: with a table name, a column name which will be ignored, and a column name which will be added to WAL.

postWALWrite

public void postWALWrite(ObserverContext<? extends WALCoprocessorEnvironment> env,
                         HRegionInfo info,
                         WALKey logKey,
                         WALEdit logEdit)
                  throws IOException

Description copied from interface: WALObserver

Called after a WALEdit is writen to WAL.

Specified by:

postWALWrite in interface WALObserver

Throws:

IOException

postWALWrite

public void postWALWrite(ObserverContext<WALCoprocessorEnvironment> env,
                         HRegionInfo info,
                         HLogKey logKey,
                         WALEdit logEdit)
                  throws IOException

Description copied from interface: WALObserver

Called after a WALEdit is writen to WAL. This method is left in place to maintain binary compatibility with older WALObservers. If an implementation directly overrides WALObserver.postWALWrite(ObserverContext, HRegionInfo, WALKey, WALEdit) then this version won't be called at all, barring problems with the Security Manager. To work correctly in the presence of a strict Security Manager, or in the case of an implementation that relies on a parent class to implement preWALWrite, you should implement this method as a call to the non-deprecated version. Users of this method will see all edits that can be treated as HLogKey. If there are edits that can't be treated as HLogKey they won't be offered to coprocessors that rely on this method. If a coprocessor gets skipped because of this mechanism, a log message at ERROR will be generated per coprocessor on the logger for CoprocessorHost once per classloader.

Specified by:

postWALWrite in interface WALObserver

Throws:

IOException

preWALWrite

public boolean preWALWrite(ObserverContext<? extends WALCoprocessorEnvironment> env,
                           HRegionInfo info,
                           WALKey logKey,
                           WALEdit logEdit)
                    throws IOException

Description copied from interface: WALObserver

Called before a WALEdit is writen to WAL.

Specified by:

preWALWrite in interface WALObserver

Returns:

true if default behavior should be bypassed, false otherwise

Throws:

IOException

preWALWrite

public boolean preWALWrite(ObserverContext<WALCoprocessorEnvironment> env,
                           HRegionInfo info,
                           HLogKey logKey,
                           WALEdit logEdit)
                    throws IOException

Description copied from interface: WALObserver

Called before a WALEdit is writen to WAL. This method is left in place to maintain binary compatibility with older WALObservers. If an implementation directly overrides WALObserver.preWALWrite(ObserverContext, HRegionInfo, WALKey, WALEdit) then this version won't be called at all, barring problems with the Security Manager. To work correctly in the presence of a strict Security Manager, or in the case of an implementation that relies on a parent class to implement preWALWrite, you should implement this method as a call to the non-deprecated version. Users of this method will see all edits that can be treated as HLogKey. If there are edits that can't be treated as HLogKey they won't be offered to coprocessors that rely on this method. If a coprocessor gets skipped because of this mechanism, a log message at ERROR will be generated per coprocessor on the logger for CoprocessorHost once per classloader.

Specified by:

preWALWrite in interface WALObserver

Returns:

true if default behavior should be bypassed, false otherwise

Throws:

IOException

preWALRestore

public void preWALRestore(ObserverContext<? extends RegionCoprocessorEnvironment> env,
                          HRegionInfo info,
                          WALKey logKey,
                          WALEdit logEdit)
                   throws IOException

Triggered before HRegion when WAL is Restoreed.

Specified by:

preWALRestore in interface RegionObserver

Overrides:

preWALRestore in class BaseRegionObserver

Throws:

IOException

preWALRestore

public void preWALRestore(ObserverContext<RegionCoprocessorEnvironment> env,
                          HRegionInfo info,
                          HLogKey logKey,
                          WALEdit logEdit)
                   throws IOException

Description copied from interface: RegionObserver

Called before a WALEdit replayed for this region. This method is left in place to maintain binary compatibility with older RegionObservers. If an implementation directly overrides RegionObserver.preWALRestore(ObserverContext, HRegionInfo, WALKey, WALEdit) then this version won't be called at all, barring problems with the Security Manager. To work correctly in the presence of a strict Security Manager, or in the case of an implementation that relies on a parent class to implement preWALRestore, you should implement this method as a call to the non-deprecated version. Users of this method will see all edits that can be treated as HLogKey. If there are edits that can't be treated as HLogKey they won't be offered to coprocessors that rely on this method. If a coprocessor gets skipped because of this mechanism, a log message at ERROR will be generated per coprocessor on the logger for CoprocessorHost once per classloader.

Specified by:

preWALRestore in interface RegionObserver

Overrides:

preWALRestore in class BaseRegionObserver

Throws:

IOException

postWALRestore

public void postWALRestore(ObserverContext<? extends RegionCoprocessorEnvironment> env,
                           HRegionInfo info,
                           WALKey logKey,
                           WALEdit logEdit)
                    throws IOException

Triggered after HRegion when WAL is Restoreed.

Specified by:

postWALRestore in interface RegionObserver

Overrides:

postWALRestore in class BaseRegionObserver

Throws:

IOException

postWALRestore

public void postWALRestore(ObserverContext<RegionCoprocessorEnvironment> env,
                           HRegionInfo info,
                           HLogKey logKey,
                           WALEdit logEdit)
                    throws IOException

Description copied from interface: RegionObserver

Called after a WALEdit replayed for this region. This method is left in place to maintain binary compatibility with older RegionObservers. If an implementation directly overrides RegionObserver.postWALRestore(ObserverContext, HRegionInfo, WALKey, WALEdit) then this version won't be called at all, barring problems with the Security Manager. To work correctly in the presence of a strict Security Manager, or in the case of an implementation that relies on a parent class to implement preWALRestore, you should implement this method as a call to the non-deprecated version. Users of this method will see all edits that can be treated as HLogKey. If there are edits that can't be treated as HLogKey they won't be offered to coprocessors that rely on this method. If a coprocessor gets skipped because of this mechanism, a log message at ERROR will be generated per coprocessor on the logger for CoprocessorHost once per classloader.

Specified by:

postWALRestore in interface RegionObserver

Overrides:

postWALRestore in class BaseRegionObserver

Throws:

IOException

isPreWALWriteCalled

public boolean isPreWALWriteCalled()

isPostWALWriteCalled

public boolean isPostWALWriteCalled()

isPreWALRestoreCalled

public boolean isPreWALRestoreCalled()

isPostWALRestoreCalled

public boolean isPostWALRestoreCalled()

isPreWALWriteDeprecatedCalled

public boolean isPreWALWriteDeprecatedCalled()

isPostWALWriteDeprecatedCalled

public boolean isPostWALWriteDeprecatedCalled()

isPreWALRestoreDeprecatedCalled

public boolean isPreWALRestoreDeprecatedCalled()

isPostWALRestoreDeprecatedCalled

public boolean isPostWALRestoreDeprecatedCalled()