View Javadoc

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