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.replication;
20  
21  import org.apache.hadoop.classification.InterfaceAudience;
22  import org.apache.zookeeper.KeeperException;
23  
24  import java.io.Closeable;
25  
26  /**
27   * This provides an interface for getting and setting the replication state of a
28   * cluster. This state is used to indicate whether replication is enabled or
29   * disabled on a cluster.
30   */
31  @InterfaceAudience.Private
32  public interface ReplicationStateInterface extends Closeable {
33  
34    /**
35     * Initialize the replication state interface.
36     */
37    public void init() throws KeeperException;
38  
39    /**
40     * Get the current state of replication (i.e. ENABLED or DISABLED).
41     * @return true if replication is enabled, false otherwise
42     * @throws KeeperException
43     */
44    public boolean getState() throws KeeperException;
45  
46    /**
47     * Set the state of replication.
48     * @param newState
49     * @throws KeeperException
50     */
51    public void setState(boolean newState) throws KeeperException;
52  }