http://git-wip-us.apache.org/repos/asf/hbase-site/blob/b838bdf0/devapidocs/src-html/org/apache/hadoop/hbase/coprocessor/ObserverContext.html ---------------------------------------------------------------------- diff --git a/devapidocs/src-html/org/apache/hadoop/hbase/coprocessor/ObserverContext.html b/devapidocs/src-html/org/apache/hadoop/hbase/coprocessor/ObserverContext.html index 1cbe7a9..11d5f8b 100644 --- a/devapidocs/src-html/org/apache/hadoop/hbase/coprocessor/ObserverContext.html +++ b/devapidocs/src-html/org/apache/hadoop/hbase/coprocessor/ObserverContext.html @@ -7,33 +7,33 @@ <body> <div class="sourceContainer"> <pre><span class="sourceLineNo">001</span>/*<a name="line.1"></a> -<span class="sourceLineNo">002</span> *<a name="line.2"></a> -<span class="sourceLineNo">003</span> * Licensed to the Apache Software Foundation (ASF) under one<a name="line.3"></a> -<span class="sourceLineNo">004</span> * or more contributor license agreements. See the NOTICE file<a name="line.4"></a> -<span class="sourceLineNo">005</span> * distributed with this work for additional information<a name="line.5"></a> -<span class="sourceLineNo">006</span> * regarding copyright ownership. The ASF licenses this file<a name="line.6"></a> -<span class="sourceLineNo">007</span> * to you under the Apache License, Version 2.0 (the<a name="line.7"></a> -<span class="sourceLineNo">008</span> * "License"); you may not use this file except in compliance<a name="line.8"></a> -<span class="sourceLineNo">009</span> * with the License. You may obtain a copy of the License at<a name="line.9"></a> -<span class="sourceLineNo">010</span> *<a name="line.10"></a> -<span class="sourceLineNo">011</span> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.11"></a> -<span class="sourceLineNo">012</span> *<a name="line.12"></a> -<span class="sourceLineNo">013</span> * Unless required by applicable law or agreed to in writing, software<a name="line.13"></a> -<span class="sourceLineNo">014</span> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.14"></a> -<span class="sourceLineNo">015</span> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.15"></a> -<span class="sourceLineNo">016</span> * See the License for the specific language governing permissions and<a name="line.16"></a> -<span class="sourceLineNo">017</span> * limitations under the License.<a name="line.17"></a> -<span class="sourceLineNo">018</span> */<a name="line.18"></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>package org.apache.hadoop.hbase.coprocessor;<a name="line.20"></a> +<span class="sourceLineNo">020</span>import java.util.Optional;<a name="line.20"></a> <span class="sourceLineNo">021</span><a name="line.21"></a> -<span class="sourceLineNo">022</span>import edu.umd.cs.findbugs.annotations.Nullable;<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>import org.apache.hadoop.hbase.CoprocessorEnvironment;<a name="line.25"></a> -<span class="sourceLineNo">026</span>import org.apache.hadoop.hbase.HBaseInterfaceAudience;<a name="line.26"></a> -<span class="sourceLineNo">027</span>import org.apache.hadoop.hbase.ipc.RpcServer;<a name="line.27"></a> -<span class="sourceLineNo">028</span>import org.apache.hadoop.hbase.security.User;<a name="line.28"></a> +<span class="sourceLineNo">022</span>import com.google.common.annotations.VisibleForTesting;<a name="line.22"></a> +<span class="sourceLineNo">023</span>import org.apache.hadoop.hbase.CoprocessorEnvironment;<a name="line.23"></a> +<span class="sourceLineNo">024</span>import org.apache.hadoop.hbase.HBaseInterfaceAudience;<a name="line.24"></a> +<span class="sourceLineNo">025</span>import org.apache.hadoop.hbase.ipc.RpcServer;<a name="line.25"></a> +<span class="sourceLineNo">026</span>import org.apache.hadoop.hbase.security.User;<a name="line.26"></a> +<span class="sourceLineNo">027</span>import org.apache.yetus.audience.InterfaceAudience;<a name="line.27"></a> +<span class="sourceLineNo">028</span>import org.apache.yetus.audience.InterfaceStability;<a name="line.28"></a> <span class="sourceLineNo">029</span><a name="line.29"></a> <span class="sourceLineNo">030</span>/**<a name="line.30"></a> <span class="sourceLineNo">031</span> * Carries the execution state for a given invocation of an Observer coprocessor<a name="line.31"></a> @@ -51,115 +51,89 @@ <span class="sourceLineNo">043</span> private E env;<a name="line.43"></a> <span class="sourceLineNo">044</span> private boolean bypass;<a name="line.44"></a> <span class="sourceLineNo">045</span> private boolean complete;<a name="line.45"></a> -<span class="sourceLineNo">046</span> private User caller;<a name="line.46"></a> +<span class="sourceLineNo">046</span> private final User caller;<a name="line.46"></a> <span class="sourceLineNo">047</span><a name="line.47"></a> -<span class="sourceLineNo">048</span> public ObserverContext(User caller) {<a name="line.48"></a> -<span class="sourceLineNo">049</span> this.caller = caller;<a name="line.49"></a> -<span class="sourceLineNo">050</span> }<a name="line.50"></a> -<span class="sourceLineNo">051</span><a name="line.51"></a> -<span class="sourceLineNo">052</span> public E getEnvironment() {<a name="line.52"></a> -<span class="sourceLineNo">053</span> return env;<a name="line.53"></a> -<span class="sourceLineNo">054</span> }<a name="line.54"></a> -<span class="sourceLineNo">055</span><a name="line.55"></a> -<span class="sourceLineNo">056</span> public void prepare(E env) {<a name="line.56"></a> -<span class="sourceLineNo">057</span> this.env = env;<a name="line.57"></a> -<span class="sourceLineNo">058</span> }<a name="line.58"></a> -<span class="sourceLineNo">059</span><a name="line.59"></a> -<span class="sourceLineNo">060</span> /**<a name="line.60"></a> -<span class="sourceLineNo">061</span> * Call to indicate that the current coprocessor's return value should be<a name="line.61"></a> -<span class="sourceLineNo">062</span> * used in place of the normal HBase obtained value.<a name="line.62"></a> -<span class="sourceLineNo">063</span> */<a name="line.63"></a> -<span class="sourceLineNo">064</span> public void bypass() {<a name="line.64"></a> -<span class="sourceLineNo">065</span> bypass = true;<a name="line.65"></a> -<span class="sourceLineNo">066</span> }<a name="line.66"></a> -<span class="sourceLineNo">067</span><a name="line.67"></a> -<span class="sourceLineNo">068</span> /**<a name="line.68"></a> -<span class="sourceLineNo">069</span> * Call to indicate that additional coprocessors further down the execution<a name="line.69"></a> -<span class="sourceLineNo">070</span> * chain do not need to be invoked. Implies that this coprocessor's response<a name="line.70"></a> -<span class="sourceLineNo">071</span> * is definitive.<a name="line.71"></a> -<span class="sourceLineNo">072</span> */<a name="line.72"></a> -<span class="sourceLineNo">073</span> public void complete() {<a name="line.73"></a> -<span class="sourceLineNo">074</span> complete = true;<a name="line.74"></a> -<span class="sourceLineNo">075</span> }<a name="line.75"></a> -<span class="sourceLineNo">076</span><a name="line.76"></a> -<span class="sourceLineNo">077</span> /**<a name="line.77"></a> -<span class="sourceLineNo">078</span> * For use by the coprocessor framework.<a name="line.78"></a> -<span class="sourceLineNo">079</span> * @return <code>true</code> if {@link ObserverContext#bypass()}<a name="line.79"></a> -<span class="sourceLineNo">080</span> * was called by one of the loaded coprocessors, <code>false</code> otherwise.<a name="line.80"></a> -<span class="sourceLineNo">081</span> */<a name="line.81"></a> -<span class="sourceLineNo">082</span> public boolean shouldBypass() {<a name="line.82"></a> -<span class="sourceLineNo">083</span> boolean current = bypass;<a name="line.83"></a> -<span class="sourceLineNo">084</span> bypass = false;<a name="line.84"></a> -<span class="sourceLineNo">085</span> return current;<a name="line.85"></a> -<span class="sourceLineNo">086</span> }<a name="line.86"></a> -<span class="sourceLineNo">087</span><a name="line.87"></a> -<span class="sourceLineNo">088</span> /**<a name="line.88"></a> -<span class="sourceLineNo">089</span> * For use by the coprocessor framework.<a name="line.89"></a> -<span class="sourceLineNo">090</span> * @return <code>true</code> if {@link ObserverContext#complete()}<a name="line.90"></a> -<span class="sourceLineNo">091</span> * was called by one of the loaded coprocessors, <code>false</code> otherwise.<a name="line.91"></a> -<span class="sourceLineNo">092</span> */<a name="line.92"></a> -<span class="sourceLineNo">093</span> public boolean shouldComplete() {<a name="line.93"></a> -<span class="sourceLineNo">094</span> boolean current = complete;<a name="line.94"></a> -<span class="sourceLineNo">095</span> complete = false;<a name="line.95"></a> -<span class="sourceLineNo">096</span> return current;<a name="line.96"></a> -<span class="sourceLineNo">097</span> }<a name="line.97"></a> -<span class="sourceLineNo">098</span><a name="line.98"></a> -<span class="sourceLineNo">099</span> /**<a name="line.99"></a> -<span class="sourceLineNo">100</span> * Returns the active user for the coprocessor call.<a name="line.100"></a> -<span class="sourceLineNo">101</span> * If an explicit {@code User} instance was provided to the constructor, that will be returned,<a name="line.101"></a> -<span class="sourceLineNo">102</span> * otherwise if we are in the context of an RPC call, the remote user is used. May return null<a name="line.102"></a> -<span class="sourceLineNo">103</span> * if the execution is outside of an RPC context.<a name="line.103"></a> -<span class="sourceLineNo">104</span> */<a name="line.104"></a> -<span class="sourceLineNo">105</span> @Nullable<a name="line.105"></a> -<span class="sourceLineNo">106</span> public User getCaller() {<a name="line.106"></a> -<span class="sourceLineNo">107</span> return caller;<a name="line.107"></a> -<span class="sourceLineNo">108</span> }<a name="line.108"></a> -<span class="sourceLineNo">109</span><a name="line.109"></a> -<span class="sourceLineNo">110</span> /**<a name="line.110"></a> -<span class="sourceLineNo">111</span> * Instantiates a new ObserverContext instance if the passed reference is<a name="line.111"></a> -<span class="sourceLineNo">112</span> * <code>null</code> and sets the environment in the new or existing instance.<a name="line.112"></a> -<span class="sourceLineNo">113</span> * This allows deferring the instantiation of a ObserverContext until it is<a name="line.113"></a> -<span class="sourceLineNo">114</span> * actually needed.<a name="line.114"></a> -<span class="sourceLineNo">115</span> *<a name="line.115"></a> +<span class="sourceLineNo">048</span> @InterfaceAudience.Private<a name="line.48"></a> +<span class="sourceLineNo">049</span> public ObserverContext(User caller) {<a name="line.49"></a> +<span class="sourceLineNo">050</span> this.caller = caller;<a name="line.50"></a> +<span class="sourceLineNo">051</span> }<a name="line.51"></a> +<span class="sourceLineNo">052</span><a name="line.52"></a> +<span class="sourceLineNo">053</span> public E getEnvironment() {<a name="line.53"></a> +<span class="sourceLineNo">054</span> return env;<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> @InterfaceAudience.Private<a name="line.57"></a> +<span class="sourceLineNo">058</span> public void prepare(E env) {<a name="line.58"></a> +<span class="sourceLineNo">059</span> this.env = env;<a name="line.59"></a> +<span class="sourceLineNo">060</span> }<a name="line.60"></a> +<span class="sourceLineNo">061</span><a name="line.61"></a> +<span class="sourceLineNo">062</span> /**<a name="line.62"></a> +<span class="sourceLineNo">063</span> * Call to indicate that the current coprocessor's return value should be<a name="line.63"></a> +<span class="sourceLineNo">064</span> * used in place of the normal HBase obtained value.<a name="line.64"></a> +<span class="sourceLineNo">065</span> */<a name="line.65"></a> +<span class="sourceLineNo">066</span> public void bypass() {<a name="line.66"></a> +<span class="sourceLineNo">067</span> bypass = true;<a name="line.67"></a> +<span class="sourceLineNo">068</span> }<a name="line.68"></a> +<span class="sourceLineNo">069</span><a name="line.69"></a> +<span class="sourceLineNo">070</span> /**<a name="line.70"></a> +<span class="sourceLineNo">071</span> * Call to indicate that additional coprocessors further down the execution<a name="line.71"></a> +<span class="sourceLineNo">072</span> * chain do not need to be invoked. Implies that this coprocessor's response<a name="line.72"></a> +<span class="sourceLineNo">073</span> * is definitive.<a name="line.73"></a> +<span class="sourceLineNo">074</span> */<a name="line.74"></a> +<span class="sourceLineNo">075</span> public void complete() {<a name="line.75"></a> +<span class="sourceLineNo">076</span> complete = true;<a name="line.76"></a> +<span class="sourceLineNo">077</span> }<a name="line.77"></a> +<span class="sourceLineNo">078</span><a name="line.78"></a> +<span class="sourceLineNo">079</span> /**<a name="line.79"></a> +<span class="sourceLineNo">080</span> * For use by the coprocessor framework.<a name="line.80"></a> +<span class="sourceLineNo">081</span> * @return <code>true</code> if {@link ObserverContext#bypass()}<a name="line.81"></a> +<span class="sourceLineNo">082</span> * was called by one of the loaded coprocessors, <code>false</code> otherwise.<a name="line.82"></a> +<span class="sourceLineNo">083</span> */<a name="line.83"></a> +<span class="sourceLineNo">084</span> public boolean shouldBypass() {<a name="line.84"></a> +<span class="sourceLineNo">085</span> boolean current = bypass;<a name="line.85"></a> +<span class="sourceLineNo">086</span> bypass = false;<a name="line.86"></a> +<span class="sourceLineNo">087</span> return current;<a name="line.87"></a> +<span class="sourceLineNo">088</span> }<a name="line.88"></a> +<span class="sourceLineNo">089</span><a name="line.89"></a> +<span class="sourceLineNo">090</span> /**<a name="line.90"></a> +<span class="sourceLineNo">091</span> * For use by the coprocessor framework.<a name="line.91"></a> +<span class="sourceLineNo">092</span> * @return <code>true</code> if {@link ObserverContext#complete()}<a name="line.92"></a> +<span class="sourceLineNo">093</span> * was called by one of the loaded coprocessors, <code>false</code> otherwise.<a name="line.93"></a> +<span class="sourceLineNo">094</span> */<a name="line.94"></a> +<span class="sourceLineNo">095</span> public boolean shouldComplete() {<a name="line.95"></a> +<span class="sourceLineNo">096</span> boolean current = complete;<a name="line.96"></a> +<span class="sourceLineNo">097</span> complete = false;<a name="line.97"></a> +<span class="sourceLineNo">098</span> return current;<a name="line.98"></a> +<span class="sourceLineNo">099</span> }<a name="line.99"></a> +<span class="sourceLineNo">100</span><a name="line.100"></a> +<span class="sourceLineNo">101</span> /**<a name="line.101"></a> +<span class="sourceLineNo">102</span> * Returns the active user for the coprocessor call. If an explicit {@code User} instance was<a name="line.102"></a> +<span class="sourceLineNo">103</span> * provided to the constructor, that will be returned, otherwise if we are in the context of an<a name="line.103"></a> +<span class="sourceLineNo">104</span> * RPC call, the remote user is used. May not be present if the execution is outside of an RPC<a name="line.104"></a> +<span class="sourceLineNo">105</span> * context.<a name="line.105"></a> +<span class="sourceLineNo">106</span> */<a name="line.106"></a> +<span class="sourceLineNo">107</span> public Optional<User> getCaller() {<a name="line.107"></a> +<span class="sourceLineNo">108</span> return Optional.ofNullable(caller);<a name="line.108"></a> +<span class="sourceLineNo">109</span> }<a name="line.109"></a> +<span class="sourceLineNo">110</span><a name="line.110"></a> +<span class="sourceLineNo">111</span> /**<a name="line.111"></a> +<span class="sourceLineNo">112</span> * Instantiates a new ObserverContext instance if the passed reference is <code>null</code> and<a name="line.112"></a> +<span class="sourceLineNo">113</span> * sets the environment in the new or existing instance. This allows deferring the instantiation<a name="line.113"></a> +<span class="sourceLineNo">114</span> * of a ObserverContext until it is actually needed.<a name="line.114"></a> +<span class="sourceLineNo">115</span> * @param <E> The environment type for the context<a name="line.115"></a> <span class="sourceLineNo">116</span> * @param env The coprocessor environment to set<a name="line.116"></a> -<span class="sourceLineNo">117</span> * @param context An existing ObserverContext instance to use, or <code>null</code><a name="line.117"></a> -<span class="sourceLineNo">118</span> * to create a new instance<a name="line.118"></a> -<span class="sourceLineNo">119</span> * @param <E> The environment type for the context<a name="line.119"></a> -<span class="sourceLineNo">120</span> * @return An instance of <code>ObserverContext</code> with the environment set<a name="line.120"></a> -<span class="sourceLineNo">121</span> */<a name="line.121"></a> -<span class="sourceLineNo">122</span> @Deprecated<a name="line.122"></a> -<span class="sourceLineNo">123</span> // TODO: Remove this method, ObserverContext should not depend on RpcServer<a name="line.123"></a> -<span class="sourceLineNo">124</span> public static <E extends CoprocessorEnvironment> ObserverContext<E> createAndPrepare(<a name="line.124"></a> -<span class="sourceLineNo">125</span> E env, ObserverContext< E> context) {<a name="line.125"></a> -<span class="sourceLineNo">126</span> if (context == null) {<a name="line.126"></a> -<span class="sourceLineNo">127</span> context = new ObserverContext<>(RpcServer.getRequestUser());<a name="line.127"></a> -<span class="sourceLineNo">128</span> }<a name="line.128"></a> -<span class="sourceLineNo">129</span> context.prepare(env);<a name="line.129"></a> -<span class="sourceLineNo">130</span> return context;<a name="line.130"></a> -<span class="sourceLineNo">131</span> }<a name="line.131"></a> -<span class="sourceLineNo">132</span><a name="line.132"></a> -<span class="sourceLineNo">133</span> /**<a name="line.133"></a> -<span class="sourceLineNo">134</span> * Instantiates a new ObserverContext instance if the passed reference is<a name="line.134"></a> -<span class="sourceLineNo">135</span> * <code>null</code> and sets the environment in the new or existing instance.<a name="line.135"></a> -<span class="sourceLineNo">136</span> * This allows deferring the instantiation of a ObserverContext until it is<a name="line.136"></a> -<span class="sourceLineNo">137</span> * actually needed.<a name="line.137"></a> -<span class="sourceLineNo">138</span> *<a name="line.138"></a> -<span class="sourceLineNo">139</span> * @param env The coprocessor environment to set<a name="line.139"></a> -<span class="sourceLineNo">140</span> * @param context An existing ObserverContext instance to use, or <code>null</code><a name="line.140"></a> -<span class="sourceLineNo">141</span> * to create a new instance<a name="line.141"></a> -<span class="sourceLineNo">142</span> * @param user The requesting caller for the execution context<a name="line.142"></a> -<span class="sourceLineNo">143</span> * @param <E> The environment type for the context<a name="line.143"></a> -<span class="sourceLineNo">144</span> * @return An instance of <code>ObserverContext</code> with the environment set<a name="line.144"></a> -<span class="sourceLineNo">145</span> */<a name="line.145"></a> -<span class="sourceLineNo">146</span> public static <E extends CoprocessorEnvironment> ObserverContext<E> createAndPrepare(<a name="line.146"></a> -<span class="sourceLineNo">147</span> E env, ObserverContext<E> context, User user) {<a name="line.147"></a> -<span class="sourceLineNo">148</span> if (context == null) {<a name="line.148"></a> -<span class="sourceLineNo">149</span> context = new ObserverContext<>(user);<a name="line.149"></a> -<span class="sourceLineNo">150</span> }<a name="line.150"></a> -<span class="sourceLineNo">151</span> context.prepare(env);<a name="line.151"></a> -<span class="sourceLineNo">152</span> return context;<a name="line.152"></a> -<span class="sourceLineNo">153</span> }<a name="line.153"></a> -<span class="sourceLineNo">154</span>}<a name="line.154"></a> +<span class="sourceLineNo">117</span> * @return An instance of <code>ObserverContext</code> with the environment set<a name="line.117"></a> +<span class="sourceLineNo">118</span> */<a name="line.118"></a> +<span class="sourceLineNo">119</span> @Deprecated<a name="line.119"></a> +<span class="sourceLineNo">120</span> @InterfaceAudience.Private<a name="line.120"></a> +<span class="sourceLineNo">121</span> @VisibleForTesting<a name="line.121"></a> +<span class="sourceLineNo">122</span> // TODO: Remove this method, ObserverContext should not depend on RpcServer<a name="line.122"></a> +<span class="sourceLineNo">123</span> public static <E extends CoprocessorEnvironment> ObserverContext<E> createAndPrepare(E env) {<a name="line.123"></a> +<span class="sourceLineNo">124</span> ObserverContext<E> ctx = new ObserverContext<>(RpcServer.getRequestUser().orElse(null));<a name="line.124"></a> +<span class="sourceLineNo">125</span> ctx.prepare(env);<a name="line.125"></a> +<span class="sourceLineNo">126</span> return ctx;<a name="line.126"></a> +<span class="sourceLineNo">127</span> }<a name="line.127"></a> +<span class="sourceLineNo">128</span>}<a name="line.128"></a>
http://git-wip-us.apache.org/repos/asf/hbase-site/blob/b838bdf0/devapidocs/src-html/org/apache/hadoop/hbase/ipc/CallRunner.html ---------------------------------------------------------------------- diff --git a/devapidocs/src-html/org/apache/hadoop/hbase/ipc/CallRunner.html b/devapidocs/src-html/org/apache/hadoop/hbase/ipc/CallRunner.html index ca7e723..036fe26 100644 --- a/devapidocs/src-html/org/apache/hadoop/hbase/ipc/CallRunner.html +++ b/devapidocs/src-html/org/apache/hadoop/hbase/ipc/CallRunner.html @@ -27,215 +27,216 @@ <span class="sourceLineNo">019</span><a name="line.19"></a> <span class="sourceLineNo">020</span>import java.net.InetSocketAddress;<a name="line.20"></a> <span class="sourceLineNo">021</span>import java.nio.channels.ClosedChannelException;<a name="line.21"></a> -<span class="sourceLineNo">022</span><a name="line.22"></a> -<span class="sourceLineNo">023</span>import org.apache.hadoop.hbase.CallDroppedException;<a name="line.23"></a> -<span class="sourceLineNo">024</span>import org.apache.hadoop.hbase.CellScanner;<a name="line.24"></a> -<span class="sourceLineNo">025</span>import org.apache.hadoop.hbase.HBaseInterfaceAudience;<a name="line.25"></a> -<span class="sourceLineNo">026</span>import org.apache.yetus.audience.InterfaceAudience;<a name="line.26"></a> -<span class="sourceLineNo">027</span>import org.apache.yetus.audience.InterfaceStability;<a name="line.27"></a> -<span class="sourceLineNo">028</span>import org.apache.hadoop.hbase.exceptions.TimeoutIOException;<a name="line.28"></a> -<span class="sourceLineNo">029</span>import org.apache.hadoop.hbase.monitoring.MonitoredRPCHandler;<a name="line.29"></a> -<span class="sourceLineNo">030</span>import org.apache.hadoop.hbase.security.User;<a name="line.30"></a> -<span class="sourceLineNo">031</span>import org.apache.hadoop.hbase.shaded.com.google.protobuf.Message;<a name="line.31"></a> -<span class="sourceLineNo">032</span>import org.apache.hadoop.hbase.util.Pair;<a name="line.32"></a> -<span class="sourceLineNo">033</span>import org.apache.hadoop.util.StringUtils;<a name="line.33"></a> -<span class="sourceLineNo">034</span>import org.apache.htrace.Trace;<a name="line.34"></a> -<span class="sourceLineNo">035</span>import org.apache.htrace.TraceScope;<a name="line.35"></a> -<span class="sourceLineNo">036</span><a name="line.36"></a> -<span class="sourceLineNo">037</span>/**<a name="line.37"></a> -<span class="sourceLineNo">038</span> * The request processing logic, which is usually executed in thread pools provided by an<a name="line.38"></a> -<span class="sourceLineNo">039</span> * {@link RpcScheduler}. Call {@link #run()} to actually execute the contained<a name="line.39"></a> -<span class="sourceLineNo">040</span> * RpcServer.Call<a name="line.40"></a> -<span class="sourceLineNo">041</span> */<a name="line.41"></a> -<span class="sourceLineNo">042</span>@InterfaceAudience.LimitedPrivate({HBaseInterfaceAudience.COPROC, HBaseInterfaceAudience.PHOENIX})<a name="line.42"></a> -<span class="sourceLineNo">043</span>@InterfaceStability.Evolving<a name="line.43"></a> -<span class="sourceLineNo">044</span>public class CallRunner {<a name="line.44"></a> -<span class="sourceLineNo">045</span><a name="line.45"></a> -<span class="sourceLineNo">046</span> private static final CallDroppedException CALL_DROPPED_EXCEPTION<a name="line.46"></a> -<span class="sourceLineNo">047</span> = new CallDroppedException();<a name="line.47"></a> -<span class="sourceLineNo">048</span><a name="line.48"></a> -<span class="sourceLineNo">049</span> private RpcCall call;<a name="line.49"></a> -<span class="sourceLineNo">050</span> private RpcServerInterface rpcServer;<a name="line.50"></a> -<span class="sourceLineNo">051</span> private MonitoredRPCHandler status;<a name="line.51"></a> -<span class="sourceLineNo">052</span> private volatile boolean sucessful;<a name="line.52"></a> -<span class="sourceLineNo">053</span><a name="line.53"></a> -<span class="sourceLineNo">054</span> /**<a name="line.54"></a> -<span class="sourceLineNo">055</span> * On construction, adds the size of this call to the running count of outstanding call sizes.<a name="line.55"></a> -<span class="sourceLineNo">056</span> * Presumption is that we are put on a queue while we wait on an executor to run us. During this<a name="line.56"></a> -<span class="sourceLineNo">057</span> * time we occupy heap.<a name="line.57"></a> -<span class="sourceLineNo">058</span> */<a name="line.58"></a> -<span class="sourceLineNo">059</span> // The constructor is shutdown so only RpcServer in this class can make one of these.<a name="line.59"></a> -<span class="sourceLineNo">060</span> CallRunner(final RpcServerInterface rpcServer, final RpcCall call) {<a name="line.60"></a> -<span class="sourceLineNo">061</span> this.call = call;<a name="line.61"></a> -<span class="sourceLineNo">062</span> this.rpcServer = rpcServer;<a name="line.62"></a> -<span class="sourceLineNo">063</span> // Add size of the call to queue size.<a name="line.63"></a> -<span class="sourceLineNo">064</span> if (call != null && rpcServer != null) {<a name="line.64"></a> -<span class="sourceLineNo">065</span> this.rpcServer.addCallSize(call.getSize());<a name="line.65"></a> -<span class="sourceLineNo">066</span> }<a name="line.66"></a> -<span class="sourceLineNo">067</span> }<a name="line.67"></a> -<span class="sourceLineNo">068</span><a name="line.68"></a> -<span class="sourceLineNo">069</span> public RpcCall getRpcCall() {<a name="line.69"></a> -<span class="sourceLineNo">070</span> return call;<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> * Keep for backward compatibility.<a name="line.74"></a> -<span class="sourceLineNo">075</span> * @deprecated As of release 2.0, this will be removed in HBase 3.0<a name="line.75"></a> -<span class="sourceLineNo">076</span> */<a name="line.76"></a> -<span class="sourceLineNo">077</span> @Deprecated<a name="line.77"></a> -<span class="sourceLineNo">078</span> public ServerCall<?> getCall() {<a name="line.78"></a> -<span class="sourceLineNo">079</span> return (ServerCall<?>) call;<a name="line.79"></a> -<span class="sourceLineNo">080</span> }<a name="line.80"></a> -<span class="sourceLineNo">081</span><a name="line.81"></a> -<span class="sourceLineNo">082</span> public void setStatus(MonitoredRPCHandler status) {<a name="line.82"></a> -<span class="sourceLineNo">083</span> this.status = status;<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> /**<a name="line.86"></a> -<span class="sourceLineNo">087</span> * Cleanup after ourselves... let go of references.<a name="line.87"></a> -<span class="sourceLineNo">088</span> */<a name="line.88"></a> -<span class="sourceLineNo">089</span> private void cleanup() {<a name="line.89"></a> -<span class="sourceLineNo">090</span> this.call = null;<a name="line.90"></a> -<span class="sourceLineNo">091</span> this.rpcServer = null;<a name="line.91"></a> -<span class="sourceLineNo">092</span> }<a name="line.92"></a> -<span class="sourceLineNo">093</span><a name="line.93"></a> -<span class="sourceLineNo">094</span> public void run() {<a name="line.94"></a> -<span class="sourceLineNo">095</span> try {<a name="line.95"></a> -<span class="sourceLineNo">096</span> if (call.disconnectSince() >= 0) {<a name="line.96"></a> -<span class="sourceLineNo">097</span> if (RpcServer.LOG.isDebugEnabled()) {<a name="line.97"></a> -<span class="sourceLineNo">098</span> RpcServer.LOG.debug(Thread.currentThread().getName() + ": skipped " + call);<a name="line.98"></a> -<span class="sourceLineNo">099</span> }<a name="line.99"></a> -<span class="sourceLineNo">100</span> return;<a name="line.100"></a> -<span class="sourceLineNo">101</span> }<a name="line.101"></a> -<span class="sourceLineNo">102</span> call.setStartTime(System.currentTimeMillis());<a name="line.102"></a> -<span class="sourceLineNo">103</span> if (call.getStartTime() > call.getDeadline()) {<a name="line.103"></a> -<span class="sourceLineNo">104</span> RpcServer.LOG.warn("Dropping timed out call: " + call);<a name="line.104"></a> -<span class="sourceLineNo">105</span> return;<a name="line.105"></a> -<span class="sourceLineNo">106</span> }<a name="line.106"></a> -<span class="sourceLineNo">107</span> this.status.setStatus("Setting up call");<a name="line.107"></a> -<span class="sourceLineNo">108</span> this.status.setConnection(call.getRemoteAddress().getHostAddress(), call.getRemotePort());<a name="line.108"></a> -<span class="sourceLineNo">109</span> if (RpcServer.LOG.isTraceEnabled()) {<a name="line.109"></a> -<span class="sourceLineNo">110</span> User remoteUser = call.getRequestUser();<a name="line.110"></a> -<span class="sourceLineNo">111</span> RpcServer.LOG.trace(call.toShortString() + " executing as " +<a name="line.111"></a> -<span class="sourceLineNo">112</span> ((remoteUser == null) ? "NULL principal" : remoteUser.getName()));<a name="line.112"></a> -<span class="sourceLineNo">113</span> }<a name="line.113"></a> -<span class="sourceLineNo">114</span> Throwable errorThrowable = null;<a name="line.114"></a> -<span class="sourceLineNo">115</span> String error = null;<a name="line.115"></a> -<span class="sourceLineNo">116</span> Pair<Message, CellScanner> resultPair = null;<a name="line.116"></a> -<span class="sourceLineNo">117</span> RpcServer.CurCall.set(call);<a name="line.117"></a> -<span class="sourceLineNo">118</span> TraceScope traceScope = null;<a name="line.118"></a> -<span class="sourceLineNo">119</span> try {<a name="line.119"></a> -<span class="sourceLineNo">120</span> if (!this.rpcServer.isStarted()) {<a name="line.120"></a> -<span class="sourceLineNo">121</span> InetSocketAddress address = rpcServer.getListenerAddress();<a name="line.121"></a> -<span class="sourceLineNo">122</span> throw new ServerNotRunningYetException("Server " +<a name="line.122"></a> -<span class="sourceLineNo">123</span> (address != null ? address : "(channel closed)") + " is not running yet");<a name="line.123"></a> -<span class="sourceLineNo">124</span> }<a name="line.124"></a> -<span class="sourceLineNo">125</span> if (call.getTraceInfo() != null) {<a name="line.125"></a> -<span class="sourceLineNo">126</span> String serviceName =<a name="line.126"></a> -<span class="sourceLineNo">127</span> call.getService() != null ? call.getService().getDescriptorForType().getName() : "";<a name="line.127"></a> -<span class="sourceLineNo">128</span> String methodName = (call.getMethod() != null) ? call.getMethod().getName() : "";<a name="line.128"></a> -<span class="sourceLineNo">129</span> String traceString = serviceName + "." + methodName;<a name="line.129"></a> -<span class="sourceLineNo">130</span> traceScope = Trace.startSpan(traceString, call.getTraceInfo());<a name="line.130"></a> -<span class="sourceLineNo">131</span> }<a name="line.131"></a> -<span class="sourceLineNo">132</span> // make the call<a name="line.132"></a> -<span class="sourceLineNo">133</span> resultPair = this.rpcServer.call(call, this.status);<a name="line.133"></a> -<span class="sourceLineNo">134</span> } catch (TimeoutIOException e){<a name="line.134"></a> -<span class="sourceLineNo">135</span> RpcServer.LOG.warn("Can not complete this request in time, drop it: " + call);<a name="line.135"></a> -<span class="sourceLineNo">136</span> return;<a name="line.136"></a> -<span class="sourceLineNo">137</span> } catch (Throwable e) {<a name="line.137"></a> -<span class="sourceLineNo">138</span> if (e instanceof ServerNotRunningYetException) {<a name="line.138"></a> -<span class="sourceLineNo">139</span> // If ServerNotRunningYetException, don't spew stack trace.<a name="line.139"></a> -<span class="sourceLineNo">140</span> if (RpcServer.LOG.isTraceEnabled()) {<a name="line.140"></a> -<span class="sourceLineNo">141</span> RpcServer.LOG.trace(call.toShortString(), e);<a name="line.141"></a> -<span class="sourceLineNo">142</span> }<a name="line.142"></a> -<span class="sourceLineNo">143</span> } else {<a name="line.143"></a> -<span class="sourceLineNo">144</span> RpcServer.LOG.debug(call.toShortString(), e);<a name="line.144"></a> -<span class="sourceLineNo">145</span> }<a name="line.145"></a> -<span class="sourceLineNo">146</span> errorThrowable = e;<a name="line.146"></a> -<span class="sourceLineNo">147</span> error = StringUtils.stringifyException(e);<a name="line.147"></a> -<span class="sourceLineNo">148</span> if (e instanceof Error) {<a name="line.148"></a> -<span class="sourceLineNo">149</span> throw (Error)e;<a name="line.149"></a> -<span class="sourceLineNo">150</span> }<a name="line.150"></a> -<span class="sourceLineNo">151</span> } finally {<a name="line.151"></a> -<span class="sourceLineNo">152</span> if (traceScope != null) {<a name="line.152"></a> -<span class="sourceLineNo">153</span> traceScope.close();<a name="line.153"></a> -<span class="sourceLineNo">154</span> }<a name="line.154"></a> -<span class="sourceLineNo">155</span> RpcServer.CurCall.set(null);<a name="line.155"></a> -<span class="sourceLineNo">156</span> if (resultPair != null) {<a name="line.156"></a> -<span class="sourceLineNo">157</span> this.rpcServer.addCallSize(call.getSize() * -1);<a name="line.157"></a> -<span class="sourceLineNo">158</span> sucessful = true;<a name="line.158"></a> -<span class="sourceLineNo">159</span> }<a name="line.159"></a> -<span class="sourceLineNo">160</span> }<a name="line.160"></a> -<span class="sourceLineNo">161</span> // return back the RPC request read BB we can do here. It is done by now.<a name="line.161"></a> -<span class="sourceLineNo">162</span> call.cleanup();<a name="line.162"></a> -<span class="sourceLineNo">163</span> // Set the response<a name="line.163"></a> -<span class="sourceLineNo">164</span> Message param = resultPair != null ? resultPair.getFirst() : null;<a name="line.164"></a> -<span class="sourceLineNo">165</span> CellScanner cells = resultPair != null ? resultPair.getSecond() : null;<a name="line.165"></a> -<span class="sourceLineNo">166</span> call.setResponse(param, cells, errorThrowable, error);<a name="line.166"></a> -<span class="sourceLineNo">167</span> call.sendResponseIfReady();<a name="line.167"></a> -<span class="sourceLineNo">168</span> this.status.markComplete("Sent response");<a name="line.168"></a> -<span class="sourceLineNo">169</span> this.status.pause("Waiting for a call");<a name="line.169"></a> -<span class="sourceLineNo">170</span> } catch (OutOfMemoryError e) {<a name="line.170"></a> -<span class="sourceLineNo">171</span> if (this.rpcServer.getErrorHandler() != null) {<a name="line.171"></a> -<span class="sourceLineNo">172</span> if (this.rpcServer.getErrorHandler().checkOOME(e)) {<a name="line.172"></a> -<span class="sourceLineNo">173</span> RpcServer.LOG.info(Thread.currentThread().getName() + ": exiting on OutOfMemoryError");<a name="line.173"></a> -<span class="sourceLineNo">174</span> return;<a name="line.174"></a> -<span class="sourceLineNo">175</span> }<a name="line.175"></a> -<span class="sourceLineNo">176</span> } else {<a name="line.176"></a> -<span class="sourceLineNo">177</span> // rethrow if no handler<a name="line.177"></a> -<span class="sourceLineNo">178</span> throw e;<a name="line.178"></a> -<span class="sourceLineNo">179</span> }<a name="line.179"></a> -<span class="sourceLineNo">180</span> } catch (ClosedChannelException cce) {<a name="line.180"></a> -<span class="sourceLineNo">181</span> InetSocketAddress address = rpcServer.getListenerAddress();<a name="line.181"></a> -<span class="sourceLineNo">182</span> RpcServer.LOG.warn(Thread.currentThread().getName() + ": caught a ClosedChannelException, " +<a name="line.182"></a> -<span class="sourceLineNo">183</span> "this means that the server " + (address != null ? address : "(channel closed)") +<a name="line.183"></a> -<span class="sourceLineNo">184</span> " was processing a request but the client went away. The error message was: " +<a name="line.184"></a> -<span class="sourceLineNo">185</span> cce.getMessage());<a name="line.185"></a> -<span class="sourceLineNo">186</span> } catch (Exception e) {<a name="line.186"></a> -<span class="sourceLineNo">187</span> RpcServer.LOG.warn(Thread.currentThread().getName()<a name="line.187"></a> -<span class="sourceLineNo">188</span> + ": caught: " + StringUtils.stringifyException(e));<a name="line.188"></a> -<span class="sourceLineNo">189</span> } finally {<a name="line.189"></a> -<span class="sourceLineNo">190</span> if (!sucessful) {<a name="line.190"></a> -<span class="sourceLineNo">191</span> this.rpcServer.addCallSize(call.getSize() * -1);<a name="line.191"></a> -<span class="sourceLineNo">192</span> }<a name="line.192"></a> -<span class="sourceLineNo">193</span> cleanup();<a name="line.193"></a> -<span class="sourceLineNo">194</span> }<a name="line.194"></a> -<span class="sourceLineNo">195</span> }<a name="line.195"></a> -<span class="sourceLineNo">196</span><a name="line.196"></a> -<span class="sourceLineNo">197</span> /**<a name="line.197"></a> -<span class="sourceLineNo">198</span> * When we want to drop this call because of server is overloaded.<a name="line.198"></a> -<span class="sourceLineNo">199</span> */<a name="line.199"></a> -<span class="sourceLineNo">200</span> public void drop() {<a name="line.200"></a> -<span class="sourceLineNo">201</span> try {<a name="line.201"></a> -<span class="sourceLineNo">202</span> if (call.disconnectSince() >= 0) {<a name="line.202"></a> -<span class="sourceLineNo">203</span> if (RpcServer.LOG.isDebugEnabled()) {<a name="line.203"></a> -<span class="sourceLineNo">204</span> RpcServer.LOG.debug(Thread.currentThread().getName() + ": skipped " + call);<a name="line.204"></a> -<span class="sourceLineNo">205</span> }<a name="line.205"></a> -<span class="sourceLineNo">206</span> return;<a name="line.206"></a> -<span class="sourceLineNo">207</span> }<a name="line.207"></a> -<span class="sourceLineNo">208</span><a name="line.208"></a> -<span class="sourceLineNo">209</span> // Set the response<a name="line.209"></a> -<span class="sourceLineNo">210</span> InetSocketAddress address = rpcServer.getListenerAddress();<a name="line.210"></a> -<span class="sourceLineNo">211</span> call.setResponse(null, null, CALL_DROPPED_EXCEPTION, "Call dropped, server "<a name="line.211"></a> -<span class="sourceLineNo">212</span> + (address != null ? address : "(channel closed)") + " is overloaded, please retry.");<a name="line.212"></a> -<span class="sourceLineNo">213</span> call.sendResponseIfReady();<a name="line.213"></a> -<span class="sourceLineNo">214</span> } catch (ClosedChannelException cce) {<a name="line.214"></a> -<span class="sourceLineNo">215</span> InetSocketAddress address = rpcServer.getListenerAddress();<a name="line.215"></a> -<span class="sourceLineNo">216</span> RpcServer.LOG.warn(Thread.currentThread().getName() + ": caught a ClosedChannelException, " +<a name="line.216"></a> -<span class="sourceLineNo">217</span> "this means that the server " + (address != null ? address : "(channel closed)") +<a name="line.217"></a> -<span class="sourceLineNo">218</span> " was processing a request but the client went away. The error message was: " +<a name="line.218"></a> -<span class="sourceLineNo">219</span> cce.getMessage());<a name="line.219"></a> -<span class="sourceLineNo">220</span> } catch (Exception e) {<a name="line.220"></a> -<span class="sourceLineNo">221</span> RpcServer.LOG.warn(Thread.currentThread().getName()<a name="line.221"></a> -<span class="sourceLineNo">222</span> + ": caught: " + StringUtils.stringifyException(e));<a name="line.222"></a> -<span class="sourceLineNo">223</span> } finally {<a name="line.223"></a> -<span class="sourceLineNo">224</span> if (!sucessful) {<a name="line.224"></a> -<span class="sourceLineNo">225</span> this.rpcServer.addCallSize(call.getSize() * -1);<a name="line.225"></a> -<span class="sourceLineNo">226</span> }<a name="line.226"></a> -<span class="sourceLineNo">227</span> cleanup();<a name="line.227"></a> -<span class="sourceLineNo">228</span> }<a name="line.228"></a> -<span class="sourceLineNo">229</span> }<a name="line.229"></a> -<span class="sourceLineNo">230</span>}<a name="line.230"></a> +<span class="sourceLineNo">022</span>import java.util.Optional;<a name="line.22"></a> +<span class="sourceLineNo">023</span><a name="line.23"></a> +<span class="sourceLineNo">024</span>import org.apache.hadoop.hbase.CallDroppedException;<a name="line.24"></a> +<span class="sourceLineNo">025</span>import org.apache.hadoop.hbase.CellScanner;<a name="line.25"></a> +<span class="sourceLineNo">026</span>import org.apache.hadoop.hbase.HBaseInterfaceAudience;<a name="line.26"></a> +<span class="sourceLineNo">027</span>import org.apache.yetus.audience.InterfaceAudience;<a name="line.27"></a> +<span class="sourceLineNo">028</span>import org.apache.yetus.audience.InterfaceStability;<a name="line.28"></a> +<span class="sourceLineNo">029</span>import org.apache.hadoop.hbase.exceptions.TimeoutIOException;<a name="line.29"></a> +<span class="sourceLineNo">030</span>import org.apache.hadoop.hbase.monitoring.MonitoredRPCHandler;<a name="line.30"></a> +<span class="sourceLineNo">031</span>import org.apache.hadoop.hbase.security.User;<a name="line.31"></a> +<span class="sourceLineNo">032</span>import org.apache.hadoop.hbase.shaded.com.google.protobuf.Message;<a name="line.32"></a> +<span class="sourceLineNo">033</span>import org.apache.hadoop.hbase.util.Pair;<a name="line.33"></a> +<span class="sourceLineNo">034</span>import org.apache.hadoop.util.StringUtils;<a name="line.34"></a> +<span class="sourceLineNo">035</span>import org.apache.htrace.Trace;<a name="line.35"></a> +<span class="sourceLineNo">036</span>import org.apache.htrace.TraceScope;<a name="line.36"></a> +<span class="sourceLineNo">037</span><a name="line.37"></a> +<span class="sourceLineNo">038</span>/**<a name="line.38"></a> +<span class="sourceLineNo">039</span> * The request processing logic, which is usually executed in thread pools provided by an<a name="line.39"></a> +<span class="sourceLineNo">040</span> * {@link RpcScheduler}. Call {@link #run()} to actually execute the contained<a name="line.40"></a> +<span class="sourceLineNo">041</span> * RpcServer.Call<a name="line.41"></a> +<span class="sourceLineNo">042</span> */<a name="line.42"></a> +<span class="sourceLineNo">043</span>@InterfaceAudience.LimitedPrivate({HBaseInterfaceAudience.COPROC, HBaseInterfaceAudience.PHOENIX})<a name="line.43"></a> +<span class="sourceLineNo">044</span>@InterfaceStability.Evolving<a name="line.44"></a> +<span class="sourceLineNo">045</span>public class CallRunner {<a name="line.45"></a> +<span class="sourceLineNo">046</span><a name="line.46"></a> +<span class="sourceLineNo">047</span> private static final CallDroppedException CALL_DROPPED_EXCEPTION<a name="line.47"></a> +<span class="sourceLineNo">048</span> = new CallDroppedException();<a name="line.48"></a> +<span class="sourceLineNo">049</span><a name="line.49"></a> +<span class="sourceLineNo">050</span> private RpcCall call;<a name="line.50"></a> +<span class="sourceLineNo">051</span> private RpcServerInterface rpcServer;<a name="line.51"></a> +<span class="sourceLineNo">052</span> private MonitoredRPCHandler status;<a name="line.52"></a> +<span class="sourceLineNo">053</span> private volatile boolean sucessful;<a name="line.53"></a> +<span class="sourceLineNo">054</span><a name="line.54"></a> +<span class="sourceLineNo">055</span> /**<a name="line.55"></a> +<span class="sourceLineNo">056</span> * On construction, adds the size of this call to the running count of outstanding call sizes.<a name="line.56"></a> +<span class="sourceLineNo">057</span> * Presumption is that we are put on a queue while we wait on an executor to run us. During this<a name="line.57"></a> +<span class="sourceLineNo">058</span> * time we occupy heap.<a name="line.58"></a> +<span class="sourceLineNo">059</span> */<a name="line.59"></a> +<span class="sourceLineNo">060</span> // The constructor is shutdown so only RpcServer in this class can make one of these.<a name="line.60"></a> +<span class="sourceLineNo">061</span> CallRunner(final RpcServerInterface rpcServer, final RpcCall call) {<a name="line.61"></a> +<span class="sourceLineNo">062</span> this.call = call;<a name="line.62"></a> +<span class="sourceLineNo">063</span> this.rpcServer = rpcServer;<a name="line.63"></a> +<span class="sourceLineNo">064</span> // Add size of the call to queue size.<a name="line.64"></a> +<span class="sourceLineNo">065</span> if (call != null && rpcServer != null) {<a name="line.65"></a> +<span class="sourceLineNo">066</span> this.rpcServer.addCallSize(call.getSize());<a name="line.66"></a> +<span class="sourceLineNo">067</span> }<a name="line.67"></a> +<span class="sourceLineNo">068</span> }<a name="line.68"></a> +<span class="sourceLineNo">069</span><a name="line.69"></a> +<span class="sourceLineNo">070</span> public RpcCall getRpcCall() {<a name="line.70"></a> +<span class="sourceLineNo">071</span> return call;<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> /**<a name="line.74"></a> +<span class="sourceLineNo">075</span> * Keep for backward compatibility.<a name="line.75"></a> +<span class="sourceLineNo">076</span> * @deprecated As of release 2.0, this will be removed in HBase 3.0<a name="line.76"></a> +<span class="sourceLineNo">077</span> */<a name="line.77"></a> +<span class="sourceLineNo">078</span> @Deprecated<a name="line.78"></a> +<span class="sourceLineNo">079</span> public ServerCall<?> getCall() {<a name="line.79"></a> +<span class="sourceLineNo">080</span> return (ServerCall<?>) call;<a name="line.80"></a> +<span class="sourceLineNo">081</span> }<a name="line.81"></a> +<span class="sourceLineNo">082</span><a name="line.82"></a> +<span class="sourceLineNo">083</span> public void setStatus(MonitoredRPCHandler status) {<a name="line.83"></a> +<span class="sourceLineNo">084</span> this.status = status;<a name="line.84"></a> +<span class="sourceLineNo">085</span> }<a name="line.85"></a> +<span class="sourceLineNo">086</span><a name="line.86"></a> +<span class="sourceLineNo">087</span> /**<a name="line.87"></a> +<span class="sourceLineNo">088</span> * Cleanup after ourselves... let go of references.<a name="line.88"></a> +<span class="sourceLineNo">089</span> */<a name="line.89"></a> +<span class="sourceLineNo">090</span> private void cleanup() {<a name="line.90"></a> +<span class="sourceLineNo">091</span> this.call = null;<a name="line.91"></a> +<span class="sourceLineNo">092</span> this.rpcServer = null;<a name="line.92"></a> +<span class="sourceLineNo">093</span> }<a name="line.93"></a> +<span class="sourceLineNo">094</span><a name="line.94"></a> +<span class="sourceLineNo">095</span> public void run() {<a name="line.95"></a> +<span class="sourceLineNo">096</span> try {<a name="line.96"></a> +<span class="sourceLineNo">097</span> if (call.disconnectSince() >= 0) {<a name="line.97"></a> +<span class="sourceLineNo">098</span> if (RpcServer.LOG.isDebugEnabled()) {<a name="line.98"></a> +<span class="sourceLineNo">099</span> RpcServer.LOG.debug(Thread.currentThread().getName() + ": skipped " + call);<a name="line.99"></a> +<span class="sourceLineNo">100</span> }<a name="line.100"></a> +<span class="sourceLineNo">101</span> return;<a name="line.101"></a> +<span class="sourceLineNo">102</span> }<a name="line.102"></a> +<span class="sourceLineNo">103</span> call.setStartTime(System.currentTimeMillis());<a name="line.103"></a> +<span class="sourceLineNo">104</span> if (call.getStartTime() > call.getDeadline()) {<a name="line.104"></a> +<span class="sourceLineNo">105</span> RpcServer.LOG.warn("Dropping timed out call: " + call);<a name="line.105"></a> +<span class="sourceLineNo">106</span> return;<a name="line.106"></a> +<span class="sourceLineNo">107</span> }<a name="line.107"></a> +<span class="sourceLineNo">108</span> this.status.setStatus("Setting up call");<a name="line.108"></a> +<span class="sourceLineNo">109</span> this.status.setConnection(call.getRemoteAddress().getHostAddress(), call.getRemotePort());<a name="line.109"></a> +<span class="sourceLineNo">110</span> if (RpcServer.LOG.isTraceEnabled()) {<a name="line.110"></a> +<span class="sourceLineNo">111</span> Optional<User> remoteUser = call.getRequestUser();<a name="line.111"></a> +<span class="sourceLineNo">112</span> RpcServer.LOG.trace(call.toShortString() + " executing as " +<a name="line.112"></a> +<span class="sourceLineNo">113</span> (remoteUser.isPresent() ? "NULL principal" : remoteUser.get().getName()));<a name="line.113"></a> +<span class="sourceLineNo">114</span> }<a name="line.114"></a> +<span class="sourceLineNo">115</span> Throwable errorThrowable = null;<a name="line.115"></a> +<span class="sourceLineNo">116</span> String error = null;<a name="line.116"></a> +<span class="sourceLineNo">117</span> Pair<Message, CellScanner> resultPair = null;<a name="line.117"></a> +<span class="sourceLineNo">118</span> RpcServer.CurCall.set(call);<a name="line.118"></a> +<span class="sourceLineNo">119</span> TraceScope traceScope = null;<a name="line.119"></a> +<span class="sourceLineNo">120</span> try {<a name="line.120"></a> +<span class="sourceLineNo">121</span> if (!this.rpcServer.isStarted()) {<a name="line.121"></a> +<span class="sourceLineNo">122</span> InetSocketAddress address = rpcServer.getListenerAddress();<a name="line.122"></a> +<span class="sourceLineNo">123</span> throw new ServerNotRunningYetException("Server " +<a name="line.123"></a> +<span class="sourceLineNo">124</span> (address != null ? address : "(channel closed)") + " is not running yet");<a name="line.124"></a> +<span class="sourceLineNo">125</span> }<a name="line.125"></a> +<span class="sourceLineNo">126</span> if (call.getTraceInfo() != null) {<a name="line.126"></a> +<span class="sourceLineNo">127</span> String serviceName =<a name="line.127"></a> +<span class="sourceLineNo">128</span> call.getService() != null ? call.getService().getDescriptorForType().getName() : "";<a name="line.128"></a> +<span class="sourceLineNo">129</span> String methodName = (call.getMethod() != null) ? call.getMethod().getName() : "";<a name="line.129"></a> +<span class="sourceLineNo">130</span> String traceString = serviceName + "." + methodName;<a name="line.130"></a> +<span class="sourceLineNo">131</span> traceScope = Trace.startSpan(traceString, call.getTraceInfo());<a name="line.131"></a> +<span class="sourceLineNo">132</span> }<a name="line.132"></a> +<span class="sourceLineNo">133</span> // make the call<a name="line.133"></a> +<span class="sourceLineNo">134</span> resultPair = this.rpcServer.call(call, this.status);<a name="line.134"></a> +<span class="sourceLineNo">135</span> } catch (TimeoutIOException e){<a name="line.135"></a> +<span class="sourceLineNo">136</span> RpcServer.LOG.warn("Can not complete this request in time, drop it: " + call);<a name="line.136"></a> +<span class="sourceLineNo">137</span> return;<a name="line.137"></a> +<span class="sourceLineNo">138</span> } catch (Throwable e) {<a name="line.138"></a> +<span class="sourceLineNo">139</span> if (e instanceof ServerNotRunningYetException) {<a name="line.139"></a> +<span class="sourceLineNo">140</span> // If ServerNotRunningYetException, don't spew stack trace.<a name="line.140"></a> +<span class="sourceLineNo">141</span> if (RpcServer.LOG.isTraceEnabled()) {<a name="line.141"></a> +<span class="sourceLineNo">142</span> RpcServer.LOG.trace(call.toShortString(), e);<a name="line.142"></a> +<span class="sourceLineNo">143</span> }<a name="line.143"></a> +<span class="sourceLineNo">144</span> } else {<a name="line.144"></a> +<span class="sourceLineNo">145</span> RpcServer.LOG.debug(call.toShortString(), e);<a name="line.145"></a> +<span class="sourceLineNo">146</span> }<a name="line.146"></a> +<span class="sourceLineNo">147</span> errorThrowable = e;<a name="line.147"></a> +<span class="sourceLineNo">148</span> error = StringUtils.stringifyException(e);<a name="line.148"></a> +<span class="sourceLineNo">149</span> if (e instanceof Error) {<a name="line.149"></a> +<span class="sourceLineNo">150</span> throw (Error)e;<a name="line.150"></a> +<span class="sourceLineNo">151</span> }<a name="line.151"></a> +<span class="sourceLineNo">152</span> } finally {<a name="line.152"></a> +<span class="sourceLineNo">153</span> if (traceScope != null) {<a name="line.153"></a> +<span class="sourceLineNo">154</span> traceScope.close();<a name="line.154"></a> +<span class="sourceLineNo">155</span> }<a name="line.155"></a> +<span class="sourceLineNo">156</span> RpcServer.CurCall.set(null);<a name="line.156"></a> +<span class="sourceLineNo">157</span> if (resultPair != null) {<a name="line.157"></a> +<span class="sourceLineNo">158</span> this.rpcServer.addCallSize(call.getSize() * -1);<a name="line.158"></a> +<span class="sourceLineNo">159</span> sucessful = true;<a name="line.159"></a> +<span class="sourceLineNo">160</span> }<a name="line.160"></a> +<span class="sourceLineNo">161</span> }<a name="line.161"></a> +<span class="sourceLineNo">162</span> // return back the RPC request read BB we can do here. It is done by now.<a name="line.162"></a> +<span class="sourceLineNo">163</span> call.cleanup();<a name="line.163"></a> +<span class="sourceLineNo">164</span> // Set the response<a name="line.164"></a> +<span class="sourceLineNo">165</span> Message param = resultPair != null ? resultPair.getFirst() : null;<a name="line.165"></a> +<span class="sourceLineNo">166</span> CellScanner cells = resultPair != null ? resultPair.getSecond() : null;<a name="line.166"></a> +<span class="sourceLineNo">167</span> call.setResponse(param, cells, errorThrowable, error);<a name="line.167"></a> +<span class="sourceLineNo">168</span> call.sendResponseIfReady();<a name="line.168"></a> +<span class="sourceLineNo">169</span> this.status.markComplete("Sent response");<a name="line.169"></a> +<span class="sourceLineNo">170</span> this.status.pause("Waiting for a call");<a name="line.170"></a> +<span class="sourceLineNo">171</span> } catch (OutOfMemoryError e) {<a name="line.171"></a> +<span class="sourceLineNo">172</span> if (this.rpcServer.getErrorHandler() != null) {<a name="line.172"></a> +<span class="sourceLineNo">173</span> if (this.rpcServer.getErrorHandler().checkOOME(e)) {<a name="line.173"></a> +<span class="sourceLineNo">174</span> RpcServer.LOG.info(Thread.currentThread().getName() + ": exiting on OutOfMemoryError");<a name="line.174"></a> +<span class="sourceLineNo">175</span> return;<a name="line.175"></a> +<span class="sourceLineNo">176</span> }<a name="line.176"></a> +<span class="sourceLineNo">177</span> } else {<a name="line.177"></a> +<span class="sourceLineNo">178</span> // rethrow if no handler<a name="line.178"></a> +<span class="sourceLineNo">179</span> throw e;<a name="line.179"></a> +<span class="sourceLineNo">180</span> }<a name="line.180"></a> +<span class="sourceLineNo">181</span> } catch (ClosedChannelException cce) {<a name="line.181"></a> +<span class="sourceLineNo">182</span> InetSocketAddress address = rpcServer.getListenerAddress();<a name="line.182"></a> +<span class="sourceLineNo">183</span> RpcServer.LOG.warn(Thread.currentThread().getName() + ": caught a ClosedChannelException, " +<a name="line.183"></a> +<span class="sourceLineNo">184</span> "this means that the server " + (address != null ? address : "(channel closed)") +<a name="line.184"></a> +<span class="sourceLineNo">185</span> " was processing a request but the client went away. The error message was: " +<a name="line.185"></a> +<span class="sourceLineNo">186</span> cce.getMessage());<a name="line.186"></a> +<span class="sourceLineNo">187</span> } catch (Exception e) {<a name="line.187"></a> +<span class="sourceLineNo">188</span> RpcServer.LOG.warn(Thread.currentThread().getName()<a name="line.188"></a> +<span class="sourceLineNo">189</span> + ": caught: " + StringUtils.stringifyException(e));<a name="line.189"></a> +<span class="sourceLineNo">190</span> } finally {<a name="line.190"></a> +<span class="sourceLineNo">191</span> if (!sucessful) {<a name="line.191"></a> +<span class="sourceLineNo">192</span> this.rpcServer.addCallSize(call.getSize() * -1);<a name="line.192"></a> +<span class="sourceLineNo">193</span> }<a name="line.193"></a> +<span class="sourceLineNo">194</span> cleanup();<a name="line.194"></a> +<span class="sourceLineNo">195</span> }<a name="line.195"></a> +<span class="sourceLineNo">196</span> }<a name="line.196"></a> +<span class="sourceLineNo">197</span><a name="line.197"></a> +<span class="sourceLineNo">198</span> /**<a name="line.198"></a> +<span class="sourceLineNo">199</span> * When we want to drop this call because of server is overloaded.<a name="line.199"></a> +<span class="sourceLineNo">200</span> */<a name="line.200"></a> +<span class="sourceLineNo">201</span> public void drop() {<a name="line.201"></a> +<span class="sourceLineNo">202</span> try {<a name="line.202"></a> +<span class="sourceLineNo">203</span> if (call.disconnectSince() >= 0) {<a name="line.203"></a> +<span class="sourceLineNo">204</span> if (RpcServer.LOG.isDebugEnabled()) {<a name="line.204"></a> +<span class="sourceLineNo">205</span> RpcServer.LOG.debug(Thread.currentThread().getName() + ": skipped " + call);<a name="line.205"></a> +<span class="sourceLineNo">206</span> }<a name="line.206"></a> +<span class="sourceLineNo">207</span> return;<a name="line.207"></a> +<span class="sourceLineNo">208</span> }<a name="line.208"></a> +<span class="sourceLineNo">209</span><a name="line.209"></a> +<span class="sourceLineNo">210</span> // Set the response<a name="line.210"></a> +<span class="sourceLineNo">211</span> InetSocketAddress address = rpcServer.getListenerAddress();<a name="line.211"></a> +<span class="sourceLineNo">212</span> call.setResponse(null, null, CALL_DROPPED_EXCEPTION, "Call dropped, server "<a name="line.212"></a> +<span class="sourceLineNo">213</span> + (address != null ? address : "(channel closed)") + " is overloaded, please retry.");<a name="line.213"></a> +<span class="sourceLineNo">214</span> call.sendResponseIfReady();<a name="line.214"></a> +<span class="sourceLineNo">215</span> } catch (ClosedChannelException cce) {<a name="line.215"></a> +<span class="sourceLineNo">216</span> InetSocketAddress address = rpcServer.getListenerAddress();<a name="line.216"></a> +<span class="sourceLineNo">217</span> RpcServer.LOG.warn(Thread.currentThread().getName() + ": caught a ClosedChannelException, " +<a name="line.217"></a> +<span class="sourceLineNo">218</span> "this means that the server " + (address != null ? address : "(channel closed)") +<a name="line.218"></a> +<span class="sourceLineNo">219</span> " was processing a request but the client went away. The error message was: " +<a name="line.219"></a> +<span class="sourceLineNo">220</span> cce.getMessage());<a name="line.220"></a> +<span class="sourceLineNo">221</span> } catch (Exception e) {<a name="line.221"></a> +<span class="sourceLineNo">222</span> RpcServer.LOG.warn(Thread.currentThread().getName()<a name="line.222"></a> +<span class="sourceLineNo">223</span> + ": caught: " + StringUtils.stringifyException(e));<a name="line.223"></a> +<span class="sourceLineNo">224</span> } finally {<a name="line.224"></a> +<span class="sourceLineNo">225</span> if (!sucessful) {<a name="line.225"></a> +<span class="sourceLineNo">226</span> this.rpcServer.addCallSize(call.getSize() * -1);<a name="line.226"></a> +<span class="sourceLineNo">227</span> }<a name="line.227"></a> +<span class="sourceLineNo">228</span> cleanup();<a name="line.228"></a> +<span class="sourceLineNo">229</span> }<a name="line.229"></a> +<span class="sourceLineNo">230</span> }<a name="line.230"></a> +<span class="sourceLineNo">231</span>}<a name="line.231"></a> http://git-wip-us.apache.org/repos/asf/hbase-site/blob/b838bdf0/devapidocs/src-html/org/apache/hadoop/hbase/ipc/RpcCallContext.html ---------------------------------------------------------------------- diff --git a/devapidocs/src-html/org/apache/hadoop/hbase/ipc/RpcCallContext.html b/devapidocs/src-html/org/apache/hadoop/hbase/ipc/RpcCallContext.html index 6a77f56..592085a 100644 --- a/devapidocs/src-html/org/apache/hadoop/hbase/ipc/RpcCallContext.html +++ b/devapidocs/src-html/org/apache/hadoop/hbase/ipc/RpcCallContext.html @@ -26,90 +26,93 @@ <span class="sourceLineNo">018</span>package org.apache.hadoop.hbase.ipc;<a name="line.18"></a> <span class="sourceLineNo">019</span><a name="line.19"></a> <span class="sourceLineNo">020</span>import java.net.InetAddress;<a name="line.20"></a> -<span class="sourceLineNo">021</span><a name="line.21"></a> -<span class="sourceLineNo">022</span>import org.apache.yetus.audience.InterfaceAudience;<a name="line.22"></a> -<span class="sourceLineNo">023</span>import org.apache.hadoop.hbase.shaded.protobuf.generated.HBaseProtos.VersionInfo;<a name="line.23"></a> -<span class="sourceLineNo">024</span>import org.apache.hadoop.hbase.security.User;<a name="line.24"></a> -<span class="sourceLineNo">025</span><a name="line.25"></a> -<span class="sourceLineNo">026</span>/**<a name="line.26"></a> -<span class="sourceLineNo">027</span> * Interface of all necessary to carry out a RPC service invocation on the server. This interface<a name="line.27"></a> -<span class="sourceLineNo">028</span> * focus on the information needed or obtained during the actual execution of the service method.<a name="line.28"></a> -<span class="sourceLineNo">029</span> */<a name="line.29"></a> -<span class="sourceLineNo">030</span>@InterfaceAudience.Private<a name="line.30"></a> -<span class="sourceLineNo">031</span>public interface RpcCallContext {<a name="line.31"></a> -<span class="sourceLineNo">032</span> /**<a name="line.32"></a> -<span class="sourceLineNo">033</span> * Check if the caller who made this IPC call has disconnected.<a name="line.33"></a> -<span class="sourceLineNo">034</span> * If called from outside the context of IPC, this does nothing.<a name="line.34"></a> -<span class="sourceLineNo">035</span> * @return &lt; 0 if the caller is still connected. The time in ms<a name="line.35"></a> -<span class="sourceLineNo">036</span> * since the disconnection otherwise<a name="line.36"></a> -<span class="sourceLineNo">037</span> */<a name="line.37"></a> -<span class="sourceLineNo">038</span> long disconnectSince();<a name="line.38"></a> -<span class="sourceLineNo">039</span><a name="line.39"></a> -<span class="sourceLineNo">040</span> /**<a name="line.40"></a> -<span class="sourceLineNo">041</span> * If the client connected and specified a codec to use, then we will use this codec making<a name="line.41"></a> -<span class="sourceLineNo">042</span> * cellblocks to return. If the client did not specify a codec, we assume it does not support<a name="line.42"></a> -<span class="sourceLineNo">043</span> * cellblocks and will return all content protobuf'd (though it makes our serving slower).<a name="line.43"></a> -<span class="sourceLineNo">044</span> * We need to ask this question per call because a server could be hosting both clients that<a name="line.44"></a> -<span class="sourceLineNo">045</span> * support cellblocks while fielding requests from clients that do not.<a name="line.45"></a> -<span class="sourceLineNo">046</span> * @return True if the client supports cellblocks, else return all content in pb<a name="line.46"></a> -<span class="sourceLineNo">047</span> */<a name="line.47"></a> -<span class="sourceLineNo">048</span> boolean isClientCellBlockSupported();<a name="line.48"></a> -<span class="sourceLineNo">049</span><a name="line.49"></a> -<span class="sourceLineNo">050</span> /**<a name="line.50"></a> -<span class="sourceLineNo">051</span> * Returns the user credentials associated with the current RPC request or<a name="line.51"></a> -<span class="sourceLineNo">052</span> * <code>null</code> if no credentials were provided.<a name="line.52"></a> -<span class="sourceLineNo">053</span> * @return A User<a name="line.53"></a> -<span class="sourceLineNo">054</span> */<a name="line.54"></a> -<span class="sourceLineNo">055</span> User getRequestUser();<a name="line.55"></a> -<span class="sourceLineNo">056</span><a name="line.56"></a> -<span class="sourceLineNo">057</span> /**<a name="line.57"></a> -<span class="sourceLineNo">058</span> * @return Current request's user name or null if none ongoing.<a name="line.58"></a> -<span class="sourceLineNo">059</span> */<a name="line.59"></a> -<span class="sourceLineNo">060</span> String getRequestUserName();<a name="line.60"></a> -<span class="sourceLineNo">061</span><a name="line.61"></a> -<span class="sourceLineNo">062</span> /**<a name="line.62"></a> -<span class="sourceLineNo">063</span> * @return Address of remote client in this call<a name="line.63"></a> -<span class="sourceLineNo">064</span> */<a name="line.64"></a> -<span class="sourceLineNo">065</span> InetAddress getRemoteAddress();<a name="line.65"></a> -<span class="sourceLineNo">066</span><a name="line.66"></a> -<span class="sourceLineNo">067</span> /**<a name="line.67"></a> -<span class="sourceLineNo">068</span> * @return the client version info, or null if the information is not present<a name="line.68"></a> -<span class="sourceLineNo">069</span> */<a name="line.69"></a> -<span class="sourceLineNo">070</span> VersionInfo getClientVersionInfo();<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> * Sets a callback which has to be executed at the end of this RPC call. Such a callback is an<a name="line.73"></a> -<span class="sourceLineNo">074</span> * optional one for any Rpc call.<a name="line.74"></a> -<span class="sourceLineNo">075</span> *<a name="line.75"></a> -<span class="sourceLineNo">076</span> * @param callback<a name="line.76"></a> -<span class="sourceLineNo">077</span> */<a name="line.77"></a> -<span class="sourceLineNo">078</span> void setCallBack(RpcCallback callback);<a name="line.78"></a> -<span class="sourceLineNo">079</span><a name="line.79"></a> -<span class="sourceLineNo">080</span> boolean isRetryImmediatelySupported();<a name="line.80"></a> -<span class="sourceLineNo">081</span><a name="line.81"></a> -<span class="sourceLineNo">082</span> /**<a name="line.82"></a> -<span class="sourceLineNo">083</span> * The size of response cells that have been accumulated so far.<a name="line.83"></a> -<span class="sourceLineNo">084</span> * This along with the corresponding increment call is used to ensure that multi's or<a name="line.84"></a> -<span class="sourceLineNo">085</span> * scans dont get too excessively large<a name="line.85"></a> -<span class="sourceLineNo">086</span> */<a name="line.86"></a> -<span class="sourceLineNo">087</span> long getResponseCellSize();<a name="line.87"></a> -<span class="sourceLineNo">088</span><a name="line.88"></a> -<span class="sourceLineNo">089</span> /**<a name="line.89"></a> -<span class="sourceLineNo">090</span> * Add on the given amount to the retained cell size.<a name="line.90"></a> -<span class="sourceLineNo">091</span> *<a name="line.91"></a> -<span class="sourceLineNo">092</span> * This is not thread safe and not synchronized at all. If this is used by more than one thread<a name="line.92"></a> -<span class="sourceLineNo">093</span> * then everything will break. Since this is called for every row synchronization would be too<a name="line.93"></a> -<span class="sourceLineNo">094</span> * onerous.<a name="line.94"></a> -<span class="sourceLineNo">095</span> */<a name="line.95"></a> -<span class="sourceLineNo">096</span> void incrementResponseCellSize(long cellSize);<a name="line.96"></a> -<span class="sourceLineNo">097</span><a name="line.97"></a> -<span class="sourceLineNo">098</span> long getResponseBlockSize();<a name="line.98"></a> -<span class="sourceLineNo">099</span><a name="line.99"></a> -<span class="sourceLineNo">100</span> void incrementResponseBlockSize(long blockSize);<a name="line.100"></a> -<span class="sourceLineNo">101</span><a name="line.101"></a> -<span class="sourceLineNo">102</span> long getResponseExceptionSize();<a name="line.102"></a> -<span class="sourceLineNo">103</span> void incrementResponseExceptionSize(long exceptionSize);<a name="line.103"></a> -<span class="sourceLineNo">104</span>}<a name="line.104"></a> +<span class="sourceLineNo">021</span>import java.util.Optional;<a name="line.21"></a> +<span class="sourceLineNo">022</span><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.hadoop.hbase.shaded.protobuf.generated.HBaseProtos.VersionInfo;<a name="line.24"></a> +<span class="sourceLineNo">025</span>import org.apache.hadoop.hbase.security.User;<a name="line.25"></a> +<span class="sourceLineNo">026</span><a name="line.26"></a> +<span class="sourceLineNo">027</span>/**<a name="line.27"></a> +<span class="sourceLineNo">028</span> * Interface of all necessary to carry out a RPC service invocation on the server. This interface<a name="line.28"></a> +<span class="sourceLineNo">029</span> * focus on the information needed or obtained during the actual execution of the service method.<a name="line.29"></a> +<span class="sourceLineNo">030</span> */<a name="line.30"></a> +<span class="sourceLineNo">031</span>@InterfaceAudience.Private<a name="line.31"></a> +<span class="sourceLineNo">032</span>public interface RpcCallContext {<a name="line.32"></a> +<span class="sourceLineNo">033</span> /**<a name="line.33"></a> +<span class="sourceLineNo">034</span> * Check if the caller who made this IPC call has disconnected.<a name="line.34"></a> +<span class="sourceLineNo">035</span> * If called from outside the context of IPC, this does nothing.<a name="line.35"></a> +<span class="sourceLineNo">036</span> * @return &lt; 0 if the caller is still connected. The time in ms<a name="line.36"></a> +<span class="sourceLineNo">037</span> * since the disconnection otherwise<a name="line.37"></a> +<span class="sourceLineNo">038</span> */<a name="line.38"></a> +<span class="sourceLineNo">039</span> long disconnectSince();<a name="line.39"></a> +<span class="sourceLineNo">040</span><a name="line.40"></a> +<span class="sourceLineNo">041</span> /**<a name="line.41"></a> +<span class="sourceLineNo">042</span> * If the client connected and specified a codec to use, then we will use this codec making<a name="line.42"></a> +<span class="sourceLineNo">043</span> * cellblocks to return. If the client did not specify a codec, we assume it does not support<a name="line.43"></a> +<span class="sourceLineNo">044</span> * cellblocks and will return all content protobuf'd (though it makes our serving slower).<a name="line.44"></a> +<span class="sourceLineNo">045</span> * We need to ask this question per call because a server could be hosting both clients that<a name="line.45"></a> +<span class="sourceLineNo">046</span> * support cellblocks while fielding requests from clients that do not.<a name="line.46"></a> +<span class="sourceLineNo">047</span> * @return True if the client supports cellblocks, else return all content in pb<a name="line.47"></a> +<span class="sourceLineNo">048</span> */<a name="line.48"></a> +<span class="sourceLineNo">049</span> boolean isClientCellBlockSupported();<a name="line.49"></a> +<span class="sourceLineNo">050</span><a name="line.50"></a> +<span class="sourceLineNo">051</span> /**<a name="line.51"></a> +<span class="sourceLineNo">052</span> * Returns the user credentials associated with the current RPC request or not present if no<a name="line.52"></a> +<span class="sourceLineNo">053</span> * credentials were provided.<a name="line.53"></a> +<span class="sourceLineNo">054</span> * @return A User<a name="line.54"></a> +<span class="sourceLineNo">055</span> */<a name="line.55"></a> +<span class="sourceLineNo">056</span> Optional<User> getRequestUser();<a name="line.56"></a> +<span class="sourceLineNo">057</span><a name="line.57"></a> +<span class="sourceLineNo">058</span> /**<a name="line.58"></a> +<span class="sourceLineNo">059</span> * @return Current request's user name or not present if none ongoing.<a name="line.59"></a> +<span class="sourceLineNo">060</span> */<a name="line.60"></a> +<span class="sourceLineNo">061</span> default Optional<String> getRequestUserName() {<a name="line.61"></a> +<span class="sourceLineNo">062</span> return getRequestUser().map(User::getShortName);<a name="line.62"></a> +<span class="sourceLineNo">063</span> }<a name="line.63"></a> +<span class="sourceLineNo">064</span><a name="line.64"></a> +<span class="sourceLineNo">065</span> /**<a name="line.65"></a> +<span class="sourceLineNo">066</span> * @return Address of remote client in this call<a name="line.66"></a> +<span class="sourceLineNo">067</span> */<a name="line.67"></a> +<span class="sourceLineNo">068</span> InetAddress getRemoteAddress();<a name="line.68"></a> +<span class="sourceLineNo">069</span><a name="line.69"></a> +<span class="sourceLineNo">070</span> /**<a name="line.70"></a> +<span class="sourceLineNo">071</span> * @return the client version info, or null if the information is not present<a name="line.71"></a> +<span class="sourceLineNo">072</span> */<a name="line.72"></a> +<span class="sourceLineNo">073</span> VersionInfo getClientVersionInfo();<a name="line.73"></a> +<span class="sourceLineNo">074</span><a name="line.74"></a> +<span class="sourceLineNo">075</span> /**<a name="line.75"></a> +<span class="sourceLineNo">076</span> * Sets a callback which has to be executed at the end of this RPC call. Such a callback is an<a name="line.76"></a> +<span class="sourceLineNo">077</span> * optional one for any Rpc call.<a name="line.77"></a> +<span class="sourceLineNo">078</span> *<a name="line.78"></a> +<span class="sourceLineNo">079</span> * @param callback<a name="line.79"></a> +<span class="sourceLineNo">080</span> */<a name="line.80"></a> +<span class="sourceLineNo">081</span> void setCallBack(RpcCallback callback);<a name="line.81"></a> +<span class="sourceLineNo">082</span><a name="line.82"></a> +<span class="sourceLineNo">083</span> boolean isRetryImmediatelySupported();<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> * The size of response cells that have been accumulated so far.<a name="line.86"></a> +<span class="sourceLineNo">087</span> * This along with the corresponding increment call is used to ensure that multi's or<a name="line.87"></a> +<span class="sourceLineNo">088</span> * scans dont get too excessively large<a name="line.88"></a> +<span class="sourceLineNo">089</span> */<a name="line.89"></a> +<span class="sourceLineNo">090</span> long getResponseCellSize();<a name="line.90"></a> +<span class="sourceLineNo">091</span><a name="line.91"></a> +<span class="sourceLineNo">092</span> /**<a name="line.92"></a> +<span class="sourceLineNo">093</span> * Add on the given amount to the retained cell size.<a name="line.93"></a> +<span class="sourceLineNo">094</span> *<a name="line.94"></a> +<span class="sourceLineNo">095</span> * This is not thread safe and not synchronized at all. If this is used by more than one thread<a name="line.95"></a> +<span class="sourceLineNo">096</span> * then everything will break. Since this is called for every row synchronization would be too<a name="line.96"></a> +<span class="sourceLineNo">097</span> * onerous.<a name="line.97"></a> +<span class="sourceLineNo">098</span> */<a name="line.98"></a> +<span class="sourceLineNo">099</span> void incrementResponseCellSize(long cellSize);<a name="line.99"></a> +<span class="sourceLineNo">100</span><a name="line.100"></a> +<span class="sourceLineNo">101</span> long getResponseBlockSize();<a name="line.101"></a> +<span class="sourceLineNo">102</span><a name="line.102"></a> +<span class="sourceLineNo">103</span> void incrementResponseBlockSize(long blockSize);<a name="line.103"></a> +<span class="sourceLineNo">104</span><a name="line.104"></a> +<span class="sourceLineNo">105</span> long getResponseExceptionSize();<a name="line.105"></a> +<span class="sourceLineNo">106</span> void incrementResponseExceptionSize(long exceptionSize);<a name="line.106"></a> +<span class="sourceLineNo">107</span>}<a name="line.107"></a>
