| <!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.testing, interface: TestingHBaseCluster"> |
| <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.testing;</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.util.List;</span> |
| <span class="source-line-no">021</span><span id="line-21">import java.util.Optional;</span> |
| <span class="source-line-no">022</span><span id="line-22">import java.util.concurrent.CompletableFuture;</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.HBaseInterfaceAudience;</span> |
| <span class="source-line-no">025</span><span id="line-25">import org.apache.hadoop.hbase.ServerName;</span> |
| <span class="source-line-no">026</span><span id="line-26">import org.apache.hadoop.hbase.client.RegionInfo;</span> |
| <span class="source-line-no">027</span><span id="line-27">import org.apache.hadoop.hbase.regionserver.OnlineRegions;</span> |
| <span class="source-line-no">028</span><span id="line-28">import org.apache.hadoop.hbase.regionserver.Region;</span> |
| <span class="source-line-no">029</span><span id="line-29">import org.apache.yetus.audience.InterfaceAudience;</span> |
| <span class="source-line-no">030</span><span id="line-30"></span> |
| <span class="source-line-no">031</span><span id="line-31">/**</span> |
| <span class="source-line-no">032</span><span id="line-32"> * A mini hbase cluster used for testing.</span> |
| <span class="source-line-no">033</span><span id="line-33"> * <p/></span> |
| <span class="source-line-no">034</span><span id="line-34"> * It will also start the necessary zookeeper cluster and dfs cluster. But we will not provide</span> |
| <span class="source-line-no">035</span><span id="line-35"> * methods for controlling the zookeeper cluster and dfs cluster, as end users do not need to test</span> |
| <span class="source-line-no">036</span><span id="line-36"> * the HBase behavior when these systems are broken.</span> |
| <span class="source-line-no">037</span><span id="line-37"> * <p/></span> |
| <span class="source-line-no">038</span><span id="line-38"> * The implementation is not required to be thread safe, so do not call different methods</span> |
| <span class="source-line-no">039</span><span id="line-39"> * concurrently.</span> |
| <span class="source-line-no">040</span><span id="line-40"> */</span> |
| <span class="source-line-no">041</span><span id="line-41">@InterfaceAudience.Public</span> |
| <span class="source-line-no">042</span><span id="line-42">public interface TestingHBaseCluster {</span> |
| <span class="source-line-no">043</span><span id="line-43"></span> |
| <span class="source-line-no">044</span><span id="line-44"> /**</span> |
| <span class="source-line-no">045</span><span id="line-45"> * Get configuration of this cluster.</span> |
| <span class="source-line-no">046</span><span id="line-46"> * <p/></span> |
| <span class="source-line-no">047</span><span id="line-47"> * You could use the returned {@link Configuration} to create</span> |
| <span class="source-line-no">048</span><span id="line-48"> * {@link org.apache.hadoop.hbase.client.Connection} for accessing the testing cluster.</span> |
| <span class="source-line-no">049</span><span id="line-49"> */</span> |
| <span class="source-line-no">050</span><span id="line-50"> Configuration getConf();</span> |
| <span class="source-line-no">051</span><span id="line-51"></span> |
| <span class="source-line-no">052</span><span id="line-52"> /**</span> |
| <span class="source-line-no">053</span><span id="line-53"> * Start a new master with localhost and random port.</span> |
| <span class="source-line-no">054</span><span id="line-54"> */</span> |
| <span class="source-line-no">055</span><span id="line-55"> void startMaster() throws Exception;</span> |
| <span class="source-line-no">056</span><span id="line-56"></span> |
| <span class="source-line-no">057</span><span id="line-57"> /**</span> |
| <span class="source-line-no">058</span><span id="line-58"> * Start a new master bind on the given host and port.</span> |
| <span class="source-line-no">059</span><span id="line-59"> */</span> |
| <span class="source-line-no">060</span><span id="line-60"> void startMaster(String hostname, int port) throws Exception;</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"> * Stop the given master.</span> |
| <span class="source-line-no">064</span><span id="line-64"> * <p/></span> |
| <span class="source-line-no">065</span><span id="line-65"> * Wait on the returned {@link CompletableFuture} to wait on the master quit. The differences</span> |
| <span class="source-line-no">066</span><span id="line-66"> * comparing to {@link org.apache.hadoop.hbase.client.Admin#stopMaster()} is that first, we could</span> |
| <span class="source-line-no">067</span><span id="line-67"> * also stop backup masters here, second, this method does not always fail since we do not use rpc</span> |
| <span class="source-line-no">068</span><span id="line-68"> * to stop the master.</span> |
| <span class="source-line-no">069</span><span id="line-69"> */</span> |
| <span class="source-line-no">070</span><span id="line-70"> CompletableFuture<Void> stopMaster(ServerName serverName) throws Exception;</span> |
| <span class="source-line-no">071</span><span id="line-71"></span> |
| <span class="source-line-no">072</span><span id="line-72"> /**</span> |
| <span class="source-line-no">073</span><span id="line-73"> * Start a new region server with localhost and random port.</span> |
| <span class="source-line-no">074</span><span id="line-74"> */</span> |
| <span class="source-line-no">075</span><span id="line-75"> void startRegionServer() throws Exception;</span> |
| <span class="source-line-no">076</span><span id="line-76"></span> |
| <span class="source-line-no">077</span><span id="line-77"> /**</span> |
| <span class="source-line-no">078</span><span id="line-78"> * Start a new region server bind on the given host and port.</span> |
| <span class="source-line-no">079</span><span id="line-79"> */</span> |
| <span class="source-line-no">080</span><span id="line-80"> void startRegionServer(String hostname, int port) throws Exception;</span> |
| <span class="source-line-no">081</span><span id="line-81"></span> |
| <span class="source-line-no">082</span><span id="line-82"> /**</span> |
| <span class="source-line-no">083</span><span id="line-83"> * Stop the given region server.</span> |
| <span class="source-line-no">084</span><span id="line-84"> * <p/></span> |
| <span class="source-line-no">085</span><span id="line-85"> * Wait on the returned {@link CompletableFuture} to wait on the master quit. The difference</span> |
| <span class="source-line-no">086</span><span id="line-86"> * comparing to {@link org.apache.hadoop.hbase.client.Admin#stopMaster()} is that this method does</span> |
| <span class="source-line-no">087</span><span id="line-87"> * not always fail since we do not use rpc to stop the region server.</span> |
| <span class="source-line-no">088</span><span id="line-88"> */</span> |
| <span class="source-line-no">089</span><span id="line-89"> CompletableFuture<Void> stopRegionServer(ServerName serverName) throws Exception;</span> |
| <span class="source-line-no">090</span><span id="line-90"></span> |
| <span class="source-line-no">091</span><span id="line-91"> /**</span> |
| <span class="source-line-no">092</span><span id="line-92"> * Stop the hbase cluster.</span> |
| <span class="source-line-no">093</span><span id="line-93"> * <p/></span> |
| <span class="source-line-no">094</span><span id="line-94"> * You need to call {@link #start()} first before calling this method, otherwise an</span> |
| <span class="source-line-no">095</span><span id="line-95"> * {@link IllegalStateException} will be thrown. If the hbase is not running because you have</span> |
| <span class="source-line-no">096</span><span id="line-96"> * already stopped the cluster, an {@link IllegalStateException} will be thrown too.</span> |
| <span class="source-line-no">097</span><span id="line-97"> */</span> |
| <span class="source-line-no">098</span><span id="line-98"> void stopHBaseCluster() throws Exception;</span> |
| <span class="source-line-no">099</span><span id="line-99"></span> |
| <span class="source-line-no">100</span><span id="line-100"> /**</span> |
| <span class="source-line-no">101</span><span id="line-101"> * Start the hbase cluster.</span> |
| <span class="source-line-no">102</span><span id="line-102"> * <p/></span> |
| <span class="source-line-no">103</span><span id="line-103"> * This is used to start the hbase cluster again after you call {@link #stopHBaseCluster()}. If</span> |
| <span class="source-line-no">104</span><span id="line-104"> * the cluster is already running or you have not called {@link #start()} yet, an</span> |
| <span class="source-line-no">105</span><span id="line-105"> * {@link IllegalStateException} will be thrown.</span> |
| <span class="source-line-no">106</span><span id="line-106"> */</span> |
| <span class="source-line-no">107</span><span id="line-107"> void startHBaseCluster() throws Exception;</span> |
| <span class="source-line-no">108</span><span id="line-108"></span> |
| <span class="source-line-no">109</span><span id="line-109"> /**</span> |
| <span class="source-line-no">110</span><span id="line-110"> * Return whether the hbase cluster is running.</span> |
| <span class="source-line-no">111</span><span id="line-111"> */</span> |
| <span class="source-line-no">112</span><span id="line-112"> boolean isHBaseClusterRunning();</span> |
| <span class="source-line-no">113</span><span id="line-113"></span> |
| <span class="source-line-no">114</span><span id="line-114"> /**</span> |
| <span class="source-line-no">115</span><span id="line-115"> * Start the whole mini cluster, including zookeeper cluster, dfs cluster and hbase cluster.</span> |
| <span class="source-line-no">116</span><span id="line-116"> * <p/></span> |
| <span class="source-line-no">117</span><span id="line-117"> * You can only call this method once at the beginning, unless you have called {@link #stop()} to</span> |
| <span class="source-line-no">118</span><span id="line-118"> * shutdown the cluster completely, and then you can call this method to start the whole cluster</span> |
| <span class="source-line-no">119</span><span id="line-119"> * again. An {@link IllegalStateException} will be thrown if you call this method incorrectly.</span> |
| <span class="source-line-no">120</span><span id="line-120"> */</span> |
| <span class="source-line-no">121</span><span id="line-121"> void start() throws Exception;</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"> * Get the address of active master if there is one.</span> |
| <span class="source-line-no">125</span><span id="line-125"> */</span> |
| <span class="source-line-no">126</span><span id="line-126"> Optional<ServerName> getActiveMasterAddress();</span> |
| <span class="source-line-no">127</span><span id="line-127"></span> |
| <span class="source-line-no">128</span><span id="line-128"> /**</span> |
| <span class="source-line-no">129</span><span id="line-129"> * Get all the backup master addresses.</span> |
| <span class="source-line-no">130</span><span id="line-130"> */</span> |
| <span class="source-line-no">131</span><span id="line-131"> List<ServerName> getBackupMasterAddresses();</span> |
| <span class="source-line-no">132</span><span id="line-132"></span> |
| <span class="source-line-no">133</span><span id="line-133"> /**</span> |
| <span class="source-line-no">134</span><span id="line-134"> * Get all the region server addresses.</span> |
| <span class="source-line-no">135</span><span id="line-135"> */</span> |
| <span class="source-line-no">136</span><span id="line-136"> List<ServerName> getRegionServerAddresses();</span> |
| <span class="source-line-no">137</span><span id="line-137"></span> |
| <span class="source-line-no">138</span><span id="line-138"> /**</span> |
| <span class="source-line-no">139</span><span id="line-139"> * Get the server side {@link Region} interface for the specific region.</span> |
| <span class="source-line-no">140</span><span id="line-140"> * <p/></span> |
| <span class="source-line-no">141</span><span id="line-141"> * This is used for CPs to test something which can only be accessed at server side, such as tags.</span> |
| <span class="source-line-no">142</span><span id="line-142"> */</span> |
| <span class="source-line-no">143</span><span id="line-143"> @InterfaceAudience.LimitedPrivate(HBaseInterfaceAudience.COPROC)</span> |
| <span class="source-line-no">144</span><span id="line-144"> Optional<Region> getRegion(RegionInfo regionInfo);</span> |
| <span class="source-line-no">145</span><span id="line-145"></span> |
| <span class="source-line-no">146</span><span id="line-146"> /**</span> |
| <span class="source-line-no">147</span><span id="line-147"> * Get the server side {@link OnlineRegions} interface for the specific region server.</span> |
| <span class="source-line-no">148</span><span id="line-148"> * <p/></span> |
| <span class="source-line-no">149</span><span id="line-149"> * You could list the addresses of all the region server through the</span> |
| <span class="source-line-no">150</span><span id="line-150"> * {@link #getRegionServerAddresses()} method.</span> |
| <span class="source-line-no">151</span><span id="line-151"> * <p/></span> |
| <span class="source-line-no">152</span><span id="line-152"> * This is used for CPs to test something which can only be accessed at server side, such as tags.</span> |
| <span class="source-line-no">153</span><span id="line-153"> * And also you could use the returned interface to get all regions on this region server, etc.</span> |
| <span class="source-line-no">154</span><span id="line-154"> */</span> |
| <span class="source-line-no">155</span><span id="line-155"> @InterfaceAudience.LimitedPrivate(HBaseInterfaceAudience.COPROC)</span> |
| <span class="source-line-no">156</span><span id="line-156"> Optional<OnlineRegions> getOnlineRegionsInterface(ServerName serverName);</span> |
| <span class="source-line-no">157</span><span id="line-157"></span> |
| <span class="source-line-no">158</span><span id="line-158"> /**</span> |
| <span class="source-line-no">159</span><span id="line-159"> * Return whether the cluster is running.</span> |
| <span class="source-line-no">160</span><span id="line-160"> * <p/></span> |
| <span class="source-line-no">161</span><span id="line-161"> * Notice that, this only means you have called {@link #start()} and have not called</span> |
| <span class="source-line-no">162</span><span id="line-162"> * {@link #stop()} yet. If you want to make sure the hbase cluster is running, use</span> |
| <span class="source-line-no">163</span><span id="line-163"> * {@link #isHBaseClusterRunning()}.</span> |
| <span class="source-line-no">164</span><span id="line-164"> */</span> |
| <span class="source-line-no">165</span><span id="line-165"> boolean isClusterRunning();</span> |
| <span class="source-line-no">166</span><span id="line-166"></span> |
| <span class="source-line-no">167</span><span id="line-167"> /**</span> |
| <span class="source-line-no">168</span><span id="line-168"> * Stop the whole mini cluster, including zookeeper cluster, dfs cluster and hbase cluster.</span> |
| <span class="source-line-no">169</span><span id="line-169"> * <p/></span> |
| <span class="source-line-no">170</span><span id="line-170"> * You can only call this method after calling {@link #start()}, otherwise an</span> |
| <span class="source-line-no">171</span><span id="line-171"> * {@link IllegalStateException} will be thrown.</span> |
| <span class="source-line-no">172</span><span id="line-172"> */</span> |
| <span class="source-line-no">173</span><span id="line-173"> void stop() throws Exception;</span> |
| <span class="source-line-no">174</span><span id="line-174"></span> |
| <span class="source-line-no">175</span><span id="line-175"> /**</span> |
| <span class="source-line-no">176</span><span id="line-176"> * Create a {@link TestingHBaseCluster}. You need to call {@link #start()} of the returned</span> |
| <span class="source-line-no">177</span><span id="line-177"> * {@link TestingHBaseCluster} to actually start the mini testing cluster.</span> |
| <span class="source-line-no">178</span><span id="line-178"> */</span> |
| <span class="source-line-no">179</span><span id="line-179"> static TestingHBaseCluster create(TestingHBaseClusterOption option) {</span> |
| <span class="source-line-no">180</span><span id="line-180"> return new TestingHBaseClusterImpl(option);</span> |
| <span class="source-line-no">181</span><span id="line-181"> }</span> |
| <span class="source-line-no">182</span><span id="line-182">}</span> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </main> |
| </body> |
| </html> |
