| <!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, interface: Coprocessor, enum: State"> |
| <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;</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.Collections;</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">import org.apache.yetus.audience.InterfaceStability;</span> |
| <span class="source-line-no">024</span><span id="line-24"></span> |
| <span class="source-line-no">025</span><span id="line-25">import org.apache.hbase.thirdparty.com.google.protobuf.Service;</span> |
| <span class="source-line-no">026</span><span id="line-26"></span> |
| <span class="source-line-no">027</span><span id="line-27">/**</span> |
| <span class="source-line-no">028</span><span id="line-28"> * Base interface for the 4 coprocessors - MasterCoprocessor, RegionCoprocessor,</span> |
| <span class="source-line-no">029</span><span id="line-29"> * RegionServerCoprocessor, and WALCoprocessor. Do NOT implement this interface directly. Unless an</span> |
| <span class="source-line-no">030</span><span id="line-30"> * implementation implements one (or more) of the above mentioned 4 coprocessors, it'll fail to be</span> |
| <span class="source-line-no">031</span><span id="line-31"> * loaded by any coprocessor host. Example: Building a coprocessor to observe Master operations.</span> |
| <span class="source-line-no">032</span><span id="line-32"> *</span> |
| <span class="source-line-no">033</span><span id="line-33"> * <pre></span> |
| <span class="source-line-no">034</span><span id="line-34"> * class MyMasterCoprocessor implements MasterCoprocessor {</span> |
| <span class="source-line-no">035</span><span id="line-35"> * &#64;Override</span> |
| <span class="source-line-no">036</span><span id="line-36"> * public Optional&lt;MasterObserver> getMasterObserver() {</span> |
| <span class="source-line-no">037</span><span id="line-37"> * return new MyMasterObserver();</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"> *</span> |
| <span class="source-line-no">041</span><span id="line-41"> * class MyMasterObserver implements MasterObserver {</span> |
| <span class="source-line-no">042</span><span id="line-42"> * ....</span> |
| <span class="source-line-no">043</span><span id="line-43"> * }</span> |
| <span class="source-line-no">044</span><span id="line-44"> * </pre></span> |
| <span class="source-line-no">045</span><span id="line-45"> *</span> |
| <span class="source-line-no">046</span><span id="line-46"> * Building a Service which can be loaded by both Master and RegionServer</span> |
| <span class="source-line-no">047</span><span id="line-47"> *</span> |
| <span class="source-line-no">048</span><span id="line-48"> * <pre></span> |
| <span class="source-line-no">049</span><span id="line-49"> * class MyCoprocessorService implements MasterCoprocessor, RegionServerCoprocessor {</span> |
| <span class="source-line-no">050</span><span id="line-50"> * &#64;Override</span> |
| <span class="source-line-no">051</span><span id="line-51"> * public Optional&lt;Service> getServices() {</span> |
| <span class="source-line-no">052</span><span id="line-52"> * return new ...;</span> |
| <span class="source-line-no">053</span><span id="line-53"> * }</span> |
| <span class="source-line-no">054</span><span id="line-54"> * }</span> |
| <span class="source-line-no">055</span><span id="line-55"> * </pre></span> |
| <span class="source-line-no">056</span><span id="line-56"> */</span> |
| <span class="source-line-no">057</span><span id="line-57">@InterfaceAudience.LimitedPrivate(HBaseInterfaceAudience.COPROC)</span> |
| <span class="source-line-no">058</span><span id="line-58">@InterfaceStability.Evolving</span> |
| <span class="source-line-no">059</span><span id="line-59">public interface Coprocessor {</span> |
| <span class="source-line-no">060</span><span id="line-60"> int VERSION = 1;</span> |
| <span class="source-line-no">061</span><span id="line-61"></span> |
| <span class="source-line-no">062</span><span id="line-62"> /** Highest installation priority */</span> |
| <span class="source-line-no">063</span><span id="line-63"> int PRIORITY_HIGHEST = 0;</span> |
| <span class="source-line-no">064</span><span id="line-64"> /** High (system) installation priority */</span> |
| <span class="source-line-no">065</span><span id="line-65"> int PRIORITY_SYSTEM = Integer.MAX_VALUE / 4;</span> |
| <span class="source-line-no">066</span><span id="line-66"> /** Default installation priority for user coprocessors */</span> |
| <span class="source-line-no">067</span><span id="line-67"> int PRIORITY_USER = Integer.MAX_VALUE / 2;</span> |
| <span class="source-line-no">068</span><span id="line-68"> /** Lowest installation priority */</span> |
| <span class="source-line-no">069</span><span id="line-69"> int PRIORITY_LOWEST = Integer.MAX_VALUE;</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"> * Lifecycle state of a given coprocessor instance.</span> |
| <span class="source-line-no">073</span><span id="line-73"> */</span> |
| <span class="source-line-no">074</span><span id="line-74"> enum State {</span> |
| <span class="source-line-no">075</span><span id="line-75"> UNINSTALLED,</span> |
| <span class="source-line-no">076</span><span id="line-76"> INSTALLED,</span> |
| <span class="source-line-no">077</span><span id="line-77"> STARTING,</span> |
| <span class="source-line-no">078</span><span id="line-78"> ACTIVE,</span> |
| <span class="source-line-no">079</span><span id="line-79"> STOPPING,</span> |
| <span class="source-line-no">080</span><span id="line-80"> STOPPED</span> |
| <span class="source-line-no">081</span><span id="line-81"> }</span> |
| <span class="source-line-no">082</span><span id="line-82"></span> |
| <span class="source-line-no">083</span><span id="line-83"> /**</span> |
| <span class="source-line-no">084</span><span id="line-84"> * Called by the {@link CoprocessorEnvironment} during it's own startup to initialize the</span> |
| <span class="source-line-no">085</span><span id="line-85"> * coprocessor.</span> |
| <span class="source-line-no">086</span><span id="line-86"> */</span> |
| <span class="source-line-no">087</span><span id="line-87"> default void start(CoprocessorEnvironment env) throws IOException {</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"> /**</span> |
| <span class="source-line-no">091</span><span id="line-91"> * Called by the {@link CoprocessorEnvironment} during it's own shutdown to stop the coprocessor.</span> |
| <span class="source-line-no">092</span><span id="line-92"> */</span> |
| <span class="source-line-no">093</span><span id="line-93"> default void stop(CoprocessorEnvironment env) throws IOException {</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"> /**</span> |
| <span class="source-line-no">097</span><span id="line-97"> * Coprocessor endpoints providing protobuf services should override this method.</span> |
| <span class="source-line-no">098</span><span id="line-98"> * @return Iterable of {@link Service}s or empty collection. Implementations should never return</span> |
| <span class="source-line-no">099</span><span id="line-99"> * null.</span> |
| <span class="source-line-no">100</span><span id="line-100"> */</span> |
| <span class="source-line-no">101</span><span id="line-101"> default Iterable<Service> getServices() {</span> |
| <span class="source-line-no">102</span><span id="line-102"> return Collections.EMPTY_SET;</span> |
| <span class="source-line-no">103</span><span id="line-103"> }</span> |
| <span class="source-line-no">104</span><span id="line-104">}</span> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </main> |
| </body> |
| </html> |
