org.apache.hadoop.hbase

Class HBaseCluster

java.lang.Object

org.apache.hadoop.hbase.HBaseCluster

All Implemented Interfaces:

Closeable, AutoCloseable

Direct Known Subclasses:

DistributedHBaseCluster, MiniHBaseCluster

@InterfaceAudience.Private
public abstract class HBaseCluster
extends Object
implements Closeable

This class defines methods that can help with managing HBase clusters from unit tests and system tests. There are 3 types of cluster deployments:

• MiniHBaseCluster: each server is run in the same JVM in separate threads, used by unit tests
• DistributedHBaseCluster: the cluster is pre-deployed, system and integration tests can interact with the cluster.
• ProcessBasedLocalHBaseCluster: each server is deployed locally but in separate JVMs.

HBaseCluster unifies the way tests interact with the cluster, so that the same test can be run against a mini-cluster during unit test execution, or a distributed cluster having tens/hundreds of nodes during execution of integration tests.

HBaseCluster exposes client-side public interfaces to tests, so that tests does not assume running in a particular mode. Not all the tests are suitable to be run on an actual cluster, and some tests will still need to mock stuff and introspect internal state. For those use cases from unit tests, or if more control is needed, you can use the subclasses directly. In that sense, this class does not abstract away every interface that MiniHBaseCluster or DistributedHBaseCluster provide.

Field Summary

Fields

Modifier and Type	Field and Description
protected Configuration	conf
protected ClusterStatus	initialClusterStatus the status of the cluster before we begin

Constructor Summary

Constructors

Constructor and Description
HBaseCluster(Configuration conf) Construct an HBaseCluster

Method Summary

Modifier and Type	Method and Description
abstract void	close() Closes all the resources held open for this cluster.
abstract AdminProtos.AdminService.BlockingInterface	getAdminProtocol(ServerName serverName) Returns an AdminProtocol interface to the regionserver
abstract ClientProtos.ClientService.BlockingInterface	getClientProtocol(ServerName serverName) Returns a ClientProtocol interface to the regionserver
abstract ClusterStatus	getClusterStatus() Returns a ClusterStatus for this HBase cluster.
Configuration	getConf()
ClusterStatus	getInitialClusterStatus() Returns a ClusterStatus for this HBase cluster as observed at the starting of the HBaseCluster
abstract MasterProtos.MasterService.BlockingInterface	getMasterAdminService() Returns an MasterService.BlockingInterface to the active master
ServerName	getServerHoldingMeta() Get the ServerName of region server serving the first hbase:meta region
abstract ServerName	getServerHoldingRegion(TableName tn, byte[] regionName) Get the ServerName of region server serving the specified region
boolean	isDistributedCluster()
abstract void	killMaster(ServerName serverName) Kills the master process if this is a distributed cluster, otherwise, this causes master to exit doing basic clean up only.
abstract void	killRegionServer(ServerName serverName) Kills the region server process if this is a distributed cluster, otherwise this causes the region server to exit doing basic clean up only.
boolean	restoreClusterStatus(ClusterStatus desiredStatus) Restores the cluster to given state if this is a real cluster, otherwise does nothing.
boolean	restoreInitialStatus() Restores the cluster to it's initial state if this is a real cluster, otherwise does nothing.
void	setConf(Configuration conf)
abstract void	shutdown() Shut down the HBase cluster
abstract void	startMaster(String hostname, int port) Starts a new master on the given hostname or if this is a mini/local cluster, starts a master locally.
abstract void	startRegionServer(String hostname, int port) Starts a new region server on the given hostname or if this is a mini/local cluster, starts a region server locally.
abstract void	stopMaster(ServerName serverName) Stops the given master, by attempting a gradual stop.
abstract void	stopRegionServer(ServerName serverName) Stops the given region server, by attempting a gradual stop.
boolean	waitForActiveAndReadyMaster() Blocks until there is an active master and that master has completed initialization.
abstract boolean	waitForActiveAndReadyMaster(long timeout) Blocks until there is an active master and that master has completed initialization.
void	waitForDatanodesRegistered(int nbDN)
abstract void	waitForMasterToStop(ServerName serverName, long timeout) Wait for the specified master to stop the thread / process.
void	waitForNamenodeAvailable() Wait for the namenode.
void	waitForRegionServerToStart(String hostname, int port, long timeout) Wait for the specified region server to join the cluster
abstract void	waitForRegionServerToStop(ServerName serverName, long timeout) Wait for the specified region server to stop the thread / process.
abstract void	waitUntilShutDown() Wait for HBase Cluster to shut down.

Methods inherited from class java.lang.Object

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

Field Detail

conf

protected Configuration conf

initialClusterStatus

protected ClusterStatus initialClusterStatus

the status of the cluster before we begin

Constructor Detail

HBaseCluster

public HBaseCluster(Configuration conf)

Construct an HBaseCluster

Parameters:

conf - Configuration to be used for cluster

Method Detail

setConf

public void setConf(Configuration conf)

getConf

public Configuration getConf()

getClusterStatus

public abstract ClusterStatus getClusterStatus()
                                        throws IOException

Returns a ClusterStatus for this HBase cluster.

Throws:

IOException

See Also:

getInitialClusterStatus()

getInitialClusterStatus

public ClusterStatus getInitialClusterStatus()
                                      throws IOException

Returns a ClusterStatus for this HBase cluster as observed at the starting of the HBaseCluster

Throws:

IOException

getMasterAdminService

public abstract MasterProtos.MasterService.BlockingInterface getMasterAdminService()
                                                                            throws IOException

Returns an MasterService.BlockingInterface to the active master

Throws:

IOException

getAdminProtocol

public abstract AdminProtos.AdminService.BlockingInterface getAdminProtocol(ServerName serverName)
                                                                     throws IOException

Returns an AdminProtocol interface to the regionserver

Throws:

IOException

getClientProtocol

public abstract ClientProtos.ClientService.BlockingInterface getClientProtocol(ServerName serverName)
                                                                        throws IOException

Returns a ClientProtocol interface to the regionserver

Throws:

IOException

startRegionServer

public abstract void startRegionServer(String hostname,
                                       int port)
                                throws IOException

Starts a new region server on the given hostname or if this is a mini/local cluster, starts a region server locally.

Parameters:

hostname - the hostname to start the regionserver on

Throws:

IOException - if something goes wrong

killRegionServer

public abstract void killRegionServer(ServerName serverName)
                               throws IOException

Kills the region server process if this is a distributed cluster, otherwise this causes the region server to exit doing basic clean up only.

Throws:

IOException - if something goes wrong

stopRegionServer

public abstract void stopRegionServer(ServerName serverName)
                               throws IOException

Stops the given region server, by attempting a gradual stop.

Throws:

IOException - if something goes wrong

waitForRegionServerToStart

public void waitForRegionServerToStart(String hostname,
                                       int port,
                                       long timeout)
                                throws IOException

Wait for the specified region server to join the cluster

Throws:

IOException - if something goes wrong or timeout occurs

waitForRegionServerToStop

public abstract void waitForRegionServerToStop(ServerName serverName,
                                               long timeout)
                                        throws IOException

Wait for the specified region server to stop the thread / process.

Throws:

IOException - if something goes wrong or timeout occurs

startMaster

public abstract void startMaster(String hostname,
                                 int port)
                          throws IOException

Starts a new master on the given hostname or if this is a mini/local cluster, starts a master locally.

Parameters:

hostname - the hostname to start the master on

Throws:

IOException - if something goes wrong

killMaster

public abstract void killMaster(ServerName serverName)
                         throws IOException

Kills the master process if this is a distributed cluster, otherwise, this causes master to exit doing basic clean up only.

Throws:

IOException - if something goes wrong

stopMaster

public abstract void stopMaster(ServerName serverName)
                         throws IOException

Stops the given master, by attempting a gradual stop.

Throws:

IOException - if something goes wrong

waitForMasterToStop

public abstract void waitForMasterToStop(ServerName serverName,
                                         long timeout)
                                  throws IOException

Wait for the specified master to stop the thread / process.

Throws:

IOException - if something goes wrong or timeout occurs

waitForActiveAndReadyMaster

public boolean waitForActiveAndReadyMaster()
                                    throws IOException

Blocks until there is an active master and that master has completed initialization.

Returns:

true if an active master becomes available. false if there are no masters left.

Throws:

IOException - if something goes wrong or timeout occurs

waitForActiveAndReadyMaster

public abstract boolean waitForActiveAndReadyMaster(long timeout)
                                             throws IOException

Blocks until there is an active master and that master has completed initialization.

Parameters:

timeout - the timeout limit in ms

Returns:

true if an active master becomes available. false if there are no masters left.

Throws:

IOException

waitUntilShutDown

public abstract void waitUntilShutDown()
                                throws IOException

Wait for HBase Cluster to shut down.

Throws:

IOException

shutdown

public abstract void shutdown()
                       throws IOException

Shut down the HBase cluster

Throws:

IOException

restoreInitialStatus

public boolean restoreInitialStatus()
                             throws IOException

Restores the cluster to it's initial state if this is a real cluster, otherwise does nothing. This is a best effort restore. If the servers are not reachable, or insufficient permissions, etc. restoration might be partial.

Returns:

whether restoration is complete

Throws:

IOException

restoreClusterStatus

public boolean restoreClusterStatus(ClusterStatus desiredStatus)
                             throws IOException

Restores the cluster to given state if this is a real cluster, otherwise does nothing. This is a best effort restore. If the servers are not reachable, or insufficient permissions, etc. restoration might be partial.

Returns:

whether restoration is complete

Throws:

IOException

getServerHoldingMeta

public ServerName getServerHoldingMeta()
                                throws IOException

Get the ServerName of region server serving the first hbase:meta region

Throws:

IOException

getServerHoldingRegion

public abstract ServerName getServerHoldingRegion(TableName tn,
                                                  byte[] regionName)
                                           throws IOException

Get the ServerName of region server serving the specified region

Parameters:

regionName - Name of the region in bytes

tn - Table name that has the region.

Returns:

ServerName that hosts the region or null

Throws:

IOException

isDistributedCluster

public boolean isDistributedCluster()

Returns:

whether we are interacting with a distributed cluster as opposed to an in-process mini/local cluster.

close

public abstract void close()
                    throws IOException

Closes all the resources held open for this cluster. Note that this call does not shutdown the cluster.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException

See Also:

shutdown()

waitForNamenodeAvailable

public void waitForNamenodeAvailable()
                              throws InterruptedException

Wait for the namenode.

Throws:

InterruptedException

waitForDatanodesRegistered

public void waitForDatanodesRegistered(int nbDN)
                                throws Exception

Throws:

Exception