ReplicationTableBase (Apache HBase 2.0.6 API)

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

@InterfaceAudience.Private
abstract class ReplicationTableBase
extends Object

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

private class ReplicationTableBase.CreateReplicationTableWorker
Attempts to build the Replication Table.

Nested Classes
Modifier and Type	Class and Description
`private class`	`ReplicationTableBase.CreateReplicationTableWorker` Attempts to build the Replication Table.

Field Summary

Fields
Modifier and Type	Field and Description
`protected Abortable`	`abortable`
`static byte[]`	`CF_QUEUE`
`private static int`	`CLIENT_RETRIES`
`static byte[]`	`COL_QUEUE_OWNER`
`static byte[]`	`COL_QUEUE_OWNER_HISTORY`
`protected org.apache.hadoop.conf.Configuration`	`conf`
`private Connection`	`connection`
`private Executor`	`executor`
`private static int`	`NUM_INITIALIZE_WORKERS`
`private static int`	`OPERATION_TIMEOUT`
`static String`	`QUEUE_HISTORY_DELIMITER`
`private static HColumnDescriptor`	`REPLICATION_COL_DESCRIPTOR`
`static TableName`	`REPLICATION_TABLE_NAME` Name of the HBase Table used for tracking replication
`private CountDownLatch`	`replicationTableInitialized`
`static String`	`ROW_KEY_DELIMITER`
`private static int`	`RPC_TIMEOUT`

Constructor Summary

Constructors
Constructor and Description

ReplicationTableBase(org.apache.hadoop.conf.Configuration conf, Abortable abort)

Constructors
Constructor and Description
`ReplicationTableBase(org.apache.hadoop.conf.Configuration conf, Abortable abort)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected String`	`buildClaimedQueueHistory(String originalHistory, String oldServer)` Creates a "\|" delimited record of the queue's past region server owners.
`protected String`	`buildQueueRowKey(String serverName, String queueId)` Build the row key for the given queueId.
`private void`	`createReplicationTableInBackground()` Builds the Replication Table in a background thread.
`private void`	`decorateConf()` Modify the connection's config so that operations run on the Replication Table have longer and a larger number of retries
`protected List<String>`	`getAllQueues(String serverName)`
`private Table`	`getAndSetUpReplicationTable()` Creates a new copy of the Replication Table and sets up the proper Table time outs for it
`boolean`	`getInitializationStatus()` Get whether the Replication Table has been successfully initialized yet
`protected List<String>`	`getListOfReplicators()` Get a list of all region servers that have outstanding replication queues.
`protected List<String>`	`getLogsInQueue(byte[] rowKey)`
`protected List<String>`	`getLogsInQueue(String serverName, String queueId)`
`protected Table`	`getOrBlockOnReplicationTable()` Attempts to acquire the Replication Table.
`protected ResultScanner`	`getQueuesBelongingToServer(String server)` Get the queue id's and meta data (Owner and History) for the queues belonging to the named server
`protected String`	`getRawQueueIdFromRowKey(String rowKey)` Parse the original queueId from a row key
`protected byte[]`	`queueIdToRowKey(String serverName, String queueId)` Returns a queue's row key given either its raw or reclaimed queueId
`protected List<String>`	`readWALsFromResult(Result queue)` Read all of the WAL's from a queue into a list
`private Table`	`setReplicationTableTimeOuts(Table replicationTable)` Increases the RPC and operations timeouts for the Replication Table
`private Executor`	`setUpExecutor()` Sets up the thread pool executor used to build the Replication Table in the background

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

- Field Detail
  - REPLICATION_TABLE_NAME
```
public static final TableName REPLICATION_TABLE_NAME
```
    Name of the HBase Table used for tracking replication
  - CF_QUEUE
```
public static final byte[] CF_QUEUE
```
  - COL_QUEUE_OWNER
```
public static final byte[] COL_QUEUE_OWNER
```
  - COL_QUEUE_OWNER_HISTORY
```
public static final byte[] COL_QUEUE_OWNER_HISTORY
```
  - REPLICATION_COL_DESCRIPTOR
```
private static final HColumnDescriptor REPLICATION_COL_DESCRIPTOR
```
  - ROW_KEY_DELIMITER
```
public static final String ROW_KEY_DELIMITER
```
    See Also:
    
    Constant Field Values
  - QUEUE_HISTORY_DELIMITER
```
public static final String QUEUE_HISTORY_DELIMITER
```
    See Also:
    
    Constant Field Values
  - CLIENT_RETRIES
```
private static final int CLIENT_RETRIES
```
    See Also:
    
    Constant Field Values
  - RPC_TIMEOUT
```
private static final int RPC_TIMEOUT
```
    See Also:
    
    Constant Field Values
  - OPERATION_TIMEOUT
```
private static final int OPERATION_TIMEOUT
```
    See Also:
    
    Constant Field Values
  - NUM_INITIALIZE_WORKERS
```
private static final int NUM_INITIALIZE_WORKERS
```
    See Also:
    
    Constant Field Values
  - conf
```
protected final org.apache.hadoop.conf.Configuration conf
```
  - abortable
```
protected final Abortable abortable
```
  - connection
```
private final Connection connection
```
  - executor
```
private final Executor executor
```
  - replicationTableInitialized
```
private volatile CountDownLatch replicationTableInitialized
```
- Constructor Detail
  - ReplicationTableBase
```
public ReplicationTableBase(org.apache.hadoop.conf.Configuration conf,
                            Abortable abort)
                     throws IOException
```
    Throws:
    
    IOException
- Method Detail
  - decorateConf
```
private void decorateConf()
```
    Modify the connection's config so that operations run on the Replication Table have longer and a larger number of retries
  - setUpExecutor
```
private Executor setUpExecutor()
```
    Sets up the thread pool executor used to build the Replication Table in the background
    
    Returns:
    
    the configured executor
  - getInitializationStatus
```
public boolean getInitializationStatus()
```
    Get whether the Replication Table has been successfully initialized yet
    
    Returns:
    
    whether the Replication Table is initialized
  - setReplicationTableTimeOuts
```
private Table setReplicationTableTimeOuts(Table replicationTable)
```
    Increases the RPC and operations timeouts for the Replication Table
  - buildQueueRowKey
```
protected String buildQueueRowKey(String serverName,
                                  String queueId)
```
    Build the row key for the given queueId. This will uniquely identify it from all other queues in the cluster.
    
    Parameters:
    
    serverName - The owner of the queue
    
    queueId - String identifier of the queue
    
    Returns:
    
    String representation of the queue's row key
  - getRawQueueIdFromRowKey
```
protected String getRawQueueIdFromRowKey(String rowKey)
```
    Parse the original queueId from a row key
    
    Parameters:
    
    rowKey - String representation of a queue's row key
    
    Returns:
    
    the original queueId
  - queueIdToRowKey
```
protected byte[] queueIdToRowKey(String serverName,
                                 String queueId)
```
    Returns a queue's row key given either its raw or reclaimed queueId
    
    Parameters:
    
    queueId - queueId of the queue
    
    Returns:
    
    byte representation of the queue's row key
  - buildClaimedQueueHistory
```
protected String buildClaimedQueueHistory(String originalHistory,
                                          String oldServer)
```
    Creates a "|" delimited record of the queue's past region server owners.
    
    Parameters:
    
    originalHistory - the queue's original owner history
    
    oldServer - the name of the server that used to own the queue
    
    Returns:
    
    the queue's new owner history
  - getListOfReplicators
```
protected List<String> getListOfReplicators()
```
    Get a list of all region servers that have outstanding replication queues. These servers could be alive, dead or from a previous run of the cluster.
    
    Returns:
    
    a list of server names
  - getAllQueues
```
protected List<String> getAllQueues(String serverName)
```
  - getLogsInQueue
```
protected List<String> getLogsInQueue(String serverName,
                                      String queueId)
```
  - getLogsInQueue
```
protected List<String> getLogsInQueue(byte[] rowKey)
```
  - readWALsFromResult
```
protected List<String> readWALsFromResult(Result queue)
```
    Read all of the WAL's from a queue into a list
    
    Parameters:
    
    queue - HBase query result containing the queue
    
    Returns:
    
    a list of all the WAL filenames
  - getQueuesBelongingToServer
```
protected ResultScanner getQueuesBelongingToServer(String server)
                                            throws IOException
```
    Get the queue id's and meta data (Owner and History) for the queues belonging to the named server
    
    Parameters:
    
    server - name of the server
    
    Returns:
    
    a ResultScanner over the QueueIds belonging to the server
    
    Throws:
    
    IOException
  - getOrBlockOnReplicationTable
```
protected Table getOrBlockOnReplicationTable()
                                      throws IOException
```
    Attempts to acquire the Replication Table. This operation will block until it is assigned by the CreateReplicationWorker thread. It is up to the caller of this method to close the returned Table
    
    Returns:
    
    the Replication Table when it is created
    
    Throws:
    
    IOException
  - getAndSetUpReplicationTable
```
private Table getAndSetUpReplicationTable()
                                   throws IOException
```
    Creates a new copy of the Replication Table and sets up the proper Table time outs for it
    
    Returns:
    
    the Replication Table
    
    Throws:
    
    IOException
  - createReplicationTableInBackground
```
private void createReplicationTableInBackground()
                                         throws IOException
```
    Builds the Replication Table in a background thread. Any method accessing the Replication Table should do so through getOrBlockOnReplicationTable()
    
    Throws:
    
    IOException - if the Replication Table takes too long to build

Class ReplicationTableBase

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

REPLICATION_TABLE_NAME

CF_QUEUE

COL_QUEUE_OWNER

COL_QUEUE_OWNER_HISTORY

REPLICATION_COL_DESCRIPTOR

ROW_KEY_DELIMITER

QUEUE_HISTORY_DELIMITER

CLIENT_RETRIES

RPC_TIMEOUT

OPERATION_TIMEOUT

NUM_INITIALIZE_WORKERS

conf

abortable

connection

executor

replicationTableInitialized

Constructor Detail

ReplicationTableBase

Method Detail

decorateConf

setUpExecutor

getInitializationStatus

setReplicationTableTimeOuts

buildQueueRowKey

getRawQueueIdFromRowKey

queueIdToRowKey

buildClaimedQueueHistory

getListOfReplicators

getAllQueues

getLogsInQueue

getLogsInQueue

readWALsFromResult

getQueuesBelongingToServer

getOrBlockOnReplicationTable

getAndSetUpReplicationTable

createReplicationTableInBackground