Package org.apache.hadoop.hbase.regionserver

Interface Summary

Interface	Description
ChangedReadersObserver	If set of MapFile.Readers in Store change, implementors are notified.
ColumnTracker	Implementing classes of this interface will be used for the tracking and enforcement of columns and numbers of versions and timeToLive during the course of a Get or Scan operation.
CompactionRequestor
DeleteTracker	This interface is used for the tracking and enforcement of Deletes during the course of a Get or Scan operation.
FavoredNodesForRegion	Abstraction that allows different modules in RegionServer to update/get the favored nodes information for regions.
FlushRequester	Request a flush.
FlushRequestListener	Listener which will get notified regarding flush requests of regions.
HeapMemoryTuner	Makes the decision regarding proper sizing of the heap memory.
InternalScanner	Internal scanners differ from client-side scanners in that they operate on HStoreKeys and byte[] instead of RowResults.
KeyValueScanner	Scanner that returns the next KeyValue.
LastSequenceId	Last flushed sequence Ids for the regions and their stores on region server
LeaseListener	LeaseListener is an interface meant to be implemented by users of the Leases class.
MemStore	The MemStore holds in-memory modifications to the Store.
MemStoreLAB	A memstore-local allocation buffer.
MetricsRegionAggregateSource	This interface will be implemented by a MetricsSource that will export metrics from multiple regions into the hadoop metrics system.
MetricsRegionServerSource	Interface for classes that expose metrics about the regionserver.
MetricsRegionServerSourceFactory	Interface of a factory to create Metrics Sources used inside of regionservers.
MetricsRegionServerWrapper	This is the interface that will expose RegionServer information to hadoop1/hadoop2 implementations of the MetricsRegionServerSource.
MetricsRegionSource	This interface will be implemented to allow single regions to push metrics into MetricsRegionAggregateSource that will in turn push data to the Hadoop metrics system.
MetricsRegionWrapper	Interface of class that will wrap an HRegion and export numbers so they can be used in MetricsRegionSource
OnlineRegions	Interface to Map of online regions.
Region	Regions store data for a certain region of a table.
Region.BulkLoadListener	Listener class to enable callers of bulkLoadHFile() to perform any necessary pre/post processing of a given bulkload call
Region.FlushResult
Region.RowLock	Row lock held by a given thread.
RegionMergeTransaction	Executes region merge as a "transaction".
RegionMergeTransaction.JournalEntry	Split transaction journal entry
RegionMergeTransaction.TransactionListener	Split transaction listener
RegionScanner	RegionScanner describes iterators over rows in an HRegion.
RegionServerServices	Services provided by HRegionServer
ReplicationService	Gateway to Cluster Replication.
ReplicationSinkService	A sink for a replication stream has to expose this service.
ReplicationSourceService	A source for a replication stream has to expose this service.
RowProcessor<S extends Message,T extends Message>	Defines the procedure to atomically perform multiple scans and mutations on a HRegion.
RpcSchedulerFactory	A factory class that constructs an RpcScheduler.
SequenceId	Interface which abstracts implementations on log sequenceId assignment
SplitLogWorker.TaskExecutor	Objects implementing this interface actually do the task that has been acquired by a SplitLogWorker.
SplitTransaction	Executes region split as a "transaction".
SplitTransaction.JournalEntry	Split transaction journal entry
SplitTransaction.TransactionListener	Split transaction listener
Store	Interface for objects that hold a column family in a Region.
StoreConfigInformation	A more restricted interface for HStore.
StoreFileManager	Manages the store files and basic metadata about that that determines the logical structure (e.g.
StripeMultiFileWriter.WriterFactory

Class Summary

Class	Description
BaseRowProcessor<S extends Message,T extends Message>	Base class for RowProcessor with some default implementations.
CellSkipListSet	A Set of Cells implemented on top of a ConcurrentSkipListMap.
ColumnCount	Simple wrapper for a byte buffer and a counter.
CompactionTool
CompactSplitThread	Compact region on request and then run split if appropriate
ConstantSizeRegionSplitPolicy	A RegionSplitPolicy implementation which splits a region as soon as any of its store files exceeds a maximum configurable size.
CreateRandomStoreFile	Creates an HFile with random key/value pairs.
DataBlockEncodingTool	Tests various algorithms for key compression on an existing HFile.
DefaultMemStore	The MemStore holds in-memory modifications to the Store.
DefaultStoreEngine	Default StoreEngine creates the default compactor, policy, and store file manager, or their derivatives.
DefaultStoreFlusher	Default implementation of StoreFlusher.
DelimitedKeyPrefixRegionSplitPolicy	A custom RegionSplitPolicy implementing a SplitPolicy that groups rows by a prefix of the row-key with a delimiter.
DisabledRegionSplitPolicy	A RegionSplitPolicy that disables region splits.
EncodedSeekPerformanceTest	Test seek performance for encoded data blocks.
ExplicitColumnTracker	This class is used for the tracking and enforcement of columns and numbers of versions during the course of a Get or Scan operation, when explicit column qualifiers have been asked for in the query.
FlushAllStoresPolicy	A FlushPolicy that always flushes all stores for a given region.
FlushLargeStoresPolicy	A FlushPolicy that only flushes store larger a given threshold.
FlushPolicy	A flush policy determines the stores that need to be flushed when flushing a region.
FlushPolicyFactory	The class that creates a flush policy from a conf and HTableDescriptor.
HeapMemoryManager	Manages tuning of Heap memory using HeapMemoryTuner.
HeapMemoryManager.TunerContext	POJO to pass all the relevant information required to do the heap memory tuning.
HeapMemoryManager.TunerResult	POJO which holds the result of memory tuning done by HeapMemoryTuner implementation.
HeapMemStoreLAB	A memstore-local allocation buffer.
HRegion
HRegion.FlushResultImpl	Objects from this class are created when flushing to describe all the different states that that method ends up in.
HRegion.RowLockImpl
HRegionFileSystem	View to an on-disk Region.
HRegionServer	HRegionServer makes a set of HRegions available to clients.
HRegionServer.MovedRegionsCleaner	Creates a Chore thread to clean the moved region cache.
HRegionServerCommandLine	Class responsible for parsing the command line and starting the RegionServer.
HStore	A Store holds a column family in a Region.
IncreasingToUpperBoundRegionSplitPolicy	Split size is the number of regions that are on this server that all are of the same table, cubed, times 2x the region flush size OR the maximum region split size, whichever is smaller.
InternalScan	Special scanner, currently used for increment operations to allow additional server-side arguments for Scan operations.
KeyPrefixRegionSplitPolicy	A custom RegionSplitPolicy implementing a SplitPolicy that groups rows by a prefix of the row-key This ensures that a region is not split "inside" a prefix of a row key.
KeyValueHeap	Implements a heap merge across any number of KeyValueScanners.
KeyValueHeap.KVScannerComparator
KeyValueScanFixture	A fixture that implements and presents a KeyValueScanner.
Leases	Leases There are several server classes in HBase that need to track external clients that occasionally send heartbeats.
LogRoller	Runs periodically to determine if the WAL should be rolled.
LruHashMap<K extends HeapSize,V extends HeapSize>	The LruHashMap is a memory-aware HashMap with a configurable maximum memory footprint.
LruHashMap.Entry<K extends HeapSize,V extends HeapSize>	Entry to store key/value mappings.
MemStoreChunkPool	A pool of HeapMemStoreLAB.Chunk instances.
MemStoreSnapshot	Holds details of the snapshot taken on a MemStore.
MetricsRegion	This is the glue between the HRegion and whatever hadoop shim layer is loaded (hbase-hadoop1-compat or hbase-hadoop2-compat).
MetricsRegionAggregateSourceImpl
MetricsRegionServer	This class is for maintaining the various regionserver statistics and publishing them through the metrics interfaces.
MetricsRegionServerSourceFactoryImpl	Factory to create MetricsRegionServerSource when given a MetricsRegionServerWrapper
MetricsRegionServerSourceImpl	Hadoop2 implementation of MetricsRegionServerSource.
MetricsRegionServerWrapperStub
MetricsRegionSourceImpl
MetricsRegionWrapperImpl
MetricsRegionWrapperStub
MiniBatchOperationInProgress<T>	Wraps together the mutations which are applied as a batch to the region and their operation status and WALEdits.
MockStoreFile	A mock used so our tests don't deal with actual StoreFiles
MultiVersionConsistencyControl	Manages the read/write consistency within memstore.
MultiVersionConsistencyControl.WriteEntry
NoLimitScannerContext	This is a special ScannerContext subclass that is designed to be used globally when limits should not be enforced during invocations of InternalScanner.next(java.util.List) or InternalScanner.next(java.util.List).
NonLazyKeyValueScanner	A "non-lazy" scanner which always does a real seek operation.
NonReversedNonLazyKeyValueScanner	A "non-reversed & non-lazy" scanner which does not support backward scanning and always does a real seek operation.
NoOpHeapMemoryTuner	An implementation of HeapMemoryTuner which is not doing any tuning activity but just allows to continue with old style fixed proportions.
NoOpScanPolicyObserver	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.
OOMERegionServer	A region server that will OOME.
OperationStatus	This class stores the Operation status code and the exception message that occurs in case of failure of operations like put, delete, etc.
RegionCoprocessorHost	Implements the coprocessor environment and runtime support for coprocessors loaded within a Region.
RegionMergeTransactionFactory	A factory for creating RegionMergeTransactions, which execute region split as a "transaction".
RegionMergeTransactionImpl
RegionMergeTransactionImpl.JournalEntryImpl
RegionServerAccounting	RegionServerAccounting keeps record of some basic real time information about the Region Server.
RegionServerCoprocessorHost
RegionServerServices.PostOpenDeployContext	Context for postOpenDeployTasks().
RegionServerServices.RegionStateTransitionContext
RegionSplitPolicy	A split policy determines when a region should be split.
ReversedKeyValueHeap	ReversedKeyValueHeap is used for supporting reversed scanning.
RSDumpServlet
RSRpcServices	Implements the regionserver RPC services.
RSStatusServlet
ScanDeleteTracker	This class is responsible for the tracking and enforcement of Deletes during the course of a Scan operation.
ScanInfo	Immutable information for scans over a store.
ScannerContext	ScannerContext instances encapsulate limit tracking AND progress towards those limits during invocations of InternalScanner.next(java.util.List) and InternalScanner.next(java.util.List).
ScannerContext.Builder
ScanQueryMatcher	A query matcher that is specifically designed for the scan case.
ScanWildcardColumnTracker	Keeps track of the columns for a scan if they are not explicitly specified
ServerNonceManager	Implementation of nonce manager that stores nonces in a hash map and cleans them up after some time; if nonce group/client ID is supplied, nonces are stored by client ID.
ShutdownHook	Manage regionserver shutdown hooks.
SimpleRpcSchedulerFactory	Constructs a SimpleRpcScheduler.
SplitLogWorker	This worker is spawned in every regionserver, including master.
SplitTransactionFactory	A factory for creating SplitTransactions, which execute region split as a "transaction".
SplitTransactionImpl
SplitTransactionImpl.JournalEntryImpl
StatefulStoreMockMaker	This class is a helper that allows to create a partially-implemented, stateful mocks of Store.
StoreEngine<SF extends org.apache.hadoop.hbase.regionserver.StoreFlusher,CP extends CompactionPolicy,C extends Compactor,SFM extends StoreFileManager>	StoreEngine is a factory that can create the objects necessary for HStore to operate.
StoreFile	A Store data file.
StoreFile.Comparators	Useful comparators for comparing StoreFiles.
StoreFile.Reader	Reader for a StoreFile.
StoreFile.Writer	A StoreFile writer.
StoreFile.WriterBuilder
StoreFileInfo	Describe a StoreFile (hfile, reference, link)
StorefileRefresherChore	A chore for refreshing the store files for secondary regions hosted in the region server.
StoreFileScanner	KeyValueScanner adaptor over the Reader.
StoreScanner	Scanner scans both the memstore and the Store.
StoreUtils	Utility functions for region server storage layer.
StripeMultiFileWriter	Base class for cell sink that separates the provided cells into multiple files.
StripeMultiFileWriter.BoundaryMultiWriter	MultiWriter that separates the cells based on fixed row-key boundaries.
StripeMultiFileWriter.SizeMultiWriter	MultiWriter that separates the cells based on target cell number per file and file count.
StripeStoreConfig	Configuration class for stripe store and compactions.
StripeStoreEngine	The storage engine that implements the stripe-based store/compaction scheme.
StripeStoreFileManager	Stripe implementation of StoreFileManager.
StripeStoreFlusher	Stripe implementation of StoreFlusher.
StripeStoreFlusher.BoundaryStripeFlushRequest	Stripe flush request wrapper based on boundaries.
StripeStoreFlusher.SizeStripeFlushRequest	Stripe flush request wrapper based on size.
StripeStoreFlusher.StripeFlushRequest	Stripe flush request wrapper that writes a non-striped file.
TestAtomicOperation	Testing of HRegion.incrementColumnValue, HRegion.increment, and HRegion.append
TestAtomicOperation.AtomicOperation
TestAtomicOperation.Incrementer	A thread that makes a few increment calls
TestAtomicOperation.MockHRegion
TestBlocksRead
TestBlocksScanned
TestBulkLoad	This class attempts to unit test bulk HLog loading.
TestCacheOnWriteInSchema	Tests HFile cache-on-write functionality for data blocks, non-root index blocks, and Bloom filter blocks, as specified by the column family.
TestCellSkipListSet
TestClusterId	Test metrics incremented on region server operations.
TestColumnSeeking
TestCompaction	Test compaction framework and common functions
TestCompaction.TrackableCompactionRequest	Simple CompactionRequest on which you can wait until the requested compaction finishes.
TestCompactionState	Unit tests to test retrieving table/region compaction state
TestCompactionWithCoprocessor	Make sure compaction tests still pass with the preFlush and preCompact overridden to implement the default behavior
TestCompoundBloomFilter	Tests writing Bloom filter blocks in the same part of the file as data blocks.
TestDefaultCompactSelection
TestDefaultMemStore	memstore test case
TestDefaultStoreEngine
TestDefaultStoreEngine.DummyCompactionPolicy
TestDefaultStoreEngine.DummyCompactor
TestDefaultStoreEngine.DummyStoreFlusher
TestEncryptionKeyRotation
TestEncryptionRandomKeying
TestEndToEndSplitTransaction
TestExplicitColumnTracker
TestFailedAppendAndSync	Testing sync/append failures.
TestFlushRegionEntry
TestFSErrorsExposed	Test cases that ensure that file system level errors are bubbled up appropriately to clients, rather than swallowed.
TestGetClosestAtOrBefore	TestGet is a medley of tests of get all done up as a single test.
TestHeapMemoryManager
TestHRegion	Basic stand-alone testing of HRegion.
TestHRegionFileSystem
TestHRegionInfo
TestHRegionOnCluster	Tests that need to spin up a cluster testing an HRegion.
TestHRegionReplayEvents	Tests of HRegion methods for replaying flush, compaction, region open, etc events for secondary region replicas
TestHRegionServerBulkLoad	Tests bulk loading of HFiles and shows the atomicity or lack of atomicity of the region server's bullkLoad functionality.
TestHRegionServerBulkLoad.AtomicHFileLoader	Thread that does full scans of the table looking for any partially completed rows.
TestHRegionServerBulkLoad.AtomicScanReader	Thread that does full scans of the table looking for any partially completed rows.
TestHRegionServerBulkLoad.MyObserver
TestJoinedScanners	Test performance improvement of joined scanners optimization: https://issues.apache.org/jira/browse/HBASE-5416
TestKeepDeletes
TestKeyValueHeap
TestKeyValueScanFixture
TestMajorCompaction	Test major compactions
TestMasterAddressTracker
TestMasterAddressTracker.NodeCreationListener
TestMemStoreChunkPool	Test the MemStoreChunkPool class
TestMemStoreLAB
TestMetricsRegion
TestMetricsRegionServer	Unit test version of rs metrics tests.
TestMetricsRegionServerSourceFactory	Test for the CompatibilitySingletonFactory and building MetricsRegionServerSource
TestMetricsRegionServerSourceImpl	Test for MetricsRegionServerSourceImpl
TestMetricsRegionSourceImpl
TestMiniBatchOperationInProgress
TestMinorCompaction	Test minor compactions
TestMinVersions	Test Minimum Versions feature (HBASE-4071).
TestMultiColumnScanner	Tests optimized scanning of multiple columns.
TestMultiVersionConsistencyControl	This is a hammer test that verifies MultiVersionConsistencyControl in a multiple writer single reader scenario.
TestParallelPut	Testing of multiPut in parallel.
TestParallelPut.Putter	A thread that makes a few put calls
TestPerColumnFamilyFlush	This test verifies the correctness of the Per Column Family flushing strategy
TestPriorityRpc	Tests that verify certain RPCs get a higher QoS.
TestQosFunction	Basic test that qos function is sort of working; i.e.
TestQueryMatcher
TestRecoveredEdits	Tests around replay of recovered.edits content.
TestRegionFavoredNodes	Tests the ability to specify favored nodes for a region.
TestRegionMergeTransaction	Test the RegionMergeTransactionImpl class against two HRegions (as opposed to running cluster).
TestRegionMergeTransactionOnCluster	Like TestRegionMergeTransaction in that we're testing RegionMergeTransactionImpl only the below tests are against a running cluster where TestRegionMergeTransaction is tests against bare HRegion.
TestRegionReplicaFailover	Tests failover of secondary region replicas.
TestRegionReplicas	Tests for region replicas.
TestRegionServerHostname	Tests for the hostname specification by region server
TestRegionServerMetrics
TestRegionServerNoMaster	Tests on the region server, without the master.
TestRegionServerOnlineConfigChange	Verify that the Online config Changes on the HRegionServer side are actually happening.
TestRegionServerReportForDuty
TestRegionServerReportForDuty.MyRegionServer
TestRegionSplitPolicy
TestResettingCounters
TestReversibleScanners	Test cases against ReversibleKeyValueScanner
TestRowTooBig	Test case to check HRS throws RowTooBigException when row size exceeds configured limits.
TestRSKilledWhenInitializing	Tests region server termination during startup.
TestRSKilledWhenInitializing.MockedRegionServer
TestRSStatusServlet	Tests for the region server status page and its template.
TestScanDeleteTracker
TestScanner	Test of a long-lived scanner validating as we go.
TestScannerHeartbeatMessages	Here we test to make sure that scans return the expected Results when the server is sending the Client heartbeat messages.
TestScannerRetriableFailure
TestScannerRetriableFailure.FaultyScannerObserver
TestScannerWithBulkload
TestScanWildcardColumnTracker
TestScanWithBloomError	Test a multi-column scanner when there is a Bloom filter false-positive.
TestSCVFWithMiniCluster
TestSeekOptimizations	Test various seek optimizations for correctness and check if they are actually saving I/O operations.
TestServerCustomProtocol
TestServerCustomProtocol.PingHandler
TestServerNonceManager
TestSplitLogWorker
TestSplitTransaction	Test the SplitTransactionImpl class against an HRegion (as opposed to running cluster).
TestSplitTransaction.CustomObserver
TestSplitTransactionOnCluster	Like TestSplitTransaction in that we're testing SplitTransactionImpl only the below tests are against a running cluster where TestSplitTransaction is tests against a bare HRegion.
TestSplitTransactionOnCluster.FailingSplitRegionObserver
TestSplitTransactionOnCluster.MockedCoordinatedStateManager
TestSplitTransactionOnCluster.MockedRegionObserver
TestSplitTransactionOnCluster.MockedSplitTransaction
TestSplitTransactionOnCluster.MockedSplitTransactionCoordination
TestSplitTransactionOnCluster.MockMasterWithoutCatalogJanitor
TestSplitWalDataLoss	Testcase for https://issues.apache.org/jira/browse/HBASE-13811
TestStore	Test class for the Store
TestStore.DummyStoreEngine
TestStoreFile	Test HStoreFile
TestStoreFileInfo	Test HStoreFile
TestStoreFileRefresherChore
TestStoreFileScannerWithTagCompression
TestStoreScanner
TestStripeCompactor
TestStripeCompactor.StoreFileWritersCapture
TestStripeCompactor.StoreFileWritersCapture.Writer
TestStripeStoreEngine
TestStripeStoreEngine.TestStoreEngine
TestStripeStoreFileManager
TestTags	Class that test tags
TestTags.TestCoprocessorForTags
TestTimeRangeTracker
TestWALLockup	Testing for lock up of WAL subsystem.
TestWideScanner
TestZKLessMergeOnCluster	Like TestRegionMergeTransaction in that we're testing RegionMergeTransaction only the below tests are against a running cluster where TestRegionMergeTransaction is tests against bare HRegion.
TestZKLessSplitOnCluster	Like TestSplitTransaction in that we're testing SplitTransaction only the below tests are against a running cluster where TestSplitTransaction is tests against a bare HRegion.
TimeRangeTracker	Stores the minimum and maximum timestamp values (both are inclusive).

Enum Summary

Enum	Description
BloomType
DeleteTracker.DeleteCompare	Return codes for comparison of two Deletes.
DeleteTracker.DeleteResult	Returns codes for delete result.
MetricsRegionServerSourceFactoryImpl.FactoryStorage
Region.FlushResult.Result
Region.Operation	Operation enum is used in Region.startRegionOperation() to provide context for various checks before any region operation begins.
RegionMergeTransaction.RegionMergeTransactionPhase	Each enum is a step in the merge transaction.
RegionOpeningState
ScannerContext.LimitScope	The various scopes where a limit can be enforced.
ScannerContext.NextState	The possible states a scanner may be in following a call to InternalScanner.next(List)
ScanQueryMatcher.MatchCode	ScanQueryMatcher.match(org.apache.hadoop.hbase.Cell) return codes.
ScanType	Enum to distinguish general scan types.
SplitLogWorker.TaskExecutor.Status
SplitTransaction.SplitTransactionPhase	Each enum is a step in the split transaction.

Exception Summary

Exception	Description
LeaseException	Reports a problem with a lease
Leases.LeaseStillHeldException	Thrown if we are asked to create a lease but lease on passed name already exists.
NoSuchColumnFamilyException	Thrown if request for nonexistent column family.
RegionAlreadyInTransitionException	This exception is thrown when a region server is asked to open or close a region but it's already processing it
RegionServerAbortedException	Thrown by the region server when it is aborting.
RegionServerRunningException	Thrown if the region server log directory exists (which indicates another region server is running at the same address)
RegionServerStoppedException	Thrown by the region server when it is in shutting down state.
RowTooBigException	Gets or Scans throw this exception if running without in-row scan flag set and row size appears to exceed max configured size (configurable via hbase.table.max.rowsize).
UnexpectedStateException
WrongRegionException	Thrown when a request contains a key which is not part of this region