View Javadoc

1   /**
2    * Licensed to the Apache Software Foundation (ASF) under one
3    * or more contributor license agreements.  See the NOTICE file
4    * distributed with this work for additional information
5    * regarding copyright ownership.  The ASF licenses this file
6    * to you under the Apache License, Version 2.0 (the
7    * "License"); you may not use this file except in compliance
8    * with the License.  You may obtain a copy of the License at
9    *
10   *     http://www.apache.org/licenses/LICENSE-2.0
11   *
12   * Unless required by applicable law or agreed to in writing, software
13   * distributed under the License is distributed on an "AS IS" BASIS,
14   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15   * See the License for the specific language governing permissions and
16   * limitations under the License.
17   */
18  package org.apache.hadoop.hbase.ipc;
19  
20  import org.apache.hadoop.classification.InterfaceAudience;
21  import org.apache.hadoop.classification.InterfaceStability;
22  import org.apache.hadoop.hbase.DoNotRetryIOException;
23  import org.apache.hadoop.ipc.RemoteException;
24  
25  /**
26   * A {@link RemoteException} with some extra information.  If source exception
27   * was a {@link DoNotRetryIOException}, {@link #isDoNotRetry()} will return true.
28   * <p>A {@link RemoteException} hosts exceptions we got from the server.
29   */
30  @SuppressWarnings("serial")
31  @InterfaceAudience.Public
32  @InterfaceStability.Evolving
33  public class RemoteWithExtrasException extends RemoteException {
34    private final String hostname;
35    private final int port;
36    private final boolean doNotRetry;
37  
38    public RemoteWithExtrasException(String className, String msg, final boolean doNotRetry) {
39      this(className, msg, null, -1, doNotRetry);
40    }
41  
42    public RemoteWithExtrasException(String className, String msg, final String hostname,
43        final int port, final boolean doNotRetry) {
44      super(className, msg);
45      this.hostname = hostname;
46      this.port = port;
47      this.doNotRetry = doNotRetry;
48    }
49  
50    /**
51     * @return null if not set
52     */
53    public String getHostname() {
54      return this.hostname;
55    }
56  
57    /**
58     * @return -1 if not set
59     */
60    public int getPort() {
61      return this.port;
62    }
63  
64    /**
65     * @return True if origin exception was a do not retry type.
66     */
67    public boolean isDoNotRetry() {
68      return this.doNotRetry;
69    }
70  }