View Javadoc

1   /**
2    * Licensed to the Apache Software Foundation (ASF) under one
3    * or more contributor license agreements.  See the NOTICE file
4    * distributed with this work for additional information
5    * regarding copyright ownership.  The ASF licenses this file
6    * to you under the Apache License, Version 2.0 (the
7    * "License"); you may not use this file except in compliance
8    * with the License.  You may obtain a copy of the License at
9    *
10   *     http://www.apache.org/licenses/LICENSE-2.0
11   *
12   * Unless required by applicable law or agreed to in writing, software
13   * distributed under the License is distributed on an "AS IS" BASIS,
14   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15   * See the License for the specific language governing permissions and
16   * limitations under the License.
17   */
18  package org.apache.hadoop.hbase.procedure;
19  
20  import java.io.IOException;
21  
22  import org.apache.hadoop.classification.InterfaceAudience;
23  import org.apache.hadoop.classification.InterfaceStability;
24  import org.apache.hadoop.hbase.regionserver.RegionServerServices;
25  import org.apache.zookeeper.KeeperException;
26  
27  /**
28   * A life-cycle management interface for globally barriered procedures on
29   * region servers.
30   */
31  @InterfaceAudience.Private
32  @InterfaceStability.Evolving
33  public abstract class RegionServerProcedureManager extends ProcedureManager {
34    /**
35     * Initialize a globally barriered procedure for region servers.
36     *
37     * @param rss Region Server service interface
38     * @throws KeeperException
39     */
40    public abstract void initialize(RegionServerServices rss) throws KeeperException;
41  
42    /**
43     * Start accepting procedure requests.
44     */
45    public abstract void start();
46  
47    /**
48     * Close <tt>this</tt> and all running procedure tasks
49     *
50     * @param force forcefully stop all running tasks
51     * @throws IOException
52     */
53    public abstract void stop(boolean force) throws IOException;
54  }