001/**
002 *
003 * Licensed to the Apache Software Foundation (ASF) under one
004 * or more contributor license agreements.  See the NOTICE file
005 * distributed with this work for additional information
006 * regarding copyright ownership.  The ASF licenses this file
007 * to you under the Apache License, Version 2.0 (the
008 * "License"); you may not use this file except in compliance
009 * with the License.  You may obtain a copy of the License at
010 *
011 *     http://www.apache.org/licenses/LICENSE-2.0
012 *
013 * Unless required by applicable law or agreed to in writing, software
014 * distributed under the License is distributed on an "AS IS" BASIS,
015 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
016 * See the License for the specific language governing permissions and
017 * limitations under the License.
018 */
019package org.apache.hadoop.hbase;
020
021import org.apache.yetus.audience.InterfaceAudience;
022
023/**
024 * Interface to support the aborting of a given server or client.
025 * <p>
026 * This is used primarily for ZooKeeper usage when we could get an unexpected
027 * and fatal exception, requiring an abort.
028 * <p>
029 * Implemented by the Master, RegionServer, and TableServers (client).
030 */
031@InterfaceAudience.Private
032public interface Abortable {
033  /**
034   * Abort the server or client.
035   * @param why Why we're aborting.
036   * @param e Throwable that caused abort. Can be null.
037   */
038  void abort(String why, Throwable e);
039
040  /**
041   * It just call another abort method and the Throwable
042   * parameter is null.
043   * @param why Why we're aborting.
044   * @see Abortable#abort(String, Throwable)
045   */
046  default void abort(String why) {
047    abort(why, null);
048  }
049
050  /**
051   * Check if the server or client was aborted.
052   * @return true if the server or client was aborted, false otherwise
053   */
054  boolean isAborted();
055}