Package org.apache.hadoop.hbase.replication

Interface ReplicationPeer

All Known Implementing Classes:

ReplicationPeerImpl

@LimitedPrivate("Replication")
public interface ReplicationPeer

ReplicationPeer manages enabled / disabled state for the peer.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	ReplicationPeer.PeerState	State of the peer, whether it is enabled or not

Method Summary

Modifier and Type	Method	Description
org.apache.hadoop.conf.Configuration	getConfiguration()	Get the configuration object required to communicate with this peer
String	getId()	Get the identifier of this peer
Set<String>	getNamespaces()	Get replicable namespace set of this peer
long	getPeerBandwidth()	Get the per node bandwidth upper limit for this peer
ReplicationPeerConfig	getPeerConfig()	Get the peer config object
ReplicationPeer.PeerState	getPeerState()	Returns the state of the peer by reading local cache.
SyncReplicationState	getSyncReplicationState()	Returns the sync replication state of the peer by reading local cache.
Map<TableName,List<String>>	getTableCFs()	Get replicable (table, cf-list) map of this peer
default boolean	isPeerEnabled()	Test whether the peer is enabled.
void	registerPeerConfigListener(ReplicationPeerConfigListener listener)	Register a peer config listener to catch the peer config change event.
default void	trackPeerConfigChanges(ReplicationPeerConfigListener listener)	Deprecated. since 2.1.0 and will be removed in 4.0.0.

Method Details

getId

String getId()

Get the identifier of this peer

Returns:

string representation of the id

getPeerState

ReplicationPeer.PeerState getPeerState()

Returns the state of the peer by reading local cache.

Returns:

the enabled state

getSyncReplicationState

SyncReplicationState getSyncReplicationState()

Returns the sync replication state of the peer by reading local cache.

If the peer is not a synchronous replication peer, a SyncReplicationState.NONE will be returned.

Returns:

the sync replication state

isPeerEnabled

default boolean isPeerEnabled()

Test whether the peer is enabled.

Returns:

true if enabled, otherwise false.

getPeerConfig

ReplicationPeerConfig getPeerConfig()

Get the peer config object

Returns:

the ReplicationPeerConfig for this peer

getConfiguration

org.apache.hadoop.conf.Configuration getConfiguration()

Get the configuration object required to communicate with this peer

Returns:

configuration object

getTableCFs

Map<TableName,List<String>> getTableCFs()

Get replicable (table, cf-list) map of this peer

Returns:

the replicable (table, cf-list) map

getNamespaces

Set<String> getNamespaces()

Get replicable namespace set of this peer

Returns:

the replicable namespaces set

getPeerBandwidth

long getPeerBandwidth()

Get the per node bandwidth upper limit for this peer

Returns:

the bandwidth upper limit

registerPeerConfigListener

void registerPeerConfigListener(ReplicationPeerConfigListener listener)

Register a peer config listener to catch the peer config change event.

Parameters:

listener - listener to catch the peer config change event.

trackPeerConfigChanges

@Deprecated
default void trackPeerConfigChanges(ReplicationPeerConfigListener listener)

Deprecated.

since 2.1.0 and will be removed in 4.0.0. Use registerPeerConfigListener(ReplicationPeerConfigListener) instead.

See Also:

• registerPeerConfigListener(ReplicationPeerConfigListener)
• HBASE-19573