org.apache.hadoop.hbase

Class DistributedHBaseCluster

java.lang.Object

org.apache.hadoop.hbase.HBaseCluster

org.apache.hadoop.hbase.DistributedHBaseCluster

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

@InterfaceAudience.Private
public class DistributedHBaseCluster
extends HBaseCluster

Manages the interactions with an already deployed distributed cluster (as opposed to a pseudo-distributed, or mini/local cluster). This is used by integration and system tests.

Field Summary

Fields inherited from class org.apache.hadoop.hbase.HBaseCluster

conf, initialClusterStatus

Constructor Summary

Constructors

Constructor and Description
DistributedHBaseCluster(Configuration conf, org.apache.hadoop.hbase.ClusterManager clusterManager)

Method Summary

Modifier and Type	Method and Description
void	close() Closes all the resources held open for this cluster.
AdminProtos.AdminService.BlockingInterface	getAdminProtocol(ServerName serverName) Returns an AdminProtocol interface to the regionserver
ClientProtos.ClientService.BlockingInterface	getClientProtocol(ServerName serverName) Returns a ClientProtocol interface to the regionserver
org.apache.hadoop.hbase.ClusterManager	getClusterManager()
ClusterStatus	getClusterStatus() Returns a ClusterStatus for this HBase cluster
ClusterStatus	getInitialClusterStatus() Returns a ClusterStatus for this HBase cluster as observed at the starting of the HBaseCluster
MasterProtos.MasterService.BlockingInterface	getMasterAdminService() Returns an MasterService.BlockingInterface to the active master
ServerName	getServerHoldingRegion(TableName tn, byte[] regionName) Get the ServerName of region server serving the specified region
boolean	isDistributedCluster()
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.
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.
protected boolean	restoreAdmin()
boolean	restoreClusterStatus(ClusterStatus initial) Restores the cluster to given state if this is a real cluster, otherwise does nothing.
protected boolean	restoreMasters(ClusterStatus initial, ClusterStatus current)
protected boolean	restoreRegionServers(ClusterStatus initial, ClusterStatus current)
void	setClusterManager(org.apache.hadoop.hbase.ClusterManager clusterManager)
void	shutdown() Shut down the HBase cluster
void	startMaster(java.lang.String hostname, int port) Starts a new master on the given hostname or if this is a mini/local cluster, starts a master locally.
void	startRegionServer(java.lang.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.
void	stopMaster(ServerName serverName) Stops the given master, by attempting a gradual stop.
void	stopRegionServer(ServerName serverName) Stops the given region server, by attempting a gradual stop.
boolean	waitForActiveAndReadyMaster(long timeout) Blocks until there is an active master and that master has completed initialization.
void	waitForMasterToStop(ServerName serverName, long timeout) Wait for the specified master to stop the thread / process.
void	waitForRegionServerToStop(ServerName serverName, long timeout) Wait for the specified region server to stop the thread / process.
void	waitUntilShutDown() Wait for HBase Cluster to shut down.

Methods inherited from class org.apache.hadoop.hbase.HBaseCluster

getConf, getServerHoldingMeta, restoreInitialStatus, setConf, waitForActiveAndReadyMaster, waitForDatanodesRegistered, waitForNamenodeAvailable, waitForRegionServerToStart

Methods inherited from class java.lang.Object

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

Constructor Detail

DistributedHBaseCluster

public DistributedHBaseCluster(Configuration conf,
                               org.apache.hadoop.hbase.ClusterManager clusterManager)
                        throws java.io.IOException

Throws:

java.io.IOException

Method Detail

setClusterManager

public void setClusterManager(org.apache.hadoop.hbase.ClusterManager clusterManager)

getClusterManager

public org.apache.hadoop.hbase.ClusterManager getClusterManager()

getClusterStatus

public ClusterStatus getClusterStatus()
                               throws java.io.IOException

Returns a ClusterStatus for this HBase cluster

Specified by:

getClusterStatus in class HBaseCluster

Throws:

java.io.IOException

See Also:

HBaseCluster.getInitialClusterStatus()

getInitialClusterStatus

public ClusterStatus getInitialClusterStatus()
                                      throws java.io.IOException

Description copied from class: HBaseCluster

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

Overrides:

getInitialClusterStatus in class HBaseCluster

Throws:

java.io.IOException

close

public void close()
           throws java.io.IOException

Description copied from class: HBaseCluster

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

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Specified by:

close in class HBaseCluster

Throws:

java.io.IOException

See Also:

HBaseCluster.shutdown()

getAdminProtocol

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

Description copied from class: HBaseCluster

Returns an AdminProtocol interface to the regionserver

Specified by:

getAdminProtocol in class HBaseCluster

Throws:

java.io.IOException

getClientProtocol

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

Description copied from class: HBaseCluster

Returns a ClientProtocol interface to the regionserver

Specified by:

getClientProtocol in class HBaseCluster

Throws:

java.io.IOException

startRegionServer

public void startRegionServer(java.lang.String hostname,
                              int port)
                       throws java.io.IOException

Description copied from class: HBaseCluster

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

Specified by:

startRegionServer in class HBaseCluster

Parameters:

hostname - the hostname to start the regionserver on

Throws:

java.io.IOException - if something goes wrong

killRegionServer

public void killRegionServer(ServerName serverName)
                      throws java.io.IOException

Description copied from class: HBaseCluster

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

Specified by:

killRegionServer in class HBaseCluster

Throws:

java.io.IOException - if something goes wrong

stopRegionServer

public void stopRegionServer(ServerName serverName)
                      throws java.io.IOException

Description copied from class: HBaseCluster

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

Specified by:

stopRegionServer in class HBaseCluster

Throws:

java.io.IOException - if something goes wrong

waitForRegionServerToStop

public void waitForRegionServerToStop(ServerName serverName,
                                      long timeout)
                               throws java.io.IOException

Description copied from class: HBaseCluster

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

Specified by:

waitForRegionServerToStop in class HBaseCluster

Throws:

java.io.IOException - if something goes wrong or timeout occurs

getMasterAdminService

public MasterProtos.MasterService.BlockingInterface getMasterAdminService()
                                                                   throws java.io.IOException

Description copied from class: HBaseCluster

Returns an MasterService.BlockingInterface to the active master

Specified by:

getMasterAdminService in class HBaseCluster

Throws:

java.io.IOException

startMaster

public void startMaster(java.lang.String hostname,
                        int port)
                 throws java.io.IOException

Description copied from class: HBaseCluster

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

Specified by:

startMaster in class HBaseCluster

Parameters:

hostname - the hostname to start the master on

Throws:

java.io.IOException - if something goes wrong

killMaster

public void killMaster(ServerName serverName)
                throws java.io.IOException

Description copied from class: HBaseCluster

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

Specified by:

killMaster in class HBaseCluster

Throws:

java.io.IOException - if something goes wrong

stopMaster

public void stopMaster(ServerName serverName)
                throws java.io.IOException

Description copied from class: HBaseCluster

Stops the given master, by attempting a gradual stop.

Specified by:

stopMaster in class HBaseCluster

Throws:

java.io.IOException - if something goes wrong

waitForMasterToStop

public void waitForMasterToStop(ServerName serverName,
                                long timeout)
                         throws java.io.IOException

Description copied from class: HBaseCluster

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

Specified by:

waitForMasterToStop in class HBaseCluster

Throws:

java.io.IOException - if something goes wrong or timeout occurs

waitForActiveAndReadyMaster

public boolean waitForActiveAndReadyMaster(long timeout)
                                    throws java.io.IOException

Description copied from class: HBaseCluster

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

Specified by:

waitForActiveAndReadyMaster in class HBaseCluster

Parameters:

timeout - the timeout limit in ms

Returns:

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

Throws:

java.io.IOException

getServerHoldingRegion

public ServerName getServerHoldingRegion(TableName tn,
                                         byte[] regionName)
                                  throws java.io.IOException

Description copied from class: HBaseCluster

Get the ServerName of region server serving the specified region

Specified by:

getServerHoldingRegion in class HBaseCluster

Parameters:

tn - Table name that has the region.

regionName - Name of the region in bytes

Returns:

ServerName that hosts the region or null

Throws:

java.io.IOException

waitUntilShutDown

public void waitUntilShutDown()

Description copied from class: HBaseCluster

Wait for HBase Cluster to shut down.

Specified by:

waitUntilShutDown in class HBaseCluster

shutdown

public void shutdown()
              throws java.io.IOException

Description copied from class: HBaseCluster

Shut down the HBase cluster

Specified by:

shutdown in class HBaseCluster

Throws:

java.io.IOException

isDistributedCluster

public boolean isDistributedCluster()

Overrides:

isDistributedCluster in class HBaseCluster

Returns:

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

restoreClusterStatus

public boolean restoreClusterStatus(ClusterStatus initial)
                             throws java.io.IOException

Description copied from class: HBaseCluster

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.

Overrides:

restoreClusterStatus in class HBaseCluster

Returns:

whether restoration is complete

Throws:

java.io.IOException

restoreMasters

protected boolean restoreMasters(ClusterStatus initial,
                                 ClusterStatus current)

restoreRegionServers

protected boolean restoreRegionServers(ClusterStatus initial,
                                       ClusterStatus current)

restoreAdmin

protected boolean restoreAdmin()
                        throws java.io.IOException

Throws:

java.io.IOException