| <!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>HBaseClusterInterface (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="HBaseClusterInterface (Apache HBase 3.0.0-alpha-2-SNAPSHOT Test API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":6,"i2":10,"i3":10,"i4":10,"i5":6,"i6":10,"i7":6,"i8":6,"i9":6,"i10":6,"i11":6,"i12":6,"i13":10,"i14":10,"i15":6,"i16":10,"i17":6,"i18":6,"i19":6,"i20":6,"i21":6,"i22":6,"i23":6,"i24":6,"i25":6,"i26":6,"i27":6,"i28":6,"i29":10,"i30":6,"i31":10,"i32":6,"i33":6,"i34":6,"i35":10,"i36":6,"i37":6,"i38":10,"i39":6,"i40":6,"i41":6,"i42":6}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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/HBaseClusterInterface.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/HBaseClassTestRuleChecker.html" title="class in org.apache.hadoop.hbase"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/hadoop/hbase/HBaseClusterManager.html" title="class in org.apache.hadoop.hbase"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/hadoop/hbase/HBaseClusterInterface.html" target="_top">Frames</a></li> |
| <li><a href="HBaseClusterInterface.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../allclasses-noframe.html">All 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: </li> |
| <li>Nested | </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="subNavList"> |
| <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> |
| <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 HBaseClusterInterface" class="title">Class HBaseClusterInterface</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>org.apache.hadoop.hbase.HBaseClusterInterface</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><a href="https://docs.oracle.com/javase/8/docs/api/java/io/Closeable.html?is-external=true" title="class or interface in java.io">Closeable</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/AutoCloseable.html?is-external=true" title="class or interface in java.lang">AutoCloseable</a>, org.apache.hadoop.conf.Configurable</dd> |
| </dl> |
| <dl> |
| <dt>Direct Known Subclasses:</dt> |
| <dd><a href="../../../../org/apache/hadoop/hbase/DistributedHBaseCluster.html" title="class in org.apache.hadoop.hbase">DistributedHBaseCluster</a>, <a href="../../../../org/apache/hadoop/hbase/SingleProcessHBaseCluster.html" title="class in org.apache.hadoop.hbase">SingleProcessHBaseCluster</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>@InterfaceAudience.LimitedPrivate(value="Phoenix") |
| @InterfaceStability.Evolving |
| public abstract class <a href="../../../../src-html/org/apache/hadoop/hbase/HBaseClusterInterface.html#line.56">HBaseClusterInterface</a> |
| extends <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> |
| implements <a href="https://docs.oracle.com/javase/8/docs/api/java/io/Closeable.html?is-external=true" title="class or interface in java.io">Closeable</a>, org.apache.hadoop.conf.Configurable</pre> |
| <div class="block">This class defines methods that can help with managing HBase clusters |
| from unit tests and system tests. There are 3 types of cluster deployments: |
| <ul> |
| <li><b>SingleProcessHBaseCluster:</b> each server is run in the same JVM in separate threads, |
| used by unit tests</li> |
| <li><b>DistributedHBaseCluster:</b> the cluster is pre-deployed, system and integration tests can |
| interact with the cluster. </li> |
| <li><b>ProcessBasedLocalHBaseCluster:</b> each server is deployed locally but in separate |
| JVMs. </li> |
| </ul> |
| <p> |
| HBaseCluster unifies the way tests interact with the cluster, so that the same test can |
| be run against a mini-cluster during unit test execution, or a distributed cluster having |
| tens/hundreds of nodes during execution of integration tests. |
| |
| <p> |
| HBaseCluster exposes client-side public interfaces to tests, so that tests does not assume |
| running in a particular mode. Not all the tests are suitable to be run on an actual cluster, |
| and some tests will still need to mock stuff and introspect internal state. For those use |
| cases from unit tests, or if more control is needed, you can use the subclasses directly. |
| In that sense, this class does not abstract away <strong>every</strong> interface that |
| SingleProcessHBaseCluster or DistributedHBaseCluster provide.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- =========== 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"> </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 org.apache.hadoop.conf.Configuration</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/HBaseClusterInterface.html#conf">conf</a></span></code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected org.apache.hadoop.hbase.ClusterMetrics</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/HBaseClusterInterface.html#initialClusterStatus">initialClusterStatus</a></span></code> |
| <div class="block">the status of the cluster before we begin</div> |
| </td> |
| </tr> |
| </table> |
| </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"> </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/HBaseClusterInterface.html#HBaseClusterInterface-org.apache.hadoop.conf.Configuration-">HBaseClusterInterface</a></span>(org.apache.hadoop.conf.Configuration conf)</code> |
| <div class="block">Construct an HBaseCluster</div> |
| </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"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </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>abstract void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/HBaseClusterInterface.html#close--">close</a></span>()</code> |
| <div class="block">Closes all the resources held open for this cluster.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>abstract org.apache.hadoop.hbase.ClusterMetrics</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/HBaseClusterInterface.html#getClusterMetrics--">getClusterMetrics</a></span>()</code> |
| <div class="block">Returns a ClusterMetrics for this HBase cluster.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>org.apache.hadoop.conf.Configuration</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/HBaseClusterInterface.html#getConf--">getConf</a></span>()</code> </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>org.apache.hadoop.hbase.ClusterMetrics</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/HBaseClusterInterface.html#getInitialClusterMetrics--">getInitialClusterMetrics</a></span>()</code> |
| <div class="block">Returns a ClusterStatus for this HBase cluster as observed at the |
| starting of the HBaseCluster</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>org.apache.hadoop.hbase.ServerName</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/HBaseClusterInterface.html#getServerHoldingMeta--">getServerHoldingMeta</a></span>()</code> |
| <div class="block">Get the ServerName of region server serving the first hbase:meta region</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>abstract org.apache.hadoop.hbase.ServerName</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/HBaseClusterInterface.html#getServerHoldingRegion-org.apache.hadoop.hbase.TableName-byte:A-">getServerHoldingRegion</a></span>(org.apache.hadoop.hbase.TableName tn, |
| byte[] regionName)</code> |
| <div class="block">Get the ServerName of region server serving the specified region</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/HBaseClusterInterface.html#isDistributedCluster--">isDistributedCluster</a></span>()</code> </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>abstract boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/HBaseClusterInterface.html#isKilledRS-org.apache.hadoop.hbase.ServerName-">isKilledRS</a></span>(org.apache.hadoop.hbase.ServerName serverName)</code> |
| <div class="block">Keeping track of killed servers and being able to check if a particular server was killed makes |
| it possible to do fault tolerance testing for dead servers in a deterministic way.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>abstract void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/HBaseClusterInterface.html#killDataNode-org.apache.hadoop.hbase.ServerName-">killDataNode</a></span>(org.apache.hadoop.hbase.ServerName serverName)</code> |
| <div class="block">Kills the datanode process if this is a distributed cluster, otherwise, |
| this causes master to exit doing basic clean up only.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>abstract void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/HBaseClusterInterface.html#killMaster-org.apache.hadoop.hbase.ServerName-">killMaster</a></span>(org.apache.hadoop.hbase.ServerName serverName)</code> |
| <div class="block">Kills the master process if this is a distributed cluster, otherwise, |
| this causes master to exit doing basic clean up only.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>abstract void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/HBaseClusterInterface.html#killNameNode-org.apache.hadoop.hbase.ServerName-">killNameNode</a></span>(org.apache.hadoop.hbase.ServerName serverName)</code> |
| <div class="block">Kills the namenode process if this is a distributed cluster, otherwise, this causes master to |
| exit doing basic clean up only.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code>abstract void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/HBaseClusterInterface.html#killRegionServer-org.apache.hadoop.hbase.ServerName-">killRegionServer</a></span>(org.apache.hadoop.hbase.ServerName serverName)</code> |
| <div class="block">Kills the region server process if this is a distributed cluster, otherwise |
| this causes the region server to exit doing basic clean up only.</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code>abstract void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/HBaseClusterInterface.html#killZkNode-org.apache.hadoop.hbase.ServerName-">killZkNode</a></span>(org.apache.hadoop.hbase.ServerName serverName)</code> |
| <div class="block">Kills the zookeeper node process if this is a distributed cluster, otherwise, |
| this causes master to exit doing basic clean up only.</div> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/HBaseClusterInterface.html#restoreClusterMetrics-org.apache.hadoop.hbase.ClusterMetrics-">restoreClusterMetrics</a></span>(org.apache.hadoop.hbase.ClusterMetrics desiredStatus)</code> |
| <div class="block">Restores the cluster to given state if this is a real cluster, |
| otherwise does nothing.</div> |
| </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/HBaseClusterInterface.html#restoreInitialStatus--">restoreInitialStatus</a></span>()</code> |
| <div class="block">Restores the cluster to it's initial state if this is a real cluster, |
| otherwise does nothing.</div> |
| </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code>abstract void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/HBaseClusterInterface.html#resumeRegionServer-org.apache.hadoop.hbase.ServerName-">resumeRegionServer</a></span>(org.apache.hadoop.hbase.ServerName serverName)</code> |
| <div class="block">Resume the region server</div> |
| </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/HBaseClusterInterface.html#setConf-org.apache.hadoop.conf.Configuration-">setConf</a></span>(org.apache.hadoop.conf.Configuration conf)</code> </td> |
| </tr> |
| <tr id="i17" class="rowColor"> |
| <td class="colFirst"><code>abstract void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/HBaseClusterInterface.html#shutdown--">shutdown</a></span>()</code> |
| <div class="block">Shut down the HBase cluster</div> |
| </td> |
| </tr> |
| <tr id="i18" class="altColor"> |
| <td class="colFirst"><code>abstract void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/HBaseClusterInterface.html#startDataNode-org.apache.hadoop.hbase.ServerName-">startDataNode</a></span>(org.apache.hadoop.hbase.ServerName serverName)</code> |
| <div class="block">Starts a new datanode on the given hostname or if this is a mini/local cluster, |
| silently logs warning message.</div> |
| </td> |
| </tr> |
| <tr id="i19" class="rowColor"> |
| <td class="colFirst"><code>abstract void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/HBaseClusterInterface.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> hostname, |
| int port)</code> |
| <div class="block">Starts a new master on the given hostname or if this is a mini/local cluster, |
| starts a master locally.</div> |
| </td> |
| </tr> |
| <tr id="i20" class="altColor"> |
| <td class="colFirst"><code>abstract void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/HBaseClusterInterface.html#startNameNode-org.apache.hadoop.hbase.ServerName-">startNameNode</a></span>(org.apache.hadoop.hbase.ServerName serverName)</code> |
| <div class="block">Starts a new namenode on the given hostname or if this is a mini/local cluster, silently logs |
| warning message.</div> |
| </td> |
| </tr> |
| <tr id="i21" class="rowColor"> |
| <td class="colFirst"><code>abstract void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/HBaseClusterInterface.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> hostname, |
| int port)</code> |
| <div class="block">Starts a new region server on the given hostname or if this is a mini/local cluster, |
| starts a region server locally.</div> |
| </td> |
| </tr> |
| <tr id="i22" class="altColor"> |
| <td class="colFirst"><code>abstract void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/HBaseClusterInterface.html#startZkNode-java.lang.String-int-">startZkNode</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> hostname, |
| int port)</code> |
| <div class="block">Starts a new zookeeper node on the given hostname or if this is a mini/local cluster, |
| silently logs warning message.</div> |
| </td> |
| </tr> |
| <tr id="i23" class="rowColor"> |
| <td class="colFirst"><code>abstract void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/HBaseClusterInterface.html#stopDataNode-org.apache.hadoop.hbase.ServerName-">stopDataNode</a></span>(org.apache.hadoop.hbase.ServerName serverName)</code> |
| <div class="block">Stops the datanode if this is a distributed cluster, otherwise |
| silently logs warning message.</div> |
| </td> |
| </tr> |
| <tr id="i24" class="altColor"> |
| <td class="colFirst"><code>abstract void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/HBaseClusterInterface.html#stopMaster-org.apache.hadoop.hbase.ServerName-">stopMaster</a></span>(org.apache.hadoop.hbase.ServerName serverName)</code> |
| <div class="block">Stops the given master, by attempting a gradual stop.</div> |
| </td> |
| </tr> |
| <tr id="i25" class="rowColor"> |
| <td class="colFirst"><code>abstract void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/HBaseClusterInterface.html#stopNameNode-org.apache.hadoop.hbase.ServerName-">stopNameNode</a></span>(org.apache.hadoop.hbase.ServerName serverName)</code> |
| <div class="block">Stops the namenode if this is a distributed cluster, otherwise silently logs warning message.</div> |
| </td> |
| </tr> |
| <tr id="i26" class="altColor"> |
| <td class="colFirst"><code>abstract void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/HBaseClusterInterface.html#stopRegionServer-org.apache.hadoop.hbase.ServerName-">stopRegionServer</a></span>(org.apache.hadoop.hbase.ServerName serverName)</code> |
| <div class="block">Stops the given region server, by attempting a gradual stop.</div> |
| </td> |
| </tr> |
| <tr id="i27" class="rowColor"> |
| <td class="colFirst"><code>abstract void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/HBaseClusterInterface.html#stopZkNode-org.apache.hadoop.hbase.ServerName-">stopZkNode</a></span>(org.apache.hadoop.hbase.ServerName serverName)</code> |
| <div class="block">Stops the region zookeeper if this is a distributed cluster, otherwise |
| silently logs warning message.</div> |
| </td> |
| </tr> |
| <tr id="i28" class="altColor"> |
| <td class="colFirst"><code>abstract void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/HBaseClusterInterface.html#suspendRegionServer-org.apache.hadoop.hbase.ServerName-">suspendRegionServer</a></span>(org.apache.hadoop.hbase.ServerName serverName)</code> |
| <div class="block">Suspend the region server</div> |
| </td> |
| </tr> |
| <tr id="i29" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/HBaseClusterInterface.html#waitForActiveAndReadyMaster--">waitForActiveAndReadyMaster</a></span>()</code> |
| <div class="block">Blocks until there is an active master and that master has completed |
| initialization.</div> |
| </td> |
| </tr> |
| <tr id="i30" class="altColor"> |
| <td class="colFirst"><code>abstract boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/HBaseClusterInterface.html#waitForActiveAndReadyMaster-long-">waitForActiveAndReadyMaster</a></span>(long timeout)</code> |
| <div class="block">Blocks until there is an active master and that master has completed |
| initialization.</div> |
| </td> |
| </tr> |
| <tr id="i31" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/HBaseClusterInterface.html#waitForDatanodesRegistered-int-">waitForDatanodesRegistered</a></span>(int nbDN)</code> </td> |
| </tr> |
| <tr id="i32" class="altColor"> |
| <td class="colFirst"><code>abstract void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/HBaseClusterInterface.html#waitForDataNodeToStart-org.apache.hadoop.hbase.ServerName-long-">waitForDataNodeToStart</a></span>(org.apache.hadoop.hbase.ServerName serverName, |
| long timeout)</code> |
| <div class="block">Wait for the specified datanode to join the cluster</div> |
| </td> |
| </tr> |
| <tr id="i33" class="rowColor"> |
| <td class="colFirst"><code>abstract void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/HBaseClusterInterface.html#waitForDataNodeToStop-org.apache.hadoop.hbase.ServerName-long-">waitForDataNodeToStop</a></span>(org.apache.hadoop.hbase.ServerName serverName, |
| long timeout)</code> |
| <div class="block">Wait for the specified datanode to stop the thread / process.</div> |
| </td> |
| </tr> |
| <tr id="i34" class="altColor"> |
| <td class="colFirst"><code>abstract void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/HBaseClusterInterface.html#waitForMasterToStop-org.apache.hadoop.hbase.ServerName-long-">waitForMasterToStop</a></span>(org.apache.hadoop.hbase.ServerName serverName, |
| long timeout)</code> |
| <div class="block">Wait for the specified master to stop the thread / process.</div> |
| </td> |
| </tr> |
| <tr id="i35" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/HBaseClusterInterface.html#waitForNamenodeAvailable--">waitForNamenodeAvailable</a></span>()</code> |
| <div class="block">Wait for the namenode.</div> |
| </td> |
| </tr> |
| <tr id="i36" class="altColor"> |
| <td class="colFirst"><code>abstract void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/HBaseClusterInterface.html#waitForNameNodeToStart-org.apache.hadoop.hbase.ServerName-long-">waitForNameNodeToStart</a></span>(org.apache.hadoop.hbase.ServerName serverName, |
| long timeout)</code> |
| <div class="block">Wait for the specified namenode to join the cluster</div> |
| </td> |
| </tr> |
| <tr id="i37" class="rowColor"> |
| <td class="colFirst"><code>abstract void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/HBaseClusterInterface.html#waitForNameNodeToStop-org.apache.hadoop.hbase.ServerName-long-">waitForNameNodeToStop</a></span>(org.apache.hadoop.hbase.ServerName serverName, |
| long timeout)</code> |
| <div class="block">Wait for the specified namenode to stop</div> |
| </td> |
| </tr> |
| <tr id="i38" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/HBaseClusterInterface.html#waitForRegionServerToStart-java.lang.String-int-long-">waitForRegionServerToStart</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> hostname, |
| int port, |
| long timeout)</code> |
| <div class="block">Wait for the specified region server to join the cluster</div> |
| </td> |
| </tr> |
| <tr id="i39" class="rowColor"> |
| <td class="colFirst"><code>abstract void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/HBaseClusterInterface.html#waitForRegionServerToStop-org.apache.hadoop.hbase.ServerName-long-">waitForRegionServerToStop</a></span>(org.apache.hadoop.hbase.ServerName serverName, |
| long timeout)</code> |
| <div class="block">Wait for the specified region server to stop the thread / process.</div> |
| </td> |
| </tr> |
| <tr id="i40" class="altColor"> |
| <td class="colFirst"><code>abstract void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/HBaseClusterInterface.html#waitForZkNodeToStart-org.apache.hadoop.hbase.ServerName-long-">waitForZkNodeToStart</a></span>(org.apache.hadoop.hbase.ServerName serverName, |
| long timeout)</code> |
| <div class="block">Wait for the specified zookeeper node to join the cluster</div> |
| </td> |
| </tr> |
| <tr id="i41" class="rowColor"> |
| <td class="colFirst"><code>abstract void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/HBaseClusterInterface.html#waitForZkNodeToStop-org.apache.hadoop.hbase.ServerName-long-">waitForZkNodeToStop</a></span>(org.apache.hadoop.hbase.ServerName serverName, |
| long timeout)</code> |
| <div class="block">Wait for the specified zookeeper node to stop the thread / process.</div> |
| </td> |
| </tr> |
| <tr id="i42" class="altColor"> |
| <td class="colFirst"><code>abstract void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/HBaseClusterInterface.html#waitUntilShutDown--">waitUntilShutDown</a></span>()</code> |
| <div class="block">Wait for HBase Cluster to shut down.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class 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="conf"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>conf</h4> |
| <pre>protected org.apache.hadoop.conf.Configuration <a href="../../../../src-html/org/apache/hadoop/hbase/HBaseClusterInterface.html#line.58">conf</a></pre> |
| </li> |
| </ul> |
| <a name="initialClusterStatus"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>initialClusterStatus</h4> |
| <pre>protected org.apache.hadoop.hbase.ClusterMetrics <a href="../../../../src-html/org/apache/hadoop/hbase/HBaseClusterInterface.html#line.61">initialClusterStatus</a></pre> |
| <div class="block">the status of the cluster before we begin</div> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="HBaseClusterInterface-org.apache.hadoop.conf.Configuration-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>HBaseClusterInterface</h4> |
| <pre>public <a href="../../../../src-html/org/apache/hadoop/hbase/HBaseClusterInterface.html#line.67">HBaseClusterInterface</a>(org.apache.hadoop.conf.Configuration conf)</pre> |
| <div class="block">Construct an HBaseCluster</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>conf</code> - Configuration to be used for cluster</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="setConf-org.apache.hadoop.conf.Configuration-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setConf</h4> |
| <pre>public void <a href="../../../../src-html/org/apache/hadoop/hbase/HBaseClusterInterface.html#line.72">setConf</a>(org.apache.hadoop.conf.Configuration conf)</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code>setConf</code> in interface <code>org.apache.hadoop.conf.Configurable</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getConf--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getConf</h4> |
| <pre>public org.apache.hadoop.conf.Configuration <a href="../../../../src-html/org/apache/hadoop/hbase/HBaseClusterInterface.html#line.77">getConf</a>()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code>getConf</code> in interface <code>org.apache.hadoop.conf.Configurable</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getClusterMetrics--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getClusterMetrics</h4> |
| <pre>public abstract org.apache.hadoop.hbase.ClusterMetrics <a href="../../../../src-html/org/apache/hadoop/hbase/HBaseClusterInterface.html#line.85">getClusterMetrics</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 ClusterMetrics for this HBase cluster.</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/HBaseClusterInterface.html#getInitialClusterMetrics--"><code>getInitialClusterMetrics()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getInitialClusterMetrics--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getInitialClusterMetrics</h4> |
| <pre>public org.apache.hadoop.hbase.ClusterMetrics <a href="../../../../src-html/org/apache/hadoop/hbase/HBaseClusterInterface.html#line.91">getInitialClusterMetrics</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 ClusterStatus for this HBase cluster as observed at the |
| starting of the HBaseCluster</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="startRegionServer-java.lang.String-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>startRegionServer</h4> |
| <pre>public abstract void <a href="../../../../src-html/org/apache/hadoop/hbase/HBaseClusterInterface.html#line.101">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> hostname, |
| int port) |
| 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">Starts a new region server on the given hostname or if this is a mini/local cluster, |
| starts a region server locally.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>hostname</code> - the hostname to start the regionserver on</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> - if something goes wrong</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="killRegionServer-org.apache.hadoop.hbase.ServerName-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>killRegionServer</h4> |
| <pre>public abstract void <a href="../../../../src-html/org/apache/hadoop/hbase/HBaseClusterInterface.html#line.108">killRegionServer</a>(org.apache.hadoop.hbase.ServerName serverName) |
| 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">Kills the region server process if this is a distributed cluster, otherwise |
| this causes the region server to exit doing basic clean up only.</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> - if something goes wrong</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isKilledRS-org.apache.hadoop.hbase.ServerName-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isKilledRS</h4> |
| <pre>public abstract boolean <a href="../../../../src-html/org/apache/hadoop/hbase/HBaseClusterInterface.html#line.117">isKilledRS</a>(org.apache.hadoop.hbase.ServerName serverName)</pre> |
| <div class="block">Keeping track of killed servers and being able to check if a particular server was killed makes |
| it possible to do fault tolerance testing for dead servers in a deterministic way. A concrete |
| example of such case is - killing servers and waiting for all regions of a particular table |
| to be assigned. We can check for server column in META table and that its value is not one |
| of the killed servers.</div> |
| </li> |
| </ul> |
| <a name="stopRegionServer-org.apache.hadoop.hbase.ServerName-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>stopRegionServer</h4> |
| <pre>public abstract void <a href="../../../../src-html/org/apache/hadoop/hbase/HBaseClusterInterface.html#line.123">stopRegionServer</a>(org.apache.hadoop.hbase.ServerName serverName) |
| 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">Stops the given region server, by attempting a gradual stop.</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> - if something goes wrong</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="waitForRegionServerToStart-java.lang.String-int-long-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>waitForRegionServerToStart</h4> |
| <pre>public void <a href="../../../../src-html/org/apache/hadoop/hbase/HBaseClusterInterface.html#line.129">waitForRegionServerToStart</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> hostname, |
| int port, |
| long timeout) |
| 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">Wait for the specified region server to join the cluster</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> - if something goes wrong or timeout occurs</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="waitForRegionServerToStop-org.apache.hadoop.hbase.ServerName-long-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>waitForRegionServerToStop</h4> |
| <pre>public abstract void <a href="../../../../src-html/org/apache/hadoop/hbase/HBaseClusterInterface.html#line.148">waitForRegionServerToStop</a>(org.apache.hadoop.hbase.ServerName serverName, |
| long timeout) |
| 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">Wait for the specified region server to stop the thread / process.</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> - if something goes wrong or timeout occurs</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="suspendRegionServer-org.apache.hadoop.hbase.ServerName-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>suspendRegionServer</h4> |
| <pre>public abstract void <a href="../../../../src-html/org/apache/hadoop/hbase/HBaseClusterInterface.html#line.156">suspendRegionServer</a>(org.apache.hadoop.hbase.ServerName serverName) |
| 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">Suspend the region server</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>serverName</code> - the hostname to suspend the regionserver on</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> - if something goes wrong</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="resumeRegionServer-org.apache.hadoop.hbase.ServerName-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>resumeRegionServer</h4> |
| <pre>public abstract void <a href="../../../../src-html/org/apache/hadoop/hbase/HBaseClusterInterface.html#line.163">resumeRegionServer</a>(org.apache.hadoop.hbase.ServerName serverName) |
| 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">Resume the region server</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>serverName</code> - the hostname to resume the regionserver on</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> - if something goes wrong</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="startZkNode-java.lang.String-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>startZkNode</h4> |
| <pre>public abstract void <a href="../../../../src-html/org/apache/hadoop/hbase/HBaseClusterInterface.html#line.171">startZkNode</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> hostname, |
| int port) |
| 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">Starts a new zookeeper node on the given hostname or if this is a mini/local cluster, |
| silently logs warning message.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>hostname</code> - the hostname to start the regionserver on</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> - if something goes wrong</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="killZkNode-org.apache.hadoop.hbase.ServerName-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>killZkNode</h4> |
| <pre>public abstract void <a href="../../../../src-html/org/apache/hadoop/hbase/HBaseClusterInterface.html#line.178">killZkNode</a>(org.apache.hadoop.hbase.ServerName serverName) |
| 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">Kills the zookeeper node process if this is a distributed cluster, otherwise, |
| this causes master to exit doing basic clean up only.</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> - if something goes wrong</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="stopZkNode-org.apache.hadoop.hbase.ServerName-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>stopZkNode</h4> |
| <pre>public abstract void <a href="../../../../src-html/org/apache/hadoop/hbase/HBaseClusterInterface.html#line.185">stopZkNode</a>(org.apache.hadoop.hbase.ServerName serverName) |
| 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">Stops the region zookeeper if this is a distributed cluster, otherwise |
| silently logs warning message.</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> - if something goes wrong</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="waitForZkNodeToStart-org.apache.hadoop.hbase.ServerName-long-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>waitForZkNodeToStart</h4> |
| <pre>public abstract void <a href="../../../../src-html/org/apache/hadoop/hbase/HBaseClusterInterface.html#line.191">waitForZkNodeToStart</a>(org.apache.hadoop.hbase.ServerName serverName, |
| long timeout) |
| 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">Wait for the specified zookeeper node to join the cluster</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> - if something goes wrong or timeout occurs</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="waitForZkNodeToStop-org.apache.hadoop.hbase.ServerName-long-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>waitForZkNodeToStop</h4> |
| <pre>public abstract void <a href="../../../../src-html/org/apache/hadoop/hbase/HBaseClusterInterface.html#line.198">waitForZkNodeToStop</a>(org.apache.hadoop.hbase.ServerName serverName, |
| long timeout) |
| 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">Wait for the specified zookeeper node to stop the thread / process.</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> - if something goes wrong or timeout occurs</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="startDataNode-org.apache.hadoop.hbase.ServerName-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>startDataNode</h4> |
| <pre>public abstract void <a href="../../../../src-html/org/apache/hadoop/hbase/HBaseClusterInterface.html#line.206">startDataNode</a>(org.apache.hadoop.hbase.ServerName serverName) |
| 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">Starts a new datanode on the given hostname or if this is a mini/local cluster, |
| silently logs warning message.</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> - if something goes wrong</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="killDataNode-org.apache.hadoop.hbase.ServerName-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>killDataNode</h4> |
| <pre>public abstract void <a href="../../../../src-html/org/apache/hadoop/hbase/HBaseClusterInterface.html#line.213">killDataNode</a>(org.apache.hadoop.hbase.ServerName serverName) |
| 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">Kills the datanode process if this is a distributed cluster, otherwise, |
| this causes master to exit doing basic clean up only.</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> - if something goes wrong</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="stopDataNode-org.apache.hadoop.hbase.ServerName-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>stopDataNode</h4> |
| <pre>public abstract void <a href="../../../../src-html/org/apache/hadoop/hbase/HBaseClusterInterface.html#line.220">stopDataNode</a>(org.apache.hadoop.hbase.ServerName serverName) |
| 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">Stops the datanode if this is a distributed cluster, otherwise |
| silently logs warning message.</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> - if something goes wrong</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="waitForDataNodeToStart-org.apache.hadoop.hbase.ServerName-long-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>waitForDataNodeToStart</h4> |
| <pre>public abstract void <a href="../../../../src-html/org/apache/hadoop/hbase/HBaseClusterInterface.html#line.226">waitForDataNodeToStart</a>(org.apache.hadoop.hbase.ServerName serverName, |
| long timeout) |
| 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">Wait for the specified datanode to join the cluster</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> - if something goes wrong or timeout occurs</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="waitForDataNodeToStop-org.apache.hadoop.hbase.ServerName-long-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>waitForDataNodeToStop</h4> |
| <pre>public abstract void <a href="../../../../src-html/org/apache/hadoop/hbase/HBaseClusterInterface.html#line.233">waitForDataNodeToStop</a>(org.apache.hadoop.hbase.ServerName serverName, |
| long timeout) |
| 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">Wait for the specified datanode to stop the thread / process.</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> - if something goes wrong or timeout occurs</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="startNameNode-org.apache.hadoop.hbase.ServerName-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>startNameNode</h4> |
| <pre>public abstract void <a href="../../../../src-html/org/apache/hadoop/hbase/HBaseClusterInterface.html#line.241">startNameNode</a>(org.apache.hadoop.hbase.ServerName serverName) |
| 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">Starts a new namenode on the given hostname or if this is a mini/local cluster, silently logs |
| warning message.</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> - if something goes wrong</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="killNameNode-org.apache.hadoop.hbase.ServerName-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>killNameNode</h4> |
| <pre>public abstract void <a href="../../../../src-html/org/apache/hadoop/hbase/HBaseClusterInterface.html#line.248">killNameNode</a>(org.apache.hadoop.hbase.ServerName serverName) |
| 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">Kills the namenode process if this is a distributed cluster, otherwise, this causes master to |
| exit doing basic clean up only.</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> - if something goes wrong</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="stopNameNode-org.apache.hadoop.hbase.ServerName-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>stopNameNode</h4> |
| <pre>public abstract void <a href="../../../../src-html/org/apache/hadoop/hbase/HBaseClusterInterface.html#line.254">stopNameNode</a>(org.apache.hadoop.hbase.ServerName serverName) |
| 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">Stops the namenode if this is a distributed cluster, otherwise silently logs warning message.</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> - if something goes wrong</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="waitForNameNodeToStart-org.apache.hadoop.hbase.ServerName-long-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>waitForNameNodeToStart</h4> |
| <pre>public abstract void <a href="../../../../src-html/org/apache/hadoop/hbase/HBaseClusterInterface.html#line.260">waitForNameNodeToStart</a>(org.apache.hadoop.hbase.ServerName serverName, |
| long timeout) |
| 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">Wait for the specified namenode to join the cluster</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> - if something goes wrong or timeout occurs</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="waitForNameNodeToStop-org.apache.hadoop.hbase.ServerName-long-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>waitForNameNodeToStop</h4> |
| <pre>public abstract void <a href="../../../../src-html/org/apache/hadoop/hbase/HBaseClusterInterface.html#line.267">waitForNameNodeToStop</a>(org.apache.hadoop.hbase.ServerName serverName, |
| long timeout) |
| 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">Wait for the specified namenode to stop</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> - if something goes wrong or timeout occurs</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="startMaster-java.lang.String-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>startMaster</h4> |
| <pre>public abstract void <a href="../../../../src-html/org/apache/hadoop/hbase/HBaseClusterInterface.html#line.276">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> hostname, |
| int port) |
| 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">Starts a new master on the given hostname or if this is a mini/local cluster, |
| starts a master locally.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>hostname</code> - the hostname to start the master on</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> - if something goes wrong</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="killMaster-org.apache.hadoop.hbase.ServerName-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>killMaster</h4> |
| <pre>public abstract void <a href="../../../../src-html/org/apache/hadoop/hbase/HBaseClusterInterface.html#line.283">killMaster</a>(org.apache.hadoop.hbase.ServerName serverName) |
| 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">Kills the master process if this is a distributed cluster, otherwise, |
| this causes master to exit doing basic clean up only.</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> - if something goes wrong</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="stopMaster-org.apache.hadoop.hbase.ServerName-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>stopMaster</h4> |
| <pre>public abstract void <a href="../../../../src-html/org/apache/hadoop/hbase/HBaseClusterInterface.html#line.289">stopMaster</a>(org.apache.hadoop.hbase.ServerName serverName) |
| 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">Stops the given master, by attempting a gradual stop.</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> - if something goes wrong</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="waitForMasterToStop-org.apache.hadoop.hbase.ServerName-long-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>waitForMasterToStop</h4> |
| <pre>public abstract void <a href="../../../../src-html/org/apache/hadoop/hbase/HBaseClusterInterface.html#line.295">waitForMasterToStop</a>(org.apache.hadoop.hbase.ServerName serverName, |
| long timeout) |
| 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">Wait for the specified master to stop the thread / process.</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> - if something goes wrong or timeout occurs</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="waitForActiveAndReadyMaster--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>waitForActiveAndReadyMaster</h4> |
| <pre>public boolean <a href="../../../../src-html/org/apache/hadoop/hbase/HBaseClusterInterface.html#line.306">waitForActiveAndReadyMaster</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">Blocks until there is an active master and that master has completed |
| initialization.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if an active master becomes available. false if there are no |
| masters left.</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> - if something goes wrong or timeout occurs</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="waitForActiveAndReadyMaster-long-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>waitForActiveAndReadyMaster</h4> |
| <pre>public abstract boolean <a href="../../../../src-html/org/apache/hadoop/hbase/HBaseClusterInterface.html#line.318">waitForActiveAndReadyMaster</a>(long timeout) |
| 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">Blocks until there is an active master and that master has completed |
| initialization.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>timeout</code> - the timeout limit in ms</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if an active master becomes available. false if there are no |
| masters left.</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="waitUntilShutDown--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>waitUntilShutDown</h4> |
| <pre>public abstract void <a href="../../../../src-html/org/apache/hadoop/hbase/HBaseClusterInterface.html#line.324">waitUntilShutDown</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">Wait for HBase Cluster to shut down.</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="shutdown--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>shutdown</h4> |
| <pre>public abstract void <a href="../../../../src-html/org/apache/hadoop/hbase/HBaseClusterInterface.html#line.329">shutdown</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">Shut down the HBase cluster</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="restoreInitialStatus--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>restoreInitialStatus</h4> |
| <pre>public boolean <a href="../../../../src-html/org/apache/hadoop/hbase/HBaseClusterInterface.html#line.338">restoreInitialStatus</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">Restores the cluster to it's initial state if this is a real cluster, |
| otherwise does nothing. |
| This is a best effort restore. If the servers are not reachable, or insufficient |
| permissions, etc. restoration might be partial.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>whether restoration is complete</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="restoreClusterMetrics-org.apache.hadoop.hbase.ClusterMetrics-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>restoreClusterMetrics</h4> |
| <pre>public boolean <a href="../../../../src-html/org/apache/hadoop/hbase/HBaseClusterInterface.html#line.349">restoreClusterMetrics</a>(org.apache.hadoop.hbase.ClusterMetrics desiredStatus) |
| 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">Restores the cluster to given state if this is a real cluster, |
| otherwise does nothing. |
| This is a best effort restore. If the servers are not reachable, or insufficient |
| permissions, etc. restoration might be partial.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>whether restoration is complete</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="getServerHoldingMeta--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getServerHoldingMeta</h4> |
| <pre>public org.apache.hadoop.hbase.ServerName <a href="../../../../src-html/org/apache/hadoop/hbase/HBaseClusterInterface.html#line.356">getServerHoldingMeta</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">Get the ServerName of region server serving the first hbase:meta region</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="getServerHoldingRegion-org.apache.hadoop.hbase.TableName-byte:A-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getServerHoldingRegion</h4> |
| <pre>public abstract org.apache.hadoop.hbase.ServerName <a href="../../../../src-html/org/apache/hadoop/hbase/HBaseClusterInterface.html#line.367">getServerHoldingRegion</a>(org.apache.hadoop.hbase.TableName tn, |
| byte[] regionName) |
| 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">Get the ServerName of region server serving the specified region</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>regionName</code> - Name of the region in bytes</dd> |
| <dd><code>tn</code> - Table name that has the region.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>ServerName that hosts the region or null</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="isDistributedCluster--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isDistributedCluster</h4> |
| <pre>public boolean <a href="../../../../src-html/org/apache/hadoop/hbase/HBaseClusterInterface.html#line.374">isDistributedCluster</a>()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>whether we are interacting with a distributed cluster as opposed to an |
| in-process mini/local cluster.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="close--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>close</h4> |
| <pre>public abstract void <a href="../../../../src-html/org/apache/hadoop/hbase/HBaseClusterInterface.html#line.384">close</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">Closes all the resources held open for this cluster. Note that this call does not shutdown |
| the cluster.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/Closeable.html?is-external=true#close--" title="class or interface in java.io">close</a></code> in interface <code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/Closeable.html?is-external=true" title="class or interface in java.io">Closeable</a></code></dd> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/AutoCloseable.html?is-external=true#close--" title="class or interface in java.lang">close</a></code> in interface <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/AutoCloseable.html?is-external=true" title="class or interface in java.lang">AutoCloseable</a></code></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> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/apache/hadoop/hbase/HBaseClusterInterface.html#shutdown--"><code>shutdown()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="waitForNamenodeAvailable--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>waitForNamenodeAvailable</h4> |
| <pre>public void <a href="../../../../src-html/org/apache/hadoop/hbase/HBaseClusterInterface.html#line.391">waitForNamenodeAvailable</a>() |
| throws <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/InterruptedException.html?is-external=true" title="class or interface in java.lang">InterruptedException</a></pre> |
| <div class="block">Wait for the namenode.</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/InterruptedException.html?is-external=true" title="class or interface in java.lang">InterruptedException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="waitForDatanodesRegistered-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>waitForDatanodesRegistered</h4> |
| <pre>public void <a href="../../../../src-html/org/apache/hadoop/hbase/HBaseClusterInterface.html#line.394">waitForDatanodesRegistered</a>(int nbDN) |
| 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> |
| <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> |
| </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/HBaseClusterInterface.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/HBaseClassTestRuleChecker.html" title="class in org.apache.hadoop.hbase"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/hadoop/hbase/HBaseClusterManager.html" title="class in org.apache.hadoop.hbase"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/hadoop/hbase/HBaseClusterInterface.html" target="_top">Frames</a></li> |
| <li><a href="HBaseClusterInterface.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../allclasses-noframe.html">All 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: </li> |
| <li>Nested | </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="subNavList"> |
| <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> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small>Copyright © 2007–2021 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |
