blob: f48db346704f66a3a47c3d7d1af2325ceaf0114d [file] [log] [blame]
<!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.master.assignment, class: RegionTransitionProcedure">
<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.master.assignment;</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.IOException;</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.atomic.AtomicBoolean;</span>
<span class="source-line-no">023</span><span id="line-23">import org.apache.hadoop.hbase.ServerName;</span>
<span class="source-line-no">024</span><span id="line-24">import org.apache.hadoop.hbase.TableName;</span>
<span class="source-line-no">025</span><span id="line-25">import org.apache.hadoop.hbase.client.RegionInfo;</span>
<span class="source-line-no">026</span><span id="line-26">import org.apache.hadoop.hbase.exceptions.UnexpectedStateException;</span>
<span class="source-line-no">027</span><span id="line-27">import org.apache.hadoop.hbase.master.procedure.MasterProcedureEnv;</span>
<span class="source-line-no">028</span><span id="line-28">import org.apache.hadoop.hbase.master.procedure.TableProcedureInterface;</span>
<span class="source-line-no">029</span><span id="line-29">import org.apache.hadoop.hbase.procedure2.Procedure;</span>
<span class="source-line-no">030</span><span id="line-30">import org.apache.hadoop.hbase.procedure2.ProcedureSuspendedException;</span>
<span class="source-line-no">031</span><span id="line-31">import org.apache.hadoop.hbase.procedure2.RemoteProcedureDispatcher.RemoteOperation;</span>
<span class="source-line-no">032</span><span id="line-32">import org.apache.hadoop.hbase.procedure2.RemoteProcedureDispatcher.RemoteProcedure;</span>
<span class="source-line-no">033</span><span id="line-33">import org.apache.hadoop.hbase.procedure2.RemoteProcedureException;</span>
<span class="source-line-no">034</span><span id="line-34">import org.apache.yetus.audience.InterfaceAudience;</span>
<span class="source-line-no">035</span><span id="line-35"></span>
<span class="source-line-no">036</span><span id="line-36">import org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProcedureProtos.RegionTransitionState;</span>
<span class="source-line-no">037</span><span id="line-37">import org.apache.hadoop.hbase.shaded.protobuf.generated.RegionServerStatusProtos.RegionStateTransition.TransitionCode;</span>
<span class="source-line-no">038</span><span id="line-38"></span>
<span class="source-line-no">039</span><span id="line-39">/**</span>
<span class="source-line-no">040</span><span id="line-40"> * Leave here only for checking if we can successfully start the master.</span>
<span class="source-line-no">041</span><span id="line-41"> * @deprecated Do not use any more.</span>
<span class="source-line-no">042</span><span id="line-42"> * @see TransitRegionStateProcedure</span>
<span class="source-line-no">043</span><span id="line-43"> */</span>
<span class="source-line-no">044</span><span id="line-44">@Deprecated</span>
<span class="source-line-no">045</span><span id="line-45">@InterfaceAudience.Private</span>
<span class="source-line-no">046</span><span id="line-46">public abstract class RegionTransitionProcedure extends Procedure&lt;MasterProcedureEnv&gt;</span>
<span class="source-line-no">047</span><span id="line-47"> implements TableProcedureInterface, RemoteProcedure&lt;MasterProcedureEnv, ServerName&gt; {</span>
<span class="source-line-no">048</span><span id="line-48"></span>
<span class="source-line-no">049</span><span id="line-49"> protected final AtomicBoolean aborted = new AtomicBoolean(false);</span>
<span class="source-line-no">050</span><span id="line-50"></span>
<span class="source-line-no">051</span><span id="line-51"> private RegionTransitionState transitionState = RegionTransitionState.REGION_TRANSITION_QUEUE;</span>
<span class="source-line-no">052</span><span id="line-52"></span>
<span class="source-line-no">053</span><span id="line-53"> private RegionInfo regionInfo;</span>
<span class="source-line-no">054</span><span id="line-54"></span>
<span class="source-line-no">055</span><span id="line-55"> private int attempt;</span>
<span class="source-line-no">056</span><span id="line-56"></span>
<span class="source-line-no">057</span><span id="line-57"> // Required by the Procedure framework to create the procedure on replay</span>
<span class="source-line-no">058</span><span id="line-58"> public RegionTransitionProcedure() {</span>
<span class="source-line-no">059</span><span id="line-59"> }</span>
<span class="source-line-no">060</span><span id="line-60"></span>
<span class="source-line-no">061</span><span id="line-61"> public RegionTransitionProcedure(final RegionInfo regionInfo) {</span>
<span class="source-line-no">062</span><span id="line-62"> this.regionInfo = regionInfo;</span>
<span class="source-line-no">063</span><span id="line-63"> }</span>
<span class="source-line-no">064</span><span id="line-64"></span>
<span class="source-line-no">065</span><span id="line-65"> public RegionInfo getRegionInfo() {</span>
<span class="source-line-no">066</span><span id="line-66"> return regionInfo;</span>
<span class="source-line-no">067</span><span id="line-67"> }</span>
<span class="source-line-no">068</span><span id="line-68"></span>
<span class="source-line-no">069</span><span id="line-69"> public void setRegionInfo(final RegionInfo regionInfo) {</span>
<span class="source-line-no">070</span><span id="line-70"> this.regionInfo = regionInfo;</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"> protected void setAttempt(int attempt) {</span>
<span class="source-line-no">074</span><span id="line-74"> this.attempt = attempt;</span>
<span class="source-line-no">075</span><span id="line-75"> }</span>
<span class="source-line-no">076</span><span id="line-76"></span>
<span class="source-line-no">077</span><span id="line-77"> protected int getAttempt() {</span>
<span class="source-line-no">078</span><span id="line-78"> return this.attempt;</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"> @Override</span>
<span class="source-line-no">082</span><span id="line-82"> public TableName getTableName() {</span>
<span class="source-line-no">083</span><span id="line-83"> RegionInfo hri = getRegionInfo();</span>
<span class="source-line-no">084</span><span id="line-84"> return hri != null ? hri.getTable() : null;</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"> public boolean isMeta() {</span>
<span class="source-line-no">088</span><span id="line-88"> return TableName.isMetaTableName(getTableName());</span>
<span class="source-line-no">089</span><span id="line-89"> }</span>
<span class="source-line-no">090</span><span id="line-90"></span>
<span class="source-line-no">091</span><span id="line-91"> @Override</span>
<span class="source-line-no">092</span><span id="line-92"> public void toStringClassDetails(final StringBuilder sb) {</span>
<span class="source-line-no">093</span><span id="line-93"> sb.append(getProcName());</span>
<span class="source-line-no">094</span><span id="line-94"> }</span>
<span class="source-line-no">095</span><span id="line-95"></span>
<span class="source-line-no">096</span><span id="line-96"> @Override</span>
<span class="source-line-no">097</span><span id="line-97"> public String getProcName() {</span>
<span class="source-line-no">098</span><span id="line-98"> RegionInfo r = getRegionInfo();</span>
<span class="source-line-no">099</span><span id="line-99"> return getClass().getSimpleName() + " " + getTableName()</span>
<span class="source-line-no">100</span><span id="line-100"> + (r != null ? r.getEncodedName() : "");</span>
<span class="source-line-no">101</span><span id="line-101"> }</span>
<span class="source-line-no">102</span><span id="line-102"></span>
<span class="source-line-no">103</span><span id="line-103"> public RegionStateNode getRegionState(final MasterProcedureEnv env) {</span>
<span class="source-line-no">104</span><span id="line-104"> return env.getAssignmentManager().getRegionStates().getOrCreateRegionStateNode(getRegionInfo());</span>
<span class="source-line-no">105</span><span id="line-105"> }</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 setTransitionState(final RegionTransitionState state) {</span>
<span class="source-line-no">108</span><span id="line-108"> this.transitionState = state;</span>
<span class="source-line-no">109</span><span id="line-109"> }</span>
<span class="source-line-no">110</span><span id="line-110"></span>
<span class="source-line-no">111</span><span id="line-111"> RegionTransitionState getTransitionState() {</span>
<span class="source-line-no">112</span><span id="line-112"> return transitionState;</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"> protected abstract boolean startTransition(MasterProcedureEnv env, RegionStateNode regionNode)</span>
<span class="source-line-no">116</span><span id="line-116"> throws IOException, ProcedureSuspendedException;</span>
<span class="source-line-no">117</span><span id="line-117"></span>
<span class="source-line-no">118</span><span id="line-118"> protected abstract boolean updateTransition(MasterProcedureEnv env, RegionStateNode regionNode)</span>
<span class="source-line-no">119</span><span id="line-119"> throws IOException, ProcedureSuspendedException;</span>
<span class="source-line-no">120</span><span id="line-120"></span>
<span class="source-line-no">121</span><span id="line-121"> protected abstract void finishTransition(MasterProcedureEnv env, RegionStateNode regionNode)</span>
<span class="source-line-no">122</span><span id="line-122"> throws IOException, ProcedureSuspendedException;</span>
<span class="source-line-no">123</span><span id="line-123"></span>
<span class="source-line-no">124</span><span id="line-124"> protected abstract void reportTransition(MasterProcedureEnv env, RegionStateNode regionNode,</span>
<span class="source-line-no">125</span><span id="line-125"> TransitionCode code, long seqId) throws UnexpectedStateException;</span>
<span class="source-line-no">126</span><span id="line-126"></span>
<span class="source-line-no">127</span><span id="line-127"> @Override</span>
<span class="source-line-no">128</span><span id="line-128"> public abstract Optional&lt;RemoteOperation&gt; remoteCallBuild(MasterProcedureEnv env,</span>
<span class="source-line-no">129</span><span id="line-129"> ServerName serverName);</span>
<span class="source-line-no">130</span><span id="line-130"></span>
<span class="source-line-no">131</span><span id="line-131"> protected abstract boolean remoteCallFailed(MasterProcedureEnv env, RegionStateNode regionNode,</span>
<span class="source-line-no">132</span><span id="line-132"> IOException exception);</span>
<span class="source-line-no">133</span><span id="line-133"></span>
<span class="source-line-no">134</span><span id="line-134"> @Override</span>
<span class="source-line-no">135</span><span id="line-135"> public synchronized void remoteCallFailed(final MasterProcedureEnv env,</span>
<span class="source-line-no">136</span><span id="line-136"> final ServerName serverName, final IOException exception) {</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"> @Override</span>
<span class="source-line-no">140</span><span id="line-140"> protected void toStringState(StringBuilder builder) {</span>
<span class="source-line-no">141</span><span id="line-141"> super.toStringState(builder);</span>
<span class="source-line-no">142</span><span id="line-142"> RegionTransitionState ts = this.transitionState;</span>
<span class="source-line-no">143</span><span id="line-143"> if (!isFinished() &amp;&amp; ts != null) {</span>
<span class="source-line-no">144</span><span id="line-144"> builder.append(":").append(ts);</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"></span>
<span class="source-line-no">148</span><span id="line-148"> @Override</span>
<span class="source-line-no">149</span><span id="line-149"> protected Procedure[] execute(final MasterProcedureEnv env) {</span>
<span class="source-line-no">150</span><span id="line-150"> return null;</span>
<span class="source-line-no">151</span><span id="line-151"> }</span>
<span class="source-line-no">152</span><span id="line-152"></span>
<span class="source-line-no">153</span><span id="line-153"> @Override</span>
<span class="source-line-no">154</span><span id="line-154"> protected void rollback(MasterProcedureEnv env) {</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"> protected abstract boolean isRollbackSupported(final RegionTransitionState state);</span>
<span class="source-line-no">158</span><span id="line-158"></span>
<span class="source-line-no">159</span><span id="line-159"> @Override</span>
<span class="source-line-no">160</span><span id="line-160"> protected boolean abort(final MasterProcedureEnv env) {</span>
<span class="source-line-no">161</span><span id="line-161"> if (isRollbackSupported(transitionState)) {</span>
<span class="source-line-no">162</span><span id="line-162"> aborted.set(true);</span>
<span class="source-line-no">163</span><span id="line-163"> return true;</span>
<span class="source-line-no">164</span><span id="line-164"> }</span>
<span class="source-line-no">165</span><span id="line-165"> return false;</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"> @Override</span>
<span class="source-line-no">169</span><span id="line-169"> public void remoteOperationCompleted(MasterProcedureEnv env, byte[] remoteResultData) {</span>
<span class="source-line-no">170</span><span id="line-170"> // should not be called for region operation until we modified the open/close region procedure</span>
<span class="source-line-no">171</span><span id="line-171"> throw new UnsupportedOperationException();</span>
<span class="source-line-no">172</span><span id="line-172"> }</span>
<span class="source-line-no">173</span><span id="line-173"></span>
<span class="source-line-no">174</span><span id="line-174"> @Override</span>
<span class="source-line-no">175</span><span id="line-175"> public void remoteOperationFailed(MasterProcedureEnv env, RemoteProcedureException error) {</span>
<span class="source-line-no">176</span><span id="line-176"> // should not be called for region operation until we modified the open/close region procedure</span>
<span class="source-line-no">177</span><span id="line-177"> throw new UnsupportedOperationException();</span>
<span class="source-line-no">178</span><span id="line-178"> }</span>
<span class="source-line-no">179</span><span id="line-179"></span>
<span class="source-line-no">180</span><span id="line-180">}</span>
</pre>
</div>
</main>
</body>
</html>