Google Git
Sign in
apache / hbase-site / 04d84309f461b17a4b831dc614b99426e0657ffd / . / devapidocs / src-html / org / apache / hadoop / hbase / ipc / ServerRpcController.html
blob: 9f6e5b23647099ed02f6a3df510a4dc0db6e30d2 [file] [log] [blame]
<!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.ipc;<a name="line.18"></a>
<span class="sourceLineNo">019</span><a name="line.19"></a>
<span class="sourceLineNo">020</span>import java.io.IOException;<a name="line.20"></a>
<span class="sourceLineNo">021</span>import org.apache.hadoop.util.StringUtils;<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><a name="line.23"></a>
<span class="sourceLineNo">024</span>import org.apache.hbase.thirdparty.com.google.protobuf.RpcCallback;<a name="line.24"></a>
<span class="sourceLineNo">025</span>import org.apache.hbase.thirdparty.com.google.protobuf.RpcController;<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> * Used for server-side protobuf RPC service invocations. This handler allows invocation exceptions<a name="line.28"></a>
<span class="sourceLineNo">029</span> * to easily be passed through to the RPC server from coprocessor<a name="line.29"></a>
<span class="sourceLineNo">030</span> * {@link org.apache.hbase.thirdparty.com.google.protobuf.Service} implementations.<a name="line.30"></a>
<span class="sourceLineNo">031</span> * &lt;p/&gt;<a name="line.31"></a>
<span class="sourceLineNo">032</span> * When implementing {@link org.apache.hbase.thirdparty.com.google.protobuf.Service} defined<a name="line.32"></a>
<span class="sourceLineNo">033</span> * methods, coprocessor endpoints can use the following pattern to pass exceptions back to the RPC<a name="line.33"></a>
<span class="sourceLineNo">034</span> * client: &lt;code&gt;<a name="line.34"></a>
<span class="sourceLineNo">035</span> * public void myMethod(RpcController controller, MyRequest request,<a name="line.35"></a>
<span class="sourceLineNo">036</span> * RpcCallback&amp;lt;MyResponse&amp;gt; done) {<a name="line.36"></a>
<span class="sourceLineNo">037</span> * MyResponse response = null;<a name="line.37"></a>
<span class="sourceLineNo">038</span> * try {<a name="line.38"></a>
<span class="sourceLineNo">039</span> * // do processing<a name="line.39"></a>
<span class="sourceLineNo">040</span> * response = MyResponse.getDefaultInstance(); // or use a new builder to populate the response<a name="line.40"></a>
<span class="sourceLineNo">041</span> * } catch (IOException ioe) {<a name="line.41"></a>
<span class="sourceLineNo">042</span> * // pass exception back up<a name="line.42"></a>
<span class="sourceLineNo">043</span> * ResponseConverter.setControllerException(controller, ioe);<a name="line.43"></a>
<span class="sourceLineNo">044</span> * }<a name="line.44"></a>
<span class="sourceLineNo">045</span> * done.run(response);<a name="line.45"></a>
<span class="sourceLineNo">046</span> * }<a name="line.46"></a>
<span class="sourceLineNo">047</span> * &lt;/code&gt;<a name="line.47"></a>
<span class="sourceLineNo">048</span> */<a name="line.48"></a>
<span class="sourceLineNo">049</span>@InterfaceAudience.Private<a name="line.49"></a>
<span class="sourceLineNo">050</span>public class ServerRpcController implements RpcController {<a name="line.50"></a>
<span class="sourceLineNo">051</span> /**<a name="line.51"></a>
<span class="sourceLineNo">052</span> * The exception thrown within<a name="line.52"></a>
<span class="sourceLineNo">053</span> * {@link com.google.protobuf.Service#callMethod(com.google.protobuf.Descriptors.MethodDescriptor, RpcController, com.google.protobuf.Message, RpcCallback)}<a name="line.53"></a>
<span class="sourceLineNo">054</span> * if any.<a name="line.54"></a>
<span class="sourceLineNo">055</span> */<a name="line.55"></a>
<span class="sourceLineNo">056</span> // TODO: it would be good widen this to just Throwable, but IOException is what we allow now<a name="line.56"></a>
<span class="sourceLineNo">057</span> private IOException serviceException;<a name="line.57"></a>
<span class="sourceLineNo">058</span> private String errorMessage;<a name="line.58"></a>
<span class="sourceLineNo">059</span><a name="line.59"></a>
<span class="sourceLineNo">060</span> @Override<a name="line.60"></a>
<span class="sourceLineNo">061</span> public void reset() {<a name="line.61"></a>
<span class="sourceLineNo">062</span> serviceException = null;<a name="line.62"></a>
<span class="sourceLineNo">063</span> errorMessage = null;<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> @Override<a name="line.66"></a>
<span class="sourceLineNo">067</span> public boolean failed() {<a name="line.67"></a>
<span class="sourceLineNo">068</span> return (failedOnException() || errorMessage != null);<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> @Override<a name="line.71"></a>
<span class="sourceLineNo">072</span> public String errorText() {<a name="line.72"></a>
<span class="sourceLineNo">073</span> return errorMessage;<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> @Override<a name="line.76"></a>
<span class="sourceLineNo">077</span> public void startCancel() {<a name="line.77"></a>
<span class="sourceLineNo">078</span> // not implemented<a name="line.78"></a>
<span class="sourceLineNo">079</span> }<a name="line.79"></a>
<span class="sourceLineNo">080</span><a name="line.80"></a>
<span class="sourceLineNo">081</span> @Override<a name="line.81"></a>
<span class="sourceLineNo">082</span> public void setFailed(String message) {<a name="line.82"></a>
<span class="sourceLineNo">083</span> errorMessage = message;<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> @Override<a name="line.86"></a>
<span class="sourceLineNo">087</span> public boolean isCanceled() {<a name="line.87"></a>
<span class="sourceLineNo">088</span> return false;<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> @Override<a name="line.91"></a>
<span class="sourceLineNo">092</span> public void notifyOnCancel(RpcCallback&lt;Object&gt; objectRpcCallback) {<a name="line.92"></a>
<span class="sourceLineNo">093</span> // not implemented<a name="line.93"></a>
<span class="sourceLineNo">094</span> }<a name="line.94"></a>
<span class="sourceLineNo">095</span><a name="line.95"></a>
<span class="sourceLineNo">096</span> /**<a name="line.96"></a>
<span class="sourceLineNo">097</span> * Sets an exception to be communicated back to the<a name="line.97"></a>
<span class="sourceLineNo">098</span> * {@link org.apache.hbase.thirdparty.com.google.protobuf.Service} client.<a name="line.98"></a>
<span class="sourceLineNo">099</span> * @param ioe the exception encountered during execution of the service method<a name="line.99"></a>
<span class="sourceLineNo">100</span> */<a name="line.100"></a>
<span class="sourceLineNo">101</span> public void setFailedOn(IOException ioe) {<a name="line.101"></a>
<span class="sourceLineNo">102</span> serviceException = ioe;<a name="line.102"></a>
<span class="sourceLineNo">103</span> setFailed(StringUtils.stringifyException(ioe));<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>
<span class="sourceLineNo">106</span> /**<a name="line.106"></a>
<span class="sourceLineNo">107</span> * Returns any exception thrown during service method invocation, or {@code null} if no exception<a name="line.107"></a>
<span class="sourceLineNo">108</span> * was thrown. This can be used by clients to receive exceptions generated by RPC calls, even when<a name="line.108"></a>
<span class="sourceLineNo">109</span> * {@link RpcCallback}s are used and no<a name="line.109"></a>
<span class="sourceLineNo">110</span> * {@link org.apache.hbase.thirdparty.com.google.protobuf.ServiceException} is declared.<a name="line.110"></a>
<span class="sourceLineNo">111</span> */<a name="line.111"></a>
<span class="sourceLineNo">112</span> public IOException getFailedOn() {<a name="line.112"></a>
<span class="sourceLineNo">113</span> return serviceException;<a name="line.113"></a>
<span class="sourceLineNo">114</span> }<a name="line.114"></a>
<span class="sourceLineNo">115</span><a name="line.115"></a>
<span class="sourceLineNo">116</span> /**<a name="line.116"></a>
<span class="sourceLineNo">117</span> * Returns whether or not a server exception was generated in the prior RPC invocation.<a name="line.117"></a>
<span class="sourceLineNo">118</span> */<a name="line.118"></a>
<span class="sourceLineNo">119</span> public boolean failedOnException() {<a name="line.119"></a>
<span class="sourceLineNo">120</span> return serviceException != null;<a name="line.120"></a>
<span class="sourceLineNo">121</span> }<a name="line.121"></a>
<span class="sourceLineNo">122</span><a name="line.122"></a>
<span class="sourceLineNo">123</span> /**<a name="line.123"></a>
<span class="sourceLineNo">124</span> * Throws an IOException back out if one is currently stored.<a name="line.124"></a>
<span class="sourceLineNo">125</span> */<a name="line.125"></a>
<span class="sourceLineNo">126</span> public void checkFailed() throws IOException {<a name="line.126"></a>
<span class="sourceLineNo">127</span> if (failedOnException()) {<a name="line.127"></a>
<span class="sourceLineNo">128</span> throw getFailedOn();<a name="line.128"></a>
<span class="sourceLineNo">129</span> }<a name="line.129"></a>
<span class="sourceLineNo">130</span> }<a name="line.130"></a>
<span class="sourceLineNo">131</span>}<a name="line.131"></a>
</pre>
</div>
</body>
</html>