org.apache.hadoop.hbase

Class HBaseServerBase<R extends HBaseRpcServicesBase<?>>

java.lang.Object

java.lang.Thread

org.apache.hadoop.hbase.HBaseServerBase<R>

All Implemented Interfaces:

Runnable, Abortable, ConnectionRegistryEndpoint, ConfigurationObserver, Server, Stoppable

Direct Known Subclasses:

HMaster, HRegionServer

@InterfaceAudience.Private
public abstract class HBaseServerBase<R extends HBaseRpcServicesBase<?>>
extends Thread
implements Server, ConfigurationObserver, ConnectionRegistryEndpoint

Base class for hbase services, such as master or region server.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Thread

Thread.State, Thread.UncaughtExceptionHandler

Field Summary

Fields

Modifier and Type	Field and Description
protected AtomicBoolean	abortRequested
protected AsyncClusterConnection	asyncClusterConnection The asynchronous cluster connection to be shared by services.
protected ChoreService	choreService ChoreService used to schedule tasks that we want to run periodically
protected ClusterStatusTracker	clusterStatusTracker
protected org.apache.hadoop.conf.Configuration	conf
protected ConfigurationManager	configurationManager Configuration manager is used to register/deregister and notify the configuration observers when the regionserver is notified that there was a change in the on disk configs.
protected CoordinatedStateManager	csm
protected HFileSystem	dataFs
protected org.apache.hadoop.fs.Path	dataRootDir
protected NettyEventLoopGroupConfig	eventLoopGroupConfig
protected ExecutorService	executorService
protected InfoServer	infoServer
private boolean	isShutdownHookInstalled
private static org.slf4j.Logger	LOG
protected MetaRegionLocationCache	metaRegionLocationCache Cache for the meta region replica's locations.
protected int	msgInterval
protected NamedQueueRecorder	namedQueueRecorder Provide online slow log responses from ringbuffer
protected R	rpcServices
protected ServerName	serverName The server name the Master sees us as.
protected Sleeper	sleeper
protected long	startcode This servers startcode.
protected boolean	stopped
protected TableDescriptors	tableDescriptors Go here to get table descriptors.
protected UserProvider	userProvider
protected String	useThisHostnameInstead hostname specified by hostname config
protected HFileSystem	walFs
protected org.apache.hadoop.fs.Path	walRootDir
protected ZKWatcher	zooKeeper

Fields inherited from class java.lang.Thread

MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY

Constructor Summary

Constructors

Constructor and Description
HBaseServerBase(org.apache.hadoop.conf.Configuration conf, String name)

Method Summary

Modifier and Type	Method and Description
protected abstract boolean	cacheTableDescriptor()
protected abstract boolean	canCreateBaseZNode()
protected abstract boolean	canUpdateTableDescriptor()
protected void	closeClusterConnection()
protected void	closeTableDescriptors()
protected void	closeZooKeeper()
protected abstract boolean	clusterMode()
protected abstract void	configureInfoServer(InfoServer infoServer)
Connection	createConnection(org.apache.hadoop.conf.Configuration conf)
protected abstract NamedQueueRecorder	createNamedQueueRecord()
protected abstract R	createRpcServices()
AccessChecker	getAccessChecker()
AsyncClusterConnection	getAsyncClusterConnection() Returns a reference to the servers' async cluster connection.
ChoreService	getChoreService() Returns The ChoreService instance for this server
org.apache.hadoop.conf.Configuration	getConfiguration() Gets the configuration object for this server.
ConfigurationManager	getConfigurationManager()
CoordinatedStateManager	getCoordinatedStateManager() Get CoordinatedStateManager instance for this server.
org.apache.hadoop.fs.Path	getDataRootDir() Returns Return the rootDir.
protected abstract Class<? extends javax.servlet.http.HttpServlet>	getDumpServlet()
NettyEventLoopGroupConfig	getEventLoopGroupConfig()
ExecutorService	getExecutorService()
org.apache.hadoop.fs.FileSystem	getFileSystem() Returns Return the FileSystem object used (can return null!).
InfoServer	getInfoServer()
MetaRegionLocationCache	getMetaRegionLocationCache()
int	getMsgInterval()
NamedQueueRecorder	getNamedQueueRecorder() get NamedQueue Provider to add different logs to ringbuffer
protected abstract String	getProcessName()
RpcServerInterface	getRpcServer()
R	getRpcServices()
ServerName	getServerName() Returns The unique server name for this server.
long	getStartcode() Returns time stamp in millis of when this server was started
TableDescriptors	getTableDescriptors() Returns Return table descriptors implementation.
protected abstract String	getUseThisHostnameInstead(org.apache.hadoop.conf.Configuration conf)
org.apache.hadoop.fs.FileSystem	getWALFileSystem() Returns Return the walFs.
org.apache.hadoop.fs.Path	getWALRootDir() Returns Return the walRootDir.
ZKPermissionWatcher	getZKPermissionWatcher()
ZKWatcher	getZooKeeper() Gets the ZooKeeper instance for this server.
protected void	initializeFileSystem()
protected void	initializeMemStoreChunkCreator(HeapMemoryManager hMemManager)
protected void	installShutdownHook() In order to register ShutdownHook, this method is called when HMaster and HRegionServer are started.
boolean	isAborted() Check if the server or client was aborted.
boolean	isClusterUp() Returns True if the cluster is up.
boolean	isShutdownHookInstalled()
boolean	isStopped() Returns True if Stoppable.stop(String) has been closed.
protected abstract void	login(UserProvider user, String host)
private void	putUpWebUI() Puts up the webui.
protected boolean	setAbortRequested() Sets the abort state if not already set.
protected void	setupClusterConnection() Setup our cluster connection if not already initialized.
private static void	setupWindows(org.apache.hadoop.conf.Configuration conf, ConfigurationManager cm) If running on Windows, do windows-specific setup.
protected void	shutdownChore(ScheduledChore chore)
protected abstract void	stopChores()
protected void	stopChoreService()
protected void	stopExecutorService()
protected void	stopInfoServer()
String	toString()
void	updateConfiguration() Reload the configuration from disk.

Methods inherited from class java.lang.Thread

activeCount, checkAccess, clone, countStackFrames, currentThread, destroy, dumpStack, enumerate, getAllStackTraces, getContextClassLoader, getDefaultUncaughtExceptionHandler, getId, getName, getPriority, getStackTrace, getState, getThreadGroup, getUncaughtExceptionHandler, holdsLock, interrupt, interrupted, isAlive, isDaemon, isInterrupted, join, join, join, resume, run, setContextClassLoader, setDaemon, setDefaultUncaughtExceptionHandler, setName, setPriority, setUncaughtExceptionHandler, sleep, sleep, start, stop, stop, suspend, yield

Methods inherited from class java.lang.Object

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

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

getAsyncConnection, getConnection, isStopping

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

abort, abort

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

stop

Methods inherited from interface org.apache.hadoop.hbase.conf.ConfigurationObserver

onConfigurationChange

Methods inherited from interface org.apache.hadoop.hbase.client.ConnectionRegistryEndpoint

getActiveMaster, getBackupMasters, getBootstrapNodes, getClusterId, getMetaLocations

Field Detail

LOG

private static final org.slf4j.Logger LOG

conf

protected final org.apache.hadoop.conf.Configuration conf

abortRequested

protected final AtomicBoolean abortRequested

stopped

protected volatile boolean stopped

isShutdownHookInstalled

private boolean isShutdownHookInstalled

startcode

protected final long startcode

This servers startcode.

userProvider

protected final UserProvider userProvider

zooKeeper

protected final ZKWatcher zooKeeper

serverName

protected ServerName serverName

The server name the Master sees us as. Its made from the hostname the master passes us, port, and server startcode. Gets set after registration against Master.

rpcServices

protected final R extends HBaseRpcServicesBase<?> rpcServices

useThisHostnameInstead

protected final String useThisHostnameInstead

hostname specified by hostname config

namedQueueRecorder

protected final NamedQueueRecorder namedQueueRecorder

Provide online slow log responses from ringbuffer

configurationManager

protected final ConfigurationManager configurationManager

Configuration manager is used to register/deregister and notify the configuration observers when the regionserver is notified that there was a change in the on disk configs.

choreService

protected final ChoreService choreService

ChoreService used to schedule tasks that we want to run periodically

executorService

protected final ExecutorService executorService

clusterStatusTracker

protected final ClusterStatusTracker clusterStatusTracker

csm

protected final CoordinatedStateManager csm

infoServer

protected InfoServer infoServer

dataFs

protected HFileSystem dataFs

walFs

protected HFileSystem walFs

dataRootDir

protected org.apache.hadoop.fs.Path dataRootDir

walRootDir

protected org.apache.hadoop.fs.Path walRootDir

msgInterval

protected final int msgInterval

sleeper

protected final Sleeper sleeper

tableDescriptors

protected TableDescriptors tableDescriptors

Go here to get table descriptors.

asyncClusterConnection

protected AsyncClusterConnection asyncClusterConnection

The asynchronous cluster connection to be shared by services.

metaRegionLocationCache

protected final MetaRegionLocationCache metaRegionLocationCache

Cache for the meta region replica's locations. Also tracks their changes to avoid stale cache entries. Used for serving ClientMetaService.

eventLoopGroupConfig

protected final NettyEventLoopGroupConfig eventLoopGroupConfig

Constructor Detail

HBaseServerBase

public HBaseServerBase(org.apache.hadoop.conf.Configuration conf,
                       String name)
                throws IOException

Throws:

IOException

Method Detail

setupWindows

private static void setupWindows(org.apache.hadoop.conf.Configuration conf,
                                 ConfigurationManager cm)

If running on Windows, do windows-specific setup.

setupClusterConnection

protected final void setupClusterConnection()
                                     throws IOException

Setup our cluster connection if not already initialized.

Throws:

IOException

initializeFileSystem

protected final void initializeFileSystem()
                                   throws IOException

Throws:

IOException

putUpWebUI

private void putUpWebUI()
                 throws IOException

Puts up the webui.

Throws:

IOException

setAbortRequested

protected final boolean setAbortRequested()

Sets the abort state if not already set.

Returns:

True if abortRequested set to True successfully, false if an abort is already in progress.

isStopped

public boolean isStopped()

Description copied from interface: Stoppable

Returns True if Stoppable.stop(String) has been closed.

Specified by:

isStopped in interface Stoppable

isAborted

public boolean isAborted()

Description copied from interface: Abortable

Check if the server or client was aborted.

Specified by:

isAborted in interface Abortable

Returns:

true if the server or client was aborted, false otherwise

getConfiguration

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

Description copied from interface: Server

Gets the configuration object for this server.

Specified by:

getConfiguration in interface Server

getAsyncClusterConnection

public AsyncClusterConnection getAsyncClusterConnection()

Description copied from interface: Server

Returns a reference to the servers' async cluster 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.

Specified by:

getAsyncClusterConnection in interface Server

getZooKeeper

public ZKWatcher getZooKeeper()

Description copied from interface: Server

Gets the ZooKeeper instance for this server.

Specified by:

getZooKeeper in interface Server

shutdownChore

protected final void shutdownChore(ScheduledChore chore)

initializeMemStoreChunkCreator

protected final void initializeMemStoreChunkCreator(HeapMemoryManager hMemManager)

stopChores

protected abstract void stopChores()

stopChoreService

protected final void stopChoreService()

stopExecutorService

protected final void stopExecutorService()

closeClusterConnection

protected final void closeClusterConnection()

stopInfoServer

protected final void stopInfoServer()

closeZooKeeper

protected final void closeZooKeeper()

closeTableDescriptors

protected final void closeTableDescriptors()

installShutdownHook

protected final void installShutdownHook()

In order to register ShutdownHook, this method is called when HMaster and HRegionServer are started. For details, please refer to HBASE-26951

isShutdownHookInstalled

public boolean isShutdownHookInstalled()

getServerName

public ServerName getServerName()

Description copied from interface: Server

Returns The unique server name for this server.

Specified by:

getServerName in interface Server

getChoreService

public ChoreService getChoreService()

Description copied from interface: Server

Returns The ChoreService instance for this server

Specified by:

getChoreService in interface Server

getTableDescriptors

public TableDescriptors getTableDescriptors()

Returns Return table descriptors implementation.

getExecutorService

public ExecutorService getExecutorService()

getAccessChecker

public AccessChecker getAccessChecker()

getZKPermissionWatcher

public ZKPermissionWatcher getZKPermissionWatcher()

getCoordinatedStateManager

public CoordinatedStateManager getCoordinatedStateManager()

Description copied from interface: Server

Get CoordinatedStateManager instance for this server.

Specified by:

getCoordinatedStateManager in interface Server

createConnection

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

Specified by:

createConnection in interface Server

Throws:

IOException

getDataRootDir

public org.apache.hadoop.fs.Path getDataRootDir()

Returns Return the rootDir.

getFileSystem

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

Description copied from interface: Server

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

Specified by:

getFileSystem in interface Server

getWALRootDir

public org.apache.hadoop.fs.Path getWALRootDir()

Returns Return the walRootDir.

getWALFileSystem

public org.apache.hadoop.fs.FileSystem getWALFileSystem()

Returns Return the walFs.

isClusterUp

public boolean isClusterUp()

Returns True if the cluster is up.

getStartcode

public long getStartcode()

Returns time stamp in millis of when this server was started

getInfoServer

public InfoServer getInfoServer()

getMsgInterval

public int getMsgInterval()

getNamedQueueRecorder

public NamedQueueRecorder getNamedQueueRecorder()

get NamedQueue Provider to add different logs to ringbuffer

getRpcServer

public RpcServerInterface getRpcServer()

getEventLoopGroupConfig

public NettyEventLoopGroupConfig getEventLoopGroupConfig()

getRpcServices

public R getRpcServices()

getMetaRegionLocationCache

public MetaRegionLocationCache getMetaRegionLocationCache()

getConfigurationManager

public ConfigurationManager getConfigurationManager()

updateConfiguration

public void updateConfiguration()

Reload the configuration from disk.

toString

public String toString()

Overrides:

toString in class Thread

canCreateBaseZNode

protected abstract boolean canCreateBaseZNode()

getProcessName

protected abstract String getProcessName()

createRpcServices

protected abstract R createRpcServices()
                                throws IOException

Throws:

IOException

getUseThisHostnameInstead

protected abstract String getUseThisHostnameInstead(org.apache.hadoop.conf.Configuration conf)
                                             throws IOException

Throws:

IOException

login

protected abstract void login(UserProvider user,
                              String host)
                       throws IOException

Throws:

IOException

createNamedQueueRecord

protected abstract NamedQueueRecorder createNamedQueueRecord()

configureInfoServer

protected abstract void configureInfoServer(InfoServer infoServer)

getDumpServlet

protected abstract Class<? extends javax.servlet.http.HttpServlet> getDumpServlet()

canUpdateTableDescriptor

protected abstract boolean canUpdateTableDescriptor()

cacheTableDescriptor

protected abstract boolean cacheTableDescriptor()

clusterMode

protected abstract boolean clusterMode()