ReplicationPeersZKImpl (Apache HBase 1.2.12 API)

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
Modifier and Type	Field and Description
`private static org.apache.commons.logging.Log`	`LOG`
`private Map<String,ReplicationPeerZKImpl>`	`peerClusters`
`private String`	`tableCFsNodeName`

Fields inherited from class org.apache.hadoop.hbase.replication.ReplicationStateZKBase
abortable, conf, DISABLED_ZNODE_BYTES, ENABLED_ZNODE_BYTES, ourClusterKey, peerStateNodeName, peersZNode, queuesZNode, replicationZNode, zookeeper

Constructor Summary

Constructors
Constructor and Description
`ReplicationPeersZKImpl(ZooKeeperWatcher zk, org.apache.hadoop.conf.Configuration conf, Abortable abortable)`

Method Summary

Methods
Modifier and Type	Method and Description
`private void`	`addExistingPeers()` A private method used during initialization.
`void`	`addPeer(String id, ReplicationPeerConfig peerConfig, String tableCFs)` Add a new remote slave cluster for replication.
`private void`	`changePeerState(String id, org.apache.hadoop.hbase.protobuf.generated.ZooKeeperProtos.ReplicationState.State state)` Update the state znode of a peer cluster.
`private static org.apache.hadoop.hbase.protobuf.generated.ZooKeeperProtos.ReplicationPeer`	`convert(ReplicationPeerConfig peerConfig)`
`private static ReplicationPeerConfig`	`convert(org.apache.hadoop.hbase.protobuf.generated.ZooKeeperProtos.ReplicationPeer peer)`
`boolean`	`createAndAddPeer(String peerId)` Attempt to connect to a new remote slave cluster.
`private ReplicationPeerZKImpl`	`createPeer(String peerId)` Helper method to connect to a peer
`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`	`getPeer(String peerId)` Returns the ReplicationPeer
`Pair<ReplicationPeerConfig,org.apache.hadoop.conf.Configuration>`	`getPeerConf(String peerId)` Returns the configuration needed to talk to the remote slave cluster.
`Set<String>`	`getPeerIds()` Returns the set of peerIds defined
`private String`	`getPeerStateNode(String id)`
`String`	`getPeerTableCFsConfig(String id)` Get the table and column-family list string of the peer from ZK.
`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.
`Map<TableName,List<String>>`	`getTableCFs(String id)` Get the table and column-family-list map of the peer.
`private String`	`getTableCFsNode(String id)`
`void`	`init()` Initialize the ReplicationPeers interface.
`private static ReplicationPeerConfig`	`parsePeerFrom(byte[] bytes)`
`boolean`	`peerAdded(String peerId)`
`void`	`peerRemoved(String peerId)`
`void`	`removePeer(String id)` Removes a remote slave cluster and stops the replication to it.
`void`	`setPeerTableCFsConfig(String id, String tableCFsStr)` Set the table and column-family list string of the peer to ZK.
`private static byte[]`	`toByteArray(ReplicationPeerConfig peerConfig)`

Methods inherited from class org.apache.hadoop.hbase.replication.ReplicationStateZKBase
getListOfReplicatorsZK, isPeerPath, peerExists, toByteArray

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - peerClusters
```
private Map<String,ReplicationPeerZKImpl> peerClusters
```
  - tableCFsNodeName
```
private final String tableCFsNodeName
```
  - LOG
```
private static final org.apache.commons.logging.Log LOG
```
- Constructor Detail
  - ReplicationPeersZKImpl
```
public ReplicationPeersZKImpl(ZooKeeperWatcher zk,
                      org.apache.hadoop.conf.Configuration conf,
                      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
  - addPeer
```
public void addPeer(String id,
           ReplicationPeerConfig peerConfig,
           String tableCFs)
             throws ReplicationException
```
    Description copied from interface: ReplicationPeers
    
    Add a new remote slave cluster for replication.
    
    Specified by:
    
    addPeer in interface ReplicationPeers
    
    Parameters:
    id - a short that identifies the cluster
    peerConfig - configuration for the replication slave cluster
    tableCFs - the table and column-family list which will be replicated for this peer or null for all table and column families
    
    Throws:
    
    ReplicationException
  - removePeer
```
public void removePeer(String id)
                throws ReplicationException
```
    Description copied from interface: ReplicationPeers
    
    Removes a remote slave cluster and stops the replication to it.
    
    Specified by:
    
    removePeer 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 String getPeerTableCFsConfig(String id)
                             throws ReplicationException
```
    Description copied from interface: ReplicationPeers
    
    Get the table and column-family list string of the peer from ZK.
    
    Specified by:
    
    getPeerTableCFsConfig in interface ReplicationPeers
    
    Parameters:
    id - a short that identifies the cluster
    
    Throws:
    
    ReplicationException
  - setPeerTableCFsConfig
```
public void setPeerTableCFsConfig(String id,
                         String tableCFsStr)
                           throws ReplicationException
```
    Description copied from interface: ReplicationPeers
    
    Set the table and column-family list string of the peer to ZK.
    
    Specified by:
    
    setPeerTableCFsConfig in interface ReplicationPeers
    
    Parameters:
    id - a short that identifies the cluster
    tableCFsStr - the table and column-family list which will be replicated for this peer
    
    Throws:
    
    ReplicationException
  - getTableCFs
```
public Map<TableName,List<String>> getTableCFs(String id)
                                        throws IllegalArgumentException
```
    Description copied from interface: ReplicationPeers
    
    Get the table and column-family-list map of the peer.
    
    Specified by:
    
    getTableCFs in interface ReplicationPeers
    
    Parameters:
    id - a short that identifies the cluster
    
    Returns:
    the table and column-family list which will be replicated for this peer
    
    Throws:
    
    IllegalArgumentException
  - 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
  - getPeer
```
public ReplicationPeer getPeer(String peerId)
```
    Description copied from interface: ReplicationPeers
    
    Returns the ReplicationPeer
    
    Specified by:
    
    getPeer in interface ReplicationPeers
    
    Parameters:
    peerId - id for the peer
    
    Returns:
    ReplicationPeer object
  - getPeerIds
```
public Set<String> getPeerIds()
```
    Description copied from interface: ReplicationPeers
    
    Returns the set of peerIds defined
    
    Specified by:
    
    getPeerIds 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
  - 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
  - addExistingPeers
```
private void addExistingPeers()
                       throws ReplicationException
```
    A private method used during initialization. This method attempts to add all registered peer clusters. This method does not set a watch on the peer cluster znodes.
    
    Throws:
    
    ReplicationException
  - peerAdded
```
public boolean peerAdded(String peerId)
                  throws ReplicationException
```
    Specified by:
    
    peerAdded in interface ReplicationPeers
    
    Throws:
    
    ReplicationException
  - peerRemoved
```
public void peerRemoved(String peerId)
```
    Specified by:
    
    peerRemoved in interface ReplicationPeers
  - 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
  - getTableCFsNode
```
private String getTableCFsNode(String id)
```
  - getPeerStateNode
```
private String getPeerStateNode(String id)
```
  - changePeerState
```
private void changePeerState(String id,
                   org.apache.hadoop.hbase.protobuf.generated.ZooKeeperProtos.ReplicationState.State state)
                      throws ReplicationException
```
    Update the state znode of a peer cluster.
    
    Parameters:
    id -
    state -
    
    Throws:
    
    ReplicationException
  - createPeer
```
private ReplicationPeerZKImpl createPeer(String peerId)
                                  throws ReplicationException
```
    Helper method to connect to a peer
    
    Parameters:
    peerId - peer's identifier
    
    Returns:
    object representing the peer
    
    Throws:
    
    ReplicationException
  - parsePeerFrom
```
private static ReplicationPeerConfig parsePeerFrom(byte[] bytes)
                                            throws DeserializationException
```
    Parameters:
    bytes - Content of a peer znode.
    
    Returns:
    ClusterKey parsed from the passed bytes.
    
    Throws:
    
    DeserializationException
  - convert
```
private static ReplicationPeerConfig convert(org.apache.hadoop.hbase.protobuf.generated.ZooKeeperProtos.ReplicationPeer peer)
```
  - convert
```
private static org.apache.hadoop.hbase.protobuf.generated.ZooKeeperProtos.ReplicationPeer convert(ReplicationPeerConfig peerConfig)
```
  - toByteArray
```
private static byte[] toByteArray(ReplicationPeerConfig peerConfig)
```
    Parameters:
    peerConfig -
    
    Returns:
    Serialized protobuf of peerConfig with pb magic prefix prepended suitable for use as content of a this.peersZNode; i.e. the content of PEER_ID znode under /hbase/replication/peers/PEER_ID

Class ReplicationPeersZKImpl

Field Summary

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

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Field Detail

peerClusters

tableCFsNodeName

LOG

Constructor Detail

ReplicationPeersZKImpl

Method Detail

init

addPeer

removePeer

enablePeer

disablePeer

getPeerTableCFsConfig

setPeerTableCFsConfig

getTableCFs

getStatusOfPeer

getStatusOfPeerFromBackingStore

getAllPeerConfigs

getPeer

getPeerIds

getReplicationPeerConfig

getPeerConf

getAllPeerIds

addExistingPeers

peerAdded

peerRemoved

createAndAddPeer

getTableCFsNode

getPeerStateNode

changePeerState

createPeer

parsePeerFrom

convert

convert

toByteArray