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