| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>Source code</title> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <meta name="description" content="source: package: org.apache.hadoop.hbase, class: HBaseClusterInterface"> |
| <meta name="generator" content="javadoc/SourceToHTMLConverter"> |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> |
| </head> |
| <body class="source-page"> |
| <main role="main"> |
| <div class="source-container"> |
| <pre><span class="source-line-no">001</span><span id="line-1">/*</span> |
| <span class="source-line-no">002</span><span id="line-2"> * Licensed to the Apache Software Foundation (ASF) under one</span> |
| <span class="source-line-no">003</span><span id="line-3"> * or more contributor license agreements. See the NOTICE file</span> |
| <span class="source-line-no">004</span><span id="line-4"> * distributed with this work for additional information</span> |
| <span class="source-line-no">005</span><span id="line-5"> * regarding copyright ownership. The ASF licenses this file</span> |
| <span class="source-line-no">006</span><span id="line-6"> * to you under the Apache License, Version 2.0 (the</span> |
| <span class="source-line-no">007</span><span id="line-7"> * "License"); you may not use this file except in compliance</span> |
| <span class="source-line-no">008</span><span id="line-8"> * with the License. You may obtain a copy of the License at</span> |
| <span class="source-line-no">009</span><span id="line-9"> *</span> |
| <span class="source-line-no">010</span><span id="line-10"> * http://www.apache.org/licenses/LICENSE-2.0</span> |
| <span class="source-line-no">011</span><span id="line-11"> *</span> |
| <span class="source-line-no">012</span><span id="line-12"> * Unless required by applicable law or agreed to in writing, software</span> |
| <span class="source-line-no">013</span><span id="line-13"> * distributed under the License is distributed on an "AS IS" BASIS,</span> |
| <span class="source-line-no">014</span><span id="line-14"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span> |
| <span class="source-line-no">015</span><span id="line-15"> * See the License for the specific language governing permissions and</span> |
| <span class="source-line-no">016</span><span id="line-16"> * limitations under the License.</span> |
| <span class="source-line-no">017</span><span id="line-17"> */</span> |
| <span class="source-line-no">018</span><span id="line-18">package org.apache.hadoop.hbase;</span> |
| <span class="source-line-no">019</span><span id="line-19"></span> |
| <span class="source-line-no">020</span><span id="line-20">import java.io.Closeable;</span> |
| <span class="source-line-no">021</span><span id="line-21">import java.io.IOException;</span> |
| <span class="source-line-no">022</span><span id="line-22">import org.apache.hadoop.conf.Configurable;</span> |
| <span class="source-line-no">023</span><span id="line-23">import org.apache.hadoop.conf.Configuration;</span> |
| <span class="source-line-no">024</span><span id="line-24">import org.apache.hadoop.hbase.client.RegionInfoBuilder;</span> |
| <span class="source-line-no">025</span><span id="line-25">import org.apache.hadoop.hbase.util.EnvironmentEdgeManager;</span> |
| <span class="source-line-no">026</span><span id="line-26">import org.apache.hadoop.hbase.util.Threads;</span> |
| <span class="source-line-no">027</span><span id="line-27">import org.apache.yetus.audience.InterfaceAudience;</span> |
| <span class="source-line-no">028</span><span id="line-28">import org.apache.yetus.audience.InterfaceStability;</span> |
| <span class="source-line-no">029</span><span id="line-29"></span> |
| <span class="source-line-no">030</span><span id="line-30">/**</span> |
| <span class="source-line-no">031</span><span id="line-31"> * This class defines methods that can help with managing HBase clusters from unit tests and system</span> |
| <span class="source-line-no">032</span><span id="line-32"> * tests. There are 3 types of cluster deployments:</span> |
| <span class="source-line-no">033</span><span id="line-33"> * <ul></span> |
| <span class="source-line-no">034</span><span id="line-34"> * <li><b>SingleProcessHBaseCluster:</b> each server is run in the same JVM in separate threads,</span> |
| <span class="source-line-no">035</span><span id="line-35"> * used by unit tests</li></span> |
| <span class="source-line-no">036</span><span id="line-36"> * <li><b>DistributedHBaseCluster:</b> the cluster is pre-deployed, system and integration tests can</span> |
| <span class="source-line-no">037</span><span id="line-37"> * interact with the cluster.</li></span> |
| <span class="source-line-no">038</span><span id="line-38"> * <li><b>ProcessBasedLocalHBaseCluster:</b> each server is deployed locally but in separate JVMs.</span> |
| <span class="source-line-no">039</span><span id="line-39"> * </li></span> |
| <span class="source-line-no">040</span><span id="line-40"> * </ul></span> |
| <span class="source-line-no">041</span><span id="line-41"> * <p></span> |
| <span class="source-line-no">042</span><span id="line-42"> * HBaseCluster unifies the way tests interact with the cluster, so that the same test can be run</span> |
| <span class="source-line-no">043</span><span id="line-43"> * against a mini-cluster during unit test execution, or a distributed cluster having tens/hundreds</span> |
| <span class="source-line-no">044</span><span id="line-44"> * of nodes during execution of integration tests.</span> |
| <span class="source-line-no">045</span><span id="line-45"> * <p></span> |
| <span class="source-line-no">046</span><span id="line-46"> * HBaseCluster exposes client-side public interfaces to tests, so that tests does not assume</span> |
| <span class="source-line-no">047</span><span id="line-47"> * running in a particular mode. Not all the tests are suitable to be run on an actual cluster, and</span> |
| <span class="source-line-no">048</span><span id="line-48"> * some tests will still need to mock stuff and introspect internal state. For those use cases from</span> |
| <span class="source-line-no">049</span><span id="line-49"> * unit tests, or if more control is needed, you can use the subclasses directly. In that sense,</span> |
| <span class="source-line-no">050</span><span id="line-50"> * this class does not abstract away <strong>every</strong> interface that SingleProcessHBaseCluster</span> |
| <span class="source-line-no">051</span><span id="line-51"> * or DistributedHBaseCluster provide.</span> |
| <span class="source-line-no">052</span><span id="line-52"> */</span> |
| <span class="source-line-no">053</span><span id="line-53">@InterfaceAudience.LimitedPrivate(HBaseInterfaceAudience.PHOENIX)</span> |
| <span class="source-line-no">054</span><span id="line-54">@InterfaceStability.Evolving</span> |
| <span class="source-line-no">055</span><span id="line-55">public abstract class HBaseClusterInterface implements Closeable, Configurable {</span> |
| <span class="source-line-no">056</span><span id="line-56"></span> |
| <span class="source-line-no">057</span><span id="line-57"> protected Configuration conf;</span> |
| <span class="source-line-no">058</span><span id="line-58"></span> |
| <span class="source-line-no">059</span><span id="line-59"> /** the status of the cluster before we begin */</span> |
| <span class="source-line-no">060</span><span id="line-60"> protected ClusterMetrics initialClusterStatus;</span> |
| <span class="source-line-no">061</span><span id="line-61"></span> |
| <span class="source-line-no">062</span><span id="line-62"> /**</span> |
| <span class="source-line-no">063</span><span id="line-63"> * Construct an HBaseCluster</span> |
| <span class="source-line-no">064</span><span id="line-64"> * @param conf Configuration to be used for cluster</span> |
| <span class="source-line-no">065</span><span id="line-65"> */</span> |
| <span class="source-line-no">066</span><span id="line-66"> public HBaseClusterInterface(Configuration conf) {</span> |
| <span class="source-line-no">067</span><span id="line-67"> setConf(conf);</span> |
| <span class="source-line-no">068</span><span id="line-68"> }</span> |
| <span class="source-line-no">069</span><span id="line-69"></span> |
| <span class="source-line-no">070</span><span id="line-70"> @Override</span> |
| <span class="source-line-no">071</span><span id="line-71"> public void setConf(Configuration conf) {</span> |
| <span class="source-line-no">072</span><span id="line-72"> this.conf = conf;</span> |
| <span class="source-line-no">073</span><span id="line-73"> }</span> |
| <span class="source-line-no">074</span><span id="line-74"></span> |
| <span class="source-line-no">075</span><span id="line-75"> @Override</span> |
| <span class="source-line-no">076</span><span id="line-76"> public Configuration getConf() {</span> |
| <span class="source-line-no">077</span><span id="line-77"> return conf;</span> |
| <span class="source-line-no">078</span><span id="line-78"> }</span> |
| <span class="source-line-no">079</span><span id="line-79"></span> |
| <span class="source-line-no">080</span><span id="line-80"> /**</span> |
| <span class="source-line-no">081</span><span id="line-81"> * Returns a ClusterMetrics for this HBase cluster.</span> |
| <span class="source-line-no">082</span><span id="line-82"> * @see #getInitialClusterMetrics()</span> |
| <span class="source-line-no">083</span><span id="line-83"> */</span> |
| <span class="source-line-no">084</span><span id="line-84"> public abstract ClusterMetrics getClusterMetrics() throws IOException;</span> |
| <span class="source-line-no">085</span><span id="line-85"></span> |
| <span class="source-line-no">086</span><span id="line-86"> /**</span> |
| <span class="source-line-no">087</span><span id="line-87"> * Returns a ClusterStatus for this HBase cluster as observed at the starting of the HBaseCluster</span> |
| <span class="source-line-no">088</span><span id="line-88"> */</span> |
| <span class="source-line-no">089</span><span id="line-89"> public ClusterMetrics getInitialClusterMetrics() throws IOException {</span> |
| <span class="source-line-no">090</span><span id="line-90"> return initialClusterStatus;</span> |
| <span class="source-line-no">091</span><span id="line-91"> }</span> |
| <span class="source-line-no">092</span><span id="line-92"></span> |
| <span class="source-line-no">093</span><span id="line-93"> /**</span> |
| <span class="source-line-no">094</span><span id="line-94"> * Starts a new region server on the given hostname or if this is a mini/local cluster, starts a</span> |
| <span class="source-line-no">095</span><span id="line-95"> * region server locally.</span> |
| <span class="source-line-no">096</span><span id="line-96"> * @param hostname the hostname to start the regionserver on</span> |
| <span class="source-line-no">097</span><span id="line-97"> * @throws IOException if something goes wrong</span> |
| <span class="source-line-no">098</span><span id="line-98"> */</span> |
| <span class="source-line-no">099</span><span id="line-99"> public abstract void startRegionServer(String hostname, int port) throws IOException;</span> |
| <span class="source-line-no">100</span><span id="line-100"></span> |
| <span class="source-line-no">101</span><span id="line-101"> /**</span> |
| <span class="source-line-no">102</span><span id="line-102"> * Kills the region server process if this is a distributed cluster, otherwise this causes the</span> |
| <span class="source-line-no">103</span><span id="line-103"> * region server to exit doing basic clean up only.</span> |
| <span class="source-line-no">104</span><span id="line-104"> * @throws IOException if something goes wrong</span> |
| <span class="source-line-no">105</span><span id="line-105"> */</span> |
| <span class="source-line-no">106</span><span id="line-106"> public abstract void killRegionServer(ServerName serverName) throws IOException;</span> |
| <span class="source-line-no">107</span><span id="line-107"></span> |
| <span class="source-line-no">108</span><span id="line-108"> /**</span> |
| <span class="source-line-no">109</span><span id="line-109"> * Keeping track of killed servers and being able to check if a particular server was killed makes</span> |
| <span class="source-line-no">110</span><span id="line-110"> * it possible to do fault tolerance testing for dead servers in a deterministic way. A concrete</span> |
| <span class="source-line-no">111</span><span id="line-111"> * example of such case is - killing servers and waiting for all regions of a particular table to</span> |
| <span class="source-line-no">112</span><span id="line-112"> * be assigned. We can check for server column in META table and that its value is not one of the</span> |
| <span class="source-line-no">113</span><span id="line-113"> * killed servers.</span> |
| <span class="source-line-no">114</span><span id="line-114"> */</span> |
| <span class="source-line-no">115</span><span id="line-115"> public abstract boolean isKilledRS(ServerName serverName);</span> |
| <span class="source-line-no">116</span><span id="line-116"></span> |
| <span class="source-line-no">117</span><span id="line-117"> /**</span> |
| <span class="source-line-no">118</span><span id="line-118"> * Stops the given region server, by attempting a gradual stop.</span> |
| <span class="source-line-no">119</span><span id="line-119"> * @throws IOException if something goes wrong</span> |
| <span class="source-line-no">120</span><span id="line-120"> */</span> |
| <span class="source-line-no">121</span><span id="line-121"> public abstract void stopRegionServer(ServerName serverName) throws IOException;</span> |
| <span class="source-line-no">122</span><span id="line-122"></span> |
| <span class="source-line-no">123</span><span id="line-123"> /**</span> |
| <span class="source-line-no">124</span><span id="line-124"> * Wait for the specified region server to join the cluster</span> |
| <span class="source-line-no">125</span><span id="line-125"> * @throws IOException if something goes wrong or timeout occurs</span> |
| <span class="source-line-no">126</span><span id="line-126"> */</span> |
| <span class="source-line-no">127</span><span id="line-127"> public void waitForRegionServerToStart(String hostname, int port, long timeout)</span> |
| <span class="source-line-no">128</span><span id="line-128"> throws IOException {</span> |
| <span class="source-line-no">129</span><span id="line-129"> long start = EnvironmentEdgeManager.currentTime();</span> |
| <span class="source-line-no">130</span><span id="line-130"> while ((EnvironmentEdgeManager.currentTime() - start) < timeout) {</span> |
| <span class="source-line-no">131</span><span id="line-131"> for (ServerName server : getClusterMetrics().getLiveServerMetrics().keySet()) {</span> |
| <span class="source-line-no">132</span><span id="line-132"> if (server.getHostname().equals(hostname) && server.getPort() == port) {</span> |
| <span class="source-line-no">133</span><span id="line-133"> return;</span> |
| <span class="source-line-no">134</span><span id="line-134"> }</span> |
| <span class="source-line-no">135</span><span id="line-135"> }</span> |
| <span class="source-line-no">136</span><span id="line-136"> Threads.sleep(100);</span> |
| <span class="source-line-no">137</span><span id="line-137"> }</span> |
| <span class="source-line-no">138</span><span id="line-138"> throw new IOException(</span> |
| <span class="source-line-no">139</span><span id="line-139"> "did timeout " + timeout + "ms waiting for region server to start: " + hostname);</span> |
| <span class="source-line-no">140</span><span id="line-140"> }</span> |
| <span class="source-line-no">141</span><span id="line-141"></span> |
| <span class="source-line-no">142</span><span id="line-142"> /**</span> |
| <span class="source-line-no">143</span><span id="line-143"> * Wait for the specified region server to stop the thread / process.</span> |
| <span class="source-line-no">144</span><span id="line-144"> * @throws IOException if something goes wrong or timeout occurs</span> |
| <span class="source-line-no">145</span><span id="line-145"> */</span> |
| <span class="source-line-no">146</span><span id="line-146"> public abstract void waitForRegionServerToStop(ServerName serverName, long timeout)</span> |
| <span class="source-line-no">147</span><span id="line-147"> throws IOException;</span> |
| <span class="source-line-no">148</span><span id="line-148"></span> |
| <span class="source-line-no">149</span><span id="line-149"> /**</span> |
| <span class="source-line-no">150</span><span id="line-150"> * Suspend the region server</span> |
| <span class="source-line-no">151</span><span id="line-151"> * @param serverName the hostname to suspend the regionserver on</span> |
| <span class="source-line-no">152</span><span id="line-152"> * @throws IOException if something goes wrong</span> |
| <span class="source-line-no">153</span><span id="line-153"> */</span> |
| <span class="source-line-no">154</span><span id="line-154"> public abstract void suspendRegionServer(ServerName serverName) throws IOException;</span> |
| <span class="source-line-no">155</span><span id="line-155"></span> |
| <span class="source-line-no">156</span><span id="line-156"> /**</span> |
| <span class="source-line-no">157</span><span id="line-157"> * Resume the region server</span> |
| <span class="source-line-no">158</span><span id="line-158"> * @param serverName the hostname to resume the regionserver on</span> |
| <span class="source-line-no">159</span><span id="line-159"> * @throws IOException if something goes wrong</span> |
| <span class="source-line-no">160</span><span id="line-160"> */</span> |
| <span class="source-line-no">161</span><span id="line-161"> public abstract void resumeRegionServer(ServerName serverName) throws IOException;</span> |
| <span class="source-line-no">162</span><span id="line-162"></span> |
| <span class="source-line-no">163</span><span id="line-163"> /**</span> |
| <span class="source-line-no">164</span><span id="line-164"> * Starts a new zookeeper node on the given hostname or if this is a mini/local cluster, silently</span> |
| <span class="source-line-no">165</span><span id="line-165"> * logs warning message.</span> |
| <span class="source-line-no">166</span><span id="line-166"> * @param hostname the hostname to start the regionserver on</span> |
| <span class="source-line-no">167</span><span id="line-167"> * @throws IOException if something goes wrong</span> |
| <span class="source-line-no">168</span><span id="line-168"> */</span> |
| <span class="source-line-no">169</span><span id="line-169"> public abstract void startZkNode(String hostname, int port) throws IOException;</span> |
| <span class="source-line-no">170</span><span id="line-170"></span> |
| <span class="source-line-no">171</span><span id="line-171"> /**</span> |
| <span class="source-line-no">172</span><span id="line-172"> * Kills the zookeeper node process if this is a distributed cluster, otherwise, this causes</span> |
| <span class="source-line-no">173</span><span id="line-173"> * master to exit doing basic clean up only.</span> |
| <span class="source-line-no">174</span><span id="line-174"> * @throws IOException if something goes wrong</span> |
| <span class="source-line-no">175</span><span id="line-175"> */</span> |
| <span class="source-line-no">176</span><span id="line-176"> public abstract void killZkNode(ServerName serverName) throws IOException;</span> |
| <span class="source-line-no">177</span><span id="line-177"></span> |
| <span class="source-line-no">178</span><span id="line-178"> /**</span> |
| <span class="source-line-no">179</span><span id="line-179"> * Stops the region zookeeper if this is a distributed cluster, otherwise silently logs warning</span> |
| <span class="source-line-no">180</span><span id="line-180"> * message.</span> |
| <span class="source-line-no">181</span><span id="line-181"> * @throws IOException if something goes wrong</span> |
| <span class="source-line-no">182</span><span id="line-182"> */</span> |
| <span class="source-line-no">183</span><span id="line-183"> public abstract void stopZkNode(ServerName serverName) throws IOException;</span> |
| <span class="source-line-no">184</span><span id="line-184"></span> |
| <span class="source-line-no">185</span><span id="line-185"> /**</span> |
| <span class="source-line-no">186</span><span id="line-186"> * Wait for the specified zookeeper node to join the cluster</span> |
| <span class="source-line-no">187</span><span id="line-187"> * @throws IOException if something goes wrong or timeout occurs</span> |
| <span class="source-line-no">188</span><span id="line-188"> */</span> |
| <span class="source-line-no">189</span><span id="line-189"> public abstract void waitForZkNodeToStart(ServerName serverName, long timeout) throws IOException;</span> |
| <span class="source-line-no">190</span><span id="line-190"></span> |
| <span class="source-line-no">191</span><span id="line-191"> /**</span> |
| <span class="source-line-no">192</span><span id="line-192"> * Wait for the specified zookeeper node to stop the thread / process.</span> |
| <span class="source-line-no">193</span><span id="line-193"> * @throws IOException if something goes wrong or timeout occurs</span> |
| <span class="source-line-no">194</span><span id="line-194"> */</span> |
| <span class="source-line-no">195</span><span id="line-195"> public abstract void waitForZkNodeToStop(ServerName serverName, long timeout) throws IOException;</span> |
| <span class="source-line-no">196</span><span id="line-196"></span> |
| <span class="source-line-no">197</span><span id="line-197"> /**</span> |
| <span class="source-line-no">198</span><span id="line-198"> * Starts a new datanode on the given hostname or if this is a mini/local cluster, silently logs</span> |
| <span class="source-line-no">199</span><span id="line-199"> * warning message.</span> |
| <span class="source-line-no">200</span><span id="line-200"> * @throws IOException if something goes wrong</span> |
| <span class="source-line-no">201</span><span id="line-201"> */</span> |
| <span class="source-line-no">202</span><span id="line-202"> public abstract void startDataNode(ServerName serverName) throws IOException;</span> |
| <span class="source-line-no">203</span><span id="line-203"></span> |
| <span class="source-line-no">204</span><span id="line-204"> /**</span> |
| <span class="source-line-no">205</span><span id="line-205"> * Kills the datanode process if this is a distributed cluster, otherwise, this causes master to</span> |
| <span class="source-line-no">206</span><span id="line-206"> * exit doing basic clean up only.</span> |
| <span class="source-line-no">207</span><span id="line-207"> * @throws IOException if something goes wrong</span> |
| <span class="source-line-no">208</span><span id="line-208"> */</span> |
| <span class="source-line-no">209</span><span id="line-209"> public abstract void killDataNode(ServerName serverName) throws IOException;</span> |
| <span class="source-line-no">210</span><span id="line-210"></span> |
| <span class="source-line-no">211</span><span id="line-211"> /**</span> |
| <span class="source-line-no">212</span><span id="line-212"> * Stops the datanode if this is a distributed cluster, otherwise silently logs warning message.</span> |
| <span class="source-line-no">213</span><span id="line-213"> * @throws IOException if something goes wrong</span> |
| <span class="source-line-no">214</span><span id="line-214"> */</span> |
| <span class="source-line-no">215</span><span id="line-215"> public abstract void stopDataNode(ServerName serverName) throws IOException;</span> |
| <span class="source-line-no">216</span><span id="line-216"></span> |
| <span class="source-line-no">217</span><span id="line-217"> /**</span> |
| <span class="source-line-no">218</span><span id="line-218"> * Wait for the specified datanode to join the cluster</span> |
| <span class="source-line-no">219</span><span id="line-219"> * @throws IOException if something goes wrong or timeout occurs</span> |
| <span class="source-line-no">220</span><span id="line-220"> */</span> |
| <span class="source-line-no">221</span><span id="line-221"> public abstract void waitForDataNodeToStart(ServerName serverName, long timeout)</span> |
| <span class="source-line-no">222</span><span id="line-222"> throws IOException;</span> |
| <span class="source-line-no">223</span><span id="line-223"></span> |
| <span class="source-line-no">224</span><span id="line-224"> /**</span> |
| <span class="source-line-no">225</span><span id="line-225"> * Wait for the specified datanode to stop the thread / process.</span> |
| <span class="source-line-no">226</span><span id="line-226"> * @throws IOException if something goes wrong or timeout occurs</span> |
| <span class="source-line-no">227</span><span id="line-227"> */</span> |
| <span class="source-line-no">228</span><span id="line-228"> public abstract void waitForDataNodeToStop(ServerName serverName, long timeout)</span> |
| <span class="source-line-no">229</span><span id="line-229"> throws IOException;</span> |
| <span class="source-line-no">230</span><span id="line-230"></span> |
| <span class="source-line-no">231</span><span id="line-231"> /**</span> |
| <span class="source-line-no">232</span><span id="line-232"> * Starts a new namenode on the given hostname or if this is a mini/local cluster, silently logs</span> |
| <span class="source-line-no">233</span><span id="line-233"> * warning message.</span> |
| <span class="source-line-no">234</span><span id="line-234"> * @throws IOException if something goes wrong</span> |
| <span class="source-line-no">235</span><span id="line-235"> */</span> |
| <span class="source-line-no">236</span><span id="line-236"> public abstract void startNameNode(ServerName serverName) throws IOException;</span> |
| <span class="source-line-no">237</span><span id="line-237"></span> |
| <span class="source-line-no">238</span><span id="line-238"> /**</span> |
| <span class="source-line-no">239</span><span id="line-239"> * Kills the namenode process if this is a distributed cluster, otherwise, this causes master to</span> |
| <span class="source-line-no">240</span><span id="line-240"> * exit doing basic clean up only.</span> |
| <span class="source-line-no">241</span><span id="line-241"> * @throws IOException if something goes wrong</span> |
| <span class="source-line-no">242</span><span id="line-242"> */</span> |
| <span class="source-line-no">243</span><span id="line-243"> public abstract void killNameNode(ServerName serverName) throws IOException;</span> |
| <span class="source-line-no">244</span><span id="line-244"></span> |
| <span class="source-line-no">245</span><span id="line-245"> /**</span> |
| <span class="source-line-no">246</span><span id="line-246"> * Stops the namenode if this is a distributed cluster, otherwise silently logs warning message.</span> |
| <span class="source-line-no">247</span><span id="line-247"> * @throws IOException if something goes wrong</span> |
| <span class="source-line-no">248</span><span id="line-248"> */</span> |
| <span class="source-line-no">249</span><span id="line-249"> public abstract void stopNameNode(ServerName serverName) throws IOException;</span> |
| <span class="source-line-no">250</span><span id="line-250"></span> |
| <span class="source-line-no">251</span><span id="line-251"> /**</span> |
| <span class="source-line-no">252</span><span id="line-252"> * Wait for the specified namenode to join the cluster</span> |
| <span class="source-line-no">253</span><span id="line-253"> * @throws IOException if something goes wrong or timeout occurs</span> |
| <span class="source-line-no">254</span><span id="line-254"> */</span> |
| <span class="source-line-no">255</span><span id="line-255"> public abstract void waitForNameNodeToStart(ServerName serverName, long timeout)</span> |
| <span class="source-line-no">256</span><span id="line-256"> throws IOException;</span> |
| <span class="source-line-no">257</span><span id="line-257"></span> |
| <span class="source-line-no">258</span><span id="line-258"> /**</span> |
| <span class="source-line-no">259</span><span id="line-259"> * Wait for the specified namenode to stop</span> |
| <span class="source-line-no">260</span><span id="line-260"> * @throws IOException if something goes wrong or timeout occurs</span> |
| <span class="source-line-no">261</span><span id="line-261"> */</span> |
| <span class="source-line-no">262</span><span id="line-262"> public abstract void waitForNameNodeToStop(ServerName serverName, long timeout)</span> |
| <span class="source-line-no">263</span><span id="line-263"> throws IOException;</span> |
| <span class="source-line-no">264</span><span id="line-264"></span> |
| <span class="source-line-no">265</span><span id="line-265"> /**</span> |
| <span class="source-line-no">266</span><span id="line-266"> * Starts a new journalnode on the given hostname or if this is a mini/local cluster, silently</span> |
| <span class="source-line-no">267</span><span id="line-267"> * logs warning message.</span> |
| <span class="source-line-no">268</span><span id="line-268"> * @throws IOException if something goes wrong</span> |
| <span class="source-line-no">269</span><span id="line-269"> */</span> |
| <span class="source-line-no">270</span><span id="line-270"> public abstract void startJournalNode(ServerName serverName) throws IOException;</span> |
| <span class="source-line-no">271</span><span id="line-271"></span> |
| <span class="source-line-no">272</span><span id="line-272"> /**</span> |
| <span class="source-line-no">273</span><span id="line-273"> * Kills the journalnode process if this is a distributed cluster, otherwise, this causes master</span> |
| <span class="source-line-no">274</span><span id="line-274"> * to exit doing basic clean up only.</span> |
| <span class="source-line-no">275</span><span id="line-275"> * @throws IOException if something goes wrong</span> |
| <span class="source-line-no">276</span><span id="line-276"> */</span> |
| <span class="source-line-no">277</span><span id="line-277"> public abstract void killJournalNode(ServerName serverName) throws IOException;</span> |
| <span class="source-line-no">278</span><span id="line-278"></span> |
| <span class="source-line-no">279</span><span id="line-279"> /**</span> |
| <span class="source-line-no">280</span><span id="line-280"> * Stops the journalnode if this is a distributed cluster, otherwise silently logs warning</span> |
| <span class="source-line-no">281</span><span id="line-281"> * message.</span> |
| <span class="source-line-no">282</span><span id="line-282"> * @throws IOException if something goes wrong</span> |
| <span class="source-line-no">283</span><span id="line-283"> */</span> |
| <span class="source-line-no">284</span><span id="line-284"> public abstract void stopJournalNode(ServerName serverName) throws IOException;</span> |
| <span class="source-line-no">285</span><span id="line-285"></span> |
| <span class="source-line-no">286</span><span id="line-286"> /**</span> |
| <span class="source-line-no">287</span><span id="line-287"> * Wait for the specified journalnode to join the cluster</span> |
| <span class="source-line-no">288</span><span id="line-288"> * @throws IOException if something goes wrong or timeout occurs</span> |
| <span class="source-line-no">289</span><span id="line-289"> */</span> |
| <span class="source-line-no">290</span><span id="line-290"> public abstract void waitForJournalNodeToStart(ServerName serverName, long timeout)</span> |
| <span class="source-line-no">291</span><span id="line-291"> throws IOException;</span> |
| <span class="source-line-no">292</span><span id="line-292"></span> |
| <span class="source-line-no">293</span><span id="line-293"> /**</span> |
| <span class="source-line-no">294</span><span id="line-294"> * Wait for the specified journalnode to stop</span> |
| <span class="source-line-no">295</span><span id="line-295"> * @throws IOException if something goes wrong or timeout occurs</span> |
| <span class="source-line-no">296</span><span id="line-296"> */</span> |
| <span class="source-line-no">297</span><span id="line-297"> public abstract void waitForJournalNodeToStop(ServerName serverName, long timeout)</span> |
| <span class="source-line-no">298</span><span id="line-298"> throws IOException;</span> |
| <span class="source-line-no">299</span><span id="line-299"></span> |
| <span class="source-line-no">300</span><span id="line-300"> /**</span> |
| <span class="source-line-no">301</span><span id="line-301"> * Starts a new master on the given hostname or if this is a mini/local cluster, starts a master</span> |
| <span class="source-line-no">302</span><span id="line-302"> * locally.</span> |
| <span class="source-line-no">303</span><span id="line-303"> * @param hostname the hostname to start the master on</span> |
| <span class="source-line-no">304</span><span id="line-304"> * @throws IOException if something goes wrong</span> |
| <span class="source-line-no">305</span><span id="line-305"> */</span> |
| <span class="source-line-no">306</span><span id="line-306"> public abstract void startMaster(String hostname, int port) throws IOException;</span> |
| <span class="source-line-no">307</span><span id="line-307"></span> |
| <span class="source-line-no">308</span><span id="line-308"> /**</span> |
| <span class="source-line-no">309</span><span id="line-309"> * Kills the master process if this is a distributed cluster, otherwise, this causes master to</span> |
| <span class="source-line-no">310</span><span id="line-310"> * exit doing basic clean up only.</span> |
| <span class="source-line-no">311</span><span id="line-311"> * @throws IOException if something goes wrong</span> |
| <span class="source-line-no">312</span><span id="line-312"> */</span> |
| <span class="source-line-no">313</span><span id="line-313"> public abstract void killMaster(ServerName serverName) throws IOException;</span> |
| <span class="source-line-no">314</span><span id="line-314"></span> |
| <span class="source-line-no">315</span><span id="line-315"> /**</span> |
| <span class="source-line-no">316</span><span id="line-316"> * Stops the given master, by attempting a gradual stop.</span> |
| <span class="source-line-no">317</span><span id="line-317"> * @throws IOException if something goes wrong</span> |
| <span class="source-line-no">318</span><span id="line-318"> */</span> |
| <span class="source-line-no">319</span><span id="line-319"> public abstract void stopMaster(ServerName serverName) throws IOException;</span> |
| <span class="source-line-no">320</span><span id="line-320"></span> |
| <span class="source-line-no">321</span><span id="line-321"> /**</span> |
| <span class="source-line-no">322</span><span id="line-322"> * Wait for the specified master to stop the thread / process.</span> |
| <span class="source-line-no">323</span><span id="line-323"> * @throws IOException if something goes wrong or timeout occurs</span> |
| <span class="source-line-no">324</span><span id="line-324"> */</span> |
| <span class="source-line-no">325</span><span id="line-325"> public abstract void waitForMasterToStop(ServerName serverName, long timeout) throws IOException;</span> |
| <span class="source-line-no">326</span><span id="line-326"></span> |
| <span class="source-line-no">327</span><span id="line-327"> /**</span> |
| <span class="source-line-no">328</span><span id="line-328"> * Blocks until there is an active master and that master has completed initialization.</span> |
| <span class="source-line-no">329</span><span id="line-329"> * @return true if an active master becomes available. false if there are no masters left.</span> |
| <span class="source-line-no">330</span><span id="line-330"> * @throws IOException if something goes wrong or timeout occurs</span> |
| <span class="source-line-no">331</span><span id="line-331"> */</span> |
| <span class="source-line-no">332</span><span id="line-332"> public boolean waitForActiveAndReadyMaster() throws IOException {</span> |
| <span class="source-line-no">333</span><span id="line-333"> return waitForActiveAndReadyMaster(Long.MAX_VALUE);</span> |
| <span class="source-line-no">334</span><span id="line-334"> }</span> |
| <span class="source-line-no">335</span><span id="line-335"></span> |
| <span class="source-line-no">336</span><span id="line-336"> /**</span> |
| <span class="source-line-no">337</span><span id="line-337"> * Blocks until there is an active master and that master has completed initialization.</span> |
| <span class="source-line-no">338</span><span id="line-338"> * @param timeout the timeout limit in ms</span> |
| <span class="source-line-no">339</span><span id="line-339"> * @return true if an active master becomes available. false if there are no masters left.</span> |
| <span class="source-line-no">340</span><span id="line-340"> */</span> |
| <span class="source-line-no">341</span><span id="line-341"> public abstract boolean waitForActiveAndReadyMaster(long timeout) throws IOException;</span> |
| <span class="source-line-no">342</span><span id="line-342"></span> |
| <span class="source-line-no">343</span><span id="line-343"> /**</span> |
| <span class="source-line-no">344</span><span id="line-344"> * Wait for HBase Cluster to shut down.</span> |
| <span class="source-line-no">345</span><span id="line-345"> */</span> |
| <span class="source-line-no">346</span><span id="line-346"> public abstract void waitUntilShutDown() throws IOException;</span> |
| <span class="source-line-no">347</span><span id="line-347"></span> |
| <span class="source-line-no">348</span><span id="line-348"> /**</span> |
| <span class="source-line-no">349</span><span id="line-349"> * Shut down the HBase cluster</span> |
| <span class="source-line-no">350</span><span id="line-350"> */</span> |
| <span class="source-line-no">351</span><span id="line-351"> public abstract void shutdown() throws IOException;</span> |
| <span class="source-line-no">352</span><span id="line-352"></span> |
| <span class="source-line-no">353</span><span id="line-353"> /**</span> |
| <span class="source-line-no">354</span><span id="line-354"> * Restores the cluster to it's initial state if this is a real cluster, otherwise does nothing.</span> |
| <span class="source-line-no">355</span><span id="line-355"> * This is a best effort restore. If the servers are not reachable, or insufficient permissions,</span> |
| <span class="source-line-no">356</span><span id="line-356"> * etc. restoration might be partial.</span> |
| <span class="source-line-no">357</span><span id="line-357"> * @return whether restoration is complete</span> |
| <span class="source-line-no">358</span><span id="line-358"> */</span> |
| <span class="source-line-no">359</span><span id="line-359"> public boolean restoreInitialStatus() throws IOException {</span> |
| <span class="source-line-no">360</span><span id="line-360"> return restoreClusterMetrics(getInitialClusterMetrics());</span> |
| <span class="source-line-no">361</span><span id="line-361"> }</span> |
| <span class="source-line-no">362</span><span id="line-362"></span> |
| <span class="source-line-no">363</span><span id="line-363"> /**</span> |
| <span class="source-line-no">364</span><span id="line-364"> * Restores the cluster to given state if this is a real cluster, otherwise does nothing. This is</span> |
| <span class="source-line-no">365</span><span id="line-365"> * a best effort restore. If the servers are not reachable, or insufficient permissions, etc.</span> |
| <span class="source-line-no">366</span><span id="line-366"> * restoration might be partial.</span> |
| <span class="source-line-no">367</span><span id="line-367"> * @return whether restoration is complete</span> |
| <span class="source-line-no">368</span><span id="line-368"> */</span> |
| <span class="source-line-no">369</span><span id="line-369"> public boolean restoreClusterMetrics(ClusterMetrics desiredStatus) throws IOException {</span> |
| <span class="source-line-no">370</span><span id="line-370"> return true;</span> |
| <span class="source-line-no">371</span><span id="line-371"> }</span> |
| <span class="source-line-no">372</span><span id="line-372"></span> |
| <span class="source-line-no">373</span><span id="line-373"> /**</span> |
| <span class="source-line-no">374</span><span id="line-374"> * Get the ServerName of region server serving the first hbase:meta region</span> |
| <span class="source-line-no">375</span><span id="line-375"> */</span> |
| <span class="source-line-no">376</span><span id="line-376"> public ServerName getServerHoldingMeta() throws IOException {</span> |
| <span class="source-line-no">377</span><span id="line-377"> return getServerHoldingRegion(TableName.META_TABLE_NAME,</span> |
| <span class="source-line-no">378</span><span id="line-378"> RegionInfoBuilder.FIRST_META_REGIONINFO.getRegionName());</span> |
| <span class="source-line-no">379</span><span id="line-379"> }</span> |
| <span class="source-line-no">380</span><span id="line-380"></span> |
| <span class="source-line-no">381</span><span id="line-381"> /**</span> |
| <span class="source-line-no">382</span><span id="line-382"> * Get the ServerName of region server serving the specified region</span> |
| <span class="source-line-no">383</span><span id="line-383"> * @param regionName Name of the region in bytes</span> |
| <span class="source-line-no">384</span><span id="line-384"> * @param tn Table name that has the region.</span> |
| <span class="source-line-no">385</span><span id="line-385"> * @return ServerName that hosts the region or null</span> |
| <span class="source-line-no">386</span><span id="line-386"> */</span> |
| <span class="source-line-no">387</span><span id="line-387"> public abstract ServerName getServerHoldingRegion(final TableName tn, byte[] regionName)</span> |
| <span class="source-line-no">388</span><span id="line-388"> throws IOException;</span> |
| <span class="source-line-no">389</span><span id="line-389"></span> |
| <span class="source-line-no">390</span><span id="line-390"> /**</span> |
| <span class="source-line-no">391</span><span id="line-391"> * @return whether we are interacting with a distributed cluster as opposed to an in-process</span> |
| <span class="source-line-no">392</span><span id="line-392"> * mini/local cluster.</span> |
| <span class="source-line-no">393</span><span id="line-393"> */</span> |
| <span class="source-line-no">394</span><span id="line-394"> public boolean isDistributedCluster() {</span> |
| <span class="source-line-no">395</span><span id="line-395"> return false;</span> |
| <span class="source-line-no">396</span><span id="line-396"> }</span> |
| <span class="source-line-no">397</span><span id="line-397"></span> |
| <span class="source-line-no">398</span><span id="line-398"> /**</span> |
| <span class="source-line-no">399</span><span id="line-399"> * Closes all the resources held open for this cluster. Note that this call does not shutdown the</span> |
| <span class="source-line-no">400</span><span id="line-400"> * cluster.</span> |
| <span class="source-line-no">401</span><span id="line-401"> * @see #shutdown()</span> |
| <span class="source-line-no">402</span><span id="line-402"> */</span> |
| <span class="source-line-no">403</span><span id="line-403"> @Override</span> |
| <span class="source-line-no">404</span><span id="line-404"> public abstract void close() throws IOException;</span> |
| <span class="source-line-no">405</span><span id="line-405"></span> |
| <span class="source-line-no">406</span><span id="line-406"> /**</span> |
| <span class="source-line-no">407</span><span id="line-407"> * Wait for the namenode.</span> |
| <span class="source-line-no">408</span><span id="line-408"> */</span> |
| <span class="source-line-no">409</span><span id="line-409"> public void waitForNamenodeAvailable() throws InterruptedException {</span> |
| <span class="source-line-no">410</span><span id="line-410"> }</span> |
| <span class="source-line-no">411</span><span id="line-411"></span> |
| <span class="source-line-no">412</span><span id="line-412"> public void waitForDatanodesRegistered(int nbDN) throws Exception {</span> |
| <span class="source-line-no">413</span><span id="line-413"> }</span> |
| <span class="source-line-no">414</span><span id="line-414">}</span> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </main> |
| </body> |
| </html> |
