blob: 152dc2e55f1c6d0d28c088332fb4db9a647df002 [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.procedure, class: ProcedureManagerHost">
<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.procedure;</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.ArrayList;</span>
<span class="source-line-no">022</span><span id="line-22">import java.util.HashSet;</span>
<span class="source-line-no">023</span><span id="line-23">import java.util.List;</span>
<span class="source-line-no">024</span><span id="line-24">import java.util.Set;</span>
<span class="source-line-no">025</span><span id="line-25">import org.apache.hadoop.conf.Configuration;</span>
<span class="source-line-no">026</span><span id="line-26">import org.apache.yetus.audience.InterfaceAudience;</span>
<span class="source-line-no">027</span><span id="line-27">import org.apache.yetus.audience.InterfaceStability;</span>
<span class="source-line-no">028</span><span id="line-28">import org.slf4j.Logger;</span>
<span class="source-line-no">029</span><span id="line-29">import org.slf4j.LoggerFactory;</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"> * Provides the common setup framework and runtime services for globally barriered procedure</span>
<span class="source-line-no">033</span><span id="line-33"> * invocation from HBase services.</span>
<span class="source-line-no">034</span><span id="line-34"> * @param &lt;E&gt; the specific procedure management extension that a concrete implementation provides</span>
<span class="source-line-no">035</span><span id="line-35"> */</span>
<span class="source-line-no">036</span><span id="line-36">@InterfaceAudience.Private</span>
<span class="source-line-no">037</span><span id="line-37">@InterfaceStability.Evolving</span>
<span class="source-line-no">038</span><span id="line-38">public abstract class ProcedureManagerHost&lt;E extends ProcedureManager&gt; {</span>
<span class="source-line-no">039</span><span id="line-39"></span>
<span class="source-line-no">040</span><span id="line-40"> public static final String REGIONSERVER_PROCEDURE_CONF_KEY =</span>
<span class="source-line-no">041</span><span id="line-41"> "hbase.procedure.regionserver.classes";</span>
<span class="source-line-no">042</span><span id="line-42"> public static final String MASTER_PROCEDURE_CONF_KEY = "hbase.procedure.master.classes";</span>
<span class="source-line-no">043</span><span id="line-43"></span>
<span class="source-line-no">044</span><span id="line-44"> private static final Logger LOG = LoggerFactory.getLogger(ProcedureManagerHost.class);</span>
<span class="source-line-no">045</span><span id="line-45"></span>
<span class="source-line-no">046</span><span id="line-46"> protected Set&lt;E&gt; procedures = new HashSet&lt;&gt;();</span>
<span class="source-line-no">047</span><span id="line-47"></span>
<span class="source-line-no">048</span><span id="line-48"> /**</span>
<span class="source-line-no">049</span><span id="line-49"> * Load system procedures. Read the class names from configuration. Called by constructor.</span>
<span class="source-line-no">050</span><span id="line-50"> */</span>
<span class="source-line-no">051</span><span id="line-51"> protected void loadUserProcedures(Configuration conf, String confKey) {</span>
<span class="source-line-no">052</span><span id="line-52"> Class&lt;?&gt; implClass = null;</span>
<span class="source-line-no">053</span><span id="line-53"></span>
<span class="source-line-no">054</span><span id="line-54"> // load default procedures from configure file</span>
<span class="source-line-no">055</span><span id="line-55"> String[] defaultProcClasses = conf.getStrings(confKey);</span>
<span class="source-line-no">056</span><span id="line-56"> if (defaultProcClasses == null || defaultProcClasses.length == 0) return;</span>
<span class="source-line-no">057</span><span id="line-57"></span>
<span class="source-line-no">058</span><span id="line-58"> List&lt;E&gt; configured = new ArrayList&lt;&gt;();</span>
<span class="source-line-no">059</span><span id="line-59"> for (String className : defaultProcClasses) {</span>
<span class="source-line-no">060</span><span id="line-60"> className = className.trim();</span>
<span class="source-line-no">061</span><span id="line-61"> ClassLoader cl = this.getClass().getClassLoader();</span>
<span class="source-line-no">062</span><span id="line-62"> Thread.currentThread().setContextClassLoader(cl);</span>
<span class="source-line-no">063</span><span id="line-63"> try {</span>
<span class="source-line-no">064</span><span id="line-64"> implClass = cl.loadClass(className);</span>
<span class="source-line-no">065</span><span id="line-65"> configured.add(loadInstance(implClass));</span>
<span class="source-line-no">066</span><span id="line-66"> LOG.info("User procedure " + className + " was loaded successfully.");</span>
<span class="source-line-no">067</span><span id="line-67"> } catch (ClassNotFoundException e) {</span>
<span class="source-line-no">068</span><span id="line-68"> LOG.warn("Class " + className + " cannot be found. " + e.getMessage());</span>
<span class="source-line-no">069</span><span id="line-69"> } catch (IOException e) {</span>
<span class="source-line-no">070</span><span id="line-70"> LOG.warn("Load procedure " + className + " failed. " + e.getMessage());</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"></span>
<span class="source-line-no">074</span><span id="line-74"> // add entire set to the collection</span>
<span class="source-line-no">075</span><span id="line-75"> procedures.addAll(configured);</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"> @SuppressWarnings("unchecked")</span>
<span class="source-line-no">079</span><span id="line-79"> public E loadInstance(Class&lt;?&gt; implClass) throws IOException {</span>
<span class="source-line-no">080</span><span id="line-80"> // create the instance</span>
<span class="source-line-no">081</span><span id="line-81"> E impl;</span>
<span class="source-line-no">082</span><span id="line-82"> Object o = null;</span>
<span class="source-line-no">083</span><span id="line-83"> try {</span>
<span class="source-line-no">084</span><span id="line-84"> o = implClass.getDeclaredConstructor().newInstance();</span>
<span class="source-line-no">085</span><span id="line-85"> impl = (E) o;</span>
<span class="source-line-no">086</span><span id="line-86"> } catch (Exception e) {</span>
<span class="source-line-no">087</span><span id="line-87"> throw new IOException(e);</span>
<span class="source-line-no">088</span><span id="line-88"> }</span>
<span class="source-line-no">089</span><span id="line-89"></span>
<span class="source-line-no">090</span><span id="line-90"> return impl;</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"> // Register a procedure manager object</span>
<span class="source-line-no">094</span><span id="line-94"> public void register(E obj) {</span>
<span class="source-line-no">095</span><span id="line-95"> procedures.add(obj);</span>
<span class="source-line-no">096</span><span id="line-96"> }</span>
<span class="source-line-no">097</span><span id="line-97"></span>
<span class="source-line-no">098</span><span id="line-98"> public Set&lt;E&gt; getProcedureManagers() {</span>
<span class="source-line-no">099</span><span id="line-99"> return new HashSet&lt;&gt;(procedures);</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"> public abstract void loadProcedures(Configuration conf);</span>
<span class="source-line-no">103</span><span id="line-103">}</span>
</pre>
</div>
</main>
</body>
</html>