org.apache.hadoop.hbase.replication

Class ReplicationPeersZKImpl

java.lang.Object

org.apache.hadoop.hbase.replication.ReplicationStateZKBase

org.apache.hadoop.hbase.replication.ReplicationPeersZKImpl

All Implemented Interfaces:

ReplicationPeers

@InterfaceAudience.Private
public class ReplicationPeersZKImpl
extends ReplicationStateZKBase
implements ReplicationPeers

This class provides an implementation of the ReplicationPeers interface using ZooKeeper. The peers znode contains a list of all peer replication clusters and the current replication state of those clusters. It has one child peer znode for each peer cluster. The peer znode is named with the cluster id provided by the user in the HBase shell. The value of the peer znode contains the peers cluster key provided by the user in the HBase Shell. The cluster key contains a list of zookeeper quorum peers, the client port for the zookeeper quorum, and the base znode for HBase. For example: /hbase/replication/peers/1 [Value: zk1.host.com,zk2.host.com,zk3.host.com:2181:/hbase] /hbase/replication/peers/2 [Value: zk5.host.com,zk6.host.com,zk7.host.com:2181:/hbase] Each of these peer znodes has a child znode that indicates whether or not replication is enabled on that peer cluster. These peer-state znodes do not have child znodes and simply contain a boolean value (i.e. ENABLED or DISABLED). This value is read/maintained by the ReplicationPeer.PeerStateTracker class. For example: /hbase/replication/peers/1/peer-state [Value: ENABLED] Each of these peer znodes has a child znode that indicates which data will be replicated to the peer cluster. These peer-tableCFs znodes do not have child znodes and only have a table/cf list config. This value is read/maintained by the ReplicationPeer.TableCFsTracker class. For example: /hbase/replication/peers/1/tableCFs [Value: "table1; table2:cf1,cf3; table3:cfx,cfy"]

Field Summary

Fields inherited from class org.apache.hadoop.hbase.replication.ReplicationStateZKBase

conf, DISABLED_ZNODE_BYTES, ENABLED_ZNODE_BYTES, hfileRefsZNode, ourClusterKey, peerStateNodeName, peersZNode, queuesZNode, replicationZNode, tableCFsNodeName, zookeeper, ZOOKEEPER_ZNODE_REPLICATION_HFILE_REFS_DEFAULT, ZOOKEEPER_ZNODE_REPLICATION_HFILE_REFS_KEY

Constructor Summary

Constructors

Constructor and Description
ReplicationPeersZKImpl(ZKWatcher zk, org.apache.hadoop.conf.Configuration conf, ReplicationQueuesClient queuesClient, Abortable abortable)

Method Summary

Modifier and Type	Method and Description
boolean	createAndAddPeer(String peerId) Attempt to connect to a new remote slave cluster.
void	disablePeer(String id) Stop the replication to the specified remote slave cluster.
void	enablePeer(String id) Restart the replication to the specified remote slave cluster.
Map<String,ReplicationPeerConfig>	getAllPeerConfigs() List the cluster replication configs of all remote slave clusters (whether they are enabled/disabled or connected/disconnected).
List<String>	getAllPeerIds() List all registered peer clusters and set a watch on their znodes.
ReplicationPeer	getConnectedPeer(String peerId) Returns the ReplicationPeer for the specified connected peer.
Set<String>	getConnectedPeerIds() Returns the set of peerIds of the clusters that have been connected and have an underlying ReplicationPeer.
Pair<ReplicationPeerConfig,org.apache.hadoop.conf.Configuration>	getPeerConf(String peerId) Returns the configuration needed to talk to the remote slave cluster.
Map<TableName,List<String>>	getPeerTableCFsConfig(String id) Get the table and column-family list string of the peer from the underlying storage.
ReplicationPeerConfig	getReplicationPeerConfig(String peerId) Returns a ReplicationPeerConfig from the znode or null for the given peerId.
boolean	getStatusOfPeer(String id) Get the replication status for the specified connected remote slave cluster.
boolean	getStatusOfPeerFromBackingStore(String id) Get the replication status for the specified remote slave cluster, which doesn't have to be connected.
void	init() Initialize the ReplicationPeers interface.
boolean	peerConnected(String peerId) Method called after a peer has been connected.
void	peerDisconnected(String peerId) Method called after a peer has been disconnected.
void	registerPeer(String id, ReplicationPeerConfig peerConfig, boolean enabled) Add a new remote slave cluster for replication.
void	setPeerTableCFsConfig(String id, Map<TableName,? extends Collection<String>> tableCFs) Set the table and column-family list string of the peer to the underlying storage.
void	unregisterPeer(String id) Removes a remote slave cluster and stops the replication to it.
void	updatePeerConfig(String id, ReplicationPeerConfig newConfig) Update the peerConfig for the a given peer cluster

Methods inherited from class org.apache.hadoop.hbase.replication.ReplicationStateZKBase

getListOfReplicatorsZK, getPeerNode, getPeerStateNode, getTableCFsNode, isPeerPath, peerExists, toByteArray

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.hadoop.hbase.replication.ReplicationPeers

registerPeer

Constructor Detail

ReplicationPeersZKImpl

public ReplicationPeersZKImpl(ZKWatcher zk,
                              org.apache.hadoop.conf.Configuration conf,
                              ReplicationQueuesClient queuesClient,
                              Abortable abortable)

Method Detail

init

public void init()
          throws ReplicationException

Description copied from interface: ReplicationPeers

Initialize the ReplicationPeers interface.

Specified by:

init in interface ReplicationPeers

Throws:

ReplicationException

registerPeer

public void registerPeer(String id,
                         ReplicationPeerConfig peerConfig,
                         boolean enabled)
                  throws ReplicationException

Description copied from interface: ReplicationPeers

Add a new remote slave cluster for replication.

Specified by:

registerPeer in interface ReplicationPeers

Parameters:

id - a short that identifies the cluster

peerConfig - configuration for the replication slave cluster

enabled - peer state, true if ENABLED and false if DISABLED

Throws:

ReplicationException

unregisterPeer

public void unregisterPeer(String id)
                    throws ReplicationException

Description copied from interface: ReplicationPeers

Removes a remote slave cluster and stops the replication to it.

Specified by:

unregisterPeer in interface ReplicationPeers

Parameters:

id - a short that identifies the cluster

Throws:

ReplicationException

enablePeer

public void enablePeer(String id)
                throws ReplicationException

Description copied from interface: ReplicationPeers

Restart the replication to the specified remote slave cluster.

Specified by:

enablePeer in interface ReplicationPeers

Parameters:

id - a short that identifies the cluster

Throws:

ReplicationException

disablePeer

public void disablePeer(String id)
                 throws ReplicationException

Description copied from interface: ReplicationPeers

Stop the replication to the specified remote slave cluster.

Specified by:

disablePeer in interface ReplicationPeers

Parameters:

id - a short that identifies the cluster

Throws:

ReplicationException

getPeerTableCFsConfig

public Map<TableName,List<String>> getPeerTableCFsConfig(String id)
                                                  throws ReplicationException

Description copied from interface: ReplicationPeers

Get the table and column-family list string of the peer from the underlying storage.

Specified by:

getPeerTableCFsConfig in interface ReplicationPeers

Parameters:

id - a short that identifies the cluster

Throws:

ReplicationException

setPeerTableCFsConfig

public void setPeerTableCFsConfig(String id,
                                  Map<TableName,? extends Collection<String>> tableCFs)
                           throws ReplicationException

Description copied from interface: ReplicationPeers

Set the table and column-family list string of the peer to the underlying storage.

Specified by:

setPeerTableCFsConfig in interface ReplicationPeers

Parameters:

id - a short that identifies the cluster

tableCFs - the table and column-family list which will be replicated for this peer

Throws:

ReplicationException

getStatusOfPeer

public boolean getStatusOfPeer(String id)

Description copied from interface: ReplicationPeers

Get the replication status for the specified connected remote slave cluster. The value might be read from cache, so it is recommended to use ReplicationPeers.getStatusOfPeerFromBackingStore(String) if reading the state after enabling or disabling it.

Specified by:

getStatusOfPeer in interface ReplicationPeers

Parameters:

id - a short that identifies the cluster

Returns:

true if replication is enabled, false otherwise.

getStatusOfPeerFromBackingStore

public boolean getStatusOfPeerFromBackingStore(String id)
                                        throws ReplicationException

Description copied from interface: ReplicationPeers

Get the replication status for the specified remote slave cluster, which doesn't have to be connected. The state is read directly from the backing store.

Specified by:

getStatusOfPeerFromBackingStore in interface ReplicationPeers

Parameters:

id - a short that identifies the cluster

Returns:

true if replication is enabled, false otherwise.

Throws:

ReplicationException - thrown if there's an error contacting the store

getAllPeerConfigs

public Map<String,ReplicationPeerConfig> getAllPeerConfigs()

Description copied from interface: ReplicationPeers

List the cluster replication configs of all remote slave clusters (whether they are enabled/disabled or connected/disconnected).

Specified by:

getAllPeerConfigs in interface ReplicationPeers

Returns:

A map of peer ids to peer cluster keys

getConnectedPeer

public ReplicationPeer getConnectedPeer(String peerId)

Description copied from interface: ReplicationPeers

Returns the ReplicationPeer for the specified connected peer. This ReplicationPeer will continue to track changes to the Peer's state and config. This method returns null if no peer has been connected with the given peerId.

Specified by:

getConnectedPeer in interface ReplicationPeers

Parameters:

peerId - id for the peer

Returns:

ReplicationPeer object

getConnectedPeerIds

public Set<String> getConnectedPeerIds()

Description copied from interface: ReplicationPeers

Returns the set of peerIds of the clusters that have been connected and have an underlying ReplicationPeer.

Specified by:

getConnectedPeerIds in interface ReplicationPeers

Returns:

a Set of Strings for peerIds

getReplicationPeerConfig

public ReplicationPeerConfig getReplicationPeerConfig(String peerId)
                                               throws ReplicationException

Returns a ReplicationPeerConfig from the znode or null for the given peerId.

Specified by:

getReplicationPeerConfig in interface ReplicationPeers

Parameters:

peerId - a short name that identifies the cluster

Returns:

ReplicationPeerConfig for the peer

Throws:

ReplicationException

getPeerConf

public Pair<ReplicationPeerConfig,org.apache.hadoop.conf.Configuration> getPeerConf(String peerId)
                                                                             throws ReplicationException

Description copied from interface: ReplicationPeers

Returns the configuration needed to talk to the remote slave cluster.

Specified by:

getPeerConf in interface ReplicationPeers

Parameters:

peerId - a short that identifies the cluster

Returns:

the configuration for the peer cluster, null if it was unable to get the configuration

Throws:

ReplicationException

updatePeerConfig

public void updatePeerConfig(String id,
                             ReplicationPeerConfig newConfig)
                      throws ReplicationException

Description copied from interface: ReplicationPeers

Update the peerConfig for the a given peer cluster

Specified by:

updatePeerConfig in interface ReplicationPeers

Parameters:

id - a short that identifies the cluster

newConfig - new config for the peer cluster

Throws:

ReplicationException

getAllPeerIds

public List<String> getAllPeerIds()

List all registered peer clusters and set a watch on their znodes.

Specified by:

getAllPeerIds in interface ReplicationPeers

Returns:

A list of peer ids

peerConnected

public boolean peerConnected(String peerId)
                      throws ReplicationException

Description copied from interface: ReplicationPeers

Method called after a peer has been connected. It will create a ReplicationPeer to track the newly connected cluster.

Specified by:

peerConnected in interface ReplicationPeers

Parameters:

peerId - a short that identifies the cluster

Returns:

whether a ReplicationPeer was successfully created

Throws:

ReplicationException

peerDisconnected

public void peerDisconnected(String peerId)

Description copied from interface: ReplicationPeers

Method called after a peer has been disconnected. It will remove the ReplicationPeer that tracked the disconnected cluster.

Specified by:

peerDisconnected in interface ReplicationPeers

Parameters:

peerId - a short that identifies the cluster

createAndAddPeer

public boolean createAndAddPeer(String peerId)
                         throws ReplicationException

Attempt to connect to a new remote slave cluster.

Parameters:

peerId - a short that identifies the cluster

Returns:

true if a new connection was made, false if no new connection was made.

Throws:

ReplicationException