ReplicationPeerZKImpl (Apache HBase 1.2.12 API)

java.lang.Object
- org.apache.hadoop.hbase.replication.ReplicationPeerZKImpl

All Implemented Interfaces:: Closeable, AutoCloseable, Abortable, ReplicationPeer

@InterfaceAudience.Private
public class ReplicationPeerZKImpl
extends Object
implements ReplicationPeer, Abortable, Closeable

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`class`	`ReplicationPeerZKImpl.PeerStateTracker` Tracker for state of this peer
`class`	`ReplicationPeerZKImpl.TableCFsTracker` Tracker for (table, cf-list) map of this peer

Nested classes/interfaces inherited from interface org.apache.hadoop.hbase.replication.ReplicationPeer
ReplicationPeer.PeerState

Field Summary

Fields
Modifier and Type	Field and Description
`private org.apache.hadoop.conf.Configuration`	`conf`
`private String`	`id`
`private static org.apache.commons.logging.Log`	`LOG`
`private ReplicationPeerConfig`	`peerConfig`
`private ReplicationPeer.PeerState`	`peerState`
`private ReplicationPeerZKImpl.PeerStateTracker`	`peerStateTracker`
`private Map<TableName,List<String>>`	`tableCFs`
`private ReplicationPeerZKImpl.TableCFsTracker`	`tableCFsTracker`

Constructor Summary

Constructors
Constructor and Description
`ReplicationPeerZKImpl(org.apache.hadoop.conf.Configuration conf, String id, ReplicationPeerConfig peerConfig)` Constructor that takes all the objects required to communicate with the specified peer, except for the region server addresses.
`ReplicationPeerZKImpl(org.apache.hadoop.conf.Configuration conf, String id, ReplicationPeerConfig peerConfig, Map<TableName,List<String>> tableCFs)` Constructor that takes all the objects required to communicate with the specified peer, except for the region server addresses.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`abort(String why, Throwable e)` Abort the server or client.
`void`	`close()`
`private static boolean`	`ensurePeerEnabled(ZooKeeperWatcher zookeeper, String path)` Utility method to ensure an ENABLED znode is in place; if not present, we create it.
`org.apache.hadoop.conf.Configuration`	`getConfiguration()` Get the configuration object required to communicate with this peer
`String`	`getId()` Get the identifier of this peer
`ReplicationPeerConfig`	`getPeerConfig()` Get the peer config object
`ReplicationPeer.PeerState`	`getPeerState()` Returns the state of the peer
`Map<TableName,List<String>>`	`getTableCFs()` Get replicable (table, cf-list) map of this peer
`boolean`	`isAborted()` Check if the server or client was aborted.
`static boolean`	`isStateEnabled(byte[] bytes)` Parse the raw data from ZK to get a peer's state
`private static org.apache.hadoop.hbase.protobuf.generated.ZooKeeperProtos.ReplicationState.State`	`parseStateFrom(byte[] bytes)`
`private void`	`readPeerStateZnode()`
`private void`	`readTableCFsZnode()`
`void`	`startStateTracker(ZooKeeperWatcher zookeeper, String peerStateNode)` start a state tracker to check whether this peer is enabled or not
`void`	`startTableCFsTracker(ZooKeeperWatcher zookeeper, String tableCFsNode)` start a table-cfs tracker to listen the (table, cf-list) map change

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

- Field Detail
  - LOG
```
private static final org.apache.commons.logging.Log LOG
```
  - peerConfig
```
private final ReplicationPeerConfig peerConfig
```
  - id
```
private final String id
```
  - peerState
```
private volatile ReplicationPeer.PeerState peerState
```
  - tableCFs
```
private volatile Map<TableName,List<String>> tableCFs
```
  - conf
```
private final org.apache.hadoop.conf.Configuration conf
```
  - peerStateTracker
```
private ReplicationPeerZKImpl.PeerStateTracker peerStateTracker
```
  - tableCFsTracker
```
private ReplicationPeerZKImpl.TableCFsTracker tableCFsTracker
```
- Constructor Detail
  - ReplicationPeerZKImpl
```
public ReplicationPeerZKImpl(org.apache.hadoop.conf.Configuration conf,
                     String id,
                     ReplicationPeerConfig peerConfig)
                      throws ReplicationException
```
    Constructor that takes all the objects required to communicate with the specified peer, except for the region server addresses.
    
    Parameters:
    conf - configuration object to this peer
    id - string representation of this peer's identifier
    peerConfig - configuration for the replication peer
    
    Throws:
    
    ReplicationException
  - ReplicationPeerZKImpl
```
public ReplicationPeerZKImpl(org.apache.hadoop.conf.Configuration conf,
                     String id,
                     ReplicationPeerConfig peerConfig,
                     Map<TableName,List<String>> tableCFs)
                      throws ReplicationException
```
    Constructor that takes all the objects required to communicate with the specified peer, except for the region server addresses.
    
    Parameters:
    conf - configuration object to this peer
    id - string representation of this peer's identifier
    peerConfig - configuration for the replication peer
    tableCFs - table-cf configuration for this peer
    
    Throws:
    
    ReplicationException
- Method Detail
  - startStateTracker
```
public void startStateTracker(ZooKeeperWatcher zookeeper,
                     String peerStateNode)
                       throws org.apache.zookeeper.KeeperException
```
    start a state tracker to check whether this peer is enabled or not
    
    Parameters:
    zookeeper - zk watcher for the local cluster
    peerStateNode - path to zk node which stores peer state
    
    Throws:
    
    org.apache.zookeeper.KeeperException
  - readPeerStateZnode
```
private void readPeerStateZnode()
                         throws DeserializationException
```
    Throws:
    
    DeserializationException
  - startTableCFsTracker
```
public void startTableCFsTracker(ZooKeeperWatcher zookeeper,
                        String tableCFsNode)
                          throws org.apache.zookeeper.KeeperException
```
    start a table-cfs tracker to listen the (table, cf-list) map change
    
    Parameters:
    zookeeper - zk watcher for the local cluster
    tableCFsNode - path to zk node which stores table-cfs
    
    Throws:
    
    org.apache.zookeeper.KeeperException
  - readTableCFsZnode
```
private void readTableCFsZnode()
```
  - getPeerState
```
public ReplicationPeer.PeerState getPeerState()
```
    Description copied from interface: ReplicationPeer
    
    Returns the state of the peer
    
    Specified by:
    
    getPeerState in interface ReplicationPeer
    
    Returns:
    the enabled state
  - getId
```
public String getId()
```
    Get the identifier of this peer
    
    Specified by:
    
    getId in interface ReplicationPeer
    
    Returns:
    string representation of the id (short)
  - getPeerConfig
```
public ReplicationPeerConfig getPeerConfig()
```
    Get the peer config object
    
    Specified by:
    
    getPeerConfig in interface ReplicationPeer
    
    Returns:
    the ReplicationPeerConfig for this peer
  - getConfiguration
```
public org.apache.hadoop.conf.Configuration getConfiguration()
```
    Get the configuration object required to communicate with this peer
    
    Specified by:
    
    getConfiguration in interface ReplicationPeer
    
    Returns:
    configuration object
  - getTableCFs
```
public Map<TableName,List<String>> getTableCFs()
```
    Get replicable (table, cf-list) map of this peer
    
    Specified by:
    
    getTableCFs in interface ReplicationPeer
    
    Returns:
    the replicable (table, cf-list) map
  - abort
```
public void abort(String why,
         Throwable e)
```
    Description copied from interface: Abortable
    
    Abort the server or client.
    
    Specified by:
    
    abort in interface Abortable
    
    Parameters:
    why - Why we're aborting.
    e - Throwable that caused abort. Can be null.
  - isAborted
```
public boolean isAborted()
```
    Description copied from interface: Abortable
    
    Check if the server or client was aborted.
    
    Specified by:
    
    isAborted in interface Abortable
    
    Returns:
    true if the server or client was aborted, false otherwise
  - close
```
public void close()
           throws IOException
```
    Specified by:
    
    close in interface Closeable
    
    Specified by:
    
    close in interface AutoCloseable
    
    Throws:
    
    IOException
  - isStateEnabled
```
public static boolean isStateEnabled(byte[] bytes)
                              throws DeserializationException
```
    Parse the raw data from ZK to get a peer's state
    
    Parameters:
    bytes - raw ZK data
    
    Returns:
    True if the passed in bytes are those of a pb serialized ENABLED state.
    
    Throws:
    
    DeserializationException
  - parseStateFrom
```
private static org.apache.hadoop.hbase.protobuf.generated.ZooKeeperProtos.ReplicationState.State parseStateFrom(byte[] bytes)
                                                                                                         throws DeserializationException
```
    Parameters:
    bytes - Content of a state znode.
    
    Returns:
    State parsed from the passed bytes.
    
    Throws:
    
    DeserializationException
  - ensurePeerEnabled
```
private static boolean ensurePeerEnabled(ZooKeeperWatcher zookeeper,
                        String path)
                                  throws org.apache.zookeeper.KeeperException.NodeExistsException,
                                         org.apache.zookeeper.KeeperException
```
    Utility method to ensure an ENABLED znode is in place; if not present, we create it.
    
    Parameters:
    zookeeper -
    path - Path to znode to check
    
    Returns:
    True if we created the znode.
    
    Throws:
    
    org.apache.zookeeper.KeeperException.NodeExistsException
    
    org.apache.zookeeper.KeeperException

Class ReplicationPeerZKImpl

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.hadoop.hbase.replication.ReplicationPeer

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

LOG

peerConfig

id

peerState

tableCFs

conf

peerStateTracker

tableCFsTracker

Constructor Detail

ReplicationPeerZKImpl

ReplicationPeerZKImpl

Method Detail

startStateTracker

readPeerStateZnode

startTableCFsTracker

readTableCFsZnode

getPeerState

getId

getPeerConfig

getConfiguration

getTableCFs

abort

isAborted

close

isStateEnabled

parseStateFrom

ensurePeerEnabled