1 /**
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements. See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership. The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License. You may obtain a copy of the License at
10 *
11 * http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS,
15 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
18 */
19 package org.apache.hadoop.hbase;
20
21 import org.apache.hadoop.classification.InterfaceAudience;
22
23 /**
24 * Interface to support the aborting of a given server or client.
25 * <p>
26 * This is used primarily for ZooKeeper usage when we could get an unexpected
27 * and fatal exception, requiring an abort.
28 * <p>
29 * Implemented by the Master, RegionServer, and TableServers (client).
30 */
31 @InterfaceAudience.Private
32 public interface Abortable {
33 /**
34 * Abort the server or client.
35 * @param why Why we're aborting.
36 * @param e Throwable that caused abort. Can be null.
37 */
38 void abort(String why, Throwable e);
39
40 /**
41 * Check if the server or client was aborted.
42 * @return true if the server or client was aborted, false otherwise
43 */
44 boolean isAborted();
45 }