org.apache.hadoop.hbase.replication

Interface ReplicationQueuesClient

All Known Implementing Classes:

ReplicationQueuesClientZKImpl

@InterfaceAudience.Private
public interface ReplicationQueuesClient

This provides an interface for clients of replication to view replication queues. These queues keep track of the sources(WALs/HFile references) that still need to be replicated to remote clusters.

Method Summary

Modifier and Type	Method and Description
List<String>	getAllPeersFromHFileRefsQueue() Get list of all peers from hfile reference queue.
List<String>	getAllQueues(String serverName) Get a list of all queues for the specified region server.
Set<String>	getAllWALs() Load all wals in all replication queues from ZK.
int	getHFileRefsNodeChangeVersion() Get the change version number of replication hfile references node.
List<String>	getListOfReplicators() Get a list of all region servers that have outstanding replication queues.
List<String>	getLogsInQueue(String serverName, String queueId) Get a list of all WALs in the given queue on the given region server.
List<String>	getReplicableHFiles(String peerId) Get a list of all hfile references in the given peer.
void	init() Initialize the replication queue client interface.

Method Detail

init

void init()
   throws ReplicationException

Initialize the replication queue client interface.

Throws:

ReplicationException

getListOfReplicators

List<String> getListOfReplicators()
                           throws org.apache.zookeeper.KeeperException

Get a list of all region servers that have outstanding replication queues. These servers could be alive, dead or from a previous run of the cluster.

Returns:

a list of server names

Throws:

org.apache.zookeeper.KeeperException - zookeeper exception

getLogsInQueue

List<String> getLogsInQueue(String serverName,
                            String queueId)
                     throws org.apache.zookeeper.KeeperException

Get a list of all WALs in the given queue on the given region server.

Parameters:

serverName - the server name of the region server that owns the queue

queueId - a String that identifies the queue

Returns:

a list of WALs, null if this region server is dead and has no outstanding queues

Throws:

org.apache.zookeeper.KeeperException - zookeeper exception

getAllQueues

List<String> getAllQueues(String serverName)
                   throws org.apache.zookeeper.KeeperException

Get a list of all queues for the specified region server.

Parameters:

serverName - the server name of the region server that owns the set of queues

Returns:

a list of queueIds, null if this region server is not a replicator.

Throws:

org.apache.zookeeper.KeeperException

getAllWALs

Set<String> getAllWALs()
                throws org.apache.zookeeper.KeeperException

Load all wals in all replication queues from ZK. This method guarantees to return a snapshot which contains all WALs in the zookeeper at the start of this call even there is concurrent queue failover. However, some newly created WALs during the call may not be included.

Throws:

org.apache.zookeeper.KeeperException

getHFileRefsNodeChangeVersion

int getHFileRefsNodeChangeVersion()
                           throws org.apache.zookeeper.KeeperException

Get the change version number of replication hfile references node. This can be used as optimistic locking to get a consistent snapshot of the replication queues of hfile references.

Returns:

change version number of hfile references node

Throws:

org.apache.zookeeper.KeeperException

getAllPeersFromHFileRefsQueue

List<String> getAllPeersFromHFileRefsQueue()
                                    throws org.apache.zookeeper.KeeperException

Get list of all peers from hfile reference queue.

Returns:

a list of peer ids

Throws:

org.apache.zookeeper.KeeperException - zookeeper exception

getReplicableHFiles

List<String> getReplicableHFiles(String peerId)
                          throws org.apache.zookeeper.KeeperException

Get a list of all hfile references in the given peer.

Parameters:

peerId - a String that identifies the peer

Returns:

a list of hfile references, null if not found any

Throws:

org.apache.zookeeper.KeeperException - zookeeper exception