blob: 62e454eefa9f21349cb06929125bc146a42c9b64 [file] [log] [blame]
<!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.master.procedure;<a name="line.18"></a>
<span class="sourceLineNo">019</span><a name="line.19"></a>
<span class="sourceLineNo">020</span>import java.io.IOException;<a name="line.20"></a>
<span class="sourceLineNo">021</span>import java.util.function.Supplier;<a name="line.21"></a>
<span class="sourceLineNo">022</span>import org.apache.hadoop.hbase.NamespaceDescriptor;<a name="line.22"></a>
<span class="sourceLineNo">023</span>import org.apache.hadoop.hbase.TableName;<a name="line.23"></a>
<span class="sourceLineNo">024</span>import org.apache.hadoop.hbase.master.MasterFileSystem;<a name="line.24"></a>
<span class="sourceLineNo">025</span>import org.apache.hadoop.hbase.master.TableNamespaceManager;<a name="line.25"></a>
<span class="sourceLineNo">026</span>import org.apache.hadoop.hbase.procedure2.StateMachineProcedure;<a name="line.26"></a>
<span class="sourceLineNo">027</span>import org.apache.hadoop.hbase.rsgroup.RSGroupInfo;<a name="line.27"></a>
<span class="sourceLineNo">028</span>import org.apache.hadoop.hbase.util.CommonFSUtils;<a name="line.28"></a>
<span class="sourceLineNo">029</span>import org.apache.yetus.audience.InterfaceAudience;<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> * Base class for all the Namespace procedures that want to use a StateMachineProcedure. It provide<a name="line.32"></a>
<span class="sourceLineNo">033</span> * some basic helpers like basic locking and basic toStringClassDetails().<a name="line.33"></a>
<span class="sourceLineNo">034</span> */<a name="line.34"></a>
<span class="sourceLineNo">035</span>@InterfaceAudience.Private<a name="line.35"></a>
<span class="sourceLineNo">036</span>public abstract class AbstractStateMachineNamespaceProcedure&lt;TState&gt;<a name="line.36"></a>
<span class="sourceLineNo">037</span> extends StateMachineProcedure&lt;MasterProcedureEnv, TState&gt; implements TableProcedureInterface {<a name="line.37"></a>
<span class="sourceLineNo">038</span><a name="line.38"></a>
<span class="sourceLineNo">039</span> private final ProcedurePrepareLatch syncLatch;<a name="line.39"></a>
<span class="sourceLineNo">040</span><a name="line.40"></a>
<span class="sourceLineNo">041</span> protected AbstractStateMachineNamespaceProcedure() {<a name="line.41"></a>
<span class="sourceLineNo">042</span> // Required by the Procedure framework to create the procedure on replay<a name="line.42"></a>
<span class="sourceLineNo">043</span> syncLatch = null;<a name="line.43"></a>
<span class="sourceLineNo">044</span> }<a name="line.44"></a>
<span class="sourceLineNo">045</span><a name="line.45"></a>
<span class="sourceLineNo">046</span> protected AbstractStateMachineNamespaceProcedure(final MasterProcedureEnv env) {<a name="line.46"></a>
<span class="sourceLineNo">047</span> this(env, null);<a name="line.47"></a>
<span class="sourceLineNo">048</span> }<a name="line.48"></a>
<span class="sourceLineNo">049</span><a name="line.49"></a>
<span class="sourceLineNo">050</span> protected AbstractStateMachineNamespaceProcedure(final MasterProcedureEnv env,<a name="line.50"></a>
<span class="sourceLineNo">051</span> final ProcedurePrepareLatch latch) {<a name="line.51"></a>
<span class="sourceLineNo">052</span> this.setOwner(env.getRequestUser());<a name="line.52"></a>
<span class="sourceLineNo">053</span> this.syncLatch = latch;<a name="line.53"></a>
<span class="sourceLineNo">054</span> }<a name="line.54"></a>
<span class="sourceLineNo">055</span><a name="line.55"></a>
<span class="sourceLineNo">056</span> protected abstract String getNamespaceName();<a name="line.56"></a>
<span class="sourceLineNo">057</span><a name="line.57"></a>
<span class="sourceLineNo">058</span> @Override<a name="line.58"></a>
<span class="sourceLineNo">059</span> public TableName getTableName() {<a name="line.59"></a>
<span class="sourceLineNo">060</span> return DUMMY_NAMESPACE_TABLE_NAME;<a name="line.60"></a>
<span class="sourceLineNo">061</span> }<a name="line.61"></a>
<span class="sourceLineNo">062</span><a name="line.62"></a>
<span class="sourceLineNo">063</span> @Override<a name="line.63"></a>
<span class="sourceLineNo">064</span> public abstract TableOperationType getTableOperationType();<a name="line.64"></a>
<span class="sourceLineNo">065</span><a name="line.65"></a>
<span class="sourceLineNo">066</span> @Override<a name="line.66"></a>
<span class="sourceLineNo">067</span> public void toStringClassDetails(final StringBuilder sb) {<a name="line.67"></a>
<span class="sourceLineNo">068</span> sb.append(getClass().getSimpleName());<a name="line.68"></a>
<span class="sourceLineNo">069</span> sb.append(", namespace=");<a name="line.69"></a>
<span class="sourceLineNo">070</span> sb.append(getNamespaceName());<a name="line.70"></a>
<span class="sourceLineNo">071</span> }<a name="line.71"></a>
<span class="sourceLineNo">072</span><a name="line.72"></a>
<span class="sourceLineNo">073</span> @Override<a name="line.73"></a>
<span class="sourceLineNo">074</span> protected boolean waitInitialized(MasterProcedureEnv env) {<a name="line.74"></a>
<span class="sourceLineNo">075</span> return env.waitInitialized(this);<a name="line.75"></a>
<span class="sourceLineNo">076</span> }<a name="line.76"></a>
<span class="sourceLineNo">077</span><a name="line.77"></a>
<span class="sourceLineNo">078</span> @Override<a name="line.78"></a>
<span class="sourceLineNo">079</span> protected LockState acquireLock(final MasterProcedureEnv env) {<a name="line.79"></a>
<span class="sourceLineNo">080</span> if (env.getProcedureScheduler().waitNamespaceExclusiveLock(this, getNamespaceName())) {<a name="line.80"></a>
<span class="sourceLineNo">081</span> return LockState.LOCK_EVENT_WAIT;<a name="line.81"></a>
<span class="sourceLineNo">082</span> }<a name="line.82"></a>
<span class="sourceLineNo">083</span> return LockState.LOCK_ACQUIRED;<a name="line.83"></a>
<span class="sourceLineNo">084</span> }<a name="line.84"></a>
<span class="sourceLineNo">085</span><a name="line.85"></a>
<span class="sourceLineNo">086</span> @Override<a name="line.86"></a>
<span class="sourceLineNo">087</span> protected void releaseLock(final MasterProcedureEnv env) {<a name="line.87"></a>
<span class="sourceLineNo">088</span> env.getProcedureScheduler().wakeNamespaceExclusiveLock(this, getNamespaceName());<a name="line.88"></a>
<span class="sourceLineNo">089</span> }<a name="line.89"></a>
<span class="sourceLineNo">090</span><a name="line.90"></a>
<span class="sourceLineNo">091</span> /**<a name="line.91"></a>
<span class="sourceLineNo">092</span> * Insert/update the row into the ns family of meta table.<a name="line.92"></a>
<span class="sourceLineNo">093</span> * @param env MasterProcedureEnv<a name="line.93"></a>
<span class="sourceLineNo">094</span> */<a name="line.94"></a>
<span class="sourceLineNo">095</span> protected static void addOrUpdateNamespace(MasterProcedureEnv env, NamespaceDescriptor ns)<a name="line.95"></a>
<span class="sourceLineNo">096</span> throws IOException {<a name="line.96"></a>
<span class="sourceLineNo">097</span> getTableNamespaceManager(env).addOrUpdateNamespace(ns);<a name="line.97"></a>
<span class="sourceLineNo">098</span> }<a name="line.98"></a>
<span class="sourceLineNo">099</span><a name="line.99"></a>
<span class="sourceLineNo">100</span> protected static TableNamespaceManager getTableNamespaceManager(MasterProcedureEnv env) {<a name="line.100"></a>
<span class="sourceLineNo">101</span> return env.getMasterServices().getClusterSchema().getTableNamespaceManager();<a name="line.101"></a>
<span class="sourceLineNo">102</span> }<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> * Create the namespace directory<a name="line.105"></a>
<span class="sourceLineNo">106</span> * @param env MasterProcedureEnv<a name="line.106"></a>
<span class="sourceLineNo">107</span> * @param nsDescriptor NamespaceDescriptor<a name="line.107"></a>
<span class="sourceLineNo">108</span> */<a name="line.108"></a>
<span class="sourceLineNo">109</span> protected static void createDirectory(MasterProcedureEnv env, NamespaceDescriptor nsDescriptor)<a name="line.109"></a>
<span class="sourceLineNo">110</span> throws IOException {<a name="line.110"></a>
<span class="sourceLineNo">111</span> createDirectory(env.getMasterServices().getMasterFileSystem(), nsDescriptor);<a name="line.111"></a>
<span class="sourceLineNo">112</span> }<a name="line.112"></a>
<span class="sourceLineNo">113</span><a name="line.113"></a>
<span class="sourceLineNo">114</span> public static void createDirectory(MasterFileSystem mfs, NamespaceDescriptor nsDescriptor)<a name="line.114"></a>
<span class="sourceLineNo">115</span> throws IOException {<a name="line.115"></a>
<span class="sourceLineNo">116</span> mfs.getFileSystem()<a name="line.116"></a>
<span class="sourceLineNo">117</span> .mkdirs(CommonFSUtils.getNamespaceDir(mfs.getRootDir(), nsDescriptor.getName()));<a name="line.117"></a>
<span class="sourceLineNo">118</span> }<a name="line.118"></a>
<span class="sourceLineNo">119</span><a name="line.119"></a>
<span class="sourceLineNo">120</span> protected void releaseSyncLatch() {<a name="line.120"></a>
<span class="sourceLineNo">121</span> ProcedurePrepareLatch.releaseLatch(syncLatch, this);<a name="line.121"></a>
<span class="sourceLineNo">122</span> }<a name="line.122"></a>
<span class="sourceLineNo">123</span><a name="line.123"></a>
<span class="sourceLineNo">124</span> protected final void checkNamespaceRSGroup(MasterProcedureEnv env, NamespaceDescriptor nd)<a name="line.124"></a>
<span class="sourceLineNo">125</span> throws IOException {<a name="line.125"></a>
<span class="sourceLineNo">126</span> Supplier&lt;String&gt; forWhom = () -&gt; "namespace " + nd.getName();<a name="line.126"></a>
<span class="sourceLineNo">127</span> RSGroupInfo rsGroupInfo = MasterProcedureUtil.checkGroupExists(<a name="line.127"></a>
<span class="sourceLineNo">128</span> env.getMasterServices().getRSGroupInfoManager()::getRSGroup,<a name="line.128"></a>
<span class="sourceLineNo">129</span> MasterProcedureUtil.getNamespaceGroup(nd), forWhom);<a name="line.129"></a>
<span class="sourceLineNo">130</span> MasterProcedureUtil.checkGroupNotEmpty(rsGroupInfo, forWhom);<a name="line.130"></a>
<span class="sourceLineNo">131</span> }<a name="line.131"></a>
<span class="sourceLineNo">132</span>}<a name="line.132"></a>
</pre>
</div>
</body>
</html>