blob: bdba8a64c1905e1a37f497f3fe387dd9c3cd0f20 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>TestingHBaseCluster (Apache HBase 3.0.0-alpha-2-SNAPSHOT API)</title>
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="TestingHBaseCluster (Apache HBase 3.0.0-alpha-2-SNAPSHOT API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":17,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":6,"i12":6,"i13":6};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],16:["t5","Default Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/TestingHBaseCluster.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev&nbsp;Class</li>
<li><a href="../../../../../org/apache/hadoop/hbase/testing/TestingHBaseClusterOption.html" title="class in org.apache.hadoop.hbase.testing"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/hadoop/hbase/testing/TestingHBaseCluster.html" target="_top">Frames</a></li>
<li><a href="TestingHBaseCluster.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.hadoop.hbase.testing</div>
<h2 title="Interface TestingHBaseCluster" class="title">Interface TestingHBaseCluster</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>@InterfaceAudience.Public
public interface <a href="../../../../../src-html/org/apache/hadoop/hbase/testing/TestingHBaseCluster.html#line.36">TestingHBaseCluster</a></pre>
<div class="block">A mini hbase cluster used for testing.
<p/>
It will also start the necessary zookeeper cluster and dfs cluster. But we will not provide
methods for controlling the zookeeper cluster and dfs cluster, as end users do not need to test
the HBase behavior when these systems are broken.
<p/>
The implementation is not required to be thread safe, so do not call different methods
concurrently.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t5" class="tableTab"><span><a href="javascript:show(16);">Default Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>static <a href="../../../../../org/apache/hadoop/hbase/testing/TestingHBaseCluster.html" title="interface in org.apache.hadoop.hbase.testing">TestingHBaseCluster</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/testing/TestingHBaseCluster.html#create-org.apache.hadoop.hbase.testing.TestingHBaseClusterOption-">create</a></span>(<a href="../../../../../org/apache/hadoop/hbase/testing/TestingHBaseClusterOption.html" title="class in org.apache.hadoop.hbase.testing">TestingHBaseClusterOption</a>&nbsp;option)</code>
<div class="block">Create a <a href="../../../../../org/apache/hadoop/hbase/testing/TestingHBaseCluster.html" title="interface in org.apache.hadoop.hbase.testing"><code>TestingHBaseCluster</code></a>.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>org.apache.hadoop.conf.Configuration</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/testing/TestingHBaseCluster.html#getConf--">getConf</a></span>()</code>
<div class="block">Get configuration of this cluster.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/testing/TestingHBaseCluster.html#isClusterRunning--">isClusterRunning</a></span>()</code>
<div class="block">Return whether the cluster is running.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/testing/TestingHBaseCluster.html#isHBaseClusterRunning--">isHBaseClusterRunning</a></span>()</code>
<div class="block">Return whether the hbase cluster is running.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/testing/TestingHBaseCluster.html#start--">start</a></span>()</code>
<div class="block">Start the whole mini cluster, including zookeeper cluster, dfs cluster and hbase cluster.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/testing/TestingHBaseCluster.html#startHBaseCluster--">startHBaseCluster</a></span>()</code>
<div class="block">Start the hbase cluster.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/testing/TestingHBaseCluster.html#startMaster--">startMaster</a></span>()</code>
<div class="block">Start a new master with localhost and random port.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/testing/TestingHBaseCluster.html#startMaster-java.lang.String-int-">startMaster</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;hostname,
int&nbsp;port)</code>
<div class="block">Start a new master bind on the given host and port.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/testing/TestingHBaseCluster.html#startRegionServer--">startRegionServer</a></span>()</code>
<div class="block">Start a new region server with localhost and random port.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/testing/TestingHBaseCluster.html#startRegionServer-java.lang.String-int-">startRegionServer</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;hostname,
int&nbsp;port)</code>
<div class="block">Start a new region server bind on the given host and port.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/testing/TestingHBaseCluster.html#stop--">stop</a></span>()</code>
<div class="block">Stop the whole mini cluster, including zookeeper cluster, dfs cluster and hbase cluster.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/testing/TestingHBaseCluster.html#stopHBaseCluster--">stopHBaseCluster</a></span>()</code>
<div class="block">Stop the hbase cluster.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html?is-external=true" title="class or interface in java.util.concurrent">CompletableFuture</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Void.html?is-external=true" title="class or interface in java.lang">Void</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/testing/TestingHBaseCluster.html#stopMaster-org.apache.hadoop.hbase.ServerName-">stopMaster</a></span>(<a href="../../../../../org/apache/hadoop/hbase/ServerName.html" title="class in org.apache.hadoop.hbase">ServerName</a>&nbsp;serverName)</code>
<div class="block">Stop the given master.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html?is-external=true" title="class or interface in java.util.concurrent">CompletableFuture</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Void.html?is-external=true" title="class or interface in java.lang">Void</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/testing/TestingHBaseCluster.html#stopRegionServer-org.apache.hadoop.hbase.ServerName-">stopRegionServer</a></span>(<a href="../../../../../org/apache/hadoop/hbase/ServerName.html" title="class in org.apache.hadoop.hbase">ServerName</a>&nbsp;serverName)</code>
<div class="block">Stop the given region server.</div>
</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getConf--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getConf</h4>
<pre>org.apache.hadoop.conf.Configuration&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/testing/TestingHBaseCluster.html#line.44">getConf</a>()</pre>
<div class="block">Get configuration of this cluster.
<p/>
You could use the returned <code>Configuration</code> to create
<a href="../../../../../org/apache/hadoop/hbase/client/Connection.html" title="interface in org.apache.hadoop.hbase.client"><code>Connection</code></a> for accessing the testing cluster.</div>
</li>
</ul>
<a name="startMaster--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>startMaster</h4>
<pre>void&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/testing/TestingHBaseCluster.html#line.49">startMaster</a>()
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
<div class="block">Start a new master with localhost and random port.</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code></dd>
</dl>
</li>
</ul>
<a name="startMaster-java.lang.String-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>startMaster</h4>
<pre>void&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/testing/TestingHBaseCluster.html#line.54">startMaster</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;hostname,
int&nbsp;port)
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
<div class="block">Start a new master bind on the given host and port.</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code></dd>
</dl>
</li>
</ul>
<a name="stopMaster-org.apache.hadoop.hbase.ServerName-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>stopMaster</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html?is-external=true" title="class or interface in java.util.concurrent">CompletableFuture</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Void.html?is-external=true" title="class or interface in java.lang">Void</a>&gt;&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/testing/TestingHBaseCluster.html#line.64">stopMaster</a>(<a href="../../../../../org/apache/hadoop/hbase/ServerName.html" title="class in org.apache.hadoop.hbase">ServerName</a>&nbsp;serverName)
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
<div class="block">Stop the given master.
<p/>
Wait on the returned <a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html?is-external=true" title="class or interface in java.util.concurrent"><code>CompletableFuture</code></a> to wait on the master quit. The differences
comparing to <a href="../../../../../org/apache/hadoop/hbase/client/Admin.html#stopMaster--"><code>Admin.stopMaster()</code></a> 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.</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code></dd>
</dl>
</li>
</ul>
<a name="startRegionServer--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>startRegionServer</h4>
<pre>void&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/testing/TestingHBaseCluster.html#line.69">startRegionServer</a>()
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
<div class="block">Start a new region server with localhost and random port.</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code></dd>
</dl>
</li>
</ul>
<a name="startRegionServer-java.lang.String-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>startRegionServer</h4>
<pre>void&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/testing/TestingHBaseCluster.html#line.74">startRegionServer</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;hostname,
int&nbsp;port)
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
<div class="block">Start a new region server bind on the given host and port.</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code></dd>
</dl>
</li>
</ul>
<a name="stopRegionServer-org.apache.hadoop.hbase.ServerName-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>stopRegionServer</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html?is-external=true" title="class or interface in java.util.concurrent">CompletableFuture</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Void.html?is-external=true" title="class or interface in java.lang">Void</a>&gt;&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/testing/TestingHBaseCluster.html#line.83">stopRegionServer</a>(<a href="../../../../../org/apache/hadoop/hbase/ServerName.html" title="class in org.apache.hadoop.hbase">ServerName</a>&nbsp;serverName)
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
<div class="block">Stop the given region server.
<p/>
Wait on the returned <a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html?is-external=true" title="class or interface in java.util.concurrent"><code>CompletableFuture</code></a> to wait on the master quit. The difference
comparing to <a href="../../../../../org/apache/hadoop/hbase/client/Admin.html#stopMaster--"><code>Admin.stopMaster()</code></a> is that this method does
not always fail since we do not use rpc to stop the region server.</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code></dd>
</dl>
</li>
</ul>
<a name="stopHBaseCluster--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>stopHBaseCluster</h4>
<pre>void&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/testing/TestingHBaseCluster.html#line.92">stopHBaseCluster</a>()
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
<div class="block">Stop the hbase cluster.
<p/>
You need to call <a href="../../../../../org/apache/hadoop/hbase/testing/TestingHBaseCluster.html#start--"><code>start()</code></a> first before calling this method, otherwise an
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang"><code>IllegalStateException</code></a> will be thrown. If the hbase is not running because you have
already stopped the cluster, an <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang"><code>IllegalStateException</code></a> will be thrown too.</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code></dd>
</dl>
</li>
</ul>
<a name="startHBaseCluster--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>startHBaseCluster</h4>
<pre>void&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/testing/TestingHBaseCluster.html#line.101">startHBaseCluster</a>()
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
<div class="block">Start the hbase cluster.
<p/>
This is used to start the hbase cluster again after you call <a href="../../../../../org/apache/hadoop/hbase/testing/TestingHBaseCluster.html#stopHBaseCluster--"><code>stopHBaseCluster()</code></a>. If
the cluster is already running or you have not called <a href="../../../../../org/apache/hadoop/hbase/testing/TestingHBaseCluster.html#start--"><code>start()</code></a> yet, an
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang"><code>IllegalStateException</code></a> will be thrown.</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code></dd>
</dl>
</li>
</ul>
<a name="isHBaseClusterRunning--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isHBaseClusterRunning</h4>
<pre>boolean&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/testing/TestingHBaseCluster.html#line.106">isHBaseClusterRunning</a>()</pre>
<div class="block">Return whether the hbase cluster is running.</div>
</li>
</ul>
<a name="start--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>start</h4>
<pre>void&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/testing/TestingHBaseCluster.html#line.115">start</a>()
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
<div class="block">Start the whole mini cluster, including zookeeper cluster, dfs cluster and hbase cluster.
<p/>
You can only call this method once at the beginning, unless you have called <a href="../../../../../org/apache/hadoop/hbase/testing/TestingHBaseCluster.html#stop--"><code>stop()</code></a> to
shutdown the cluster completely, and then you can call this method to start the whole cluster
again. An <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang"><code>IllegalStateException</code></a> will be thrown if you call this method incorrectly.</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code></dd>
</dl>
</li>
</ul>
<a name="isClusterRunning--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isClusterRunning</h4>
<pre>boolean&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/testing/TestingHBaseCluster.html#line.124">isClusterRunning</a>()</pre>
<div class="block">Return whether the cluster is running.
<p/>
Notice that, this only means you have called <a href="../../../../../org/apache/hadoop/hbase/testing/TestingHBaseCluster.html#start--"><code>start()</code></a> and have not called
<a href="../../../../../org/apache/hadoop/hbase/testing/TestingHBaseCluster.html#stop--"><code>stop()</code></a> yet. If you want to make sure the hbase cluster is running, use
<a href="../../../../../org/apache/hadoop/hbase/testing/TestingHBaseCluster.html#isHBaseClusterRunning--"><code>isHBaseClusterRunning()</code></a>.</div>
</li>
</ul>
<a name="stop--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>stop</h4>
<pre>void&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/testing/TestingHBaseCluster.html#line.132">stop</a>()
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
<div class="block">Stop the whole mini cluster, including zookeeper cluster, dfs cluster and hbase cluster.
<p/>
You can only call this method after calling <a href="../../../../../org/apache/hadoop/hbase/testing/TestingHBaseCluster.html#start--"><code>start()</code></a>, otherwise an
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang"><code>IllegalStateException</code></a> will be thrown.</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code></dd>
</dl>
</li>
</ul>
<a name="create-org.apache.hadoop.hbase.testing.TestingHBaseClusterOption-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>create</h4>
<pre>static&nbsp;<a href="../../../../../org/apache/hadoop/hbase/testing/TestingHBaseCluster.html" title="interface in org.apache.hadoop.hbase.testing">TestingHBaseCluster</a>&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/testing/TestingHBaseCluster.html#line.138">create</a>(<a href="../../../../../org/apache/hadoop/hbase/testing/TestingHBaseClusterOption.html" title="class in org.apache.hadoop.hbase.testing">TestingHBaseClusterOption</a>&nbsp;option)</pre>
<div class="block">Create a <a href="../../../../../org/apache/hadoop/hbase/testing/TestingHBaseCluster.html" title="interface in org.apache.hadoop.hbase.testing"><code>TestingHBaseCluster</code></a>. You need to call <a href="../../../../../org/apache/hadoop/hbase/testing/TestingHBaseCluster.html#start--"><code>start()</code></a> of the returned
<a href="../../../../../org/apache/hadoop/hbase/testing/TestingHBaseCluster.html" title="interface in org.apache.hadoop.hbase.testing"><code>TestingHBaseCluster</code></a> to actually start the mini testing cluster.</div>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/TestingHBaseCluster.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev&nbsp;Class</li>
<li><a href="../../../../../org/apache/hadoop/hbase/testing/TestingHBaseClusterOption.html" title="class in org.apache.hadoop.hbase.testing"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/hadoop/hbase/testing/TestingHBaseCluster.html" target="_top">Frames</a></li>
<li><a href="TestingHBaseCluster.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2007&#x2013;2021 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>