| <!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, software<a name="line.12"></a> |
| <span class="sourceLineNo">013</span> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.13"></a> |
| <span class="sourceLineNo">014</span> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.14"></a> |
| <span class="sourceLineNo">015</span> * See the License for the specific language governing permissions and<a name="line.15"></a> |
| <span class="sourceLineNo">016</span> * limitations under the License.<a name="line.16"></a> |
| <span class="sourceLineNo">017</span> */<a name="line.17"></a> |
| <span class="sourceLineNo">018</span>package org.apache.hadoop.hbase.coprocessor;<a name="line.18"></a> |
| <span class="sourceLineNo">019</span><a name="line.19"></a> |
| <span class="sourceLineNo">020</span>import org.apache.hadoop.hbase.CoprocessorEnvironment;<a name="line.20"></a> |
| <span class="sourceLineNo">021</span>import org.apache.hadoop.hbase.HBaseInterfaceAudience;<a name="line.21"></a> |
| <span class="sourceLineNo">022</span>import org.apache.hadoop.hbase.security.User;<a name="line.22"></a> |
| <span class="sourceLineNo">023</span>import org.apache.yetus.audience.InterfaceAudience;<a name="line.23"></a> |
| <span class="sourceLineNo">024</span>import org.apache.yetus.audience.InterfaceStability;<a name="line.24"></a> |
| <span class="sourceLineNo">025</span><a name="line.25"></a> |
| <span class="sourceLineNo">026</span>import java.util.Optional;<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> * Carries the execution state for a given invocation of an Observer coprocessor<a name="line.29"></a> |
| <span class="sourceLineNo">030</span> * ({@link RegionObserver}, {@link MasterObserver}, or {@link WALObserver})<a name="line.30"></a> |
| <span class="sourceLineNo">031</span> * method. The same ObserverContext instance is passed sequentially to all loaded<a name="line.31"></a> |
| <span class="sourceLineNo">032</span> * coprocessors for a given Observer method trigger, with the<a name="line.32"></a> |
| <span class="sourceLineNo">033</span> * <code>CoprocessorEnvironment</code> reference set appropriately for each Coprocessor type:<a name="line.33"></a> |
| <span class="sourceLineNo">034</span> * e.g. the RegionCoprocessorEnvironment is passed to RegionCoprocessors, and so on.<a name="line.34"></a> |
| <span class="sourceLineNo">035</span> * @param <E> The {@link CoprocessorEnvironment} subclass applicable to the<a name="line.35"></a> |
| <span class="sourceLineNo">036</span> * revelant Observer interface.<a name="line.36"></a> |
| <span class="sourceLineNo">037</span> */<a name="line.37"></a> |
| <span class="sourceLineNo">038</span>@InterfaceAudience.LimitedPrivate(HBaseInterfaceAudience.COPROC)<a name="line.38"></a> |
| <span class="sourceLineNo">039</span>@InterfaceStability.Evolving<a name="line.39"></a> |
| <span class="sourceLineNo">040</span>public interface ObserverContext<E extends CoprocessorEnvironment> {<a name="line.40"></a> |
| <span class="sourceLineNo">041</span> E getEnvironment();<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> * Call to indicate that the current coprocessor's return value (or parameter -- depends on the<a name="line.44"></a> |
| <span class="sourceLineNo">045</span> * call-type) should be used in place of the value that would be obtained via normal processing;<a name="line.45"></a> |
| <span class="sourceLineNo">046</span> * i.e. bypass the core call and return the Coprocessor's result instead. DOES NOT work for all<a name="line.46"></a> |
| <span class="sourceLineNo">047</span> * Coprocessor invocations, only on a small subset of methods, mostly preXXX calls in<a name="line.47"></a> |
| <span class="sourceLineNo">048</span> * RegionObserver. Check javadoc on the pertinent Coprocessor Observer to see if<a name="line.48"></a> |
| <span class="sourceLineNo">049</span> * <code>bypass</code> is supported.<a name="line.49"></a> |
| <span class="sourceLineNo">050</span> * <p>This behavior of honoring only a subset of methods is new since hbase-2.0.0.<a name="line.50"></a> |
| <span class="sourceLineNo">051</span> * <p>Where bypass is supported what is being bypassed is all of the core code<a name="line.51"></a> |
| <span class="sourceLineNo">052</span> * implementing the remainder of the operation. In order to understand what<a name="line.52"></a> |
| <span class="sourceLineNo">053</span> * calling bypass() will skip, a coprocessor implementer should read and<a name="line.53"></a> |
| <span class="sourceLineNo">054</span> * understand all of the remaining code and its nuances. Although this<a name="line.54"></a> |
| <span class="sourceLineNo">055</span> * is good practice for coprocessor developers in general, it demands a lot.<a name="line.55"></a> |
| <span class="sourceLineNo">056</span> * What is skipped is extremely version dependent. The core code will vary, perhaps significantly,<a name="line.56"></a> |
| <span class="sourceLineNo">057</span> * even between point releases. We do not provide the promise of consistent behavior even between<a name="line.57"></a> |
| <span class="sourceLineNo">058</span> * point releases for the bypass semantic. To achieve<a name="line.58"></a> |
| <span class="sourceLineNo">059</span> * that we could not change any code between hook points. Therefore the<a name="line.59"></a> |
| <span class="sourceLineNo">060</span> * coprocessor implementer becomes an HBase core developer in practice as soon<a name="line.60"></a> |
| <span class="sourceLineNo">061</span> * as they rely on bypass(). Every release of HBase may break the assumption<a name="line.61"></a> |
| <span class="sourceLineNo">062</span> * that the replacement for the bypassed code takes care of all necessary<a name="line.62"></a> |
| <span class="sourceLineNo">063</span> * skipped concerns. Because those concerns can change at any point, such an<a name="line.63"></a> |
| <span class="sourceLineNo">064</span> * assumption is never safe.</p><a name="line.64"></a> |
| <span class="sourceLineNo">065</span> * <p>As of hbase2, when bypass has been set, we will NOT call any Coprocessors follow the<a name="line.65"></a> |
| <span class="sourceLineNo">066</span> * bypassing Coprocessor; we cut short the processing and return the bypassing Coprocessors<a name="line.66"></a> |
| <span class="sourceLineNo">067</span> * response (this used be a separate 'complete' option that has been folded into the<a name="line.67"></a> |
| <span class="sourceLineNo">068</span> * 'bypass' in hbase2.</p><a name="line.68"></a> |
| <span class="sourceLineNo">069</span> */<a name="line.69"></a> |
| <span class="sourceLineNo">070</span> void bypass();<a name="line.70"></a> |
| <span class="sourceLineNo">071</span><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> * Returns the active user for the coprocessor call. If an explicit {@code User} instance was<a name="line.74"></a> |
| <span class="sourceLineNo">075</span> * provided to the constructor, that will be returned, otherwise if we are in the context of an<a name="line.75"></a> |
| <span class="sourceLineNo">076</span> * RPC call, the remote user is used. May not be present if the execution is outside of an RPC<a name="line.76"></a> |
| <span class="sourceLineNo">077</span> * context.<a name="line.77"></a> |
| <span class="sourceLineNo">078</span> */<a name="line.78"></a> |
| <span class="sourceLineNo">079</span> Optional<User> getCaller();<a name="line.79"></a> |
| <span class="sourceLineNo">080</span>}<a name="line.80"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |
