| <!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: MasterProcedureManager"> |
| <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 org.apache.hadoop.hbase.Stoppable;</span> |
| <span class="source-line-no">022</span><span id="line-22">import org.apache.hadoop.hbase.master.MasterServices;</span> |
| <span class="source-line-no">023</span><span id="line-23">import org.apache.hadoop.hbase.master.MetricsMaster;</span> |
| <span class="source-line-no">024</span><span id="line-24">import org.apache.hadoop.hbase.security.User;</span> |
| <span class="source-line-no">025</span><span id="line-25">import org.apache.hadoop.hbase.security.access.AccessChecker;</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.zookeeper.KeeperException;</span> |
| <span class="source-line-no">028</span><span id="line-28"></span> |
| <span class="source-line-no">029</span><span id="line-29">import org.apache.hadoop.hbase.shaded.protobuf.generated.HBaseProtos.ProcedureDescription;</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 life-cycle management interface for globally barriered procedures on master. See the following</span> |
| <span class="source-line-no">033</span><span id="line-33"> * doc on details of globally barriered procedure:</span> |
| <span class="source-line-no">034</span><span id="line-34"> * https://issues.apache.org/jira/secure/attachment/12555103/121127-global-barrier-proc.pdf To</span> |
| <span class="source-line-no">035</span><span id="line-35"> * implement a custom globally barriered procedure, user needs to extend two classes:</span> |
| <span class="source-line-no">036</span><span id="line-36"> * {@link MasterProcedureManager} and {@link RegionServerProcedureManager}. Implementation of</span> |
| <span class="source-line-no">037</span><span id="line-37"> * {@link MasterProcedureManager} is loaded into {@link org.apache.hadoop.hbase.master.HMaster}</span> |
| <span class="source-line-no">038</span><span id="line-38"> * process via configuration parameter 'hbase.procedure.master.classes', while implementation of</span> |
| <span class="source-line-no">039</span><span id="line-39"> * {@link RegionServerProcedureManager} is loaded into</span> |
| <span class="source-line-no">040</span><span id="line-40"> * {@link org.apache.hadoop.hbase.regionserver.HRegionServer} process via configuration parameter</span> |
| <span class="source-line-no">041</span><span id="line-41"> * 'hbase.procedure.regionserver.classes'. An example of globally barriered procedure implementation</span> |
| <span class="source-line-no">042</span><span id="line-42"> * is {@link org.apache.hadoop.hbase.master.snapshot.SnapshotManager} and</span> |
| <span class="source-line-no">043</span><span id="line-43"> * {@link org.apache.hadoop.hbase.regionserver.snapshot.RegionServerSnapshotManager}. A globally</span> |
| <span class="source-line-no">044</span><span id="line-44"> * barriered procedure is identified by its signature (usually it is the name of the procedure</span> |
| <span class="source-line-no">045</span><span id="line-45"> * znode). During the initialization phase, the initialize methods are called by both</span> |
| <span class="source-line-no">046</span><span id="line-46"> * {@link org.apache.hadoop.hbase.master.HMaster} and</span> |
| <span class="source-line-no">047</span><span id="line-47"> * {@link org.apache.hadoop.hbase.regionserver.HRegionServer} which create the procedure znode and</span> |
| <span class="source-line-no">048</span><span id="line-48"> * register the listeners. A procedure can be triggered by its signature and an instant name</span> |
| <span class="source-line-no">049</span><span id="line-49"> * (encapsulated in a {@link ProcedureDescription} object). When the servers are shutdown, the stop</span> |
| <span class="source-line-no">050</span><span id="line-50"> * methods on both classes are called to clean up the data associated with the procedure.</span> |
| <span class="source-line-no">051</span><span id="line-51"> */</span> |
| <span class="source-line-no">052</span><span id="line-52">@InterfaceAudience.Private</span> |
| <span class="source-line-no">053</span><span id="line-53">public abstract class MasterProcedureManager extends ProcedureManager implements Stoppable {</span> |
| <span class="source-line-no">054</span><span id="line-54"> /**</span> |
| <span class="source-line-no">055</span><span id="line-55"> * Initialize a globally barriered procedure for master.</span> |
| <span class="source-line-no">056</span><span id="line-56"> * @param master Master service interface</span> |
| <span class="source-line-no">057</span><span id="line-57"> */</span> |
| <span class="source-line-no">058</span><span id="line-58"> public abstract void initialize(MasterServices master, MetricsMaster metricsMaster)</span> |
| <span class="source-line-no">059</span><span id="line-59"> throws KeeperException, IOException, UnsupportedOperationException;</span> |
| <span class="source-line-no">060</span><span id="line-60"></span> |
| <span class="source-line-no">061</span><span id="line-61"> /**</span> |
| <span class="source-line-no">062</span><span id="line-62"> * Execute a distributed procedure on cluster</span> |
| <span class="source-line-no">063</span><span id="line-63"> * @param desc Procedure description</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 void execProcedure(ProcedureDescription desc) throws IOException {</span> |
| <span class="source-line-no">066</span><span id="line-66"> }</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"> * Execute a distributed procedure on cluster with return data.</span> |
| <span class="source-line-no">070</span><span id="line-70"> * @param desc Procedure description</span> |
| <span class="source-line-no">071</span><span id="line-71"> * @return data returned from the procedure execution, null if no data</span> |
| <span class="source-line-no">072</span><span id="line-72"> */</span> |
| <span class="source-line-no">073</span><span id="line-73"> public byte[] execProcedureWithRet(ProcedureDescription desc) throws IOException {</span> |
| <span class="source-line-no">074</span><span id="line-74"> return null;</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"> /**</span> |
| <span class="source-line-no">078</span><span id="line-78"> * Check for required permissions before executing the procedure.</span> |
| <span class="source-line-no">079</span><span id="line-79"> * @throws IOException if permissions requirements are not met.</span> |
| <span class="source-line-no">080</span><span id="line-80"> */</span> |
| <span class="source-line-no">081</span><span id="line-81"> public abstract void checkPermissions(ProcedureDescription desc, AccessChecker accessChecker,</span> |
| <span class="source-line-no">082</span><span id="line-82"> User user) throws IOException;</span> |
| <span class="source-line-no">083</span><span id="line-83"></span> |
| <span class="source-line-no">084</span><span id="line-84"> /**</span> |
| <span class="source-line-no">085</span><span id="line-85"> * Check if the procedure is finished successfully</span> |
| <span class="source-line-no">086</span><span id="line-86"> * @param desc Procedure description</span> |
| <span class="source-line-no">087</span><span id="line-87"> * @return true if the specified procedure is finished successfully</span> |
| <span class="source-line-no">088</span><span id="line-88"> */</span> |
| <span class="source-line-no">089</span><span id="line-89"> public abstract boolean isProcedureDone(ProcedureDescription desc) throws IOException;</span> |
| <span class="source-line-no">090</span><span id="line-90">}</span> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </main> |
| </body> |
| </html> |
