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 24 /** 25 * This provides an interface for clients of replication to view replication queues. These queues 26 * keep track of the HLogs that still need to be replicated to remote clusters. 27 */ 28 public interface ReplicationQueuesClient { 29 30 /** 31 * Initialize the replication queue client interface. 32 */ 33 public void init() throws ReplicationException; 34 35 /** 36 * Get a list of all region servers that have outstanding replication queues. These servers could 37 * be alive, dead or from a previous run of the cluster. 38 * @return a list of server names 39 */ 40 List<String> getListOfReplicators(); 41 42 /** 43 * Get a list of all HLogs in the given queue on the given region server. 44 * @param serverName the server name of the region server that owns the queue 45 * @param queueId a String that identifies the queue 46 * @return a list of HLogs, null if this region server is dead and has no outstanding queues 47 */ 48 List<String> getLogsInQueue(String serverName, String queueId); 49 50 /** 51 * Get a list of all queues for the specified region server. 52 * @param serverName the server name of the region server that owns the set of queues 53 * @return a list of queueIds, null if this region server is not a replicator. 54 */ 55 List<String> getAllQueues(String serverName); 56 }