blob: 64b48409cd28f99b42870d1245a959d579d2b72c [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, class: HBaseServerException">
<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;</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 org.apache.yetus.audience.InterfaceAudience;</span>
<span class="source-line-no">021</span><span id="line-21"></span>
<span class="source-line-no">022</span><span id="line-22">/**</span>
<span class="source-line-no">023</span><span id="line-23"> * Base class for exceptions thrown by an HBase server. May contain extra info about the state of</span>
<span class="source-line-no">024</span><span id="line-24"> * the server when the exception was thrown.</span>
<span class="source-line-no">025</span><span id="line-25"> */</span>
<span class="source-line-no">026</span><span id="line-26">@InterfaceAudience.Public</span>
<span class="source-line-no">027</span><span id="line-27">public class HBaseServerException extends HBaseIOException {</span>
<span class="source-line-no">028</span><span id="line-28"> private boolean serverOverloaded;</span>
<span class="source-line-no">029</span><span id="line-29"></span>
<span class="source-line-no">030</span><span id="line-30"> public HBaseServerException() {</span>
<span class="source-line-no">031</span><span id="line-31"> this(false);</span>
<span class="source-line-no">032</span><span id="line-32"> }</span>
<span class="source-line-no">033</span><span id="line-33"></span>
<span class="source-line-no">034</span><span id="line-34"> public HBaseServerException(String message) {</span>
<span class="source-line-no">035</span><span id="line-35"> this(false, message);</span>
<span class="source-line-no">036</span><span id="line-36"> }</span>
<span class="source-line-no">037</span><span id="line-37"></span>
<span class="source-line-no">038</span><span id="line-38"> public HBaseServerException(boolean serverOverloaded) {</span>
<span class="source-line-no">039</span><span id="line-39"> this.serverOverloaded = serverOverloaded;</span>
<span class="source-line-no">040</span><span id="line-40"> }</span>
<span class="source-line-no">041</span><span id="line-41"></span>
<span class="source-line-no">042</span><span id="line-42"> public HBaseServerException(boolean serverOverloaded, String message) {</span>
<span class="source-line-no">043</span><span id="line-43"> super(message);</span>
<span class="source-line-no">044</span><span id="line-44"> this.serverOverloaded = serverOverloaded;</span>
<span class="source-line-no">045</span><span id="line-45"> }</span>
<span class="source-line-no">046</span><span id="line-46"></span>
<span class="source-line-no">047</span><span id="line-47"> /** Returns True if the server was considered overloaded when the exception was thrown */</span>
<span class="source-line-no">048</span><span id="line-48"> public static boolean isServerOverloaded(Throwable t) {</span>
<span class="source-line-no">049</span><span id="line-49"> if (t instanceof HBaseServerException) {</span>
<span class="source-line-no">050</span><span id="line-50"> return ((HBaseServerException) t).isServerOverloaded();</span>
<span class="source-line-no">051</span><span id="line-51"> }</span>
<span class="source-line-no">052</span><span id="line-52"> return false;</span>
<span class="source-line-no">053</span><span id="line-53"> }</span>
<span class="source-line-no">054</span><span id="line-54"></span>
<span class="source-line-no">055</span><span id="line-55"> /**</span>
<span class="source-line-no">056</span><span id="line-56"> * Necessary for parsing RemoteException on client side</span>
<span class="source-line-no">057</span><span id="line-57"> * @param serverOverloaded True if server was overloaded when exception was thrown</span>
<span class="source-line-no">058</span><span id="line-58"> */</span>
<span class="source-line-no">059</span><span id="line-59"> public void setServerOverloaded(boolean serverOverloaded) {</span>
<span class="source-line-no">060</span><span id="line-60"> this.serverOverloaded = serverOverloaded;</span>
<span class="source-line-no">061</span><span id="line-61"> }</span>
<span class="source-line-no">062</span><span id="line-62"></span>
<span class="source-line-no">063</span><span id="line-63"> /** Returns True if server was considered overloaded when exception was thrown */</span>
<span class="source-line-no">064</span><span id="line-64"> public boolean isServerOverloaded() {</span>
<span class="source-line-no">065</span><span id="line-65"> return serverOverloaded;</span>
<span class="source-line-no">066</span><span id="line-66"> }</span>
<span class="source-line-no">067</span><span id="line-67">}</span>
</pre>
</div>
</main>
</body>
</html>