org.apache.hadoop.hbase.replication

Interface ReplicationPeers

All Known Implementing Classes:

ReplicationPeersZKImpl

@InterfaceAudience.Private
public interface ReplicationPeers

This provides an interface for maintaining a set of peer clusters. These peers are remote slave clusters that data is replicated to. A peer cluster can be in three different states: 1. Not-Registered - There is no notion of the peer cluster. 2. Registered - The peer has an id and is being tracked but there is no connection. 3. Connected - There is an active connection to the remote peer. In the registered or connected state, a peer cluster can either be enabled or disabled.

Method Summary

Modifier and Type	Method and Description
void	disablePeer(String peerId) Stop the replication to the specified remote slave cluster.
void	enablePeer(String peerId) 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 the peer ids of all remote slave clusters (whether they are enabled/disabled or connected/disconnected).
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 peerId) Get the table and column-family list string of the peer from the underlying storage.
ReplicationPeerConfig	getReplicationPeerConfig(String peerId) Returns the configured ReplicationPeerConfig for this peerId
boolean	getStatusOfPeer(String peerId) Get the replication status for the specified connected remote slave cluster.
boolean	getStatusOfPeerFromBackingStore(String peerId) 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.
default void	registerPeer(String peerId, ReplicationPeerConfig peerConfig) Add a new remote slave cluster for replication.
void	registerPeer(String peerId, ReplicationPeerConfig peerConfig, boolean enabled) Add a new remote slave cluster for replication.
void	setPeerTableCFsConfig(String peerId, Map<TableName,? extends Collection<String>> tableCFs) Set the table and column-family list string of the peer to the underlying storage.
void	unregisterPeer(String peerId) Removes a remote slave cluster and stops the replication to it.
void	updatePeerConfig(String id, ReplicationPeerConfig peerConfig) Update the peerConfig for the a given peer cluster

Method Detail

init

void init()
   throws ReplicationException

Initialize the ReplicationPeers interface.

Throws:

ReplicationException

registerPeer

default void registerPeer(String peerId,
                          ReplicationPeerConfig peerConfig)
                   throws ReplicationException

Add a new remote slave cluster for replication.

Parameters:

peerId - a short that identifies the cluster

peerConfig - configuration for the replication slave cluster

Throws:

ReplicationException

registerPeer

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

Add a new remote slave cluster for replication.

Parameters:

peerId - 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

void unregisterPeer(String peerId)
             throws ReplicationException

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

Parameters:

peerId - a short that identifies the cluster

Throws:

ReplicationException

peerConnected

boolean peerConnected(String peerId)
               throws ReplicationException

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

Parameters:

peerId - a short that identifies the cluster

Returns:

whether a ReplicationPeer was successfully created

Throws:

ReplicationException

peerDisconnected

void peerDisconnected(String peerId)

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

Parameters:

peerId - a short that identifies the cluster

enablePeer

void enablePeer(String peerId)
         throws ReplicationException

Restart the replication to the specified remote slave cluster.

Parameters:

peerId - a short that identifies the cluster

Throws:

ReplicationException

disablePeer

void disablePeer(String peerId)
          throws ReplicationException

Stop the replication to the specified remote slave cluster.

Parameters:

peerId - a short that identifies the cluster

Throws:

ReplicationException

getPeerTableCFsConfig

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

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

Parameters:

peerId - a short that identifies the cluster

Throws:

ReplicationException

setPeerTableCFsConfig

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

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

Parameters:

peerId - a short that identifies the cluster

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

Throws:

ReplicationException

getConnectedPeer

ReplicationPeer getConnectedPeer(String peerId)

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.

Parameters:

peerId - id for the peer

Returns:

ReplicationPeer object

getConnectedPeerIds

Set<String> getConnectedPeerIds()

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

Returns:

a Set of Strings for peerIds

getStatusOfPeer

boolean getStatusOfPeer(String peerId)

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

Parameters:

peerId - a short that identifies the cluster

Returns:

true if replication is enabled, false otherwise.

getStatusOfPeerFromBackingStore

boolean getStatusOfPeerFromBackingStore(String peerId)
                                 throws ReplicationException

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.

Parameters:

peerId - 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

Map<String,ReplicationPeerConfig> getAllPeerConfigs()

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

Returns:

A map of peer ids to peer cluster keys

getAllPeerIds

List<String> getAllPeerIds()

List the peer ids of all remote slave clusters (whether they are enabled/disabled or connected/disconnected).

Returns:

A list of peer ids

getReplicationPeerConfig

ReplicationPeerConfig getReplicationPeerConfig(String peerId)
                                        throws ReplicationException

Returns the configured ReplicationPeerConfig for this peerId

Parameters:

peerId - a short name that identifies the cluster

Returns:

ReplicationPeerConfig for the peer

Throws:

ReplicationException

getPeerConf

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

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

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

void updatePeerConfig(String id,
                      ReplicationPeerConfig peerConfig)
               throws ReplicationException

Update the peerConfig for the a given peer cluster

Parameters:

id - a short that identifies the cluster

peerConfig - new config for the peer cluster

Throws:

ReplicationException