org.apache.hadoop.hbase.Abortable Maven / Gradle / Ivy
/*
* 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;
import org.apache.yetus.audience.InterfaceAudience;
/**
* Interface to support the aborting of a given server or client.
*
* This is used primarily for ZooKeeper usage when we could get an unexpected and fatal exception,
* requiring an abort.
*
* Implemented by the Master, RegionServer, and TableServers (client).
*/
@InterfaceAudience.Private
public interface Abortable {
/**
* Abort the server or client.
* @param why Why we're aborting.
* @param e Throwable that caused abort. Can be null.
*/
void abort(String why, Throwable e);
/**
* It just calls another abort method and the Throwable parameter is null.
* @param why Why we're aborting.
* @see Abortable#abort(String, Throwable)
*/
default void abort(String why) {
abort(why, null);
}
/**
* Check if the server or client was aborted.
* @return true if the server or client was aborted, false otherwise
*/
boolean isAborted();
}