| <!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,<a name="line.12"></a> |
| <span class="sourceLineNo">013</span> * software distributed under the License is distributed on an<a name="line.13"></a> |
| <span class="sourceLineNo">014</span> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY<a name="line.14"></a> |
| <span class="sourceLineNo">015</span> * KIND, either express or implied. See the License for the<a name="line.15"></a> |
| <span class="sourceLineNo">016</span> * specific language governing permissions and limitations<a name="line.16"></a> |
| <span class="sourceLineNo">017</span> * under the License.<a name="line.17"></a> |
| <span class="sourceLineNo">018</span> */<a name="line.18"></a> |
| <span class="sourceLineNo">019</span><a name="line.19"></a> |
| <span class="sourceLineNo">020</span>package org.apache.hadoop.hbase;<a name="line.20"></a> |
| <span class="sourceLineNo">021</span><a name="line.21"></a> |
| <span class="sourceLineNo">022</span>import java.io.IOException;<a name="line.22"></a> |
| <span class="sourceLineNo">023</span>import java.util.Collections;<a name="line.23"></a> |
| <span class="sourceLineNo">024</span>import org.apache.yetus.audience.InterfaceAudience;<a name="line.24"></a> |
| <span class="sourceLineNo">025</span>import org.apache.yetus.audience.InterfaceStability;<a name="line.25"></a> |
| <span class="sourceLineNo">026</span>import org.apache.hbase.thirdparty.com.google.protobuf.Service;<a name="line.26"></a> |
| <span class="sourceLineNo">027</span><a name="line.27"></a> |
| <span class="sourceLineNo">028</span>/**<a name="line.28"></a> |
| <span class="sourceLineNo">029</span> * Base interface for the 4 coprocessors - MasterCoprocessor, RegionCoprocessor,<a name="line.29"></a> |
| <span class="sourceLineNo">030</span> * RegionServerCoprocessor, and WALCoprocessor.<a name="line.30"></a> |
| <span class="sourceLineNo">031</span> * Do NOT implement this interface directly. Unless an implementation implements one (or more) of<a name="line.31"></a> |
| <span class="sourceLineNo">032</span> * the above mentioned 4 coprocessors, it'll fail to be loaded by any coprocessor host.<a name="line.32"></a> |
| <span class="sourceLineNo">033</span> *<a name="line.33"></a> |
| <span class="sourceLineNo">034</span> * Example:<a name="line.34"></a> |
| <span class="sourceLineNo">035</span> * Building a coprocessor to observe Master operations.<a name="line.35"></a> |
| <span class="sourceLineNo">036</span> * <pre><a name="line.36"></a> |
| <span class="sourceLineNo">037</span> * class MyMasterCoprocessor implements MasterCoprocessor {<a name="line.37"></a> |
| <span class="sourceLineNo">038</span> * &#64;Override<a name="line.38"></a> |
| <span class="sourceLineNo">039</span> * public Optional&lt;MasterObserver> getMasterObserver() {<a name="line.39"></a> |
| <span class="sourceLineNo">040</span> * return new MyMasterObserver();<a name="line.40"></a> |
| <span class="sourceLineNo">041</span> * }<a name="line.41"></a> |
| <span class="sourceLineNo">042</span> * }<a name="line.42"></a> |
| <span class="sourceLineNo">043</span> *<a name="line.43"></a> |
| <span class="sourceLineNo">044</span> * class MyMasterObserver implements MasterObserver {<a name="line.44"></a> |
| <span class="sourceLineNo">045</span> * ....<a name="line.45"></a> |
| <span class="sourceLineNo">046</span> * }<a name="line.46"></a> |
| <span class="sourceLineNo">047</span> * </pre><a name="line.47"></a> |
| <span class="sourceLineNo">048</span> *<a name="line.48"></a> |
| <span class="sourceLineNo">049</span> * Building a Service which can be loaded by both Master and RegionServer<a name="line.49"></a> |
| <span class="sourceLineNo">050</span> * <pre><a name="line.50"></a> |
| <span class="sourceLineNo">051</span> * class MyCoprocessorService implements MasterCoprocessor, RegionServerCoprocessor {<a name="line.51"></a> |
| <span class="sourceLineNo">052</span> * &#64;Override<a name="line.52"></a> |
| <span class="sourceLineNo">053</span> * public Optional&lt;Service> getServices() {<a name="line.53"></a> |
| <span class="sourceLineNo">054</span> * return new ...;<a name="line.54"></a> |
| <span class="sourceLineNo">055</span> * }<a name="line.55"></a> |
| <span class="sourceLineNo">056</span> * }<a name="line.56"></a> |
| <span class="sourceLineNo">057</span> * </pre><a name="line.57"></a> |
| <span class="sourceLineNo">058</span> */<a name="line.58"></a> |
| <span class="sourceLineNo">059</span>@InterfaceAudience.LimitedPrivate(HBaseInterfaceAudience.COPROC)<a name="line.59"></a> |
| <span class="sourceLineNo">060</span>@InterfaceStability.Evolving<a name="line.60"></a> |
| <span class="sourceLineNo">061</span>public interface Coprocessor {<a name="line.61"></a> |
| <span class="sourceLineNo">062</span> int VERSION = 1;<a name="line.62"></a> |
| <span class="sourceLineNo">063</span><a name="line.63"></a> |
| <span class="sourceLineNo">064</span> /** Highest installation priority */<a name="line.64"></a> |
| <span class="sourceLineNo">065</span> int PRIORITY_HIGHEST = 0;<a name="line.65"></a> |
| <span class="sourceLineNo">066</span> /** High (system) installation priority */<a name="line.66"></a> |
| <span class="sourceLineNo">067</span> int PRIORITY_SYSTEM = Integer.MAX_VALUE / 4;<a name="line.67"></a> |
| <span class="sourceLineNo">068</span> /** Default installation priority for user coprocessors */<a name="line.68"></a> |
| <span class="sourceLineNo">069</span> int PRIORITY_USER = Integer.MAX_VALUE / 2;<a name="line.69"></a> |
| <span class="sourceLineNo">070</span> /** Lowest installation priority */<a name="line.70"></a> |
| <span class="sourceLineNo">071</span> int PRIORITY_LOWEST = Integer.MAX_VALUE;<a name="line.71"></a> |
| <span class="sourceLineNo">072</span><a name="line.72"></a> |
| <span class="sourceLineNo">073</span> /**<a name="line.73"></a> |
| <span class="sourceLineNo">074</span> * Lifecycle state of a given coprocessor instance.<a name="line.74"></a> |
| <span class="sourceLineNo">075</span> */<a name="line.75"></a> |
| <span class="sourceLineNo">076</span> enum State {<a name="line.76"></a> |
| <span class="sourceLineNo">077</span> UNINSTALLED,<a name="line.77"></a> |
| <span class="sourceLineNo">078</span> INSTALLED,<a name="line.78"></a> |
| <span class="sourceLineNo">079</span> STARTING,<a name="line.79"></a> |
| <span class="sourceLineNo">080</span> ACTIVE,<a name="line.80"></a> |
| <span class="sourceLineNo">081</span> STOPPING,<a name="line.81"></a> |
| <span class="sourceLineNo">082</span> STOPPED<a name="line.82"></a> |
| <span class="sourceLineNo">083</span> }<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> * Called by the {@link CoprocessorEnvironment} during it's own startup to initialize the<a name="line.86"></a> |
| <span class="sourceLineNo">087</span> * coprocessor.<a name="line.87"></a> |
| <span class="sourceLineNo">088</span> */<a name="line.88"></a> |
| <span class="sourceLineNo">089</span> default void start(CoprocessorEnvironment env) throws IOException {}<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> * Called by the {@link CoprocessorEnvironment} during it's own shutdown to stop the<a name="line.92"></a> |
| <span class="sourceLineNo">093</span> * coprocessor.<a name="line.93"></a> |
| <span class="sourceLineNo">094</span> */<a name="line.94"></a> |
| <span class="sourceLineNo">095</span> default void stop(CoprocessorEnvironment env) throws IOException {}<a name="line.95"></a> |
| <span class="sourceLineNo">096</span><a name="line.96"></a> |
| <span class="sourceLineNo">097</span> /**<a name="line.97"></a> |
| <span class="sourceLineNo">098</span> * Coprocessor endpoints providing protobuf services should override this method.<a name="line.98"></a> |
| <span class="sourceLineNo">099</span> * @return Iterable of {@link Service}s or empty collection. Implementations should never<a name="line.99"></a> |
| <span class="sourceLineNo">100</span> * return null.<a name="line.100"></a> |
| <span class="sourceLineNo">101</span> */<a name="line.101"></a> |
| <span class="sourceLineNo">102</span> default Iterable<Service> getServices() {<a name="line.102"></a> |
| <span class="sourceLineNo">103</span> return Collections.EMPTY_SET;<a name="line.103"></a> |
| <span class="sourceLineNo">104</span> }<a name="line.104"></a> |
| <span class="sourceLineNo">105</span>}<a name="line.105"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |