Package org.apache.hadoop.hbase.replication

Interface ReplicationPeerStorage

All Known Implementing Classes:

FSReplicationPeerStorage, ZKReplicationPeerStorage

@Private
public interface ReplicationPeerStorage

Perform read/write to the replication peer storage.

Method Summary

Modifier and Type	Method	Description
void	addPeer(String peerId, ReplicationPeerConfig peerConfig, boolean enabled, SyncReplicationState syncReplicationState)	Add a replication peer.
ReplicationPeerConfig	getPeerConfig(String peerId)	Get the peer config of a replication peer.
SyncReplicationState	getPeerNewSyncReplicationState(String peerId)	Get the new sync replication state.
SyncReplicationState	getPeerSyncReplicationState(String peerId)	Get the sync replication state.
boolean	isPeerEnabled(String peerId)	Test whether a replication peer is enabled.
List<String>	listPeerIds()	Return the peer ids of all replication peers.
void	removePeer(String peerId)	Remove a replication peer.
void	setPeerNewSyncReplicationState(String peerId, SyncReplicationState state)	Set the new sync replication state that we are going to transit to.
void	setPeerState(String peerId, boolean enabled)	Set the state of peer, true to ENABLED, otherwise to DISABLED.
void	transitPeerSyncReplicationState(String peerId)	Overwrite the sync replication state with the new sync replication state which is set with the setPeerNewSyncReplicationState(String, SyncReplicationState) method above, and clear the new sync replication state.
void	updatePeerConfig(String peerId, ReplicationPeerConfig peerConfig)	Update the config a replication peer.

Method Details

addPeer

void addPeer(String peerId,
 ReplicationPeerConfig peerConfig,
 boolean enabled,
 SyncReplicationState syncReplicationState)
      throws ReplicationException

Add a replication peer.

Throws:

ReplicationException - if there are errors accessing the storage service.

removePeer

void removePeer(String peerId)
         throws ReplicationException

Remove a replication peer.

Throws:

ReplicationException - if there are errors accessing the storage service.

setPeerState

void setPeerState(String peerId,
 boolean enabled)
           throws ReplicationException

Set the state of peer, true to ENABLED, otherwise to DISABLED.

Throws:

ReplicationException - if there are errors accessing the storage service.

updatePeerConfig

void updatePeerConfig(String peerId,
 ReplicationPeerConfig peerConfig)
               throws ReplicationException

Update the config a replication peer.

Throws:

ReplicationException - if there are errors accessing the storage service.

listPeerIds

List<String> listPeerIds()
                  throws ReplicationException

Return the peer ids of all replication peers.

Throws:

ReplicationException - if there are errors accessing the storage service.

isPeerEnabled

boolean isPeerEnabled(String peerId)
               throws ReplicationException

Test whether a replication peer is enabled.

Throws:

ReplicationException - if there are errors accessing the storage service.

getPeerConfig

ReplicationPeerConfig getPeerConfig(String peerId)
                             throws ReplicationException

Get the peer config of a replication peer.

Throws:

ReplicationException - if there are errors accessing the storage service.

setPeerNewSyncReplicationState

void setPeerNewSyncReplicationState(String peerId,
 SyncReplicationState state)
                             throws ReplicationException

Set the new sync replication state that we are going to transit to.

Throws:

ReplicationException - if there are errors accessing the storage service.

transitPeerSyncReplicationState

void transitPeerSyncReplicationState(String peerId)
                              throws ReplicationException

Overwrite the sync replication state with the new sync replication state which is set with the setPeerNewSyncReplicationState(String, SyncReplicationState) method above, and clear the new sync replication state.

Throws:

ReplicationException - if there are errors accessing the storage service.

getPeerSyncReplicationState

SyncReplicationState getPeerSyncReplicationState(String peerId)
                                          throws ReplicationException

Get the sync replication state.

Throws:

ReplicationException - if there are errors accessing the storage service.

getPeerNewSyncReplicationState

SyncReplicationState getPeerNewSyncReplicationState(String peerId)
                                             throws ReplicationException

Get the new sync replication state. Will return SyncReplicationState.NONE if we are not in a transition.

Throws:

ReplicationException - if there are errors accessing the storage service.