Package org.apache.hadoop.hbase

Interface Summary

Interface	Description
Abortable	Interface to support the aborting of a given server or client.
Cell	The unit of storage in HBase consisting of the following fields:
CellBuilder	Use CellBuilderFactory to get CellBuilder instance.
CellComparator	Comparator for comparing cells and has some specialized methods that allows comparing individual cell components like row, family, qualifier and timestamp
CellScannable	Implementer can return a CellScanner over its Cell content.
CellScanner	An interface for iterating through a sequence of cells.
ClusterMetrics	Metrics information on the HBase cluster.
CoordinatedStateManager	Implementations of this interface will keep and return to clients implementations of classes providing API to execute coordinated operations.
Coprocessor	Base interface for the 4 coprocessors - MasterCoprocessor, RegionCoprocessor, RegionServerCoprocessor, and WALCoprocessor.
CoprocessorEnvironment<C extends Coprocessor>	Coprocessor environment state.
ExtendedCell	Extension to Cell with server side required functions.
ExtendedCellBuilder	For internal purpose.
KeyValue.SamePrefixComparator<T>	Avoids redundant comparisons for better performance.
MetaTableAccessor.CloseableVisitor	Implementations 'visit' a catalog table row but with close() at the end.
MetaTableAccessor.Visitor	Implementations 'visit' a catalog table row.
RawCell	An extended version of cell that gives more power to CPs
RawCellBuilder	Allows creating a cell with Tag An instance of this type can be acquired by using RegionCoprocessorEnvironment#getCellBuilder (for prod code) and RawCellBuilderFactory (for unit tests).
RegionMetrics	Encapsulates per-region load metrics.
RegionStateListener	The listener interface for receiving region state events.
Server	Defines a curated set of shared functions implemented by HBase servers (Masters and RegionServers).
ServerMetrics	This class is used for exporting current state of load on a RegionServer.
Stoppable	Implementers are Stoppable.
TableDescriptors	Get, remove and modify table descriptors.
Tag	Tags are part of cells and helps to add metadata about them.

Class Summary

Class	Description
ArrayBackedTag	This is a Tag implementation in which value is backed by an on heap byte array.
AsyncConsoleAppender	Logger class that buffers before trying to log to the specified console.
AsyncMetaTableAccessor	The asynchronous meta table accessor.
AuthUtil	Utility methods for helping with security tasks.
BaseConfigurable	HBase version of Hadoop's Configured class that doesn't initialize the configuration via BaseConfigurable.setConf(Configuration) in the constructor, but only sets the configuration through the BaseConfigurable.setConf(Configuration) method
BBKVComparator	A comparator for case where ByteBufferKeyValue is prevalent type (BBKV is base-type in hbase2).
ByteBufferExtendedCell	This class is a server side extension to the Cell interface.
ByteBufferKeyOnlyKeyValue	This is a key only Cell implementation which is identical to KeyValue.KeyOnlyKeyValue with respect to key serialization but have its data in the form of Byte buffer (onheap and offheap).
ByteBufferKeyValue	This Cell is an implementation of ByteBufferExtendedCell where the data resides in off heap/ on heap ByteBuffer
ByteBufferTag	This is a Tag implementation in which value is backed by ByteBuffer
CacheEvictionStats
CacheEvictionStatsAggregator	Used to merge CacheEvictionStats.
CacheEvictionStatsBuilder
CellBuilderFactory	Create a CellBuilder instance.
CellComparatorImpl	Compare two HBase cells.
CellComparatorImpl.MetaCellComparator	A CellComparatorImpl for hbase:meta catalog table KeyValues.
CellUtil	Utility methods helpful for slinging Cell instances.
ChoreService	ChoreService is a service that can be used to schedule instances of ScheduledChore to run periodically while sharing threads.
ClusterId	The identifier for this cluster.
ClusterMetricsBuilder
ClusterStatus	Deprecated As of release 2.0.0, this will be removed in HBase 3.0.0 Use ClusterMetrics instead.
CompatibilityFactory	Class that will create many instances of classes provided by the hbase-hadoop{1|2}-compat jars.
CompatibilitySingletonFactory	Factory for classes supplied by hadoop compatibility modules.
CompoundConfiguration	Do a shallow merge of multiple KV configuration pools.
DaemonThreadFactory	Thread factory that creates daemon threads
ExtendedCellBuilderFactory
ExtendedCellBuilderImpl
HBaseConfiguration	Adds HBase configuration files to a Configuration
HBaseInterfaceAudience	This class defines constants for different classes of hbase limited private apis
HColumnDescriptor	Deprecated
HConstants	HConstants holds a bunch of HBase-related constants
HDFSBlocksDistribution	Data structure to describe the distribution of HDFS blocks among hosts.
HDFSBlocksDistribution.HostAndWeight	Stores the hostname and weight for that hostname.
HDFSBlocksDistribution.HostAndWeight.WeightComparator	comparator used to sort hosts based on weight
HealthCheckChore	The Class HealthCheckChore for running health checker regularly.
HRegionInfo	Deprecated As of release 2.0.0, this will be removed in HBase 3.0.0.
HRegionLocation	Data structure to hold RegionInfo and the address for the hosting HRegionServer.
HTableDescriptor	Deprecated As of release 2.0.0, this will be removed in HBase 3.0.0.
IndividualBytesFieldCell
JitterScheduledThreadPoolExecutorImpl	ScheduledThreadPoolExecutor that will add some jitter to the RunnableScheduledFuture.getDelay.
JMXListener	Pluggable JMX Agent for HBase(to fix the 2 random TCP ports issue of the out-of-the-box JMX Agent): 1)connector port can share with the registry port if SSL is OFF 2)support password authentication 3)support subset of SSL (with default configuration)
KeyValue	An HBase Key/Value.
KeyValue.KeyOnlyKeyValue	A simple form of KeyValue that creates a keyvalue with only the key part of the byte[] Mainly used in places where we need to compare two cells.
KeyValue.KVComparator	Deprecated : Use CellComparatorImpl.
KeyValue.MetaComparator	Deprecated : CellComparatorImpl.META_COMPARATOR to be used.
KeyValueTestUtil
KeyValueUtil	static convenience methods for dealing with KeyValues and collections of KeyValues
LocalHBaseCluster	This class creates a single process HBase cluster.
MetaTableAccessor	Read/write operations on region and assignment information store in hbase:meta.
MetaTableAccessor.DefaultVisitorBase	A Visitor that skips offline regions and split parents
MetaTableAccessor.ReplicationBarrierResult
MetaTableAccessor.TableVisitorBase	A Visitor for a table.
NamespaceDescriptor	Namespace POJO class.
NamespaceDescriptor.Builder
NoTagsByteBufferKeyValue	An extension of the ByteBufferKeyValue where the tags length is always 0
NoTagsKeyValue	An extension of the KeyValue where the tags length is always 0
PrivateCellUtil	Utility methods helpful slinging Cell instances.
RawCellBuilderFactory	Factory for creating cells for CPs.
RegionLoad	Deprecated As of release 2.0.0, this will be removed in HBase 3.0.0 Use RegionMetrics instead.
RegionLocations	Container for holding a list of HRegionLocation's that correspond to the same range.
RegionMetricsBuilder
RSGroupTableAccessor	Read rs group information from hbase:rsgroup.
ScheduledChore	ScheduledChore is a task performed on a period in hbase.
ServerLoad	Deprecated As of release 2.0.0, this will be removed in HBase 3.0.0 Use ServerMetrics instead.
ServerMetricsBuilder
ServerName	Name of a particular incarnation of an HBase Server.
SharedConnection	Wraps a Connection to make it can't be closed or aborted.
Size	It is used to represent the size with different units.
SizeCachedKeyValue	This class is an extension to KeyValue where rowLen and keyLen are cached.
SizeCachedNoTagsKeyValue	This class is an extension to ContentSizeCachedKeyValue where there are no tags in Cell.
SplitLogCounters	Counters kept by the distributed WAL split log process.
SplitLogTask	State of a WAL log split during distributed splitting.
SplitLogTask.Done
SplitLogTask.Err
SplitLogTask.Owned
SplitLogTask.Resigned
SplitLogTask.Unassigned
SslRMIClientSocketFactorySecure	Avoid SSL V3.0 "Poodle" Vulnerability - CVE-2014-3566
SslRMIServerSocketFactorySecure	Avoid SSL V3.0 "Poodle" Vulnerability - CVE-2014-3566
TableName	Immutable POJO class for representing a table name.
TagType
TagUtil
Version
ZKNamespaceManager	Class servers two purposes: 1.
ZNodeClearer	Contains a set of methods for the collaboration between the start/stop scripts and the servers.

Enum Summary

Enum	Description
Cell.Type	The valid types for user to build the cell.
CellBuilderType	Used by CellBuilderFactory and ExtendedCellBuilderFactory.
ClusterMetrics.Option	Kinds of ClusterMetrics
CompareOperator	Generic set of comparison operators.
CompatibilitySingletonFactory.SingletonStorage
Coprocessor.State	Lifecycle state of a given coprocessor instance.
HConstants.OperationStatusCode	Status codes used for return values of bulk operations.
KeepDeletedCells	Ways to keep cells marked for delete around.
KeyValue.Type	Key type.
MemoryCompactionPolicy	Enum describing all possible memory compaction policies
MetaTableAccessor.QueryType
Size.Unit

Exception Summary

Exception	Description
CallDroppedException	Returned to the clients when their request was discarded due to server being overloaded.
CallQueueTooBigException
ClockOutOfSyncException	This exception is thrown by the master when a region server clock skew is too high.
DoNotRetryIOException	Subclass if exception is not meant to be retried: e.g.
DroppedSnapshotException	Thrown during flush if the possibility snapshot content was not properly persisted into store files.
HBaseIOException	All hbase specific IOExceptions should be subclasses of HBaseIOException
InvalidFamilyOperationException	Thrown if a request is table schema modification is requested but made for an invalid family name.
MasterNotRunningException	Thrown if the master is not running
MultiActionResultTooLarge	Exception thrown when the result needs to be chunked on the server side.
NamespaceExistException	Thrown when a namespace exists but should not
NamespaceNotFoundException	Thrown when a namespace can not be located
NotAllMetaRegionsOnlineException	Thrown when an operation requires the root and all meta regions to be online
NotServingRegionException	Thrown by a region server if it is sent a request for a region it is not serving.
PleaseHoldException	This exception is thrown by the master when a region server was shut down and restarted so fast that the master still hasn't processed the server shutdown of the first instance, or when master is initializing and client call admin operations, or when an operation is performed on a region server that is still starting.
RegionException	Thrown when something happens related to region handling.
RegionTooBusyException	Thrown by a region server if it will block and wait to serve a request.
ReplicationPeerNotFoundException	Thrown when a replication peer can not be found
RetryImmediatelyException
ServiceNotRunningException
TableExistsException	Thrown when a table exists but should not
TableInfoMissingException	Failed to find .tableinfo file under table dir
TableNotDisabledException	Thrown if a table should be offline but is not
TableNotEnabledException	Thrown if a table should be enabled but is not
TableNotFoundException	Thrown when a table can not be located
UnknownRegionException	Thrown when we are asked to operate on a region we know nothing about.
UnknownScannerException	Thrown if a region server is passed an unknown scanner id.
YouAreDeadException	This exception is thrown by the master when a region server reports and is already being processed as dead.
ZooKeeperConnectionException	Thrown if the client can't connect to zookeeper

Annotation Types Summary

Annotation Type	Description
MetaMutationAnnotation	The field or the parameter to which this annotation can be applied only when it holds mutations for hbase:meta table.