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