blob: b8e3fb40400c66fc914b3d3bd4ee04be0c1e1c0b [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.procedure2;<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><a name="line.21"></a>
<span class="sourceLineNo">022</span>import org.apache.hadoop.hbase.util.ForeignExceptionUtil;<a name="line.22"></a>
<span class="sourceLineNo">023</span>import org.apache.hadoop.ipc.RemoteException;<a name="line.23"></a>
<span class="sourceLineNo">024</span>import org.apache.yetus.audience.InterfaceAudience;<a name="line.24"></a>
<span class="sourceLineNo">025</span>import org.apache.yetus.audience.InterfaceStability;<a name="line.25"></a>
<span class="sourceLineNo">026</span><a name="line.26"></a>
<span class="sourceLineNo">027</span>import org.apache.hadoop.hbase.shaded.protobuf.generated.ErrorHandlingProtos.ForeignExceptionMessage;<a name="line.27"></a>
<span class="sourceLineNo">028</span><a name="line.28"></a>
<span class="sourceLineNo">029</span>/**<a name="line.29"></a>
<span class="sourceLineNo">030</span> * A RemoteProcedureException is an exception from another thread or process.<a name="line.30"></a>
<span class="sourceLineNo">031</span> * &lt;p&gt;<a name="line.31"></a>
<span class="sourceLineNo">032</span> * RemoteProcedureExceptions are sent to 'remote' peers to signal an abort in the face of failures.<a name="line.32"></a>
<span class="sourceLineNo">033</span> * When serialized for transmission we encode using Protobufs to ensure version compatibility.<a name="line.33"></a>
<span class="sourceLineNo">034</span> * &lt;p&gt;<a name="line.34"></a>
<span class="sourceLineNo">035</span> * RemoteProcedureException exceptions contain a Throwable as its cause.<a name="line.35"></a>
<span class="sourceLineNo">036</span> * This can be a "regular" exception generated locally or a ProxyThrowable that is a representation<a name="line.36"></a>
<span class="sourceLineNo">037</span> * of the original exception created on original 'remote' source. These ProxyThrowables have their<a name="line.37"></a>
<span class="sourceLineNo">038</span> * their stacks traces and messages overridden to reflect the original 'remote' exception.<a name="line.38"></a>
<span class="sourceLineNo">039</span> */<a name="line.39"></a>
<span class="sourceLineNo">040</span>@InterfaceAudience.Private<a name="line.40"></a>
<span class="sourceLineNo">041</span>@InterfaceStability.Evolving<a name="line.41"></a>
<span class="sourceLineNo">042</span>@SuppressWarnings("serial")<a name="line.42"></a>
<span class="sourceLineNo">043</span>public class RemoteProcedureException extends ProcedureException {<a name="line.43"></a>
<span class="sourceLineNo">044</span> /**<a name="line.44"></a>
<span class="sourceLineNo">045</span> * Name of the throwable's source such as a host or thread name. Must be non-null.<a name="line.45"></a>
<span class="sourceLineNo">046</span> */<a name="line.46"></a>
<span class="sourceLineNo">047</span> private final String source;<a name="line.47"></a>
<span class="sourceLineNo">048</span><a name="line.48"></a>
<span class="sourceLineNo">049</span> /**<a name="line.49"></a>
<span class="sourceLineNo">050</span> * Create a new RemoteProcedureException that can be serialized.<a name="line.50"></a>
<span class="sourceLineNo">051</span> * It is assumed that this came form a local source.<a name="line.51"></a>
<span class="sourceLineNo">052</span> * @param source the host or thread name of the source<a name="line.52"></a>
<span class="sourceLineNo">053</span> * @param cause the actual cause of the exception<a name="line.53"></a>
<span class="sourceLineNo">054</span> */<a name="line.54"></a>
<span class="sourceLineNo">055</span> public RemoteProcedureException(String source, Throwable cause) {<a name="line.55"></a>
<span class="sourceLineNo">056</span> super(cause);<a name="line.56"></a>
<span class="sourceLineNo">057</span> assert source != null;<a name="line.57"></a>
<span class="sourceLineNo">058</span> assert cause != null;<a name="line.58"></a>
<span class="sourceLineNo">059</span> this.source = source;<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> public String getSource() {<a name="line.62"></a>
<span class="sourceLineNo">063</span> return source;<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> public Exception unwrapRemoteException() {<a name="line.66"></a>
<span class="sourceLineNo">067</span> final Throwable cause = getCause();<a name="line.67"></a>
<span class="sourceLineNo">068</span> if (cause instanceof RemoteException) {<a name="line.68"></a>
<span class="sourceLineNo">069</span> return ((RemoteException)cause).unwrapRemoteException();<a name="line.69"></a>
<span class="sourceLineNo">070</span> }<a name="line.70"></a>
<span class="sourceLineNo">071</span> if (cause instanceof Exception) {<a name="line.71"></a>
<span class="sourceLineNo">072</span> return (Exception)cause;<a name="line.72"></a>
<span class="sourceLineNo">073</span> }<a name="line.73"></a>
<span class="sourceLineNo">074</span> return new Exception(cause);<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> // NOTE: Does not throw DoNotRetryIOE because it does not<a name="line.77"></a>
<span class="sourceLineNo">078</span> // have access (DNRIOE is in the client module). Use<a name="line.78"></a>
<span class="sourceLineNo">079</span> // MasterProcedureUtil.unwrapRemoteIOException if need to<a name="line.79"></a>
<span class="sourceLineNo">080</span> // throw DNRIOE.<a name="line.80"></a>
<span class="sourceLineNo">081</span> public IOException unwrapRemoteIOException() {<a name="line.81"></a>
<span class="sourceLineNo">082</span> final Exception cause = unwrapRemoteException();<a name="line.82"></a>
<span class="sourceLineNo">083</span> if (cause instanceof IOException) {<a name="line.83"></a>
<span class="sourceLineNo">084</span> return (IOException)cause;<a name="line.84"></a>
<span class="sourceLineNo">085</span> }<a name="line.85"></a>
<span class="sourceLineNo">086</span> return new IOException(cause);<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> @Override<a name="line.89"></a>
<span class="sourceLineNo">090</span> public String toString() {<a name="line.90"></a>
<span class="sourceLineNo">091</span> String className = getCause().getClass().getName();<a name="line.91"></a>
<span class="sourceLineNo">092</span> return className + " via " + getSource() + ":" + getLocalizedMessage();<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> /**<a name="line.95"></a>
<span class="sourceLineNo">096</span> * Converts a RemoteProcedureException to an array of bytes.<a name="line.96"></a>
<span class="sourceLineNo">097</span> * @param source the name of the external exception source<a name="line.97"></a>
<span class="sourceLineNo">098</span> * @param t the "local" external exception (local)<a name="line.98"></a>
<span class="sourceLineNo">099</span> * @return protobuf serialized version of RemoteProcedureException<a name="line.99"></a>
<span class="sourceLineNo">100</span> */<a name="line.100"></a>
<span class="sourceLineNo">101</span> public static byte[] serialize(String source, Throwable t) {<a name="line.101"></a>
<span class="sourceLineNo">102</span> return toProto(source, t).toByteArray();<a name="line.102"></a>
<span class="sourceLineNo">103</span> }<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> * Takes a series of bytes and tries to generate an RemoteProcedureException instance for it.<a name="line.106"></a>
<span class="sourceLineNo">107</span> * @param bytes the bytes to generate the {@link RemoteProcedureException} from<a name="line.107"></a>
<span class="sourceLineNo">108</span> * @return the ForeignExcpetion instance<a name="line.108"></a>
<span class="sourceLineNo">109</span> * @throws IOException if there was deserialization problem this is thrown.<a name="line.109"></a>
<span class="sourceLineNo">110</span> */<a name="line.110"></a>
<span class="sourceLineNo">111</span> public static RemoteProcedureException deserialize(byte[] bytes) throws IOException {<a name="line.111"></a>
<span class="sourceLineNo">112</span> return fromProto(ForeignExceptionMessage.parseFrom(bytes));<a name="line.112"></a>
<span class="sourceLineNo">113</span> }<a name="line.113"></a>
<span class="sourceLineNo">114</span><a name="line.114"></a>
<span class="sourceLineNo">115</span> public ForeignExceptionMessage convert() {<a name="line.115"></a>
<span class="sourceLineNo">116</span> return ForeignExceptionUtil.toProtoForeignException(getSource(), getCause());<a name="line.116"></a>
<span class="sourceLineNo">117</span> }<a name="line.117"></a>
<span class="sourceLineNo">118</span><a name="line.118"></a>
<span class="sourceLineNo">119</span> public static ForeignExceptionMessage toProto(String source, Throwable t) {<a name="line.119"></a>
<span class="sourceLineNo">120</span> return ForeignExceptionUtil.toProtoForeignException(source, t);<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> public static RemoteProcedureException fromProto(final ForeignExceptionMessage eem) {<a name="line.123"></a>
<span class="sourceLineNo">124</span> return new RemoteProcedureException(eem.getSource(), ForeignExceptionUtil.toException(eem));<a name="line.124"></a>
<span class="sourceLineNo">125</span> }<a name="line.125"></a>
<span class="sourceLineNo">126</span>}<a name="line.126"></a>
</pre>
</div>
</body>
</html>