| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>Source code</title> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <meta name="description" content="source: package: org.apache.hadoop.hbase.ipc, class: ServerRpcController"> |
| <meta name="generator" content="javadoc/SourceToHTMLConverter"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> |
| </head> |
| <body class="source-page"> |
| <main role="main"> |
| <div class="source-container"> |
| <pre><span class="source-line-no">001</span><span id="line-1">/*</span> |
| <span class="source-line-no">002</span><span id="line-2"> * Licensed to the Apache Software Foundation (ASF) under one</span> |
| <span class="source-line-no">003</span><span id="line-3"> * or more contributor license agreements. See the NOTICE file</span> |
| <span class="source-line-no">004</span><span id="line-4"> * distributed with this work for additional information</span> |
| <span class="source-line-no">005</span><span id="line-5"> * regarding copyright ownership. The ASF licenses this file</span> |
| <span class="source-line-no">006</span><span id="line-6"> * to you under the Apache License, Version 2.0 (the</span> |
| <span class="source-line-no">007</span><span id="line-7"> * "License"); you may not use this file except in compliance</span> |
| <span class="source-line-no">008</span><span id="line-8"> * with the License. You may obtain a copy of the License at</span> |
| <span class="source-line-no">009</span><span id="line-9"> *</span> |
| <span class="source-line-no">010</span><span id="line-10"> * http://www.apache.org/licenses/LICENSE-2.0</span> |
| <span class="source-line-no">011</span><span id="line-11"> *</span> |
| <span class="source-line-no">012</span><span id="line-12"> * Unless required by applicable law or agreed to in writing, software</span> |
| <span class="source-line-no">013</span><span id="line-13"> * distributed under the License is distributed on an "AS IS" BASIS,</span> |
| <span class="source-line-no">014</span><span id="line-14"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span> |
| <span class="source-line-no">015</span><span id="line-15"> * See the License for the specific language governing permissions and</span> |
| <span class="source-line-no">016</span><span id="line-16"> * limitations under the License.</span> |
| <span class="source-line-no">017</span><span id="line-17"> */</span> |
| <span class="source-line-no">018</span><span id="line-18">package org.apache.hadoop.hbase.ipc;</span> |
| <span class="source-line-no">019</span><span id="line-19"></span> |
| <span class="source-line-no">020</span><span id="line-20">import java.io.IOException;</span> |
| <span class="source-line-no">021</span><span id="line-21">import org.apache.hadoop.util.StringUtils;</span> |
| <span class="source-line-no">022</span><span id="line-22">import org.apache.yetus.audience.InterfaceAudience;</span> |
| <span class="source-line-no">023</span><span id="line-23"></span> |
| <span class="source-line-no">024</span><span id="line-24">import org.apache.hbase.thirdparty.com.google.protobuf.RpcCallback;</span> |
| <span class="source-line-no">025</span><span id="line-25">import org.apache.hbase.thirdparty.com.google.protobuf.RpcController;</span> |
| <span class="source-line-no">026</span><span id="line-26"></span> |
| <span class="source-line-no">027</span><span id="line-27">/**</span> |
| <span class="source-line-no">028</span><span id="line-28"> * Used for server-side protobuf RPC service invocations. This handler allows invocation exceptions</span> |
| <span class="source-line-no">029</span><span id="line-29"> * to easily be passed through to the RPC server from coprocessor</span> |
| <span class="source-line-no">030</span><span id="line-30"> * {@link org.apache.hbase.thirdparty.com.google.protobuf.Service} implementations.</span> |
| <span class="source-line-no">031</span><span id="line-31"> * <p/></span> |
| <span class="source-line-no">032</span><span id="line-32"> * When implementing {@link org.apache.hbase.thirdparty.com.google.protobuf.Service} defined</span> |
| <span class="source-line-no">033</span><span id="line-33"> * methods, coprocessor endpoints can use the following pattern to pass exceptions back to the RPC</span> |
| <span class="source-line-no">034</span><span id="line-34"> * client: <code></span> |
| <span class="source-line-no">035</span><span id="line-35"> * public void myMethod(RpcController controller, MyRequest request,</span> |
| <span class="source-line-no">036</span><span id="line-36"> * RpcCallback&lt;MyResponse&gt; done) {</span> |
| <span class="source-line-no">037</span><span id="line-37"> * MyResponse response = null;</span> |
| <span class="source-line-no">038</span><span id="line-38"> * try {</span> |
| <span class="source-line-no">039</span><span id="line-39"> * // do processing</span> |
| <span class="source-line-no">040</span><span id="line-40"> * response = MyResponse.getDefaultInstance(); // or use a new builder to populate the response</span> |
| <span class="source-line-no">041</span><span id="line-41"> * } catch (IOException ioe) {</span> |
| <span class="source-line-no">042</span><span id="line-42"> * // pass exception back up</span> |
| <span class="source-line-no">043</span><span id="line-43"> * ResponseConverter.setControllerException(controller, ioe);</span> |
| <span class="source-line-no">044</span><span id="line-44"> * }</span> |
| <span class="source-line-no">045</span><span id="line-45"> * done.run(response);</span> |
| <span class="source-line-no">046</span><span id="line-46"> * }</span> |
| <span class="source-line-no">047</span><span id="line-47"> * </code></span> |
| <span class="source-line-no">048</span><span id="line-48"> */</span> |
| <span class="source-line-no">049</span><span id="line-49">@InterfaceAudience.Private</span> |
| <span class="source-line-no">050</span><span id="line-50">public class ServerRpcController implements RpcController {</span> |
| <span class="source-line-no">051</span><span id="line-51"> /**</span> |
| <span class="source-line-no">052</span><span id="line-52"> * The exception thrown within</span> |
| <span class="source-line-no">053</span><span id="line-53"> * {@link com.google.protobuf.Service#callMethod(com.google.protobuf.Descriptors.MethodDescriptor, RpcController, com.google.protobuf.Message, RpcCallback)}</span> |
| <span class="source-line-no">054</span><span id="line-54"> * if any.</span> |
| <span class="source-line-no">055</span><span id="line-55"> */</span> |
| <span class="source-line-no">056</span><span id="line-56"> // TODO: it would be good widen this to just Throwable, but IOException is what we allow now</span> |
| <span class="source-line-no">057</span><span id="line-57"> private IOException serviceException;</span> |
| <span class="source-line-no">058</span><span id="line-58"> private String errorMessage;</span> |
| <span class="source-line-no">059</span><span id="line-59"></span> |
| <span class="source-line-no">060</span><span id="line-60"> @Override</span> |
| <span class="source-line-no">061</span><span id="line-61"> public void reset() {</span> |
| <span class="source-line-no">062</span><span id="line-62"> serviceException = null;</span> |
| <span class="source-line-no">063</span><span id="line-63"> errorMessage = null;</span> |
| <span class="source-line-no">064</span><span id="line-64"> }</span> |
| <span class="source-line-no">065</span><span id="line-65"></span> |
| <span class="source-line-no">066</span><span id="line-66"> @Override</span> |
| <span class="source-line-no">067</span><span id="line-67"> public boolean failed() {</span> |
| <span class="source-line-no">068</span><span id="line-68"> return (failedOnException() || errorMessage != null);</span> |
| <span class="source-line-no">069</span><span id="line-69"> }</span> |
| <span class="source-line-no">070</span><span id="line-70"></span> |
| <span class="source-line-no">071</span><span id="line-71"> @Override</span> |
| <span class="source-line-no">072</span><span id="line-72"> public String errorText() {</span> |
| <span class="source-line-no">073</span><span id="line-73"> return errorMessage;</span> |
| <span class="source-line-no">074</span><span id="line-74"> }</span> |
| <span class="source-line-no">075</span><span id="line-75"></span> |
| <span class="source-line-no">076</span><span id="line-76"> @Override</span> |
| <span class="source-line-no">077</span><span id="line-77"> public void startCancel() {</span> |
| <span class="source-line-no">078</span><span id="line-78"> // not implemented</span> |
| <span class="source-line-no">079</span><span id="line-79"> }</span> |
| <span class="source-line-no">080</span><span id="line-80"></span> |
| <span class="source-line-no">081</span><span id="line-81"> @Override</span> |
| <span class="source-line-no">082</span><span id="line-82"> public void setFailed(String message) {</span> |
| <span class="source-line-no">083</span><span id="line-83"> errorMessage = message;</span> |
| <span class="source-line-no">084</span><span id="line-84"> }</span> |
| <span class="source-line-no">085</span><span id="line-85"></span> |
| <span class="source-line-no">086</span><span id="line-86"> @Override</span> |
| <span class="source-line-no">087</span><span id="line-87"> public boolean isCanceled() {</span> |
| <span class="source-line-no">088</span><span id="line-88"> return false;</span> |
| <span class="source-line-no">089</span><span id="line-89"> }</span> |
| <span class="source-line-no">090</span><span id="line-90"></span> |
| <span class="source-line-no">091</span><span id="line-91"> @Override</span> |
| <span class="source-line-no">092</span><span id="line-92"> public void notifyOnCancel(RpcCallback<Object> objectRpcCallback) {</span> |
| <span class="source-line-no">093</span><span id="line-93"> // not implemented</span> |
| <span class="source-line-no">094</span><span id="line-94"> }</span> |
| <span class="source-line-no">095</span><span id="line-95"></span> |
| <span class="source-line-no">096</span><span id="line-96"> /**</span> |
| <span class="source-line-no">097</span><span id="line-97"> * Sets an exception to be communicated back to the</span> |
| <span class="source-line-no">098</span><span id="line-98"> * {@link org.apache.hbase.thirdparty.com.google.protobuf.Service} client.</span> |
| <span class="source-line-no">099</span><span id="line-99"> * @param ioe the exception encountered during execution of the service method</span> |
| <span class="source-line-no">100</span><span id="line-100"> */</span> |
| <span class="source-line-no">101</span><span id="line-101"> public void setFailedOn(IOException ioe) {</span> |
| <span class="source-line-no">102</span><span id="line-102"> serviceException = ioe;</span> |
| <span class="source-line-no">103</span><span id="line-103"> setFailed(StringUtils.stringifyException(ioe));</span> |
| <span class="source-line-no">104</span><span id="line-104"> }</span> |
| <span class="source-line-no">105</span><span id="line-105"></span> |
| <span class="source-line-no">106</span><span id="line-106"> /**</span> |
| <span class="source-line-no">107</span><span id="line-107"> * Returns any exception thrown during service method invocation, or {@code null} if no exception</span> |
| <span class="source-line-no">108</span><span id="line-108"> * was thrown. This can be used by clients to receive exceptions generated by RPC calls, even when</span> |
| <span class="source-line-no">109</span><span id="line-109"> * {@link RpcCallback}s are used and no</span> |
| <span class="source-line-no">110</span><span id="line-110"> * {@link org.apache.hbase.thirdparty.com.google.protobuf.ServiceException} is declared.</span> |
| <span class="source-line-no">111</span><span id="line-111"> */</span> |
| <span class="source-line-no">112</span><span id="line-112"> public IOException getFailedOn() {</span> |
| <span class="source-line-no">113</span><span id="line-113"> return serviceException;</span> |
| <span class="source-line-no">114</span><span id="line-114"> }</span> |
| <span class="source-line-no">115</span><span id="line-115"></span> |
| <span class="source-line-no">116</span><span id="line-116"> /**</span> |
| <span class="source-line-no">117</span><span id="line-117"> * Returns whether or not a server exception was generated in the prior RPC invocation.</span> |
| <span class="source-line-no">118</span><span id="line-118"> */</span> |
| <span class="source-line-no">119</span><span id="line-119"> public boolean failedOnException() {</span> |
| <span class="source-line-no">120</span><span id="line-120"> return serviceException != null;</span> |
| <span class="source-line-no">121</span><span id="line-121"> }</span> |
| <span class="source-line-no">122</span><span id="line-122"></span> |
| <span class="source-line-no">123</span><span id="line-123"> /**</span> |
| <span class="source-line-no">124</span><span id="line-124"> * Throws an IOException back out if one is currently stored.</span> |
| <span class="source-line-no">125</span><span id="line-125"> */</span> |
| <span class="source-line-no">126</span><span id="line-126"> public void checkFailed() throws IOException {</span> |
| <span class="source-line-no">127</span><span id="line-127"> if (failedOnException()) {</span> |
| <span class="source-line-no">128</span><span id="line-128"> throw getFailedOn();</span> |
| <span class="source-line-no">129</span><span id="line-129"> }</span> |
| <span class="source-line-no">130</span><span id="line-130"> }</span> |
| <span class="source-line-no">131</span><span id="line-131">}</span> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </main> |
| </body> |
| </html> |
