org.apache.hadoop.hbase.replication

Class FSReplicationPeerStorage

java.lang.Object

org.apache.hadoop.hbase.replication.FSReplicationPeerStorage

All Implemented Interfaces:

ReplicationPeerStorage

@InterfaceAudience.Private
public class FSReplicationPeerStorage
extends Object
implements ReplicationPeerStorage

A filesystem based replication peer storage. The implementation does not require atomic rename so you can use it on cloud OSS.

FileSystem layout:

 hbase
   |
   --peers
       |
       --<peer_id>
           |
           --peer_config
           |
           --disabled
           |
           --sync-rep-state
 

Notice that, if the peer is enabled, we will not have a disabled file.

And for other files, to avoid depending on atomic rename, we will use two files for storing the content. When loading, we will try to read both the files and load the newer one. And when writing, we will write to the older file.

Field Summary

Fields

Modifier and Type	Field and Description
static String	PEERS_DIR
static String	PEERS_DIR_DEFAULT

Constructor Summary

Constructors

Constructor and Description
FSReplicationPeerStorage(org.apache.hadoop.fs.FileSystem fs, org.apache.hadoop.conf.Configuration conf)

Method Summary

Modifier and Type	Method and 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 newState) 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 ReplicationPeerStorage.setPeerNewSyncReplicationState(String, SyncReplicationState) method above, and clear the new sync replication state.
void	updatePeerConfig(String peerId, ReplicationPeerConfig peerConfig) Update the config a replication peer.

Methods inherited from class java.lang.Object

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

Field Detail

PEERS_DIR

public static final String PEERS_DIR

See Also:

Constant Field Values

PEERS_DIR_DEFAULT

public static final String PEERS_DIR_DEFAULT

See Also:

Constant Field Values

Constructor Detail

FSReplicationPeerStorage

public FSReplicationPeerStorage(org.apache.hadoop.fs.FileSystem fs,
                                org.apache.hadoop.conf.Configuration conf)
                         throws IOException

Throws:

IOException

Method Detail

addPeer

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

Description copied from interface: ReplicationPeerStorage

Add a replication peer.

Specified by:

addPeer in interface ReplicationPeerStorage

Throws:

ReplicationException - if there are errors accessing the storage service.

removePeer

public void removePeer(String peerId)
                throws ReplicationException

Description copied from interface: ReplicationPeerStorage

Remove a replication peer.

Specified by:

removePeer in interface ReplicationPeerStorage

Throws:

ReplicationException - if there are errors accessing the storage service.

setPeerState

public void setPeerState(String peerId,
                         boolean enabled)
                  throws ReplicationException

Description copied from interface: ReplicationPeerStorage

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

Specified by:

setPeerState in interface ReplicationPeerStorage

Throws:

ReplicationException - if there are errors accessing the storage service.

updatePeerConfig

public void updatePeerConfig(String peerId,
                             ReplicationPeerConfig peerConfig)
                      throws ReplicationException

Description copied from interface: ReplicationPeerStorage

Update the config a replication peer.

Specified by:

updatePeerConfig in interface ReplicationPeerStorage

Throws:

ReplicationException - if there are errors accessing the storage service.

listPeerIds

public List<String> listPeerIds()
                         throws ReplicationException

Description copied from interface: ReplicationPeerStorage

Return the peer ids of all replication peers.

Specified by:

listPeerIds in interface ReplicationPeerStorage

Throws:

ReplicationException - if there are errors accessing the storage service.

isPeerEnabled

public boolean isPeerEnabled(String peerId)
                      throws ReplicationException

Description copied from interface: ReplicationPeerStorage

Test whether a replication peer is enabled.

Specified by:

isPeerEnabled in interface ReplicationPeerStorage

Throws:

ReplicationException - if there are errors accessing the storage service.

getPeerConfig

public ReplicationPeerConfig getPeerConfig(String peerId)
                                    throws ReplicationException

Description copied from interface: ReplicationPeerStorage

Get the peer config of a replication peer.

Specified by:

getPeerConfig in interface ReplicationPeerStorage

Throws:

ReplicationException - if there are errors accessing the storage service.

setPeerNewSyncReplicationState

public void setPeerNewSyncReplicationState(String peerId,
                                           SyncReplicationState newState)
                                    throws ReplicationException

Description copied from interface: ReplicationPeerStorage

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

Specified by:

setPeerNewSyncReplicationState in interface ReplicationPeerStorage

Throws:

ReplicationException - if there are errors accessing the storage service.

transitPeerSyncReplicationState

public void transitPeerSyncReplicationState(String peerId)
                                     throws ReplicationException

Description copied from interface: ReplicationPeerStorage

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

Specified by:

transitPeerSyncReplicationState in interface ReplicationPeerStorage

Throws:

ReplicationException - if there are errors accessing the storage service.

getPeerSyncReplicationState

public SyncReplicationState getPeerSyncReplicationState(String peerId)
                                                 throws ReplicationException

Description copied from interface: ReplicationPeerStorage

Get the sync replication state.

Specified by:

getPeerSyncReplicationState in interface ReplicationPeerStorage

Throws:

ReplicationException - if there are errors accessing the storage service.

getPeerNewSyncReplicationState

public SyncReplicationState getPeerNewSyncReplicationState(String peerId)
                                                    throws ReplicationException

Description copied from interface: ReplicationPeerStorage

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

Specified by:

getPeerNewSyncReplicationState in interface ReplicationPeerStorage

Throws:

ReplicationException - if there are errors accessing the storage service.