http://git-wip-us.apache.org/repos/asf/hbase-site/blob/48bd3915/devapidocs/org/apache/hadoop/hbase/zookeeper/MetaTableLocator.html ---------------------------------------------------------------------- diff --git a/devapidocs/org/apache/hadoop/hbase/zookeeper/MetaTableLocator.html b/devapidocs/org/apache/hadoop/hbase/zookeeper/MetaTableLocator.html index 05e03a6..9a0936c 100644 --- a/devapidocs/org/apache/hadoop/hbase/zookeeper/MetaTableLocator.html +++ b/devapidocs/org/apache/hadoop/hbase/zookeeper/MetaTableLocator.html @@ -241,12 +241,16 @@ extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html? </tr> <tr id="i9" class="rowColor"> <td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><<a href="../../../../../org/apache/hadoop/hbase/client/RegionInfo.html" title="interface in org.apache.hadoop.hbase.client">RegionInfo</a>></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/zookeeper/MetaTableLocator.html#getMetaRegions-org.apache.hadoop.hbase.zookeeper.ZKWatcher-">getMetaRegions</a></span>(<a href="../../../../../org/apache/hadoop/hbase/zookeeper/ZKWatcher.html" title="class in org.apache.hadoop.hbase.zookeeper">ZKWatcher</a> zkw)</code> </td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/zookeeper/MetaTableLocator.html#getMetaRegions-org.apache.hadoop.hbase.zookeeper.ZKWatcher-">getMetaRegions</a></span>(<a href="../../../../../org/apache/hadoop/hbase/zookeeper/ZKWatcher.html" title="class in org.apache.hadoop.hbase.zookeeper">ZKWatcher</a> zkw)</code> +<div class="block">Gets the meta regions for the given path with the default replica ID.</div> +</td> </tr> <tr id="i10" class="altColor"> <td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><<a href="../../../../../org/apache/hadoop/hbase/client/RegionInfo.html" title="interface in org.apache.hadoop.hbase.client">RegionInfo</a>></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/zookeeper/MetaTableLocator.html#getMetaRegions-org.apache.hadoop.hbase.zookeeper.ZKWatcher-int-">getMetaRegions</a></span>(<a href="../../../../../org/apache/hadoop/hbase/zookeeper/ZKWatcher.html" title="class in org.apache.hadoop.hbase.zookeeper">ZKWatcher</a> zkw, - int replicaId)</code> </td> + int replicaId)</code> +<div class="block">Gets the meta regions for the given path and replica ID.</div> +</td> </tr> <tr id="i11" class="rowColor"> <td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><<a href="../../../../../org/apache/hadoop/hbase/util/Pair.html" title="class in org.apache.hadoop.hbase.util">Pair</a><<a href="../../../../../org/apache/hadoop/hbase/client/RegionInfo.html" title="interface in org.apache.hadoop.hbase.client">RegionInfo</a>,<a href="../../../../../org/apache/hadoop/hbase/ServerName.html" title="class in org.apache.hadoop.hbase">ServerName</a>>></code></td> @@ -255,7 +259,9 @@ extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html? <tr id="i12" class="altColor"> <td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><<a href="../../../../../org/apache/hadoop/hbase/util/Pair.html" title="class in org.apache.hadoop.hbase.util">Pair</a><<a href="../../../../../org/apache/hadoop/hbase/client/RegionInfo.html" title="interface in org.apache.hadoop.hbase.client">RegionInfo</a>,<a href="../../../../../org/apache/hadoop/hbase/ServerName.html" title="class in org.apache.hadoop.hbase">ServerName</a>>></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/zookeeper/MetaTableLocator.html#getMetaRegionsAndLocations-org.apache.hadoop.hbase.zookeeper.ZKWatcher-int-">getMetaRegionsAndLocations</a></span>(<a href="../../../../../org/apache/hadoop/hbase/zookeeper/ZKWatcher.html" title="class in org.apache.hadoop.hbase.zookeeper">ZKWatcher</a> zkw, - int replicaId)</code> </td> + int replicaId)</code> +<div class="block">Gets the meta regions and their locations for the given path and replica ID.</div> +</td> </tr> <tr id="i13" class="rowColor"> <td class="colFirst"><code>static <a href="../../../../../org/apache/hadoop/hbase/master/RegionState.html" title="class in org.apache.hadoop.hbase.master">RegionState</a></code></td> @@ -276,8 +282,8 @@ extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html? <a href="../../../../../org/apache/hadoop/hbase/zookeeper/ZKWatcher.html" title="class in org.apache.hadoop.hbase.zookeeper">ZKWatcher</a> zkw, long timeout, int replicaId)</code> -<div class="block">Gets a connection to the server hosting meta, as reported by ZooKeeper, - waiting up to the specified timeout for availability.</div> +<div class="block">Gets a connection to the server hosting meta, as reported by ZooKeeper, waiting up to the + specified timeout for availability.</div> </td> </tr> <tr id="i16" class="altColor"> @@ -292,8 +298,7 @@ extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html? <a href="../../../../../org/apache/hadoop/hbase/ServerName.html" title="class in org.apache.hadoop.hbase">ServerName</a> serverName, int replicaId, <a href="../../../../../org/apache/hadoop/hbase/master/RegionState.State.html" title="enum in org.apache.hadoop.hbase.master">RegionState.State</a> state)</code> -<div class="block">Sets the location of <code>hbase:meta</code> in ZooKeeper to the - specified server address.</div> +<div class="block">Sets the location of <code>hbase:meta</code> in ZooKeeper to the specified server address.</div> </td> </tr> <tr id="i18" class="altColor"> @@ -349,8 +354,8 @@ extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html? <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/zookeeper/MetaTableLocator.html#waitMetaRegionLocation-org.apache.hadoop.hbase.zookeeper.ZKWatcher-int-long-">waitMetaRegionLocation</a></span>(<a href="../../../../../org/apache/hadoop/hbase/zookeeper/ZKWatcher.html" title="class in org.apache.hadoop.hbase.zookeeper">ZKWatcher</a> zkw, int replicaId, long timeout)</code> -<div class="block">Gets the meta region location, if available, and waits for up to the - specified timeout if not immediately available.</div> +<div class="block">Gets the meta region location, if available, and waits for up to the specified timeout if not + immediately available.</div> </td> </tr> <tr id="i25" class="rowColor"> @@ -461,12 +466,13 @@ extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html? <ul class="blockList"> <li class="blockList"> <h4>getMetaRegionsAndLocations</h4> -<pre>public <a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><<a href="../../../../../org/apache/hadoop/hbase/util/Pair.html" title="class in org.apache.hadoop.hbase.util">Pair</a><<a href="../../../../../org/apache/hadoop/hbase/client/RegionInfo.html" title="interface in org.apache.hadoop.hbase.client">RegionInfo</a>,<a href="../../../../../org/apache/hadoop/hbase/ServerName.html" title="class in org.apache.hadoop.hbase">ServerName</a>>> <a href="../../../../../src-html/org/apache/hadoop/hbase/zookeeper/MetaTableLocator.html#line.107">getMetaRegionsAndLocations</a>(<a href="../../../../../org/apache/hadoop/hbase/zookeeper/ZKWatcher.html" title="class in org.apache.hadoop.hbase.zookeeper">ZKWatcher</a> zkw, +<pre>public <a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><<a href="../../../../../org/apache/hadoop/hbase/util/Pair.html" title="class in org.apache.hadoop.hbase.util">Pair</a><<a href="../../../../../org/apache/hadoop/hbase/client/RegionInfo.html" title="interface in org.apache.hadoop.hbase.client">RegionInfo</a>,<a href="../../../../../org/apache/hadoop/hbase/ServerName.html" title="class in org.apache.hadoop.hbase">ServerName</a>>> <a href="../../../../../src-html/org/apache/hadoop/hbase/zookeeper/MetaTableLocator.html#line.108">getMetaRegionsAndLocations</a>(<a href="../../../../../org/apache/hadoop/hbase/zookeeper/ZKWatcher.html" title="class in org.apache.hadoop.hbase.zookeeper">ZKWatcher</a> zkw, int replicaId)</pre> +<div class="block">Gets the meta regions and their locations for the given path and replica ID.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>zkw</code> - </dd> -<dd><code>replicaId</code> - </dd> +<dd><code>zkw</code> - reference to the <a href="../../../../../org/apache/hadoop/hbase/zookeeper/ZKWatcher.html" title="class in org.apache.hadoop.hbase.zookeeper"><code>ZKWatcher</code></a> which also contains configuration and operation</dd> +<dd><code>replicaId</code> - the ID of the replica</dd> <dt><span class="returnLabel">Returns:</span></dt> <dd>meta table regions and their locations.</dd> </dl> @@ -478,7 +484,8 @@ extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html? <ul class="blockList"> <li class="blockList"> <h4>getMetaRegions</h4> -<pre>public <a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><<a href="../../../../../org/apache/hadoop/hbase/client/RegionInfo.html" title="interface in org.apache.hadoop.hbase.client">RegionInfo</a>> <a href="../../../../../src-html/org/apache/hadoop/hbase/zookeeper/MetaTableLocator.html#line.120">getMetaRegions</a>(<a href="../../../../../org/apache/hadoop/hbase/zookeeper/ZKWatcher.html" title="class in org.apache.hadoop.hbase.zookeeper">ZKWatcher</a> zkw)</pre> +<pre>public <a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><<a href="../../../../../org/apache/hadoop/hbase/client/RegionInfo.html" title="interface in org.apache.hadoop.hbase.client">RegionInfo</a>> <a href="../../../../../src-html/org/apache/hadoop/hbase/zookeeper/MetaTableLocator.html#line.123">getMetaRegions</a>(<a href="../../../../../org/apache/hadoop/hbase/zookeeper/ZKWatcher.html" title="class in org.apache.hadoop.hbase.zookeeper">ZKWatcher</a> zkw)</pre> +<div class="block">Gets the meta regions for the given path with the default replica ID.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>zkw</code> - ZooKeeper watcher to be used</dd> @@ -493,12 +500,13 @@ extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html? <ul class="blockList"> <li class="blockList"> <h4>getMetaRegions</h4> -<pre>public <a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><<a href="../../../../../org/apache/hadoop/hbase/client/RegionInfo.html" title="interface in org.apache.hadoop.hbase.client">RegionInfo</a>> <a href="../../../../../src-html/org/apache/hadoop/hbase/zookeeper/MetaTableLocator.html#line.130">getMetaRegions</a>(<a href="../../../../../org/apache/hadoop/hbase/zookeeper/ZKWatcher.html" title="class in org.apache.hadoop.hbase.zookeeper">ZKWatcher</a> zkw, +<pre>public <a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><<a href="../../../../../org/apache/hadoop/hbase/client/RegionInfo.html" title="interface in org.apache.hadoop.hbase.client">RegionInfo</a>> <a href="../../../../../src-html/org/apache/hadoop/hbase/zookeeper/MetaTableLocator.html#line.134">getMetaRegions</a>(<a href="../../../../../org/apache/hadoop/hbase/zookeeper/ZKWatcher.html" title="class in org.apache.hadoop.hbase.zookeeper">ZKWatcher</a> zkw, int replicaId)</pre> +<div class="block">Gets the meta regions for the given path and replica ID.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>zkw</code> - </dd> -<dd><code>replicaId</code> - </dd> +<dd><code>zkw</code> - reference to the <a href="../../../../../org/apache/hadoop/hbase/zookeeper/ZKWatcher.html" title="class in org.apache.hadoop.hbase.zookeeper"><code>ZKWatcher</code></a> which also contains configuration and operation</dd> +<dd><code>replicaId</code> - the ID of the replica</dd> <dt><span class="returnLabel">Returns:</span></dt> <dd>List of meta regions</dd> </dl> @@ -510,7 +518,7 @@ extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html? <ul class="blockList"> <li class="blockList"> <h4>getListOfRegionInfos</h4> -<pre>private <a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><<a href="../../../../../org/apache/hadoop/hbase/client/RegionInfo.html" title="interface in org.apache.hadoop.hbase.client">RegionInfo</a>> <a href="../../../../../src-html/org/apache/hadoop/hbase/zookeeper/MetaTableLocator.html#line.136">getListOfRegionInfos</a>(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><<a href="../../../../../org/apache/hadoop/hbase/util/Pair.html" title="class in org.apache.hadoop.hbase.util">Pair</a><<a href="../../../../../org/apache/hadoop/hbase/client/RegionInfo.html" title="interface in org.apache.hadoop.hbase.client">RegionInfo</a>,<a href="../../../../../org/apache/hadoop/hbase/ServerName.html" title="class in org.apache.hadoop.hbase">ServerName</a>>> pairs)</pre> +<pre>private <a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><<a href="../../../../../org/apache/hadoop/hbase/client/RegionInfo.html" title="interface in org.apache.hadoop.hbase.client">RegionInfo</a>> <a href="../../../../../src-html/org/apache/hadoop/hbase/zookeeper/MetaTableLocator.html#line.140">getListOfRegionInfos</a>(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><<a href="../../../../../org/apache/hadoop/hbase/util/Pair.html" title="class in org.apache.hadoop.hbase.util">Pair</a><<a href="../../../../../org/apache/hadoop/hbase/client/RegionInfo.html" title="interface in org.apache.hadoop.hbase.client">RegionInfo</a>,<a href="../../../../../org/apache/hadoop/hbase/ServerName.html" title="class in org.apache.hadoop.hbase">ServerName</a>>> pairs)</pre> </li> </ul> <a name="getMetaRegionLocation-org.apache.hadoop.hbase.zookeeper.ZKWatcher-"> @@ -519,7 +527,7 @@ extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html? <ul class="blockList"> <li class="blockList"> <h4>getMetaRegionLocation</h4> -<pre>public <a href="../../../../../org/apache/hadoop/hbase/ServerName.html" title="class in org.apache.hadoop.hbase">ServerName</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/zookeeper/MetaTableLocator.html#line.151">getMetaRegionLocation</a>(<a href="../../../../../org/apache/hadoop/hbase/zookeeper/ZKWatcher.html" title="class in org.apache.hadoop.hbase.zookeeper">ZKWatcher</a> zkw)</pre> +<pre>public <a href="../../../../../org/apache/hadoop/hbase/ServerName.html" title="class in org.apache.hadoop.hbase">ServerName</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/zookeeper/MetaTableLocator.html#line.157">getMetaRegionLocation</a>(<a href="../../../../../org/apache/hadoop/hbase/zookeeper/ZKWatcher.html" title="class in org.apache.hadoop.hbase.zookeeper">ZKWatcher</a> zkw)</pre> <div class="block">Gets the meta region location, if available. Does not block.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> @@ -535,13 +543,13 @@ extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html? <ul class="blockList"> <li class="blockList"> <h4>getMetaRegionLocation</h4> -<pre>public <a href="../../../../../org/apache/hadoop/hbase/ServerName.html" title="class in org.apache.hadoop.hbase">ServerName</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/zookeeper/MetaTableLocator.html#line.166">getMetaRegionLocation</a>(<a href="../../../../../org/apache/hadoop/hbase/zookeeper/ZKWatcher.html" title="class in org.apache.hadoop.hbase.zookeeper">ZKWatcher</a> zkw, +<pre>public <a href="../../../../../org/apache/hadoop/hbase/ServerName.html" title="class in org.apache.hadoop.hbase">ServerName</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/zookeeper/MetaTableLocator.html#line.172">getMetaRegionLocation</a>(<a href="../../../../../org/apache/hadoop/hbase/zookeeper/ZKWatcher.html" title="class in org.apache.hadoop.hbase.zookeeper">ZKWatcher</a> zkw, int replicaId)</pre> <div class="block">Gets the meta region location, if available. Does not block.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>zkw</code> - </dd> -<dd><code>replicaId</code> - </dd> +<dd><code>zkw</code> - reference to the <a href="../../../../../org/apache/hadoop/hbase/zookeeper/ZKWatcher.html" title="class in org.apache.hadoop.hbase.zookeeper"><code>ZKWatcher</code></a> which also contains configuration and operation</dd> +<dd><code>replicaId</code> - the ID of the replica</dd> <dt><span class="returnLabel">Returns:</span></dt> <dd>server name</dd> </dl> @@ -553,7 +561,7 @@ extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html? <ul class="blockList"> <li class="blockList"> <h4>waitMetaRegionLocation</h4> -<pre>public <a href="../../../../../org/apache/hadoop/hbase/ServerName.html" title="class in org.apache.hadoop.hbase">ServerName</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/zookeeper/MetaTableLocator.html#line.187">waitMetaRegionLocation</a>(<a href="../../../../../org/apache/hadoop/hbase/zookeeper/ZKWatcher.html" title="class in org.apache.hadoop.hbase.zookeeper">ZKWatcher</a> zkw, +<pre>public <a href="../../../../../org/apache/hadoop/hbase/ServerName.html" title="class in org.apache.hadoop.hbase">ServerName</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/zookeeper/MetaTableLocator.html#line.194">waitMetaRegionLocation</a>(<a href="../../../../../org/apache/hadoop/hbase/zookeeper/ZKWatcher.html" title="class in org.apache.hadoop.hbase.zookeeper">ZKWatcher</a> zkw, long timeout) throws <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/InterruptedException.html?is-external=true"; title="class or interface in java.lang">InterruptedException</a>, <a href="../../../../../org/apache/hadoop/hbase/NotAllMetaRegionsOnlineException.html" title="class in org.apache.hadoop.hbase">NotAllMetaRegionsOnlineException</a></pre> @@ -563,14 +571,14 @@ extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html? get the latest data.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>zkw</code> - </dd> +<dd><code>zkw</code> - reference to the <a href="../../../../../org/apache/hadoop/hbase/zookeeper/ZKWatcher.html" title="class in org.apache.hadoop.hbase.zookeeper"><code>ZKWatcher</code></a> which also contains configuration and operation</dd> <dd><code>timeout</code> - maximum time to wait, in millis</dd> <dt><span class="returnLabel">Returns:</span></dt> <dd>server name for server hosting meta region formatted as per <a href="../../../../../org/apache/hadoop/hbase/ServerName.html" title="class in org.apache.hadoop.hbase"><code>ServerName</code></a>, or null if none available</dd> <dt><span class="throwsLabel">Throws:</span></dt> <dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/InterruptedException.html?is-external=true"; title="class or interface in java.lang">InterruptedException</a></code> - if interrupted while waiting</dd> -<dd><code><a href="../../../../../org/apache/hadoop/hbase/NotAllMetaRegionsOnlineException.html" title="class in org.apache.hadoop.hbase">NotAllMetaRegionsOnlineException</a></code></dd> +<dd><code><a href="../../../../../org/apache/hadoop/hbase/NotAllMetaRegionsOnlineException.html" title="class in org.apache.hadoop.hbase">NotAllMetaRegionsOnlineException</a></code> - if a meta or root region is not online</dd> </dl> </li> </ul> @@ -580,26 +588,25 @@ extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html? <ul class="blockList"> <li class="blockList"> <h4>waitMetaRegionLocation</h4> -<pre>public <a href="../../../../../org/apache/hadoop/hbase/ServerName.html" title="class in org.apache.hadoop.hbase">ServerName</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/zookeeper/MetaTableLocator.html#line.205">waitMetaRegionLocation</a>(<a href="../../../../../org/apache/hadoop/hbase/zookeeper/ZKWatcher.html" title="class in org.apache.hadoop.hbase.zookeeper">ZKWatcher</a> zkw, +<pre>public <a href="../../../../../org/apache/hadoop/hbase/ServerName.html" title="class in org.apache.hadoop.hbase">ServerName</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/zookeeper/MetaTableLocator.html#line.212">waitMetaRegionLocation</a>(<a href="../../../../../org/apache/hadoop/hbase/zookeeper/ZKWatcher.html" title="class in org.apache.hadoop.hbase.zookeeper">ZKWatcher</a> zkw, int replicaId, long timeout) throws <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/InterruptedException.html?is-external=true"; title="class or interface in java.lang">InterruptedException</a>, <a href="../../../../../org/apache/hadoop/hbase/NotAllMetaRegionsOnlineException.html" title="class in org.apache.hadoop.hbase">NotAllMetaRegionsOnlineException</a></pre> -<div class="block">Gets the meta region location, if available, and waits for up to the - specified timeout if not immediately available. - Given the zookeeper notification could be delayed, we will try to +<div class="block">Gets the meta region location, if available, and waits for up to the specified timeout if not + immediately available. Given the zookeeper notification could be delayed, we will try to get the latest data.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>zkw</code> - </dd> -<dd><code>replicaId</code> - </dd> +<dd><code>zkw</code> - reference to the <a href="../../../../../org/apache/hadoop/hbase/zookeeper/ZKWatcher.html" title="class in org.apache.hadoop.hbase.zookeeper"><code>ZKWatcher</code></a> which also contains configuration and operation</dd> +<dd><code>replicaId</code> - the ID of the replica</dd> <dd><code>timeout</code> - maximum time to wait, in millis</dd> <dt><span class="returnLabel">Returns:</span></dt> <dd>server name for server hosting meta region formatted as per <a href="../../../../../org/apache/hadoop/hbase/ServerName.html" title="class in org.apache.hadoop.hbase"><code>ServerName</code></a>, or null if none available</dd> <dt><span class="throwsLabel">Throws:</span></dt> -<dd><code><a href="http://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> -<dd><code><a href="../../../../../org/apache/hadoop/hbase/NotAllMetaRegionsOnlineException.html" title="class in org.apache.hadoop.hbase">NotAllMetaRegionsOnlineException</a></code></dd> +<dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/InterruptedException.html?is-external=true"; title="class or interface in java.lang">InterruptedException</a></code> - if waiting for the socket operation fails</dd> +<dd><code><a href="../../../../../org/apache/hadoop/hbase/NotAllMetaRegionsOnlineException.html" title="class in org.apache.hadoop.hbase">NotAllMetaRegionsOnlineException</a></code> - if a meta or root region is not online</dd> </dl> </li> </ul> @@ -609,7 +616,7 @@ extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html? <ul class="blockList"> <li class="blockList"> <h4>waitMetaRegionLocation</h4> -<pre>public void <a href="../../../../../src-html/org/apache/hadoop/hbase/zookeeper/MetaTableLocator.html#line.233">waitMetaRegionLocation</a>(<a href="../../../../../org/apache/hadoop/hbase/zookeeper/ZKWatcher.html" title="class in org.apache.hadoop.hbase.zookeeper">ZKWatcher</a> zkw) +<pre>public void <a href="../../../../../src-html/org/apache/hadoop/hbase/zookeeper/MetaTableLocator.html#line.240">waitMetaRegionLocation</a>(<a href="../../../../../org/apache/hadoop/hbase/zookeeper/ZKWatcher.html" title="class in org.apache.hadoop.hbase.zookeeper">ZKWatcher</a> zkw) throws <a href="http://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">Waits indefinitely for availability of <code>hbase:meta</code>. Used during cluster startup. Does not verify meta, just that something has been @@ -628,7 +635,7 @@ extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html? <ul class="blockList"> <li class="blockList"> <h4>verifyMetaRegionLocation</h4> -<pre>public boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/zookeeper/MetaTableLocator.html#line.262">verifyMetaRegionLocation</a>(<a href="../../../../../org/apache/hadoop/hbase/client/ClusterConnection.html" title="interface in org.apache.hadoop.hbase.client">ClusterConnection</a> hConnection, +<pre>public boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/zookeeper/MetaTableLocator.html#line.273">verifyMetaRegionLocation</a>(<a href="../../../../../org/apache/hadoop/hbase/client/ClusterConnection.html" title="interface in org.apache.hadoop.hbase.client">ClusterConnection</a> hConnection, <a href="../../../../../org/apache/hadoop/hbase/zookeeper/ZKWatcher.html" title="class in org.apache.hadoop.hbase.zookeeper">ZKWatcher</a> zkw, long timeout) throws <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/InterruptedException.html?is-external=true"; title="class or interface in java.lang">InterruptedException</a>, @@ -636,15 +643,15 @@ extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html? <div class="block">Verify <code>hbase:meta</code> is deployed and accessible.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>hConnection</code> - </dd> -<dd><code>zkw</code> - </dd> +<dd><code>hConnection</code> - the connection to use</dd> +<dd><code>zkw</code> - reference to the <a href="../../../../../org/apache/hadoop/hbase/zookeeper/ZKWatcher.html" title="class in org.apache.hadoop.hbase.zookeeper"><code>ZKWatcher</code></a> which also contains configuration and operation</dd> <dd><code>timeout</code> - How long to wait on zk for meta address (passed through to - the internal call to <a href="../../../../../org/apache/hadoop/hbase/zookeeper/MetaTableLocator.html#getMetaServerConnection-org.apache.hadoop.hbase.client.ClusterConnection-org.apache.hadoop.hbase.zookeeper.ZKWatcher-long-int-"><code>getMetaServerConnection(org.apache.hadoop.hbase.client.ClusterConnection, org.apache.hadoop.hbase.zookeeper.ZKWatcher, long, int)</code></a>.</dd> + the internal call to <a href="../../../../../org/apache/hadoop/hbase/zookeeper/MetaTableLocator.html#getMetaServerConnection-org.apache.hadoop.hbase.client.ClusterConnection-org.apache.hadoop.hbase.zookeeper.ZKWatcher-long-int-"><code>getMetaServerConnection(org.apache.hadoop.hbase.client.ClusterConnection, org.apache.hadoop.hbase.zookeeper.ZKWatcher, long, int)</code></a>.</dd> <dt><span class="returnLabel">Returns:</span></dt> <dd>True if the <code>hbase:meta</code> location is healthy.</dd> <dt><span class="throwsLabel">Throws:</span></dt> -<dd><code><a href="http://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> -<dd><code><a href="http://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> +<dd><code><a href="http://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 the number of retries for getting the connection is exceeded</dd> +<dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/InterruptedException.html?is-external=true"; title="class or interface in java.lang">InterruptedException</a></code> - if waiting for the socket operation fails</dd> </dl> </li> </ul> @@ -654,7 +661,7 @@ extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html? <ul class="blockList"> <li class="blockList"> <h4>verifyMetaRegionLocation</h4> -<pre>public boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/zookeeper/MetaTableLocator.html#line.278">verifyMetaRegionLocation</a>(<a href="../../../../../org/apache/hadoop/hbase/client/ClusterConnection.html" title="interface in org.apache.hadoop.hbase.client">ClusterConnection</a> connection, +<pre>public boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/zookeeper/MetaTableLocator.html#line.289">verifyMetaRegionLocation</a>(<a href="../../../../../org/apache/hadoop/hbase/client/ClusterConnection.html" title="interface in org.apache.hadoop.hbase.client">ClusterConnection</a> connection, <a href="../../../../../org/apache/hadoop/hbase/zookeeper/ZKWatcher.html" title="class in org.apache.hadoop.hbase.zookeeper">ZKWatcher</a> zkw, long timeout, int replicaId) @@ -663,15 +670,15 @@ extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html? <div class="block">Verify <code>hbase:meta</code> is deployed and accessible.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>connection</code> - </dd> -<dd><code>zkw</code> - </dd> +<dd><code>connection</code> - the connection to use</dd> +<dd><code>zkw</code> - reference to the <a href="../../../../../org/apache/hadoop/hbase/zookeeper/ZKWatcher.html" title="class in org.apache.hadoop.hbase.zookeeper"><code>ZKWatcher</code></a> which also contains configuration and operation</dd> <dd><code>timeout</code> - How long to wait on zk for meta address (passed through to</dd> -<dd><code>replicaId</code> - </dd> +<dd><code>replicaId</code> - the ID of the replica</dd> <dt><span class="returnLabel">Returns:</span></dt> <dd>True if the <code>hbase:meta</code> location is healthy.</dd> <dt><span class="throwsLabel">Throws:</span></dt> -<dd><code><a href="http://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> -<dd><code><a href="http://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> +<dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/InterruptedException.html?is-external=true"; title="class or interface in java.lang">InterruptedException</a></code> - if waiting for the socket operation fails</dd> +<dd><code><a href="http://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 the number of retries for getting the connection is exceeded</dd> </dl> </li> </ul> @@ -681,24 +688,20 @@ extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html? <ul class="blockList"> <li class="blockList"> <h4>verifyRegionLocation</h4> -<pre>private boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/zookeeper/MetaTableLocator.html#line.313">verifyRegionLocation</a>(<a href="../../../../../org/apache/hadoop/hbase/client/ClusterConnection.html" title="interface in org.apache.hadoop.hbase.client">ClusterConnection</a> connection, +<pre>private boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/zookeeper/MetaTableLocator.html#line.321">verifyRegionLocation</a>(<a href="../../../../../org/apache/hadoop/hbase/client/ClusterConnection.html" title="interface in org.apache.hadoop.hbase.client">ClusterConnection</a> connection, org.apache.hadoop.hbase.shaded.protobuf.generated.AdminProtos.AdminService.BlockingInterface hostingServer, <a href="../../../../../org/apache/hadoop/hbase/ServerName.html" title="class in org.apache.hadoop.hbase">ServerName</a> address, - byte[] regionName) - throws <a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></pre> + byte[] regionName)</pre> <div class="block">Verify we can connect to <code>hostingServer</code> and that its carrying <code>regionName</code>.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>hostingServer</code> - Interface to the server hosting <code>regionName</code></dd> -<dd><code>address</code> - The servername that goes with the <code>metaServer</code> - Interface. Used logging.</dd> +<dd><code>address</code> - The servername that goes with the <code>metaServer</code> interface. + Used logging.</dd> <dd><code>regionName</code> - The regionname we are interested in.</dd> <dt><span class="returnLabel">Returns:</span></dt> -<dd>True if we were able to verify the region located at other side of - the Interface.</dd> -<dt><span class="throwsLabel">Throws:</span></dt> -<dd><code><a href="http://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> +<dd>True if we were able to verify the region located at other side of the interface.</dd> </dl> </li> </ul> @@ -708,28 +711,27 @@ extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html? <ul class="blockList"> <li class="blockList"> <h4>getMetaServerConnection</h4> -<pre>private org.apache.hadoop.hbase.shaded.protobuf.generated.AdminProtos.AdminService.BlockingInterface <a href="../../../../../src-html/org/apache/hadoop/hbase/zookeeper/MetaTableLocator.html#line.362">getMetaServerConnection</a>(<a href="../../../../../org/apache/hadoop/hbase/client/ClusterConnection.html" title="interface in org.apache.hadoop.hbase.client">ClusterConnection</a> connection, +<pre>private org.apache.hadoop.hbase.shaded.protobuf.generated.AdminProtos.AdminService.BlockingInterface <a href="../../../../../src-html/org/apache/hadoop/hbase/zookeeper/MetaTableLocator.html#line.370">getMetaServerConnection</a>(<a href="../../../../../org/apache/hadoop/hbase/client/ClusterConnection.html" title="interface in org.apache.hadoop.hbase.client">ClusterConnection</a> connection, <a href="../../../../../org/apache/hadoop/hbase/zookeeper/ZKWatcher.html" title="class in org.apache.hadoop.hbase.zookeeper">ZKWatcher</a> zkw, long timeout, int replicaId) throws <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/InterruptedException.html?is-external=true"; title="class or interface in java.lang">InterruptedException</a>, - <a href="../../../../../org/apache/hadoop/hbase/NotAllMetaRegionsOnlineException.html" title="class in org.apache.hadoop.hbase">NotAllMetaRegionsOnlineException</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></pre> -<div class="block">Gets a connection to the server hosting meta, as reported by ZooKeeper, - waiting up to the specified timeout for availability. +<div class="block">Gets a connection to the server hosting meta, as reported by ZooKeeper, waiting up to the + specified timeout for availability. + <p>WARNING: Does not retry. Use an <a href="../../../../../org/apache/hadoop/hbase/client/HTable.html" title="class in org.apache.hadoop.hbase.client"><code>HTable</code></a> instead.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>connection</code> - </dd> -<dd><code>zkw</code> - </dd> +<dd><code>connection</code> - the connection to use</dd> +<dd><code>zkw</code> - reference to the <a href="../../../../../org/apache/hadoop/hbase/zookeeper/ZKWatcher.html" title="class in org.apache.hadoop.hbase.zookeeper"><code>ZKWatcher</code></a> which also contains configuration and operation</dd> <dd><code>timeout</code> - How long to wait on meta location</dd> -<dd><code>replicaId</code> - </dd> +<dd><code>replicaId</code> - the ID of the replica</dd> <dt><span class="returnLabel">Returns:</span></dt> <dd>connection to server hosting meta</dd> <dt><span class="throwsLabel">Throws:</span></dt> -<dd><code><a href="http://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> -<dd><code><a href="../../../../../org/apache/hadoop/hbase/NotAllMetaRegionsOnlineException.html" title="class in org.apache.hadoop.hbase">NotAllMetaRegionsOnlineException</a></code> - if timed out waiting</dd> -<dd><code><a href="http://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> +<dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/InterruptedException.html?is-external=true"; title="class or interface in java.lang">InterruptedException</a></code> - if waiting for the socket operation fails</dd> +<dd><code><a href="http://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 the number of retries for getting the connection is exceeded</dd> </dl> </li> </ul> @@ -739,7 +741,7 @@ extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html? <ul class="blockList"> <li class="blockList"> <h4>getCachedConnection</h4> -<pre>private static org.apache.hadoop.hbase.shaded.protobuf.generated.AdminProtos.AdminService.BlockingInterface <a href="../../../../../src-html/org/apache/hadoop/hbase/zookeeper/MetaTableLocator.html#line.375">getCachedConnection</a>(<a href="../../../../../org/apache/hadoop/hbase/client/ClusterConnection.html" title="interface in org.apache.hadoop.hbase.client">ClusterConnection</a> connection, +<pre>private static org.apache.hadoop.hbase.shaded.protobuf.generated.AdminProtos.AdminService.BlockingInterface <a href="../../../../../src-html/org/apache/hadoop/hbase/zookeeper/MetaTableLocator.html#line.382">getCachedConnection</a>(<a href="../../../../../org/apache/hadoop/hbase/client/ClusterConnection.html" title="interface in org.apache.hadoop.hbase.client">ClusterConnection</a> connection, <a href="../../../../../org/apache/hadoop/hbase/ServerName.html" title="class in org.apache.hadoop.hbase">ServerName</a> sn) throws <a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></pre> <dl> @@ -747,10 +749,10 @@ extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html? <dd><code>sn</code> - ServerName to get a connection against.</dd> <dt><span class="returnLabel">Returns:</span></dt> <dd>The AdminProtocol we got when we connected to <code>sn</code> - May have come from cache, may not be good, may have been setup by this - invocation, or may be null.</dd> + May have come from cache, may not be good, may have been setup by this invocation, or + may be null.</dd> <dt><span class="throwsLabel">Throws:</span></dt> -<dd><code><a href="http://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> +<dd><code><a href="http://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 the number of retries for getting the connection is exceeded</dd> </dl> </li> </ul> @@ -760,7 +762,7 @@ extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html? <ul class="blockList"> <li class="blockList"> <h4>setMetaLocation</h4> -<pre>public static void <a href="../../../../../src-html/org/apache/hadoop/hbase/zookeeper/MetaTableLocator.html#line.427">setMetaLocation</a>(<a href="../../../../../org/apache/hadoop/hbase/zookeeper/ZKWatcher.html" title="class in org.apache.hadoop.hbase.zookeeper">ZKWatcher</a> zookeeper, +<pre>public static void <a href="../../../../../src-html/org/apache/hadoop/hbase/zookeeper/MetaTableLocator.html#line.433">setMetaLocation</a>(<a href="../../../../../org/apache/hadoop/hbase/zookeeper/ZKWatcher.html" title="class in org.apache.hadoop.hbase.zookeeper">ZKWatcher</a> zookeeper, <a href="../../../../../org/apache/hadoop/hbase/ServerName.html" title="class in org.apache.hadoop.hbase">ServerName</a> serverName, <a href="../../../../../org/apache/hadoop/hbase/master/RegionState.State.html" title="enum in org.apache.hadoop.hbase.master">RegionState.State</a> state) throws org.apache.zookeeper.KeeperException</pre> @@ -782,21 +784,21 @@ extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html? <ul class="blockList"> <li class="blockList"> <h4>setMetaLocation</h4> -<pre>public static void <a href="../../../../../src-html/org/apache/hadoop/hbase/zookeeper/MetaTableLocator.html#line.441">setMetaLocation</a>(<a href="../../../../../org/apache/hadoop/hbase/zookeeper/ZKWatcher.html" title="class in org.apache.hadoop.hbase.zookeeper">ZKWatcher</a> zookeeper, +<pre>public static void <a href="../../../../../src-html/org/apache/hadoop/hbase/zookeeper/MetaTableLocator.html#line.447">setMetaLocation</a>(<a href="../../../../../org/apache/hadoop/hbase/zookeeper/ZKWatcher.html" title="class in org.apache.hadoop.hbase.zookeeper">ZKWatcher</a> zookeeper, <a href="../../../../../org/apache/hadoop/hbase/ServerName.html" title="class in org.apache.hadoop.hbase">ServerName</a> serverName, int replicaId, <a href="../../../../../org/apache/hadoop/hbase/master/RegionState.State.html" title="enum in org.apache.hadoop.hbase.master">RegionState.State</a> state) throws org.apache.zookeeper.KeeperException</pre> -<div class="block">Sets the location of <code>hbase:meta</code> in ZooKeeper to the - specified server address.</div> +<div class="block">Sets the location of <code>hbase:meta</code> in ZooKeeper to the specified server address.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>zookeeper</code> - </dd> -<dd><code>serverName</code> - </dd> -<dd><code>replicaId</code> - </dd> -<dd><code>state</code> - </dd> +<dd><code>zookeeper</code> - reference to the <a href="../../../../../org/apache/hadoop/hbase/zookeeper/ZKWatcher.html" title="class in org.apache.hadoop.hbase.zookeeper"><code>ZKWatcher</code></a> which also contains configuration and + operation</dd> +<dd><code>serverName</code> - the name of the server</dd> +<dd><code>replicaId</code> - the ID of the replica</dd> +<dd><code>state</code> - the state of the region</dd> <dt><span class="throwsLabel">Throws:</span></dt> -<dd><code>org.apache.zookeeper.KeeperException</code></dd> +<dd><code>org.apache.zookeeper.KeeperException</code> - if a ZooKeeper operation fails</dd> </dl> </li> </ul> @@ -806,7 +808,7 @@ extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html? <ul class="blockList"> <li class="blockList"> <h4>getMetaRegionState</h4> -<pre>public static <a href="../../../../../org/apache/hadoop/hbase/master/RegionState.html" title="class in org.apache.hadoop.hbase.master">RegionState</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/zookeeper/MetaTableLocator.html#line.473">getMetaRegionState</a>(<a href="../../../../../org/apache/hadoop/hbase/zookeeper/ZKWatcher.html" title="class in org.apache.hadoop.hbase.zookeeper">ZKWatcher</a> zkw) +<pre>public static <a href="../../../../../org/apache/hadoop/hbase/master/RegionState.html" title="class in org.apache.hadoop.hbase.master">RegionState</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/zookeeper/MetaTableLocator.html#line.479">getMetaRegionState</a>(<a href="../../../../../org/apache/hadoop/hbase/zookeeper/ZKWatcher.html" title="class in org.apache.hadoop.hbase.zookeeper">ZKWatcher</a> zkw) throws org.apache.zookeeper.KeeperException</pre> <div class="block">Load the meta region state from the meta server ZNode.</div> <dl> @@ -821,18 +823,18 @@ extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html? <ul class="blockList"> <li class="blockList"> <h4>getMetaRegionState</h4> -<pre>public static <a href="../../../../../org/apache/hadoop/hbase/master/RegionState.html" title="class in org.apache.hadoop.hbase.master">RegionState</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/zookeeper/MetaTableLocator.html#line.484">getMetaRegionState</a>(<a href="../../../../../org/apache/hadoop/hbase/zookeeper/ZKWatcher.html" title="class in org.apache.hadoop.hbase.zookeeper">ZKWatcher</a> zkw, +<pre>public static <a href="../../../../../org/apache/hadoop/hbase/master/RegionState.html" title="class in org.apache.hadoop.hbase.master">RegionState</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/zookeeper/MetaTableLocator.html#line.491">getMetaRegionState</a>(<a href="../../../../../org/apache/hadoop/hbase/zookeeper/ZKWatcher.html" title="class in org.apache.hadoop.hbase.zookeeper">ZKWatcher</a> zkw, int replicaId) throws org.apache.zookeeper.KeeperException</pre> <div class="block">Load the meta region state from the meta server ZNode.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>zkw</code> - </dd> -<dd><code>replicaId</code> - </dd> +<dd><code>zkw</code> - reference to the <a href="../../../../../org/apache/hadoop/hbase/zookeeper/ZKWatcher.html" title="class in org.apache.hadoop.hbase.zookeeper"><code>ZKWatcher</code></a> which also contains configuration and operation</dd> +<dd><code>replicaId</code> - the ID of the replica</dd> <dt><span class="returnLabel">Returns:</span></dt> <dd>regionstate</dd> <dt><span class="throwsLabel">Throws:</span></dt> -<dd><code>org.apache.zookeeper.KeeperException</code></dd> +<dd><code>org.apache.zookeeper.KeeperException</code> - if a ZooKeeper operation fails</dd> </dl> </li> </ul> @@ -842,7 +844,7 @@ extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html? <ul class="blockList"> <li class="blockList"> <h4>deleteMetaLocation</h4> -<pre>public void <a href="../../../../../src-html/org/apache/hadoop/hbase/zookeeper/MetaTableLocator.html#line.528">deleteMetaLocation</a>(<a href="../../../../../org/apache/hadoop/hbase/zookeeper/ZKWatcher.html" title="class in org.apache.hadoop.hbase.zookeeper">ZKWatcher</a> zookeeper) +<pre>public void <a href="../../../../../src-html/org/apache/hadoop/hbase/zookeeper/MetaTableLocator.html#line.535">deleteMetaLocation</a>(<a href="../../../../../org/apache/hadoop/hbase/zookeeper/ZKWatcher.html" title="class in org.apache.hadoop.hbase.zookeeper">ZKWatcher</a> zookeeper) throws org.apache.zookeeper.KeeperException</pre> <div class="block">Deletes the location of <code>hbase:meta</code> in ZooKeeper.</div> <dl> @@ -859,7 +861,7 @@ extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html? <ul class="blockList"> <li class="blockList"> <h4>deleteMetaLocation</h4> -<pre>public void <a href="../../../../../src-html/org/apache/hadoop/hbase/zookeeper/MetaTableLocator.html#line.533">deleteMetaLocation</a>(<a href="../../../../../org/apache/hadoop/hbase/zookeeper/ZKWatcher.html" title="class in org.apache.hadoop.hbase.zookeeper">ZKWatcher</a> zookeeper, +<pre>public void <a href="../../../../../src-html/org/apache/hadoop/hbase/zookeeper/MetaTableLocator.html#line.540">deleteMetaLocation</a>(<a href="../../../../../org/apache/hadoop/hbase/zookeeper/ZKWatcher.html" title="class in org.apache.hadoop.hbase.zookeeper">ZKWatcher</a> zookeeper, int replicaId) throws org.apache.zookeeper.KeeperException</pre> <dl> @@ -874,21 +876,21 @@ extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html? <ul class="blockList"> <li class="blockList"> <h4>blockUntilAvailable</h4> -<pre>public <a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><<a href="../../../../../org/apache/hadoop/hbase/ServerName.html" title="class in org.apache.hadoop.hbase">ServerName</a>> <a href="../../../../../src-html/org/apache/hadoop/hbase/zookeeper/MetaTableLocator.html#line.556">blockUntilAvailable</a>(<a href="../../../../../org/apache/hadoop/hbase/zookeeper/ZKWatcher.html" title="class in org.apache.hadoop.hbase.zookeeper">ZKWatcher</a> zkw, +<pre>public <a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><<a href="../../../../../org/apache/hadoop/hbase/ServerName.html" title="class in org.apache.hadoop.hbase">ServerName</a>> <a href="../../../../../src-html/org/apache/hadoop/hbase/zookeeper/MetaTableLocator.html#line.564">blockUntilAvailable</a>(<a href="../../../../../org/apache/hadoop/hbase/zookeeper/ZKWatcher.html" title="class in org.apache.hadoop.hbase.zookeeper">ZKWatcher</a> zkw, long timeout, org.apache.hadoop.conf.Configuration conf) throws <a href="http://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 until the primary meta region is available. Get the secondary - locations as well but don't block for those.</div> +<div class="block">Wait until the primary meta region is available. Get the secondary locations as well but don't + block for those.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>zkw</code> - </dd> -<dd><code>timeout</code> - </dd> -<dd><code>conf</code> - </dd> +<dd><code>zkw</code> - reference to the <a href="../../../../../org/apache/hadoop/hbase/zookeeper/ZKWatcher.html" title="class in org.apache.hadoop.hbase.zookeeper"><code>ZKWatcher</code></a> which also contains configuration and operation</dd> +<dd><code>timeout</code> - maximum time to wait in millis</dd> +<dd><code>conf</code> - the <code>Configuration</code> to use</dd> <dt><span class="returnLabel">Returns:</span></dt> <dd>ServerName or null if we timed out.</dd> <dt><span class="throwsLabel">Throws:</span></dt> -<dd><code><a href="http://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> +<dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/InterruptedException.html?is-external=true"; title="class or interface in java.lang">InterruptedException</a></code> - if waiting for the socket operation fails</dd> </dl> </li> </ul> @@ -898,7 +900,7 @@ extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html? <ul class="blockList"> <li class="blockList"> <h4>blockUntilAvailable</h4> -<pre>public <a href="../../../../../org/apache/hadoop/hbase/ServerName.html" title="class in org.apache.hadoop.hbase">ServerName</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/zookeeper/MetaTableLocator.html#line.588">blockUntilAvailable</a>(<a href="../../../../../org/apache/hadoop/hbase/zookeeper/ZKWatcher.html" title="class in org.apache.hadoop.hbase.zookeeper">ZKWatcher</a> zkw, +<pre>public <a href="../../../../../org/apache/hadoop/hbase/ServerName.html" title="class in org.apache.hadoop.hbase">ServerName</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/zookeeper/MetaTableLocator.html#line.599">blockUntilAvailable</a>(<a href="../../../../../org/apache/hadoop/hbase/zookeeper/ZKWatcher.html" title="class in org.apache.hadoop.hbase.zookeeper">ZKWatcher</a> zkw, long timeout) throws <a href="http://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 until the meta region is available and is not in transition.</div> @@ -909,7 +911,7 @@ extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html? <dt><span class="returnLabel">Returns:</span></dt> <dd>ServerName or null if we timed out.</dd> <dt><span class="throwsLabel">Throws:</span></dt> -<dd><code><a href="http://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> +<dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/InterruptedException.html?is-external=true"; title="class or interface in java.lang">InterruptedException</a></code> - if waiting for the socket operation fails</dd> </dl> </li> </ul> @@ -919,20 +921,20 @@ extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html? <ul class="blockList"> <li class="blockList"> <h4>blockUntilAvailable</h4> -<pre>public <a href="../../../../../org/apache/hadoop/hbase/ServerName.html" title="class in org.apache.hadoop.hbase">ServerName</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/zookeeper/MetaTableLocator.html#line.602">blockUntilAvailable</a>(<a href="../../../../../org/apache/hadoop/hbase/zookeeper/ZKWatcher.html" title="class in org.apache.hadoop.hbase.zookeeper">ZKWatcher</a> zkw, +<pre>public <a href="../../../../../org/apache/hadoop/hbase/ServerName.html" title="class in org.apache.hadoop.hbase">ServerName</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/zookeeper/MetaTableLocator.html#line.613">blockUntilAvailable</a>(<a href="../../../../../org/apache/hadoop/hbase/zookeeper/ZKWatcher.html" title="class in org.apache.hadoop.hbase.zookeeper">ZKWatcher</a> zkw, int replicaId, long timeout) throws <a href="http://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 until the meta region is available and is not in transition.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>zkw</code> - </dd> -<dd><code>replicaId</code> - </dd> -<dd><code>timeout</code> - </dd> +<dd><code>zkw</code> - reference to the <a href="../../../../../org/apache/hadoop/hbase/zookeeper/ZKWatcher.html" title="class in org.apache.hadoop.hbase.zookeeper"><code>ZKWatcher</code></a> which also contains configuration and constants</dd> +<dd><code>replicaId</code> - the ID of the replica</dd> +<dd><code>timeout</code> - maximum time to wait in millis</dd> <dt><span class="returnLabel">Returns:</span></dt> <dd>ServerName or null if we timed out.</dd> <dt><span class="throwsLabel">Throws:</span></dt> -<dd><code><a href="http://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> +<dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/InterruptedException.html?is-external=true"; title="class or interface in java.lang">InterruptedException</a></code> - if waiting for the socket operation fails</dd> </dl> </li> </ul> @@ -942,7 +944,7 @@ extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html? <ul class="blockListLast"> <li class="blockList"> <h4>stop</h4> -<pre>public void <a href="../../../../../src-html/org/apache/hadoop/hbase/zookeeper/MetaTableLocator.html#line.624">stop</a>()</pre> +<pre>public void <a href="../../../../../src-html/org/apache/hadoop/hbase/zookeeper/MetaTableLocator.html#line.640">stop</a>()</pre> <div class="block">Stop working. Interrupts any ongoing waits.</div> </li>
http://git-wip-us.apache.org/repos/asf/hbase-site/blob/48bd3915/devapidocs/org/apache/hadoop/hbase/zookeeper/MiniZooKeeperCluster.html ---------------------------------------------------------------------- diff --git a/devapidocs/org/apache/hadoop/hbase/zookeeper/MiniZooKeeperCluster.html b/devapidocs/org/apache/hadoop/hbase/zookeeper/MiniZooKeeperCluster.html index eed23f9..4ce62b3 100644 --- a/devapidocs/org/apache/hadoop/hbase/zookeeper/MiniZooKeeperCluster.html +++ b/devapidocs/org/apache/hadoop/hbase/zookeeper/MiniZooKeeperCluster.html @@ -263,7 +263,7 @@ extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html? <tr id="i9" class="rowColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/zookeeper/MiniZooKeeperCluster.html#killOneBackupZooKeeperServer--">killOneBackupZooKeeperServer</a></span>()</code> -<div class="block">Kill one back up ZK servers</div> +<div class="block">Kill one back up ZK servers.</div> </td> </tr> <tr id="i10" class="altColor"> @@ -609,14 +609,14 @@ extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html? <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/InterruptedException.html?is-external=true"; title="class or interface in java.lang">InterruptedException</a></pre> <dl> <dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>baseDir</code> - </dd> -<dd><code>numZooKeeperServers</code> - </dd> +<dd><code>baseDir</code> - the base directory to use</dd> +<dd><code>numZooKeeperServers</code> - the number of ZooKeeper servers</dd> <dt><span class="returnLabel">Returns:</span></dt> -<dd>ClientPort server bound to, -1 if there was a - binding problem and we couldn't pick another port.</dd> +<dd>ClientPort server bound to, -1 if there was a binding problem and we couldn't pick + another port.</dd> <dt><span class="throwsLabel">Throws:</span></dt> -<dd><code><a href="http://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> -<dd><code><a href="http://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> +<dd><code><a href="http://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 an operation fails during the startup</dd> +<dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/InterruptedException.html?is-external=true"; title="class or interface in java.lang">InterruptedException</a></code> - if the startup fails</dd> </dl> </li> </ul> @@ -626,7 +626,7 @@ extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html? <ul class="blockList"> <li class="blockList"> <h4>createDir</h4> -<pre>private void <a href="../../../../../src-html/org/apache/hadoop/hbase/zookeeper/MiniZooKeeperCluster.html#line.282">createDir</a>(<a href="http://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true"; title="class or interface in java.io">File</a> dir) +<pre>private void <a href="../../../../../src-html/org/apache/hadoop/hbase/zookeeper/MiniZooKeeperCluster.html#line.286">createDir</a>(<a href="http://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true"; title="class or interface in java.io">File</a> dir) throws <a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></pre> <dl> <dt><span class="throwsLabel">Throws:</span></dt> @@ -640,11 +640,11 @@ extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html? <ul class="blockList"> <li class="blockList"> <h4>shutdown</h4> -<pre>public void <a href="../../../../../src-html/org/apache/hadoop/hbase/zookeeper/MiniZooKeeperCluster.html#line.295">shutdown</a>() +<pre>public void <a href="../../../../../src-html/org/apache/hadoop/hbase/zookeeper/MiniZooKeeperCluster.html#line.299">shutdown</a>() throws <a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></pre> <dl> <dt><span class="throwsLabel">Throws:</span></dt> -<dd><code><a href="http://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> +<dd><code><a href="http://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 waiting for the shutdown of a server fails</dd> </dl> </li> </ul> @@ -654,7 +654,7 @@ extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html? <ul class="blockList"> <li class="blockList"> <h4>killCurrentActiveZooKeeperServer</h4> -<pre>public int <a href="../../../../../src-html/org/apache/hadoop/hbase/zookeeper/MiniZooKeeperCluster.html#line.329">killCurrentActiveZooKeeperServer</a>() +<pre>public int <a href="../../../../../src-html/org/apache/hadoop/hbase/zookeeper/MiniZooKeeperCluster.html#line.333">killCurrentActiveZooKeeperServer</a>() throws <a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/InterruptedException.html?is-external=true"; title="class or interface in java.lang">InterruptedException</a></pre> <dl> @@ -662,7 +662,7 @@ extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html? <dd>clientPort return clientPort if there is another ZK backup can run when killing the current active; return -1, if there is no backups.</dd> <dt><span class="throwsLabel">Throws:</span></dt> -<dd><code><a href="http://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> +<dd><code><a href="http://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 waiting for the shutdown of a server fails</dd> <dd><code><a href="http://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> @@ -673,13 +673,13 @@ extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html? <ul class="blockList"> <li class="blockList"> <h4>killOneBackupZooKeeperServer</h4> -<pre>public void <a href="../../../../../src-html/org/apache/hadoop/hbase/zookeeper/MiniZooKeeperCluster.html#line.370">killOneBackupZooKeeperServer</a>() +<pre>public void <a href="../../../../../src-html/org/apache/hadoop/hbase/zookeeper/MiniZooKeeperCluster.html#line.373">killOneBackupZooKeeperServer</a>() throws <a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a>, <a href="http://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">Kill one back up ZK servers</div> +<div class="block">Kill one back up ZK servers.</div> <dl> <dt><span class="throwsLabel">Throws:</span></dt> -<dd><code><a href="http://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> +<dd><code><a href="http://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 waiting for the shutdown of a server fails</dd> <dd><code><a href="http://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> @@ -690,7 +690,7 @@ extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html? <ul class="blockList"> <li class="blockList"> <h4>waitForServerDown</h4> -<pre>private static boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/zookeeper/MiniZooKeeperCluster.html#line.399">waitForServerDown</a>(int port, +<pre>private static boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/zookeeper/MiniZooKeeperCluster.html#line.400">waitForServerDown</a>(int port, long timeout) throws <a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></pre> <dl> @@ -705,7 +705,7 @@ extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html? <ul class="blockList"> <li class="blockList"> <h4>waitForServerUp</h4> -<pre>private static boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/zookeeper/MiniZooKeeperCluster.html#line.428">waitForServerUp</a>(int port, +<pre>private static boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/zookeeper/MiniZooKeeperCluster.html#line.429">waitForServerUp</a>(int port, long timeout) throws <a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></pre> <dl> @@ -720,7 +720,7 @@ extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html? <ul class="blockList"> <li class="blockList"> <h4>getClientPort</h4> -<pre>public int <a href="../../../../../src-html/org/apache/hadoop/hbase/zookeeper/MiniZooKeeperCluster.html#line.468">getClientPort</a>()</pre> +<pre>public int <a href="../../../../../src-html/org/apache/hadoop/hbase/zookeeper/MiniZooKeeperCluster.html#line.469">getClientPort</a>()</pre> </li> </ul> <a name="getZooKeeperServers--"> @@ -729,7 +729,7 @@ extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html? <ul class="blockListLast"> <li class="blockList"> <h4>getZooKeeperServers</h4> -<pre><a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><org.apache.zookeeper.server.ZooKeeperServer> <a href="../../../../../src-html/org/apache/hadoop/hbase/zookeeper/MiniZooKeeperCluster.html#line.473">getZooKeeperServers</a>()</pre> +<pre><a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><org.apache.zookeeper.server.ZooKeeperServer> <a href="../../../../../src-html/org/apache/hadoop/hbase/zookeeper/MiniZooKeeperCluster.html#line.474">getZooKeeperServers</a>()</pre> </li> </ul> </li>
