blob: 90fb34a94d52e81fa0f813cef628f8939b6311c4 [file] [log] [blame]
<!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.client, class: RetriesExhaustedException, class: ThrowableWithExtraContext">
<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.client;</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 java.time.Instant;</span>
<span class="source-line-no">022</span><span id="line-22">import java.time.format.DateTimeFormatter;</span>
<span class="source-line-no">023</span><span id="line-23">import java.util.List;</span>
<span class="source-line-no">024</span><span id="line-24">import java.util.StringJoiner;</span>
<span class="source-line-no">025</span><span id="line-25">import org.apache.commons.lang3.StringUtils;</span>
<span class="source-line-no">026</span><span id="line-26">import org.apache.yetus.audience.InterfaceAudience;</span>
<span class="source-line-no">027</span><span id="line-27"></span>
<span class="source-line-no">028</span><span id="line-28">/**</span>
<span class="source-line-no">029</span><span id="line-29"> * Exception thrown by HTable methods when an attempt to do something (like commit changes) fails</span>
<span class="source-line-no">030</span><span id="line-30"> * after a bunch of retries.</span>
<span class="source-line-no">031</span><span id="line-31"> */</span>
<span class="source-line-no">032</span><span id="line-32">@InterfaceAudience.Public</span>
<span class="source-line-no">033</span><span id="line-33">public class RetriesExhaustedException extends IOException {</span>
<span class="source-line-no">034</span><span id="line-34"> private static final long serialVersionUID = 1876775844L;</span>
<span class="source-line-no">035</span><span id="line-35"></span>
<span class="source-line-no">036</span><span id="line-36"> public RetriesExhaustedException(final String msg) {</span>
<span class="source-line-no">037</span><span id="line-37"> super(msg);</span>
<span class="source-line-no">038</span><span id="line-38"> }</span>
<span class="source-line-no">039</span><span id="line-39"></span>
<span class="source-line-no">040</span><span id="line-40"> public RetriesExhaustedException(final String msg, final IOException e) {</span>
<span class="source-line-no">041</span><span id="line-41"> super(msg, e);</span>
<span class="source-line-no">042</span><span id="line-42"> }</span>
<span class="source-line-no">043</span><span id="line-43"></span>
<span class="source-line-no">044</span><span id="line-44"> /**</span>
<span class="source-line-no">045</span><span id="line-45"> * Data structure that allows adding more info around Throwable incident.</span>
<span class="source-line-no">046</span><span id="line-46"> */</span>
<span class="source-line-no">047</span><span id="line-47"> @InterfaceAudience.Private</span>
<span class="source-line-no">048</span><span id="line-48"> public static class ThrowableWithExtraContext {</span>
<span class="source-line-no">049</span><span id="line-49"> private final Throwable throwable;</span>
<span class="source-line-no">050</span><span id="line-50"> private final long whenAsEpochMilli;</span>
<span class="source-line-no">051</span><span id="line-51"> private final String extras;</span>
<span class="source-line-no">052</span><span id="line-52"></span>
<span class="source-line-no">053</span><span id="line-53"> public ThrowableWithExtraContext(final Throwable throwable, final long whenAsEpochMilli,</span>
<span class="source-line-no">054</span><span id="line-54"> final String extras) {</span>
<span class="source-line-no">055</span><span id="line-55"> this.throwable = throwable;</span>
<span class="source-line-no">056</span><span id="line-56"> this.whenAsEpochMilli = whenAsEpochMilli;</span>
<span class="source-line-no">057</span><span id="line-57"> this.extras = extras;</span>
<span class="source-line-no">058</span><span id="line-58"> }</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 String toString() {</span>
<span class="source-line-no">062</span><span id="line-62"> final StringJoiner joiner = new StringJoiner(", ");</span>
<span class="source-line-no">063</span><span id="line-63"> if (whenAsEpochMilli != 0) {</span>
<span class="source-line-no">064</span><span id="line-64"> joiner.add(DateTimeFormatter.ISO_INSTANT.format(Instant.ofEpochMilli(whenAsEpochMilli)));</span>
<span class="source-line-no">065</span><span id="line-65"> }</span>
<span class="source-line-no">066</span><span id="line-66"> if (StringUtils.isNotEmpty(extras)) {</span>
<span class="source-line-no">067</span><span id="line-67"> joiner.add(extras);</span>
<span class="source-line-no">068</span><span id="line-68"> }</span>
<span class="source-line-no">069</span><span id="line-69"> if (throwable != null) {</span>
<span class="source-line-no">070</span><span id="line-70"> joiner.add(throwable.toString());</span>
<span class="source-line-no">071</span><span id="line-71"> }</span>
<span class="source-line-no">072</span><span id="line-72"> return joiner.toString();</span>
<span class="source-line-no">073</span><span id="line-73"> }</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"> /**</span>
<span class="source-line-no">077</span><span id="line-77"> * Create a new RetriesExhaustedException from the list of prior failures.</span>
<span class="source-line-no">078</span><span id="line-78"> * @param callableVitals Details from the Callable we were using when we got this exception.</span>
<span class="source-line-no">079</span><span id="line-79"> * @param numTries The number of tries we made</span>
<span class="source-line-no">080</span><span id="line-80"> * @param exceptions List of exceptions that failed before giving up</span>
<span class="source-line-no">081</span><span id="line-81"> */</span>
<span class="source-line-no">082</span><span id="line-82"> public RetriesExhaustedException(final String callableVitals, int numTries,</span>
<span class="source-line-no">083</span><span id="line-83"> List&lt;Throwable&gt; exceptions) {</span>
<span class="source-line-no">084</span><span id="line-84"> super(getMessage(callableVitals, numTries, exceptions));</span>
<span class="source-line-no">085</span><span id="line-85"> }</span>
<span class="source-line-no">086</span><span id="line-86"></span>
<span class="source-line-no">087</span><span id="line-87"> /**</span>
<span class="source-line-no">088</span><span id="line-88"> * Create a new RetriesExhaustedException from the list of prior failures.</span>
<span class="source-line-no">089</span><span id="line-89"> * @param numRetries How many times we have retried, one less than total attempts</span>
<span class="source-line-no">090</span><span id="line-90"> * @param exceptions List of exceptions that failed before giving up</span>
<span class="source-line-no">091</span><span id="line-91"> */</span>
<span class="source-line-no">092</span><span id="line-92"> @InterfaceAudience.Private</span>
<span class="source-line-no">093</span><span id="line-93"> public RetriesExhaustedException(final int numRetries,</span>
<span class="source-line-no">094</span><span id="line-94"> final List&lt;ThrowableWithExtraContext&gt; exceptions) {</span>
<span class="source-line-no">095</span><span id="line-95"> super(getMessage(numRetries, exceptions),</span>
<span class="source-line-no">096</span><span id="line-96"> exceptions.isEmpty() ? null : exceptions.get(exceptions.size() - 1).throwable);</span>
<span class="source-line-no">097</span><span id="line-97"> }</span>
<span class="source-line-no">098</span><span id="line-98"></span>
<span class="source-line-no">099</span><span id="line-99"> private static String getMessage(String callableVitals, int numTries,</span>
<span class="source-line-no">100</span><span id="line-100"> List&lt;Throwable&gt; exceptions) {</span>
<span class="source-line-no">101</span><span id="line-101"> StringBuilder buffer = new StringBuilder("Failed contacting ");</span>
<span class="source-line-no">102</span><span id="line-102"> buffer.append(callableVitals);</span>
<span class="source-line-no">103</span><span id="line-103"> buffer.append(" after ");</span>
<span class="source-line-no">104</span><span id="line-104"> buffer.append(numTries);</span>
<span class="source-line-no">105</span><span id="line-105"> buffer.append(" attempts.\nExceptions:\n");</span>
<span class="source-line-no">106</span><span id="line-106"> for (Throwable t : exceptions) {</span>
<span class="source-line-no">107</span><span id="line-107"> buffer.append(t.toString());</span>
<span class="source-line-no">108</span><span id="line-108"> buffer.append("\n");</span>
<span class="source-line-no">109</span><span id="line-109"> }</span>
<span class="source-line-no">110</span><span id="line-110"> return buffer.toString();</span>
<span class="source-line-no">111</span><span id="line-111"> }</span>
<span class="source-line-no">112</span><span id="line-112"></span>
<span class="source-line-no">113</span><span id="line-113"> private static String getMessage(final int numRetries,</span>
<span class="source-line-no">114</span><span id="line-114"> final List&lt;ThrowableWithExtraContext&gt; exceptions) {</span>
<span class="source-line-no">115</span><span id="line-115"> StringBuilder buffer = new StringBuilder("Failed after attempts=");</span>
<span class="source-line-no">116</span><span id="line-116"> buffer.append(numRetries + 1);</span>
<span class="source-line-no">117</span><span id="line-117"> buffer.append(", exceptions:\n");</span>
<span class="source-line-no">118</span><span id="line-118"> for (ThrowableWithExtraContext t : exceptions) {</span>
<span class="source-line-no">119</span><span id="line-119"> buffer.append(t.toString());</span>
<span class="source-line-no">120</span><span id="line-120"> buffer.append("\n");</span>
<span class="source-line-no">121</span><span id="line-121"> }</span>
<span class="source-line-no">122</span><span id="line-122"> return buffer.toString();</span>
<span class="source-line-no">123</span><span id="line-123"> }</span>
<span class="source-line-no">124</span><span id="line-124">}</span>
</pre>
</div>
</main>
</body>
</html>