blob: c7e91f3268e72efac63a441942576923ab657ec2 [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.procedure, interface: ServerProcedureInterface">
<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.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 org.apache.hadoop.hbase.ServerName;</span>
<span class="source-line-no">021</span><span id="line-21">import org.apache.hadoop.hbase.quotas.QuotaCache;</span>
<span class="source-line-no">022</span><span id="line-22">import org.apache.yetus.audience.InterfaceAudience;</span>
<span class="source-line-no">023</span><span id="line-23"></span>
<span class="source-line-no">024</span><span id="line-24">/**</span>
<span class="source-line-no">025</span><span id="line-25"> * Procedures that handle servers -- e.g. server crash -- must implement this Interface. It is used</span>
<span class="source-line-no">026</span><span id="line-26"> * by the procedure runner to figure locking and what queuing.</span>
<span class="source-line-no">027</span><span id="line-27"> */</span>
<span class="source-line-no">028</span><span id="line-28">@InterfaceAudience.Private</span>
<span class="source-line-no">029</span><span id="line-29">public interface ServerProcedureInterface {</span>
<span class="source-line-no">030</span><span id="line-30"> public enum ServerOperationType {</span>
<span class="source-line-no">031</span><span id="line-31"> CRASH_HANDLER,</span>
<span class="source-line-no">032</span><span id="line-32"> SWITCH_RPC_THROTTLE,</span>
<span class="source-line-no">033</span><span id="line-33"></span>
<span class="source-line-no">034</span><span id="line-34"> /**</span>
<span class="source-line-no">035</span><span id="line-35"> * help find a available region server as worker and release worker after task done invoke</span>
<span class="source-line-no">036</span><span id="line-36"> * SPLIT_WAL_REMOTE operation to send real WAL splitting request to worker manage the split wal</span>
<span class="source-line-no">037</span><span id="line-37"> * task flow, will retry if SPLIT_WAL_REMOTE failed</span>
<span class="source-line-no">038</span><span id="line-38"> */</span>
<span class="source-line-no">039</span><span id="line-39"> SPLIT_WAL,</span>
<span class="source-line-no">040</span><span id="line-40"></span>
<span class="source-line-no">041</span><span id="line-41"> /**</span>
<span class="source-line-no">042</span><span id="line-42"> * send the split WAL request to region server and handle the response</span>
<span class="source-line-no">043</span><span id="line-43"> */</span>
<span class="source-line-no">044</span><span id="line-44"> SPLIT_WAL_REMOTE,</span>
<span class="source-line-no">045</span><span id="line-45"></span>
<span class="source-line-no">046</span><span id="line-46"> /**</span>
<span class="source-line-no">047</span><span id="line-47"> * Get all the replication queues of a crash server and assign them to other region servers</span>
<span class="source-line-no">048</span><span id="line-48"> */</span>
<span class="source-line-no">049</span><span id="line-49"> CLAIM_REPLICATION_QUEUES,</span>
<span class="source-line-no">050</span><span id="line-50"></span>
<span class="source-line-no">051</span><span id="line-51"> /**</span>
<span class="source-line-no">052</span><span id="line-52"> * send the claim replication queue request to region server to actually assign it</span>
<span class="source-line-no">053</span><span id="line-53"> */</span>
<span class="source-line-no">054</span><span id="line-54"> CLAIM_REPLICATION_QUEUE_REMOTE,</span>
<span class="source-line-no">055</span><span id="line-55"></span>
<span class="source-line-no">056</span><span id="line-56"> /**</span>
<span class="source-line-no">057</span><span id="line-57"> * send verify snapshot request to region server and handle the response</span>
<span class="source-line-no">058</span><span id="line-58"> */</span>
<span class="source-line-no">059</span><span id="line-59"> VERIFY_SNAPSHOT,</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"> * Re-read the hbase:quotas table and update {@link QuotaCache}.</span>
<span class="source-line-no">063</span><span id="line-63"> */</span>
<span class="source-line-no">064</span><span id="line-64"> RELOAD_QUOTAS,</span>
<span class="source-line-no">065</span><span id="line-65"></span>
<span class="source-line-no">066</span><span id="line-66"> /**</span>
<span class="source-line-no">067</span><span id="line-67"> * send roll log request to region server and handle the response</span>
<span class="source-line-no">068</span><span id="line-68"> */</span>
<span class="source-line-no">069</span><span id="line-69"> LOG_ROLL</span>
<span class="source-line-no">070</span><span id="line-70"> }</span>
<span class="source-line-no">071</span><span id="line-71"></span>
<span class="source-line-no">072</span><span id="line-72"> /** Returns Name of this server instance. */</span>
<span class="source-line-no">073</span><span id="line-73"> ServerName getServerName();</span>
<span class="source-line-no">074</span><span id="line-74"></span>
<span class="source-line-no">075</span><span id="line-75"> /** Returns True if this server has an hbase:meta table region. */</span>
<span class="source-line-no">076</span><span id="line-76"> boolean hasMetaTableRegion();</span>
<span class="source-line-no">077</span><span id="line-77"></span>
<span class="source-line-no">078</span><span id="line-78"> /**</span>
<span class="source-line-no">079</span><span id="line-79"> * Given an operation type we can take decisions about what to do with pending operations. e.g. if</span>
<span class="source-line-no">080</span><span id="line-80"> * we get a crash handler and we have some assignment operation pending we can abort those</span>
<span class="source-line-no">081</span><span id="line-81"> * operations.</span>
<span class="source-line-no">082</span><span id="line-82"> * @return the operation type that the procedure is executing.</span>
<span class="source-line-no">083</span><span id="line-83"> */</span>
<span class="source-line-no">084</span><span id="line-84"> ServerOperationType getServerOperationType();</span>
<span class="source-line-no">085</span><span id="line-85">}</span>
</pre>
</div>
</main>
</body>
</html>