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.replication;
19  
20  import java.util.List;
21  import java.util.Map;
22  
23  import org.apache.hadoop.conf.Configuration;
24  import org.apache.hadoop.hbase.HBaseInterfaceAudience;
25  import org.apache.hadoop.hbase.TableName;
26  import org.apache.hadoop.hbase.classification.InterfaceAudience;
27  
28  
29  /**
30   * ReplicationPeer manages enabled / disabled state for the peer.
31   */
32  @InterfaceAudience.LimitedPrivate(HBaseInterfaceAudience.REPLICATION)
33  public interface ReplicationPeer {
34  
35    /**
36     * State of the peer, whether it is enabled or not
37     */
38    @InterfaceAudience.LimitedPrivate(HBaseInterfaceAudience.REPLICATION)
39    enum PeerState {
40      ENABLED,
41      DISABLED
42    }
43  
44    /**
45     * Get the identifier of this peer
46     * @return string representation of the id
47     */
48    String getId();
49  
50    /**
51     * Get the peer config object
52     * @return the ReplicationPeerConfig for this peer
53     */
54    public ReplicationPeerConfig getPeerConfig();
55  
56    /**
57     * Returns the state of the peer
58     * @return the enabled state
59     */
60    PeerState getPeerState();
61  
62    /**
63     * Get the configuration object required to communicate with this peer
64     * @return configuration object
65     */
66    public Configuration getConfiguration();
67  
68    /**
69     * Get replicable (table, cf-list) map of this peer
70     * @return the replicable (table, cf-list) map
71     */
72    public Map<TableName, List<String>> getTableCFs();
73  
74    void trackPeerConfigChanges(ReplicationPeerConfigListener listener);
75  
76  }