| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>HBaseZKTestingUtil (Apache HBase 4.0.0-alpha-1-SNAPSHOT Test API)</title> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="description" content="declaration: package: org.apache.hadoop.hbase, class: HBaseZKTestingUtil"> |
| <meta name="generator" content="javadoc/ClassWriterImpl"> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> |
| <script type="text/javascript" src="../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../script-dir/jquery-3.6.1.min.js"></script> |
| <script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> |
| </head> |
| <body class="class-declaration-page"> |
| <script type="text/javascript">var evenRowColor = "even-row-color"; |
| var oddRowColor = "odd-row-color"; |
| var tableTab = "table-tab"; |
| var activeTableTab = "active-table-tab"; |
| var pathtoroot = "../../../../"; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <div class="flex-box"> |
| <header role="banner" class="flex-header"> |
| <nav role="navigation"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="top-nav" id="navbar-top"> |
| <div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> |
| <ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> |
| <li><a href="../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="nav-bar-cell1-rev">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#class">Help</a></li> |
| </ul> |
| </div> |
| <div class="sub-nav"> |
| <div> |
| <ul class="sub-nav-list"> |
| <li>Summary: </li> |
| <li><a href="#nested-class-summary">Nested</a> | </li> |
| <li><a href="#field-summary">Field</a> | </li> |
| <li><a href="#constructor-summary">Constr</a> | </li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li><a href="#field-detail">Field</a> | </li> |
| <li><a href="#constructor-detail">Constr</a> | </li> |
| <li><a href="#method-detail">Method</a></li> |
| </ul> |
| </div> |
| <div class="nav-list-search"><label for="search-input">SEARCH:</label> |
| <input type="text" id="search-input" value="search" disabled="disabled"> |
| <input type="reset" id="reset-button" value="reset" disabled="disabled"> |
| </div> |
| </div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <span class="skip-nav" id="skip-navbar-top"></span></nav> |
| </header> |
| <div class="flex-content"> |
| <main role="main"> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.hadoop.hbase</a></div> |
| <h1 title="Class HBaseZKTestingUtil" class="title">Class HBaseZKTestingUtil</h1> |
| </div> |
| <div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> |
| <div class="inheritance"><a href="HBaseCommonTestingUtil.html" title="class in org.apache.hadoop.hbase">org.apache.hadoop.hbase.HBaseCommonTestingUtil</a> |
| <div class="inheritance">org.apache.hadoop.hbase.HBaseZKTestingUtil</div> |
| </div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>Direct Known Subclasses:</dt> |
| <dd><code><a href="HBaseTestingUtil.html" title="class in org.apache.hadoop.hbase">HBaseTestingUtil</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="annotations">@LimitedPrivate("Phoenix") |
| @Evolving |
| </span><span class="modifiers">public class </span><span class="element-name"><a href="../../../../src-html/org/apache/hadoop/hbase/HBaseZKTestingUtil.html#line-33">HBaseZKTestingUtil</a></span> |
| <span class="extends-implements">extends <a href="HBaseCommonTestingUtil.html" title="class in org.apache.hadoop.hbase">HBaseCommonTestingUtil</a></span></div> |
| <div class="block">Helpers for testing HBase that do not depend on specific server/etc. things. The main difference |
| from <a href="HBaseCommonTestingUtil.html" title="class in org.apache.hadoop.hbase"><code>HBaseCommonTestingUtil</code></a> is that we can start a zookeeper cluster.</div> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <li> |
| <section class="nested-class-summary" id="nested-class-summary"> |
| <h2>Nested Class Summary</h2> |
| <div class="inherited-list"> |
| <h2 id="nested-classes-inherited-from-class-org.apache.hadoop.hbase.HBaseCommonTestingUtil">Nested classes/interfaces inherited from class org.apache.hadoop.hbase.<a href="HBaseCommonTestingUtil.html" title="class in org.apache.hadoop.hbase">HBaseCommonTestingUtil</a></h2> |
| <code><a href="HBaseCommonTestingUtil.PortAllocator.html" title="class in org.apache.hadoop.hbase">HBaseCommonTestingUtil.PortAllocator</a></code></div> |
| </section> |
| </li> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <li> |
| <section class="field-summary" id="field-summary"> |
| <h2>Field Summary</h2> |
| <div class="caption"><span>Fields</span></div> |
| <div class="summary-table three-column-summary"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Field</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><code>protected <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/File.html" title="class or interface in java.io" class="external-link">File</a></code></div> |
| <div class="col-second even-row-color"><code><a href="#clusterTestDir" class="member-name-link">clusterTestDir</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Directory (a subdirectory of dataTestDir) used by the dfs cluster if any</div> |
| </div> |
| <div class="col-first odd-row-color"><code>private boolean</code></div> |
| <div class="col-second odd-row-color"><code><a href="#passedZkCluster" class="member-name-link">passedZkCluster</a></code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Set if we were passed a zkCluster.</div> |
| </div> |
| <div class="col-first even-row-color"><code>private org.apache.hadoop.hbase.zookeeper.MiniZooKeeperCluster</code></div> |
| <div class="col-second even-row-color"><code><a href="#zkCluster" class="member-name-link">zkCluster</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>protected org.apache.hadoop.hbase.zookeeper.ZKWatcher</code></div> |
| <div class="col-second odd-row-color"><code><a href="#zooKeeperWatcher" class="member-name-link">zooKeeperWatcher</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="fields-inherited-from-class-org.apache.hadoop.hbase.HBaseCommonTestingUtil">Fields inherited from class org.apache.hadoop.hbase.<a href="HBaseCommonTestingUtil.html" title="class in org.apache.hadoop.hbase">HBaseCommonTestingUtil</a></h3> |
| <code><a href="HBaseCommonTestingUtil.html#BASE_TEST_DIRECTORY_KEY">BASE_TEST_DIRECTORY_KEY</a>, <a href="HBaseCommonTestingUtil.html#BOOLEAN_PARAMETERIZED">BOOLEAN_PARAMETERIZED</a>, <a href="HBaseCommonTestingUtil.html#COMPRESSION_ALGORITHMS">COMPRESSION_ALGORITHMS</a>, <a href="HBaseCommonTestingUtil.html#COMPRESSION_ALGORITHMS_PARAMETERIZED">COMPRESSION_ALGORITHMS_PARAMETERIZED</a>, <a href="HBaseCommonTestingUtil.html#conf">conf</a>, <a href="HBaseCommonTestingUtil.html#DEFAULT_BASE_TEST_DIRECTORY">DEFAULT_BASE_TEST_DIRECTORY</a>, <a href="HBaseCommonTestingUtil.html#LOG">LOG</a></code></div> |
| </section> |
| </li> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <li> |
| <section class="constructor-summary" id="constructor-summary"> |
| <h2>Constructor Summary</h2> |
| <div class="caption"><span>Constructors</span></div> |
| <div class="summary-table two-column-summary"> |
| <div class="table-header col-first">Constructor</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">HBaseZKTestingUtil</a>()</code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(org.apache.hadoop.conf.Configuration)" class="member-name-link">HBaseZKTestingUtil</a><wbr>(org.apache.hadoop.conf.Configuration conf)</code></div> |
| <div class="col-last odd-row-color"> </div> |
| </div> |
| </section> |
| </li> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <li> |
| <section class="method-summary" id="method-summary"> |
| <h2>Method Summary</h2> |
| <div id="method-summary-table"> |
| <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> |
| <div id="method-summary-table.tabpanel" role="tabpanel"> |
| <div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Method</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#cleanupTestDir()" class="member-name-link">cleanupTestDir</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns true if we removed the test dirs</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>(package private) org.apache.hadoop.fs.Path</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getClusterTestDir()" class="member-name-link">getClusterTestDir</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns Where the cluster will write data on the local subsystem.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>org.apache.hadoop.hbase.zookeeper.MiniZooKeeperCluster</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getZkCluster()" class="member-name-link">getZkCluster</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>org.apache.hadoop.hbase.zookeeper.ZKWatcher</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getZooKeeperWatcher()" class="member-name-link">getZooKeeperWatcher</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns a ZKWatcher instance.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setupClusterTestDir()" class="member-name-link">setupClusterTestDir</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Creates a directory for the cluster, under the test data</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setZkCluster(org.apache.hadoop.hbase.zookeeper.MiniZooKeeperCluster)" class="member-name-link">setZkCluster</a><wbr>(org.apache.hadoop.hbase.zookeeper.MiniZooKeeperCluster zkCluster)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#shutdownMiniZKCluster()" class="member-name-link">shutdownMiniZKCluster</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Shuts down zk cluster created by call to <a href="#startMiniZKCluster()"><code>startMiniZKCluster()</code></a> or does nothing.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>org.apache.hadoop.hbase.zookeeper.MiniZooKeeperCluster</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#startMiniZKCluster()" class="member-name-link">startMiniZKCluster</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Call this if you only want a zk cluster.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>org.apache.hadoop.hbase.zookeeper.MiniZooKeeperCluster</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#startMiniZKCluster(int,int...)" class="member-name-link">startMiniZKCluster</a><wbr>(int zooKeeperServerNum, |
| int... clientPortList)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Call this if you only want a zk cluster.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>private org.apache.hadoop.hbase.zookeeper.MiniZooKeeperCluster</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#startMiniZKCluster(java.io.File,int,int%5B%5D)" class="member-name-link">startMiniZKCluster</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/File.html" title="class or interface in java.io" class="external-link">File</a> dir, |
| int zooKeeperServerNum, |
| int[] clientPortList)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Start a mini ZK cluster.</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-org.apache.hadoop.hbase.HBaseCommonTestingUtil">Methods inherited from class org.apache.hadoop.hbase.<a href="HBaseCommonTestingUtil.html" title="class in org.apache.hadoop.hbase">HBaseCommonTestingUtil</a></h3> |
| <code><a href="HBaseCommonTestingUtil.html#cleanupTestDir(java.lang.String)">cleanupTestDir</a>, <a href="HBaseCommonTestingUtil.html#createSubDir(java.lang.String,org.apache.hadoop.fs.Path,java.lang.String)">createSubDir</a>, <a href="HBaseCommonTestingUtil.html#deleteDir(java.io.File)">deleteDir</a>, <a href="HBaseCommonTestingUtil.html#deleteOnExit()">deleteOnExit</a>, <a href="HBaseCommonTestingUtil.html#getConfiguration()">getConfiguration</a>, <a href="HBaseCommonTestingUtil.html#getDataTestDir()">getDataTestDir</a>, <a href="HBaseCommonTestingUtil.html#getDataTestDir(java.lang.String)">getDataTestDir</a>, <a href="HBaseCommonTestingUtil.html#getRandomDir()">getRandomDir</a>, <a href="HBaseCommonTestingUtil.html#getRandomUUID()">getRandomUUID</a>, <a href="HBaseCommonTestingUtil.html#randomFreePort()">randomFreePort</a>, <a href="HBaseCommonTestingUtil.html#setupDataTestDir()">setupDataTestDir</a>, <a href="HBaseCommonTestingUtil.html#waitFor(long,long,boolean,org.apache.hadoop.hbase.Waiter.Predicate)">waitFor</a>, <a href="HBaseCommonTestingUtil.html#waitFor(long,long,org.apache.hadoop.hbase.Waiter.Predicate)">waitFor</a>, <a href="HBaseCommonTestingUtil.html#waitFor(long,org.apache.hadoop.hbase.Waiter.Predicate)">waitFor</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> |
| <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <li> |
| <section class="field-details" id="field-detail"> |
| <h2>Field Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="zkCluster"> |
| <h3>zkCluster</h3> |
| <div class="member-signature"><span class="modifiers">private</span> <span class="return-type">org.apache.hadoop.hbase.zookeeper.MiniZooKeeperCluster</span> <span class="element-name"><a href="../../../../src-html/org/apache/hadoop/hbase/HBaseZKTestingUtil.html#line-36">zkCluster</a></span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="passedZkCluster"> |
| <h3>passedZkCluster</h3> |
| <div class="member-signature"><span class="modifiers">private</span> <span class="return-type">boolean</span> <span class="element-name"><a href="../../../../src-html/org/apache/hadoop/hbase/HBaseZKTestingUtil.html#line-41">passedZkCluster</a></span></div> |
| <div class="block">Set if we were passed a zkCluster. If so, we won't shutdown zk as part of general shutdown.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="zooKeeperWatcher"> |
| <h3>zooKeeperWatcher</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type">org.apache.hadoop.hbase.zookeeper.ZKWatcher</span> <span class="element-name"><a href="../../../../src-html/org/apache/hadoop/hbase/HBaseZKTestingUtil.html#line-43">zooKeeperWatcher</a></span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="clusterTestDir"> |
| <h3>clusterTestDir</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/File.html" title="class or interface in java.io" class="external-link">File</a></span> <span class="element-name"><a href="../../../../src-html/org/apache/hadoop/hbase/HBaseZKTestingUtil.html#line-46">clusterTestDir</a></span></div> |
| <div class="block">Directory (a subdirectory of dataTestDir) used by the dfs cluster if any</div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <li> |
| <section class="constructor-details" id="constructor-detail"> |
| <h2>Constructor Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="<init>()"> |
| <h3>HBaseZKTestingUtil</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name"><a href="../../../../src-html/org/apache/hadoop/hbase/HBaseZKTestingUtil.html#line-48">HBaseZKTestingUtil</a></span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="<init>(org.apache.hadoop.conf.Configuration)"> |
| <h3>HBaseZKTestingUtil</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name"><a href="../../../../src-html/org/apache/hadoop/hbase/HBaseZKTestingUtil.html#line-52">HBaseZKTestingUtil</a></span><wbr><span class="parameters">(org.apache.hadoop.conf.Configuration conf)</span></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li> |
| <section class="method-details" id="method-detail"> |
| <h2>Method Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="getClusterTestDir()"> |
| <h3>getClusterTestDir</h3> |
| <div class="member-signature"><span class="return-type">org.apache.hadoop.fs.Path</span> <span class="element-name"><a href="../../../../src-html/org/apache/hadoop/hbase/HBaseZKTestingUtil.html#line-60">getClusterTestDir</a></span>()</div> |
| <div class="block">Returns 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></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setupClusterTestDir()"> |
| <h3>setupClusterTestDir</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type">void</span> <span class="element-name"><a href="../../../../src-html/org/apache/hadoop/hbase/HBaseZKTestingUtil.html#line-70">setupClusterTestDir</a></span>()</div> |
| <div class="block">Creates a directory for the cluster, under the test data</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="startMiniZKCluster()"> |
| <h3>startMiniZKCluster</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">org.apache.hadoop.hbase.zookeeper.MiniZooKeeperCluster</span> <span class="element-name"><a href="../../../../src-html/org/apache/hadoop/hbase/HBaseZKTestingUtil.html#line-92">startMiniZKCluster</a></span>() |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Exception.html" title="class or interface in java.lang" class="external-link">Exception</a></span></div> |
| <div class="block">Call this if you only want a zk cluster.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>zk cluster started.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Exception.html" title="class or interface in java.lang" class="external-link">Exception</a></code></dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="#shutdownMiniZKCluster()"><code>shutdownMiniZKCluster()</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="startMiniZKCluster(int,int...)"> |
| <h3>startMiniZKCluster</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">org.apache.hadoop.hbase.zookeeper.MiniZooKeeperCluster</span> <span class="element-name"><a href="../../../../src-html/org/apache/hadoop/hbase/HBaseZKTestingUtil.html#line-101">startMiniZKCluster</a></span><wbr><span class="parameters">(int zooKeeperServerNum, |
| int... clientPortList)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Exception.html" title="class or interface in java.lang" class="external-link">Exception</a></span></div> |
| <div class="block">Call this if you only want a zk cluster.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>zk cluster started.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Exception.html" title="class or interface in java.lang" class="external-link">Exception</a></code></dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="#shutdownMiniZKCluster()"><code>shutdownMiniZKCluster()</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="startMiniZKCluster(java.io.File,int,int[])"> |
| <h3>startMiniZKCluster</h3> |
| <div class="member-signature"><span class="modifiers">private</span> <span class="return-type">org.apache.hadoop.hbase.zookeeper.MiniZooKeeperCluster</span> <span class="element-name"><a href="../../../../src-html/org/apache/hadoop/hbase/HBaseZKTestingUtil.html#line-111">startMiniZKCluster</a></span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/File.html" title="class or interface in java.io" class="external-link">File</a> dir, |
| int zooKeeperServerNum, |
| int[] clientPortList)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Exception.html" title="class or interface in java.lang" class="external-link">Exception</a></span></div> |
| <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 class="notes"> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Exception.html" title="class or interface in java.lang" class="external-link">Exception</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getZkCluster()"> |
| <h3>getZkCluster</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">org.apache.hadoop.hbase.zookeeper.MiniZooKeeperCluster</span> <span class="element-name"><a href="../../../../src-html/org/apache/hadoop/hbase/HBaseZKTestingUtil.html#line-136">getZkCluster</a></span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setZkCluster(org.apache.hadoop.hbase.zookeeper.MiniZooKeeperCluster)"> |
| <h3>setZkCluster</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name"><a href="../../../../src-html/org/apache/hadoop/hbase/HBaseZKTestingUtil.html#line-140">setZkCluster</a></span><wbr><span class="parameters">(org.apache.hadoop.hbase.zookeeper.MiniZooKeeperCluster zkCluster)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="shutdownMiniZKCluster()"> |
| <h3>shutdownMiniZKCluster</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name"><a href="../../../../src-html/org/apache/hadoop/hbase/HBaseZKTestingUtil.html#line-150">shutdownMiniZKCluster</a></span>() |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div> |
| <div class="block">Shuts down zk cluster created by call to <a href="#startMiniZKCluster()"><code>startMiniZKCluster()</code></a> or does nothing.</div> |
| <dl class="notes"> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code></dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="#startMiniZKCluster()"><code>startMiniZKCluster()</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getZooKeeperWatcher()"> |
| <h3>getZooKeeperWatcher</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">org.apache.hadoop.hbase.zookeeper.ZKWatcher</span> <span class="element-name"><a href="../../../../src-html/org/apache/hadoop/hbase/HBaseZKTestingUtil.html#line-162">getZooKeeperWatcher</a></span>() |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div> |
| <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 class="notes"> |
| <dt>Returns:</dt> |
| <dd>The ZKWatcher instance.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="cleanupTestDir()"> |
| <h3>cleanupTestDir</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name"><a href="../../../../src-html/org/apache/hadoop/hbase/HBaseZKTestingUtil.html#line-182">cleanupTestDir</a></span>()</div> |
| <div class="block">Returns true if we removed the test dirs</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="HBaseCommonTestingUtil.html#cleanupTestDir()">cleanupTestDir</a></code> in class <code><a href="HBaseCommonTestingUtil.html" title="class in org.apache.hadoop.hbase">HBaseCommonTestingUtil</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| <footer role="contentinfo"> |
| <hr> |
| <p class="legal-copy"><small>Copyright © 2007–2020 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |
