org.apache.hadoop.hbase.testing

Class TestingHBaseClusterImpl

java.lang.Object

org.apache.hadoop.hbase.testing.TestingHBaseClusterImpl

All Implemented Interfaces:

TestingHBaseCluster

@InterfaceAudience.Private
class TestingHBaseClusterImpl
extends Object
implements TestingHBaseCluster

Field Summary

Fields

Modifier and Type	Field and Description
private ExecutorService	executor
private String	externalDfsUri
private String	externalZkConnectString
private boolean	miniClusterRunning
private boolean	miniHBaseClusterRunning
private StartMiniClusterOption	option
private HBaseTestingUtility	util

Constructor Summary

Constructors

Constructor and Description
TestingHBaseClusterImpl(TestingHBaseClusterOption option)

Method Summary

Modifier and Type	Method and Description
Optional<ServerName>	getActiveMasterAddress() Get the address of active master if there is one.
List<ServerName>	getBackupMasterAddresses() Get all the backup master addresses.
org.apache.hadoop.conf.Configuration	getConf() Get configuration of this cluster.
private int	getMasterIndex(ServerName serverName)
Optional<OnlineRegions>	getOnlineRegionsInterface(ServerName serverName) Get the server side OnlineRegions interface for the specific region server.
Optional<Region>	getRegion(RegionInfo regionInfo) Get the server side Region interface for the specific region.
List<ServerName>	getRegionServerAddresses() Get all the region server addresses.
private int	getRegionServerIndex(ServerName serverName)
boolean	isClusterRunning() Return whether the cluster is running.
boolean	isHBaseClusterRunning() Return whether the hbase cluster is running.
private void	join(Thread thread, CompletableFuture<?> future)
void	start() Start the whole mini cluster, including zookeeper cluster, dfs cluster and hbase cluster.
void	startHBaseCluster() Start the hbase cluster.
void	startMaster() Start a new master with localhost and random port.
void	startMaster(String hostname, int port) Start a new master bind on the given host and port.
void	startRegionServer() Start a new region server with localhost and random port.
void	startRegionServer(String hostname, int port) Start a new region server bind on the given host and port.
void	stop() Stop the whole mini cluster, including zookeeper cluster, dfs cluster and hbase cluster.
void	stopHBaseCluster() Stop the hbase cluster.
CompletableFuture<Void>	stopMaster(ServerName serverName) Stop the given master.
CompletableFuture<Void>	stopRegionServer(ServerName serverName) Stop the given region server.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.hadoop.hbase.testing.TestingHBaseCluster

create

Field Detail

util

private final HBaseTestingUtility util

option

private final StartMiniClusterOption option

externalDfsUri

private final String externalDfsUri

externalZkConnectString

private final String externalZkConnectString

executor

private final ExecutorService executor

miniClusterRunning

private boolean miniClusterRunning

miniHBaseClusterRunning

private boolean miniHBaseClusterRunning

Constructor Detail

TestingHBaseClusterImpl

TestingHBaseClusterImpl(TestingHBaseClusterOption option)

Method Detail

getConf

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

Description copied from interface: TestingHBaseCluster

Get configuration of this cluster.

You could use the returned Configuration to create Connection for accessing the testing cluster.

Specified by:

getConf in interface TestingHBaseCluster

getRegionServerIndex

private int getRegionServerIndex(ServerName serverName)

getMasterIndex

private int getMasterIndex(ServerName serverName)

join

private void join(Thread thread,
                  CompletableFuture<?> future)

stopMaster

public CompletableFuture<Void> stopMaster(ServerName serverName)
                                   throws Exception

Description copied from interface: TestingHBaseCluster

Stop the given master.

Wait on the returned CompletableFuture to wait on the master quit. The differences comparing to Admin.stopMaster() is that first, we could also stop backup masters here, second, this method does not always fail since we do not use rpc to stop the master.

Specified by:

stopMaster in interface TestingHBaseCluster

Throws:

Exception

stopRegionServer

public CompletableFuture<Void> stopRegionServer(ServerName serverName)
                                         throws Exception

Description copied from interface: TestingHBaseCluster

Stop the given region server.

Wait on the returned CompletableFuture to wait on the master quit. The difference comparing to Admin.stopMaster() is that this method does not always fail since we do not use rpc to stop the region server.

Specified by:

stopRegionServer in interface TestingHBaseCluster

Throws:

Exception

stopHBaseCluster

public void stopHBaseCluster()
                      throws Exception

Description copied from interface: TestingHBaseCluster

Stop the hbase cluster.

You need to call TestingHBaseCluster.start() first before calling this method, otherwise an IllegalStateException will be thrown. If the hbase is not running because you have already stopped the cluster, an IllegalStateException will be thrown too.

Specified by:

stopHBaseCluster in interface TestingHBaseCluster

Throws:

Exception

startHBaseCluster

public void startHBaseCluster()
                       throws Exception

Description copied from interface: TestingHBaseCluster

Start the hbase cluster.

This is used to start the hbase cluster again after you call TestingHBaseCluster.stopHBaseCluster(). If the cluster is already running or you have not called TestingHBaseCluster.start() yet, an IllegalStateException will be thrown.

Specified by:

startHBaseCluster in interface TestingHBaseCluster

Throws:

Exception

start

public void start()
           throws Exception

Description copied from interface: TestingHBaseCluster

Start the whole mini cluster, including zookeeper cluster, dfs cluster and hbase cluster.

You can only call this method once at the beginning, unless you have called TestingHBaseCluster.stop() to shutdown the cluster completely, and then you can call this method to start the whole cluster again. An IllegalStateException will be thrown if you call this method incorrectly.

Specified by:

start in interface TestingHBaseCluster

Throws:

Exception

stop

public void stop()
          throws Exception

Description copied from interface: TestingHBaseCluster

Stop the whole mini cluster, including zookeeper cluster, dfs cluster and hbase cluster.

You can only call this method after calling TestingHBaseCluster.start(), otherwise an IllegalStateException will be thrown.

Specified by:

stop in interface TestingHBaseCluster

Throws:

Exception

isHBaseClusterRunning

public boolean isHBaseClusterRunning()

Description copied from interface: TestingHBaseCluster

Return whether the hbase cluster is running.

Specified by:

isHBaseClusterRunning in interface TestingHBaseCluster

isClusterRunning

public boolean isClusterRunning()

Description copied from interface: TestingHBaseCluster

Return whether the cluster is running.

Notice that, this only means you have called TestingHBaseCluster.start() and have not called TestingHBaseCluster.stop() yet. If you want to make sure the hbase cluster is running, use TestingHBaseCluster.isHBaseClusterRunning().

Specified by:

isClusterRunning in interface TestingHBaseCluster

startMaster

public void startMaster()
                 throws Exception

Description copied from interface: TestingHBaseCluster

Start a new master with localhost and random port.

Specified by:

startMaster in interface TestingHBaseCluster

Throws:

Exception

startMaster

public void startMaster(String hostname,
                        int port)
                 throws Exception

Description copied from interface: TestingHBaseCluster

Start a new master bind on the given host and port.

Specified by:

startMaster in interface TestingHBaseCluster

Throws:

Exception

startRegionServer

public void startRegionServer()
                       throws Exception

Description copied from interface: TestingHBaseCluster

Start a new region server with localhost and random port.

Specified by:

startRegionServer in interface TestingHBaseCluster

Throws:

Exception

startRegionServer

public void startRegionServer(String hostname,
                              int port)
                       throws Exception

Description copied from interface: TestingHBaseCluster

Start a new region server bind on the given host and port.

Specified by:

startRegionServer in interface TestingHBaseCluster

Throws:

Exception

getActiveMasterAddress

public Optional<ServerName> getActiveMasterAddress()

Description copied from interface: TestingHBaseCluster

Get the address of active master if there is one.

Specified by:

getActiveMasterAddress in interface TestingHBaseCluster

getBackupMasterAddresses

public List<ServerName> getBackupMasterAddresses()

Description copied from interface: TestingHBaseCluster

Get all the backup master addresses.

Specified by:

getBackupMasterAddresses in interface TestingHBaseCluster

getRegionServerAddresses

public List<ServerName> getRegionServerAddresses()

Description copied from interface: TestingHBaseCluster

Get all the region server addresses.

Specified by:

getRegionServerAddresses in interface TestingHBaseCluster

getRegion

public Optional<Region> getRegion(RegionInfo regionInfo)

Description copied from interface: TestingHBaseCluster

Get the server side Region interface for the specific region.

This is used for CPs to test something which can only be accessed at server side, such as tags.

Specified by:

getRegion in interface TestingHBaseCluster

getOnlineRegionsInterface

public Optional<OnlineRegions> getOnlineRegionsInterface(ServerName serverName)

Description copied from interface: TestingHBaseCluster

Get the server side OnlineRegions interface for the specific region server.

You could list the addresses of all the region server through the TestingHBaseCluster.getRegionServerAddresses() method.

This is used for CPs to test something which can only be accessed at server side, such as tags. And also you could use the returned interface to get all regions on this region server, etc.

Specified by:

getOnlineRegionsInterface in interface TestingHBaseCluster