Google Git
Sign in
apache / hbase-site / 2b6b4d6f00a7a835910d90ac476efb4526b3005d / . / devapidocs / src-html / org / apache / hadoop / hbase / exceptions / ClientExceptionsUtil.html
blob: 0d7c9afa029c4d3a5b523e60d42895628d6b6309 [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> *<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">019</span><a name="line.19"></a>
<span class="sourceLineNo">020</span>package org.apache.hadoop.hbase.exceptions;<a name="line.20"></a>
<span class="sourceLineNo">021</span><a name="line.21"></a>
<span class="sourceLineNo">022</span>import java.io.EOFException;<a name="line.22"></a>
<span class="sourceLineNo">023</span>import java.io.IOException;<a name="line.23"></a>
<span class="sourceLineNo">024</span>import java.io.SyncFailedException;<a name="line.24"></a>
<span class="sourceLineNo">025</span>import java.lang.reflect.UndeclaredThrowableException;<a name="line.25"></a>
<span class="sourceLineNo">026</span>import java.net.ConnectException;<a name="line.26"></a>
<span class="sourceLineNo">027</span>import java.net.SocketTimeoutException;<a name="line.27"></a>
<span class="sourceLineNo">028</span>import java.nio.channels.ClosedChannelException;<a name="line.28"></a>
<span class="sourceLineNo">029</span>import java.util.Set;<a name="line.29"></a>
<span class="sourceLineNo">030</span>import java.util.concurrent.TimeoutException;<a name="line.30"></a>
<span class="sourceLineNo">031</span><a name="line.31"></a>
<span class="sourceLineNo">032</span>import org.apache.hadoop.hbase.CallDroppedException;<a name="line.32"></a>
<span class="sourceLineNo">033</span>import org.apache.hadoop.hbase.CallQueueTooBigException;<a name="line.33"></a>
<span class="sourceLineNo">034</span>import org.apache.hadoop.hbase.DoNotRetryIOException;<a name="line.34"></a>
<span class="sourceLineNo">035</span>import org.apache.hadoop.hbase.NotServingRegionException;<a name="line.35"></a>
<span class="sourceLineNo">036</span>import org.apache.hadoop.hbase.RegionTooBusyException;<a name="line.36"></a>
<span class="sourceLineNo">037</span>import org.apache.hadoop.hbase.RetryImmediatelyException;<a name="line.37"></a>
<span class="sourceLineNo">038</span>import org.apache.yetus.audience.InterfaceAudience;<a name="line.38"></a>
<span class="sourceLineNo">039</span>import org.apache.yetus.audience.InterfaceStability;<a name="line.39"></a>
<span class="sourceLineNo">040</span><a name="line.40"></a>
<span class="sourceLineNo">041</span>import org.apache.hbase.thirdparty.com.google.common.annotations.VisibleForTesting;<a name="line.41"></a>
<span class="sourceLineNo">042</span>import org.apache.hbase.thirdparty.com.google.common.collect.ImmutableSet;<a name="line.42"></a>
<span class="sourceLineNo">043</span><a name="line.43"></a>
<span class="sourceLineNo">044</span>import org.apache.hadoop.hbase.ipc.CallTimeoutException;<a name="line.44"></a>
<span class="sourceLineNo">045</span>import org.apache.hadoop.hbase.ipc.FailedServerException;<a name="line.45"></a>
<span class="sourceLineNo">046</span>import org.apache.hadoop.hbase.quotas.RpcThrottlingException;<a name="line.46"></a>
<span class="sourceLineNo">047</span>import org.apache.hadoop.ipc.RemoteException;<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>@InterfaceStability.Evolving<a name="line.50"></a>
<span class="sourceLineNo">051</span>public final class ClientExceptionsUtil {<a name="line.51"></a>
<span class="sourceLineNo">052</span><a name="line.52"></a>
<span class="sourceLineNo">053</span> private ClientExceptionsUtil() {}<a name="line.53"></a>
<span class="sourceLineNo">054</span><a name="line.54"></a>
<span class="sourceLineNo">055</span> public static boolean isMetaClearingException(Throwable cur) {<a name="line.55"></a>
<span class="sourceLineNo">056</span> cur = findException(cur);<a name="line.56"></a>
<span class="sourceLineNo">057</span><a name="line.57"></a>
<span class="sourceLineNo">058</span> if (cur == null) {<a name="line.58"></a>
<span class="sourceLineNo">059</span> return true;<a name="line.59"></a>
<span class="sourceLineNo">060</span> }<a name="line.60"></a>
<span class="sourceLineNo">061</span> return !regionDefinitelyOnTheRegionServerException(cur);<a name="line.61"></a>
<span class="sourceLineNo">062</span> }<a name="line.62"></a>
<span class="sourceLineNo">063</span><a name="line.63"></a>
<span class="sourceLineNo">064</span> private static boolean regionDefinitelyOnTheRegionServerException(Throwable t) {<a name="line.64"></a>
<span class="sourceLineNo">065</span> return (t instanceof RegionTooBusyException || t instanceof RpcThrottlingException<a name="line.65"></a>
<span class="sourceLineNo">066</span> || t instanceof RetryImmediatelyException || t instanceof CallQueueTooBigException<a name="line.66"></a>
<span class="sourceLineNo">067</span> || t instanceof CallDroppedException || t instanceof NotServingRegionException<a name="line.67"></a>
<span class="sourceLineNo">068</span> || t instanceof RequestTooBigException);<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> /**<a name="line.71"></a>
<span class="sourceLineNo">072</span> * This function is the alias of regionDefinitelyOnTheRegionServerException,<a name="line.72"></a>
<span class="sourceLineNo">073</span> * whose name is confusing in the function findException().<a name="line.73"></a>
<span class="sourceLineNo">074</span> */<a name="line.74"></a>
<span class="sourceLineNo">075</span> private static boolean matchExceptionWeCare(Throwable t) {<a name="line.75"></a>
<span class="sourceLineNo">076</span> return regionDefinitelyOnTheRegionServerException(t);<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> * Look for an exception we know in the remote exception:<a name="line.80"></a>
<span class="sourceLineNo">081</span> * - hadoop.ipc wrapped exceptions<a name="line.81"></a>
<span class="sourceLineNo">082</span> * - nested exceptions<a name="line.82"></a>
<span class="sourceLineNo">083</span> *<a name="line.83"></a>
<span class="sourceLineNo">084</span> * Looks for: RegionMovedException / RegionOpeningException / RegionTooBusyException /<a name="line.84"></a>
<span class="sourceLineNo">085</span> * RpcThrottlingException<a name="line.85"></a>
<span class="sourceLineNo">086</span> * @return null if we didn't find the exception, the exception otherwise.<a name="line.86"></a>
<span class="sourceLineNo">087</span> */<a name="line.87"></a>
<span class="sourceLineNo">088</span> public static Throwable findException(Object exception) {<a name="line.88"></a>
<span class="sourceLineNo">089</span> if (exception == null || !(exception instanceof Throwable)) {<a name="line.89"></a>
<span class="sourceLineNo">090</span> return null;<a name="line.90"></a>
<span class="sourceLineNo">091</span> }<a name="line.91"></a>
<span class="sourceLineNo">092</span> Throwable cur = (Throwable) exception;<a name="line.92"></a>
<span class="sourceLineNo">093</span> while (cur != null) {<a name="line.93"></a>
<span class="sourceLineNo">094</span> if (matchExceptionWeCare(cur)) {<a name="line.94"></a>
<span class="sourceLineNo">095</span> return cur;<a name="line.95"></a>
<span class="sourceLineNo">096</span> }<a name="line.96"></a>
<span class="sourceLineNo">097</span> if (cur instanceof RemoteException) {<a name="line.97"></a>
<span class="sourceLineNo">098</span> RemoteException re = (RemoteException) cur;<a name="line.98"></a>
<span class="sourceLineNo">099</span> cur = re.unwrapRemoteException();<a name="line.99"></a>
<span class="sourceLineNo">100</span><a name="line.100"></a>
<span class="sourceLineNo">101</span> // unwrapRemoteException can return the exception given as a parameter when it cannot<a name="line.101"></a>
<span class="sourceLineNo">102</span> // unwrap it. In this case, there is no need to look further<a name="line.102"></a>
<span class="sourceLineNo">103</span> // noinspection ObjectEquality<a name="line.103"></a>
<span class="sourceLineNo">104</span> if (cur == re) {<a name="line.104"></a>
<span class="sourceLineNo">105</span> return cur;<a name="line.105"></a>
<span class="sourceLineNo">106</span> }<a name="line.106"></a>
<span class="sourceLineNo">107</span><a name="line.107"></a>
<span class="sourceLineNo">108</span> // When we receive RemoteException which wraps IOException which has a cause as<a name="line.108"></a>
<span class="sourceLineNo">109</span> // RemoteException we can get into infinite loop here; so if the cause of the exception<a name="line.109"></a>
<span class="sourceLineNo">110</span> // is RemoteException, we shouldn't look further.<a name="line.110"></a>
<span class="sourceLineNo">111</span> } else if (cur.getCause() != null &amp;&amp; !(cur.getCause() instanceof RemoteException)) {<a name="line.111"></a>
<span class="sourceLineNo">112</span> cur = cur.getCause();<a name="line.112"></a>
<span class="sourceLineNo">113</span> } else {<a name="line.113"></a>
<span class="sourceLineNo">114</span> return cur;<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><a name="line.117"></a>
<span class="sourceLineNo">118</span> return null;<a name="line.118"></a>
<span class="sourceLineNo">119</span> }<a name="line.119"></a>
<span class="sourceLineNo">120</span><a name="line.120"></a>
<span class="sourceLineNo">121</span> /**<a name="line.121"></a>
<span class="sourceLineNo">122</span> * Checks if the exception is CallQueueTooBig exception (maybe wrapped<a name="line.122"></a>
<span class="sourceLineNo">123</span> * into some RemoteException).<a name="line.123"></a>
<span class="sourceLineNo">124</span> * @param t exception to check<a name="line.124"></a>
<span class="sourceLineNo">125</span> * @return true if it's a CQTBE, false otherwise<a name="line.125"></a>
<span class="sourceLineNo">126</span> */<a name="line.126"></a>
<span class="sourceLineNo">127</span> public static boolean isCallQueueTooBigException(Throwable t) {<a name="line.127"></a>
<span class="sourceLineNo">128</span> t = findException(t);<a name="line.128"></a>
<span class="sourceLineNo">129</span> return (t instanceof CallQueueTooBigException);<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>
<span class="sourceLineNo">132</span> /**<a name="line.132"></a>
<span class="sourceLineNo">133</span> * Checks if the exception is CallDroppedException (maybe wrapped<a name="line.133"></a>
<span class="sourceLineNo">134</span> * into some RemoteException).<a name="line.134"></a>
<span class="sourceLineNo">135</span> * @param t exception to check<a name="line.135"></a>
<span class="sourceLineNo">136</span> * @return true if it's a CQTBE, false otherwise<a name="line.136"></a>
<span class="sourceLineNo">137</span> */<a name="line.137"></a>
<span class="sourceLineNo">138</span> public static boolean isCallDroppedException(Throwable t) {<a name="line.138"></a>
<span class="sourceLineNo">139</span> t = findException(t);<a name="line.139"></a>
<span class="sourceLineNo">140</span> return (t instanceof CallDroppedException);<a name="line.140"></a>
<span class="sourceLineNo">141</span> }<a name="line.141"></a>
<span class="sourceLineNo">142</span><a name="line.142"></a>
<span class="sourceLineNo">143</span> // This list covers most connectivity exceptions but not all.<a name="line.143"></a>
<span class="sourceLineNo">144</span> // For example, in SocketOutputStream a plain IOException is thrown at times when the channel is<a name="line.144"></a>
<span class="sourceLineNo">145</span> // closed.<a name="line.145"></a>
<span class="sourceLineNo">146</span> private static final ImmutableSet&lt;Class&lt;? extends Throwable&gt;&gt; CONNECTION_EXCEPTION_TYPES =<a name="line.146"></a>
<span class="sourceLineNo">147</span> ImmutableSet.of(SocketTimeoutException.class, ConnectException.class,<a name="line.147"></a>
<span class="sourceLineNo">148</span> ClosedChannelException.class, SyncFailedException.class, EOFException.class,<a name="line.148"></a>
<span class="sourceLineNo">149</span> TimeoutException.class, TimeoutIOException.class, CallTimeoutException.class,<a name="line.149"></a>
<span class="sourceLineNo">150</span> ConnectionClosingException.class, FailedServerException.class,<a name="line.150"></a>
<span class="sourceLineNo">151</span> ConnectionClosedException.class);<a name="line.151"></a>
<span class="sourceLineNo">152</span><a name="line.152"></a>
<span class="sourceLineNo">153</span> /**<a name="line.153"></a>
<span class="sourceLineNo">154</span> * For test only. Usually you should use the {@link #isConnectionException(Throwable)} method<a name="line.154"></a>
<span class="sourceLineNo">155</span> * below.<a name="line.155"></a>
<span class="sourceLineNo">156</span> */<a name="line.156"></a>
<span class="sourceLineNo">157</span> @VisibleForTesting<a name="line.157"></a>
<span class="sourceLineNo">158</span> public static Set&lt;Class&lt;? extends Throwable&gt;&gt; getConnectionExceptionTypes() {<a name="line.158"></a>
<span class="sourceLineNo">159</span> return CONNECTION_EXCEPTION_TYPES;<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> /**<a name="line.162"></a>
<span class="sourceLineNo">163</span> * Check if the exception is something that indicates that we cannot contact/communicate with the<a name="line.163"></a>
<span class="sourceLineNo">164</span> * server.<a name="line.164"></a>
<span class="sourceLineNo">165</span> * @param e exception to check<a name="line.165"></a>
<span class="sourceLineNo">166</span> * @return true when exception indicates that the client wasn't able to make contact with server<a name="line.166"></a>
<span class="sourceLineNo">167</span> */<a name="line.167"></a>
<span class="sourceLineNo">168</span> public static boolean isConnectionException(Throwable e) {<a name="line.168"></a>
<span class="sourceLineNo">169</span> if (e == null) {<a name="line.169"></a>
<span class="sourceLineNo">170</span> return false;<a name="line.170"></a>
<span class="sourceLineNo">171</span> }<a name="line.171"></a>
<span class="sourceLineNo">172</span> for (Class&lt;? extends Throwable&gt; clazz : CONNECTION_EXCEPTION_TYPES) {<a name="line.172"></a>
<span class="sourceLineNo">173</span> if (clazz.isAssignableFrom(e.getClass())) {<a name="line.173"></a>
<span class="sourceLineNo">174</span> return true;<a name="line.174"></a>
<span class="sourceLineNo">175</span> }<a name="line.175"></a>
<span class="sourceLineNo">176</span> }<a name="line.176"></a>
<span class="sourceLineNo">177</span> return false;<a name="line.177"></a>
<span class="sourceLineNo">178</span> }<a name="line.178"></a>
<span class="sourceLineNo">179</span><a name="line.179"></a>
<span class="sourceLineNo">180</span> /**<a name="line.180"></a>
<span class="sourceLineNo">181</span> * Translates exception for preemptive fast fail checks.<a name="line.181"></a>
<span class="sourceLineNo">182</span> * @param t exception to check<a name="line.182"></a>
<span class="sourceLineNo">183</span> * @return translated exception<a name="line.183"></a>
<span class="sourceLineNo">184</span> * @throws IOException<a name="line.184"></a>
<span class="sourceLineNo">185</span> */<a name="line.185"></a>
<span class="sourceLineNo">186</span> public static Throwable translatePFFE(Throwable t) throws IOException {<a name="line.186"></a>
<span class="sourceLineNo">187</span> if (t instanceof NoSuchMethodError) {<a name="line.187"></a>
<span class="sourceLineNo">188</span> // We probably can't recover from this exception by retrying.<a name="line.188"></a>
<span class="sourceLineNo">189</span> throw (NoSuchMethodError) t;<a name="line.189"></a>
<span class="sourceLineNo">190</span> }<a name="line.190"></a>
<span class="sourceLineNo">191</span><a name="line.191"></a>
<span class="sourceLineNo">192</span> if (t instanceof NullPointerException) {<a name="line.192"></a>
<span class="sourceLineNo">193</span> // The same here. This is probably a bug.<a name="line.193"></a>
<span class="sourceLineNo">194</span> throw (NullPointerException) t;<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> if (t instanceof UndeclaredThrowableException) {<a name="line.197"></a>
<span class="sourceLineNo">198</span> t = t.getCause();<a name="line.198"></a>
<span class="sourceLineNo">199</span> }<a name="line.199"></a>
<span class="sourceLineNo">200</span> if (t instanceof RemoteException) {<a name="line.200"></a>
<span class="sourceLineNo">201</span> t = ((RemoteException) t).unwrapRemoteException();<a name="line.201"></a>
<span class="sourceLineNo">202</span> }<a name="line.202"></a>
<span class="sourceLineNo">203</span> if (t instanceof DoNotRetryIOException) {<a name="line.203"></a>
<span class="sourceLineNo">204</span> throw (DoNotRetryIOException) t;<a name="line.204"></a>
<span class="sourceLineNo">205</span> }<a name="line.205"></a>
<span class="sourceLineNo">206</span> if (t instanceof Error) {<a name="line.206"></a>
<span class="sourceLineNo">207</span> throw (Error) t;<a name="line.207"></a>
<span class="sourceLineNo">208</span> }<a name="line.208"></a>
<span class="sourceLineNo">209</span> return t;<a name="line.209"></a>
<span class="sourceLineNo">210</span> }<a name="line.210"></a>
<span class="sourceLineNo">211</span>}<a name="line.211"></a>
</pre>
</div>
</body>
</html>