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 java.util.List;
22
23 import org.apache.hadoop.hbase.classification.InterfaceAudience;
24 import org.apache.zookeeper.KeeperException;
25
26 /**
27 * This provides an interface for clients of replication to view replication queues. These queues
28 * keep track of the WALs that still need to be replicated to remote clusters.
29 */
30 @InterfaceAudience.Private
31 public interface ReplicationQueuesClient {
32
33 /**
34 * Initialize the replication queue client interface.
35 */
36 public void init() throws ReplicationException;
37
38 /**
39 * Get a list of all region servers that have outstanding replication queues. These servers could
40 * be alive, dead or from a previous run of the cluster.
41 * @return a list of server names
42 * @throws KeeperException zookeeper exception
43 */
44 List<String> getListOfReplicators() throws KeeperException;
45
46 /**
47 * Get a list of all WALs in the given queue on the given region server.
48 * @param serverName the server name of the region server that owns the queue
49 * @param queueId a String that identifies the queue
50 * @return a list of WALs, null if this region server is dead and has no outstanding queues
51 * @throws KeeperException zookeeper exception
52 */
53 List<String> getLogsInQueue(String serverName, String queueId) throws KeeperException;
54
55 /**
56 * Get a list of all queues for the specified region server.
57 * @param serverName the server name of the region server that owns the set of queues
58 * @return a list of queueIds, null if this region server is not a replicator.
59 */
60 List<String> getAllQueues(String serverName) throws KeeperException;
61
62 /**
63 * Get the cversion of replication rs node. This can be used as optimistic locking to get a
64 * consistent snapshot of the replication queues.
65 * @return cversion of replication rs node
66 */
67 int getQueuesZNodeCversion() throws KeeperException;
68 }