org.apache.hadoop.hbase.ipc.RemoteWithExtrasException Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of hbase-client Show documentation
Client of HBase
There is a newer version: 3.0.0-beta-1
/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.apache.hadoop.hbase.ipc;

import java.io.IOException;
import java.lang.reflect.Constructor;
import java.security.AccessController;
import java.security.PrivilegedAction;
import org.apache.hadoop.conf.Configuration;
import org.apache.hadoop.hbase.DoNotRetryIOException;
import org.apache.hadoop.hbase.HBaseConfiguration;
import org.apache.hadoop.hbase.HBaseServerException;
import org.apache.hadoop.hbase.util.DynamicClassLoader;
import org.apache.hadoop.ipc.RemoteException;
import org.apache.yetus.audience.InterfaceAudience;

/**
 * A {@link RemoteException} with some extra information. If source exception was a
 * {@link org.apache.hadoop.hbase.DoNotRetryIOException}, {@link #isDoNotRetry()} will return true.
 * 
 * A {@link RemoteException} hosts exceptions we got from the server.
 */
@SuppressWarnings("serial")
@InterfaceAudience.Public
public class RemoteWithExtrasException extends RemoteException {
  private final String hostname;
  private final int port;
  private final boolean doNotRetry;
  private final boolean serverOverloaded;

  /**
   * Dynamic class loader to load filter/comparators
   */
  private final static class ClassLoaderHolder {
    private final static ClassLoader CLASS_LOADER;

    static {
      ClassLoader parent = RemoteWithExtrasException.class.getClassLoader();
      Configuration conf = HBaseConfiguration.create();
      CLASS_LOADER = AccessController
        .doPrivileged((PrivilegedAction) () -> new DynamicClassLoader(conf, parent));
    }
  }

  public RemoteWithExtrasException(String className, String msg, final boolean doNotRetry) {
    this(className, msg, doNotRetry, false);
  }

  public RemoteWithExtrasException(String className, String msg, final boolean doNotRetry,
    final boolean serverOverloaded) {
    this(className, msg, null, -1, doNotRetry, serverOverloaded);
  }

  public RemoteWithExtrasException(String className, String msg, final String hostname,
    final int port, final boolean doNotRetry) {
    this(className, msg, hostname, port, doNotRetry, false);
  }

  public RemoteWithExtrasException(String className, String msg, final String hostname,
    final int port, final boolean doNotRetry, final boolean serverOverloaded) {
    super(className, msg);
    this.hostname = hostname;
    this.port = port;
    this.doNotRetry = doNotRetry;
    this.serverOverloaded = serverOverloaded;
  }

  @Override
  public IOException unwrapRemoteException() {
    Class realClass;
    try {
      // try to load a exception class from where the HBase classes are loaded or from Dynamic
      // classloader.
      realClass = Class.forName(getClassName(), false, ClassLoaderHolder.CLASS_LOADER);
    } catch (ClassNotFoundException cnfe) {
      try {
        // cause could be a hadoop exception, try to load from hadoop classpath
        realClass = Class.forName(getClassName(), false, super.getClass().getClassLoader());
      } catch (ClassNotFoundException e) {
        return new DoNotRetryIOException(
          "Unable to load exception received from server:" + e.getMessage(), this);
      }
    }
    try {
      return instantiateException(realClass.asSubclass(IOException.class));
    } catch (Exception e) {
      return new DoNotRetryIOException(
        "Unable to instantiate exception received from server:" + e.getMessage(), this);
    }
  }

  private IOException instantiateException(Class cls) throws Exception {
    Constructor cn = cls.getConstructor(String.class);
    cn.setAccessible(true);
    IOException ex = cn.newInstance(this.getMessage());
    ex.initCause(this);

    if (ex instanceof HBaseServerException) {
      // this is a newly constructed exception.
      // if an exception defaults to meaning isServerOverloaded, we use that.
      // otherwise, see if the remote exception value should mean setting to true.
      HBaseServerException serverException = (HBaseServerException) ex;
      if (serverOverloaded && !serverException.isServerOverloaded()) {
        serverException.setServerOverloaded(true);
      }
    }

    return ex;
  }

  /** Returns null if not set */
  public String getHostname() {
    return this.hostname;
  }

  /** Returns -1 if not set */
  public int getPort() {
    return this.port;
  }

  /** Returns True if origin exception was a do not retry type. */
  public boolean isDoNotRetry() {
    return this.doNotRetry;
  }

  /** Returns True if the server was considered overloaded when the exception was thrown. */
  public boolean isServerOverloaded() {
    return serverOverloaded;
  }
}