org.apache.hadoop.hbase

Interface Server

All Superinterfaces:

Abortable, Stoppable

All Known Subinterfaces:

MasterServices, RegionServerServices

All Known Implementing Classes:

HMaster, HMasterCommandLine.LocalHMaster, HRegionServer

@InterfaceAudience.Private
public interface Server
extends Abortable, Stoppable

Defines a curated set of shared functions implemented by HBase servers (Masters and RegionServers). For use internally only. Be judicious adding API. Changes cause ripples through the code base.

Method Summary

Modifier and Type	Method and Description
Connection	createConnection(org.apache.hadoop.conf.Configuration conf)
ChoreService	getChoreService()
ClusterConnection	getClusterConnection() Returns a reference to the servers' cluster connection.
org.apache.hadoop.conf.Configuration	getConfiguration() Gets the configuration object for this server.
Connection	getConnection() Returns a reference to the servers' connection.
CoordinatedStateManager	getCoordinatedStateManager() Get CoordinatedStateManager instance for this server.
default org.apache.hadoop.fs.FileSystem	getFileSystem()
MetaTableLocator	getMetaTableLocator() Returns instance of MetaTableLocator running inside this server.
ServerName	getServerName()
ZKWatcher	getZooKeeper() Gets the ZooKeeper instance for this server.
default boolean	isStopping()

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

abort, isAborted

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

isStopped, stop

Method Detail

getConfiguration

org.apache.hadoop.conf.Configuration getConfiguration()

Gets the configuration object for this server.

getZooKeeper

ZKWatcher getZooKeeper()

Gets the ZooKeeper instance for this server.

getConnection

Connection getConnection()

Returns a reference to the servers' connection. Important note: this method returns a reference to Connection which is managed by Server itself, so callers must NOT attempt to close connection obtained.

createConnection

Connection createConnection(org.apache.hadoop.conf.Configuration conf)
                     throws IOException

Throws:

IOException

getClusterConnection

ClusterConnection getClusterConnection()

Returns a reference to the servers' cluster connection. Prefer getConnection(). Important note: this method returns a reference to Connection which is managed by Server itself, so callers must NOT attempt to close connection obtained.

getMetaTableLocator

MetaTableLocator getMetaTableLocator()

Returns instance of MetaTableLocator running inside this server. This MetaServerLocator is started and stopped by server, clients shouldn't manage it's lifecycle.

Returns:

instance of MetaTableLocator associated with this server.

getServerName

ServerName getServerName()

Returns:

The unique server name for this server.

getCoordinatedStateManager

CoordinatedStateManager getCoordinatedStateManager()

Get CoordinatedStateManager instance for this server.

getChoreService

ChoreService getChoreService()

Returns:

The ChoreService instance for this server

getFileSystem

default org.apache.hadoop.fs.FileSystem getFileSystem()

Returns:

Return the FileSystem object used (can return null!).

isStopping

default boolean isStopping()

Returns:

True is the server is Stopping