blob: a46682e7a82025152ea7adb9e53da5f956c25212 [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>HBaseZKTestingUtil (Apache HBase 3.0.0-alpha-2-SNAPSHOT Test 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="HBaseZKTestingUtil (Apache HBase 3.0.0-alpha-2-SNAPSHOT Test API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":9,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete 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/HBaseZKTestingUtil.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><a href="../../../../org/apache/hadoop/hbase/HBaseTestingUtil.SeenRowTracker.html" title="class in org.apache.hadoop.hbase"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/apache/hadoop/hbase/HFilePerformanceEvaluation.html" title="class in org.apache.hadoop.hbase"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/hadoop/hbase/HBaseZKTestingUtil.html" target="_top">Frames</a></li>
<li><a href="HBaseZKTestingUtil.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><a href="#nested.classes.inherited.from.class.org.apache.hadoop.hbase.HBaseCommonTestingUtil">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&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</div>
<h2 title="Class HBaseZKTestingUtil" class="title">Class HBaseZKTestingUtil</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li><a href="../../../../org/apache/hadoop/hbase/HBaseCommonTestingUtil.html" title="class in org.apache.hadoop.hbase">org.apache.hadoop.hbase.HBaseCommonTestingUtil</a></li>
<li>
<ul class="inheritance">
<li>org.apache.hadoop.hbase.HBaseZKTestingUtil</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><a href="../../../../org/apache/hadoop/hbase/HBaseTestingUtil.html" title="class in org.apache.hadoop.hbase">HBaseTestingUtil</a></dd>
</dl>
<hr>
<br>
<pre>@InterfaceAudience.LimitedPrivate(value="Phoenix")
@InterfaceStability.Evolving
public class <a href="../../../../src-html/org/apache/hadoop/hbase/HBaseZKTestingUtil.html#line.35">HBaseZKTestingUtil</a>
extends <a href="../../../../org/apache/hadoop/hbase/HBaseCommonTestingUtil.html" title="class in org.apache.hadoop.hbase">HBaseCommonTestingUtil</a></pre>
<div class="block">Helpers for testing HBase that do not depend on specific server/etc. things. The main difference
from <a href="../../../../org/apache/hadoop/hbase/HBaseCommonTestingUtil.html" title="class in org.apache.hadoop.hbase"><code>HBaseCommonTestingUtil</code></a> is that we can start a zookeeper cluster.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="nested.class.summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<ul class="blockList">
<li class="blockList"><a name="nested.classes.inherited.from.class.org.apache.hadoop.hbase.HBaseCommonTestingUtil">
<!-- -->
</a>
<h3>Nested classes/interfaces inherited from class&nbsp;org.apache.hadoop.hbase.<a href="../../../../org/apache/hadoop/hbase/HBaseCommonTestingUtil.html" title="class in org.apache.hadoop.hbase">HBaseCommonTestingUtil</a></h3>
<code><a href="../../../../org/apache/hadoop/hbase/HBaseCommonTestingUtil.PortAllocator.html" title="class in org.apache.hadoop.hbase">HBaseCommonTestingUtil.PortAllocator</a></code></li>
</ul>
</li>
</ul>
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/HBaseZKTestingUtil.html#clusterTestDir">clusterTestDir</a></span></code>
<div class="block">Directory (a subdirectory of dataTestDir) used by the dfs cluster if any</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>private boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/HBaseZKTestingUtil.html#passedZkCluster">passedZkCluster</a></span></code>
<div class="block">Set if we were passed a zkCluster.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>private org.apache.hadoop.hbase.zookeeper.MiniZooKeeperCluster</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/HBaseZKTestingUtil.html#zkCluster">zkCluster</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected org.apache.hadoop.hbase.zookeeper.ZKWatcher</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/HBaseZKTestingUtil.html#zooKeeperWatcher">zooKeeperWatcher</a></span></code>&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="fields.inherited.from.class.org.apache.hadoop.hbase.HBaseCommonTestingUtil">
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;org.apache.hadoop.hbase.<a href="../../../../org/apache/hadoop/hbase/HBaseCommonTestingUtil.html" title="class in org.apache.hadoop.hbase">HBaseCommonTestingUtil</a></h3>
<code><a href="../../../../org/apache/hadoop/hbase/HBaseCommonTestingUtil.html#BASE_TEST_DIRECTORY_KEY">BASE_TEST_DIRECTORY_KEY</a>, <a href="../../../../org/apache/hadoop/hbase/HBaseCommonTestingUtil.html#BOOLEAN_PARAMETERIZED">BOOLEAN_PARAMETERIZED</a>, <a href="../../../../org/apache/hadoop/hbase/HBaseCommonTestingUtil.html#COMPRESSION_ALGORITHMS">COMPRESSION_ALGORITHMS</a>, <a href="../../../../org/apache/hadoop/hbase/HBaseCommonTestingUtil.html#COMPRESSION_ALGORITHMS_PARAMETERIZED">COMPRESSION_ALGORITHMS_PARAMETERIZED</a>, <a href="../../../../org/apache/hadoop/hbase/HBaseCommonTestingUtil.html#conf">conf</a>, <a href="../../../../org/apache/hadoop/hbase/HBaseCommonTestingUtil.html#DEFAULT_BASE_TEST_DIRECTORY">DEFAULT_BASE_TEST_DIRECTORY</a>, <a href="../../../../org/apache/hadoop/hbase/HBaseCommonTestingUtil.html#LOG">LOG</a>, <a href="../../../../org/apache/hadoop/hbase/HBaseCommonTestingUtil.html#random">random</a></code></li>
</ul>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/HBaseZKTestingUtil.html#HBaseZKTestingUtil--">HBaseZKTestingUtil</a></span>()</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/HBaseZKTestingUtil.html#HBaseZKTestingUtil-org.apache.hadoop.conf.Configuration-">HBaseZKTestingUtil</a></span>(org.apache.hadoop.conf.Configuration&nbsp;conf)</code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ========== 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="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete 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>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/HBaseZKTestingUtil.html#cleanupTestDir--">cleanupTestDir</a></span>()</code>
<div class="block">Returns true if we removed the test dirs</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>(package private) org.apache.hadoop.fs.Path</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/HBaseZKTestingUtil.html#getClusterTestDir--">getClusterTestDir</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>org.apache.hadoop.hbase.zookeeper.MiniZooKeeperCluster</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/HBaseZKTestingUtil.html#getZkCluster--">getZkCluster</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>org.apache.hadoop.hbase.zookeeper.ZKWatcher</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/HBaseZKTestingUtil.html#getZooKeeperWatcher--">getZooKeeperWatcher</a></span>()</code>
<div class="block">Returns a ZKWatcher instance.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>static org.apache.hadoop.hbase.zookeeper.ZKWatcher</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/HBaseZKTestingUtil.html#getZooKeeperWatcher-org.apache.hadoop.hbase.HBaseZKTestingUtil-">getZooKeeperWatcher</a></span>(<a href="../../../../org/apache/hadoop/hbase/HBaseZKTestingUtil.html" title="class in org.apache.hadoop.hbase">HBaseZKTestingUtil</a>&nbsp;testUtil)</code>
<div class="block">Gets a ZKWatcher.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/HBaseZKTestingUtil.html#setupClusterTestDir--">setupClusterTestDir</a></span>()</code>
<div class="block">Creates a directory for the cluster, under the test data</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/HBaseZKTestingUtil.html#setZkCluster-org.apache.hadoop.hbase.zookeeper.MiniZooKeeperCluster-">setZkCluster</a></span>(org.apache.hadoop.hbase.zookeeper.MiniZooKeeperCluster&nbsp;zkCluster)</code>&nbsp;</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/HBaseZKTestingUtil.html#shutdownMiniZKCluster--">shutdownMiniZKCluster</a></span>()</code>
<div class="block">Shuts down zk cluster created by call to <a href="../../../../org/apache/hadoop/hbase/HBaseZKTestingUtil.html#startMiniZKCluster--"><code>startMiniZKCluster()</code></a> or does nothing.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>org.apache.hadoop.hbase.zookeeper.MiniZooKeeperCluster</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/HBaseZKTestingUtil.html#startMiniZKCluster--">startMiniZKCluster</a></span>()</code>
<div class="block">Call this if you only want a zk cluster.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>private org.apache.hadoop.hbase.zookeeper.MiniZooKeeperCluster</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/HBaseZKTestingUtil.html#startMiniZKCluster-java.io.File-int-int:A-">startMiniZKCluster</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a>&nbsp;dir,
int&nbsp;zooKeeperServerNum,
int[]&nbsp;clientPortList)</code>
<div class="block">Start a mini ZK cluster.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>org.apache.hadoop.hbase.zookeeper.MiniZooKeeperCluster</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/HBaseZKTestingUtil.html#startMiniZKCluster-int-int...-">startMiniZKCluster</a></span>(int&nbsp;zooKeeperServerNum,
int...&nbsp;clientPortList)</code>
<div class="block">Call this if you only want a zk cluster.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.hadoop.hbase.HBaseCommonTestingUtil">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.hadoop.hbase.<a href="../../../../org/apache/hadoop/hbase/HBaseCommonTestingUtil.html" title="class in org.apache.hadoop.hbase">HBaseCommonTestingUtil</a></h3>
<code><a href="../../../../org/apache/hadoop/hbase/HBaseCommonTestingUtil.html#cleanupTestDir-java.lang.String-">cleanupTestDir</a>, <a href="../../../../org/apache/hadoop/hbase/HBaseCommonTestingUtil.html#createSubDir-java.lang.String-org.apache.hadoop.fs.Path-java.lang.String-">createSubDir</a>, <a href="../../../../org/apache/hadoop/hbase/HBaseCommonTestingUtil.html#deleteDir-java.io.File-">deleteDir</a>, <a href="../../../../org/apache/hadoop/hbase/HBaseCommonTestingUtil.html#deleteOnExit--">deleteOnExit</a>, <a href="../../../../org/apache/hadoop/hbase/HBaseCommonTestingUtil.html#getConfiguration--">getConfiguration</a>, <a href="../../../../org/apache/hadoop/hbase/HBaseCommonTestingUtil.html#getDataTestDir--">getDataTestDir</a>, <a href="../../../../org/apache/hadoop/hbase/HBaseCommonTestingUtil.html#getDataTestDir-java.lang.String-">getDataTestDir</a>, <a href="../../../../org/apache/hadoop/hbase/HBaseCommonTestingUtil.html#getRandomDir--">getRandomDir</a>, <a href="../../../../org/apache/hadoop/hbase/HBaseCommonTestingUtil.html#getRandomUUID--">getRandomUUID</a>, <a href="../../../../org/apache/hadoop/hbase/HBaseCommonTestingUtil.html#randomFreePort--">randomFreePort</a>, <a href="../../../../org/apache/hadoop/hbase/HBaseCommonTestingUtil.html#setupDataTestDir--">setupDataTestDir</a>, <a href="../../../../org/apache/hadoop/hbase/HBaseCommonTestingUtil.html#waitFor-long-long-boolean-org.apache.hadoop.hbase.Waiter.Predicate-">waitFor</a>, <a href="../../../../org/apache/hadoop/hbase/HBaseCommonTestingUtil.html#waitFor-long-long-org.apache.hadoop.hbase.Waiter.Predicate-">waitFor</a>, <a href="../../../../org/apache/hadoop/hbase/HBaseCommonTestingUtil.html#waitFor-long-org.apache.hadoop.hbase.Waiter.Predicate-">waitFor</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="zkCluster">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>zkCluster</h4>
<pre>private&nbsp;org.apache.hadoop.hbase.zookeeper.MiniZooKeeperCluster <a href="../../../../src-html/org/apache/hadoop/hbase/HBaseZKTestingUtil.html#line.36">zkCluster</a></pre>
</li>
</ul>
<a name="passedZkCluster">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>passedZkCluster</h4>
<pre>private&nbsp;boolean <a href="../../../../src-html/org/apache/hadoop/hbase/HBaseZKTestingUtil.html#line.41">passedZkCluster</a></pre>
<div class="block">Set if we were passed a zkCluster. If so, we won't shutdown zk as part of general shutdown.</div>
</li>
</ul>
<a name="zooKeeperWatcher">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>zooKeeperWatcher</h4>
<pre>protected&nbsp;org.apache.hadoop.hbase.zookeeper.ZKWatcher <a href="../../../../src-html/org/apache/hadoop/hbase/HBaseZKTestingUtil.html#line.43">zooKeeperWatcher</a></pre>
</li>
</ul>
<a name="clusterTestDir">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>clusterTestDir</h4>
<pre>protected&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> <a href="../../../../src-html/org/apache/hadoop/hbase/HBaseZKTestingUtil.html#line.46">clusterTestDir</a></pre>
<div class="block">Directory (a subdirectory of dataTestDir) used by the dfs cluster if any</div>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="HBaseZKTestingUtil--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>HBaseZKTestingUtil</h4>
<pre>public&nbsp;<a href="../../../../src-html/org/apache/hadoop/hbase/HBaseZKTestingUtil.html#line.48">HBaseZKTestingUtil</a>()</pre>
</li>
</ul>
<a name="HBaseZKTestingUtil-org.apache.hadoop.conf.Configuration-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>HBaseZKTestingUtil</h4>
<pre>public&nbsp;<a href="../../../../src-html/org/apache/hadoop/hbase/HBaseZKTestingUtil.html#line.52">HBaseZKTestingUtil</a>(org.apache.hadoop.conf.Configuration&nbsp;conf)</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getClusterTestDir--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getClusterTestDir</h4>
<pre>org.apache.hadoop.fs.Path&nbsp;<a href="../../../../src-html/org/apache/hadoop/hbase/HBaseZKTestingUtil.html#line.60">getClusterTestDir</a>()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Where the cluster will write data on the local subsystem. Creates it if it does not
exist already. A subdir of <code>HBaseCommonTestingUtility#getBaseTestDir()</code></dd>
</dl>
</li>
</ul>
<a name="setupClusterTestDir--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setupClusterTestDir</h4>
<pre>protected&nbsp;void&nbsp;<a href="../../../../src-html/org/apache/hadoop/hbase/HBaseZKTestingUtil.html#line.70">setupClusterTestDir</a>()</pre>
<div class="block">Creates a directory for the cluster, under the test data</div>
</li>
</ul>
<a name="startMiniZKCluster--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>startMiniZKCluster</h4>
<pre>public&nbsp;org.apache.hadoop.hbase.zookeeper.MiniZooKeeperCluster&nbsp;<a href="../../../../src-html/org/apache/hadoop/hbase/HBaseZKTestingUtil.html#line.92">startMiniZKCluster</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">Call this if you only want a zk cluster.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>zk cluster started.</dd>
<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>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../org/apache/hadoop/hbase/HBaseZKTestingUtil.html#shutdownMiniZKCluster--"><code>shutdownMiniZKCluster()</code></a></dd>
</dl>
</li>
</ul>
<a name="startMiniZKCluster-int-int...-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>startMiniZKCluster</h4>
<pre>public&nbsp;org.apache.hadoop.hbase.zookeeper.MiniZooKeeperCluster&nbsp;<a href="../../../../src-html/org/apache/hadoop/hbase/HBaseZKTestingUtil.html#line.101">startMiniZKCluster</a>(int&nbsp;zooKeeperServerNum,
int...&nbsp;clientPortList)
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">Call this if you only want a zk cluster.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>zk cluster started.</dd>
<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>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../org/apache/hadoop/hbase/HBaseZKTestingUtil.html#shutdownMiniZKCluster--"><code>shutdownMiniZKCluster()</code></a></dd>
</dl>
</li>
</ul>
<a name="startMiniZKCluster-java.io.File-int-int:A-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>startMiniZKCluster</h4>
<pre>private&nbsp;org.apache.hadoop.hbase.zookeeper.MiniZooKeeperCluster&nbsp;<a href="../../../../src-html/org/apache/hadoop/hbase/HBaseZKTestingUtil.html#line.111">startMiniZKCluster</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a>&nbsp;dir,
int&nbsp;zooKeeperServerNum,
int[]&nbsp;clientPortList)
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 mini ZK cluster. If the property "test.hbase.zookeeper.property.clientPort" is set the
port mentioned is used as the default port for ZooKeeper.</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="getZkCluster--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getZkCluster</h4>
<pre>public&nbsp;org.apache.hadoop.hbase.zookeeper.MiniZooKeeperCluster&nbsp;<a href="../../../../src-html/org/apache/hadoop/hbase/HBaseZKTestingUtil.html#line.136">getZkCluster</a>()</pre>
</li>
</ul>
<a name="setZkCluster-org.apache.hadoop.hbase.zookeeper.MiniZooKeeperCluster-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setZkCluster</h4>
<pre>public&nbsp;void&nbsp;<a href="../../../../src-html/org/apache/hadoop/hbase/HBaseZKTestingUtil.html#line.140">setZkCluster</a>(org.apache.hadoop.hbase.zookeeper.MiniZooKeeperCluster&nbsp;zkCluster)</pre>
</li>
</ul>
<a name="shutdownMiniZKCluster--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>shutdownMiniZKCluster</h4>
<pre>public&nbsp;void&nbsp;<a href="../../../../src-html/org/apache/hadoop/hbase/HBaseZKTestingUtil.html#line.150">shutdownMiniZKCluster</a>()
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Shuts down zk cluster created by call to <a href="../../../../org/apache/hadoop/hbase/HBaseZKTestingUtil.html#startMiniZKCluster--"><code>startMiniZKCluster()</code></a> or does nothing.</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../org/apache/hadoop/hbase/HBaseZKTestingUtil.html#startMiniZKCluster--"><code>startMiniZKCluster()</code></a></dd>
</dl>
</li>
</ul>
<a name="getZooKeeperWatcher--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getZooKeeperWatcher</h4>
<pre>public&nbsp;org.apache.hadoop.hbase.zookeeper.ZKWatcher&nbsp;<a href="../../../../src-html/org/apache/hadoop/hbase/HBaseZKTestingUtil.html#line.162">getZooKeeperWatcher</a>()
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Returns a ZKWatcher instance. This instance is shared between HBaseTestingUtility instance
users. Don't close it, it will be closed automatically when the cluster shutdowns</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The ZKWatcher instance.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd>
</dl>
</li>
</ul>
<a name="getZooKeeperWatcher-org.apache.hadoop.hbase.HBaseZKTestingUtil-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getZooKeeperWatcher</h4>
<pre>public static&nbsp;org.apache.hadoop.hbase.zookeeper.ZKWatcher&nbsp;<a href="../../../../src-html/org/apache/hadoop/hbase/HBaseZKTestingUtil.html#line.182">getZooKeeperWatcher</a>(<a href="../../../../org/apache/hadoop/hbase/HBaseZKTestingUtil.html" title="class in org.apache.hadoop.hbase">HBaseZKTestingUtil</a>&nbsp;testUtil)
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Gets a ZKWatcher.</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd>
</dl>
</li>
</ul>
<a name="cleanupTestDir--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>cleanupTestDir</h4>
<pre>public&nbsp;boolean&nbsp;<a href="../../../../src-html/org/apache/hadoop/hbase/HBaseZKTestingUtil.html#line.203">cleanupTestDir</a>()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../org/apache/hadoop/hbase/HBaseCommonTestingUtil.html#cleanupTestDir--">HBaseCommonTestingUtil</a></code></span></div>
<div class="block">Returns true if we removed the test dirs</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../org/apache/hadoop/hbase/HBaseCommonTestingUtil.html#cleanupTestDir--">cleanupTestDir</a></code>&nbsp;in class&nbsp;<code><a href="../../../../org/apache/hadoop/hbase/HBaseCommonTestingUtil.html" title="class in org.apache.hadoop.hbase">HBaseCommonTestingUtil</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>True if we removed the test dirs</dd>
</dl>
</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/HBaseZKTestingUtil.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><a href="../../../../org/apache/hadoop/hbase/HBaseTestingUtil.SeenRowTracker.html" title="class in org.apache.hadoop.hbase"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/apache/hadoop/hbase/HFilePerformanceEvaluation.html" title="class in org.apache.hadoop.hbase"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/hadoop/hbase/HBaseZKTestingUtil.html" target="_top">Frames</a></li>
<li><a href="HBaseZKTestingUtil.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><a href="#nested.classes.inherited.from.class.org.apache.hadoop.hbase.HBaseCommonTestingUtil">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&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>