ZKTableStateManager (Apache HBase 1.2.12 API)

java.lang.Object
- org.apache.hadoop.hbase.zookeeper.ZKTableStateManager

All Implemented Interfaces:

TableStateManager
```
@InterfaceAudience.Private
public class ZKTableStateManager
extends Object
implements TableStateManager
```
Implementation of TableStateManager which reads, caches and sets state up in ZooKeeper. If multiple read/write clients, will make for confusion. Code running on client side without consensus context should use ZKTableStateClientSideReader instead.
To save on trips to the zookeeper ensemble, internally we cache table state.

Field Summary

Fields
Modifier and Type	Field and Description
`private Map<TableName,org.apache.hadoop.hbase.protobuf.generated.ZooKeeperProtos.Table.State>`	`cache` Cache of what we found in zookeeper so we don't have to go to zk ensemble for every query.
`private static org.apache.commons.logging.Log`	`LOG`
`private ZooKeeperWatcher`	`watcher`

Constructor Summary

Constructors
Constructor and Description

ZKTableStateManager(ZooKeeperWatcher zkw)

Constructors
Constructor and Description
`ZKTableStateManager(ZooKeeperWatcher zkw)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`checkAndRemoveTableState(TableName tableName, org.apache.hadoop.hbase.protobuf.generated.ZooKeeperProtos.Table.State states, boolean deletePermanentState)` If the table is found in the given state the in-memory state is removed.
`(package private) Set<TableName>`	`getAllTables(org.apache.hadoop.hbase.protobuf.generated.ZooKeeperProtos.Table.State... states)` Gets a list of all the tables of specified states in zookeeper.
`Set<TableName>`	`getTablesInStates(org.apache.hadoop.hbase.protobuf.generated.ZooKeeperProtos.Table.State... states)` Gets a list of all the tables set as disabling in zookeeper.
`private org.apache.hadoop.hbase.protobuf.generated.ZooKeeperProtos.Table.State`	`getTableState(ZooKeeperWatcher zkw, TableName tableName)` Gets table state from ZK.
`private boolean`	`isTableInState(List<org.apache.hadoop.hbase.protobuf.generated.ZooKeeperProtos.Table.State> expectedStates, org.apache.hadoop.hbase.protobuf.generated.ZooKeeperProtos.Table.State currentState)`
`boolean`	`isTablePresent(TableName tableName)` check if table is present.
`boolean`	`isTableState(TableName tableName, boolean checkSource, org.apache.hadoop.hbase.protobuf.generated.ZooKeeperProtos.Table.State... states)` Checks if table is marked in specified state in ZK.
`boolean`	`isTableState(TableName tableName, org.apache.hadoop.hbase.protobuf.generated.ZooKeeperProtos.Table.State... states)` Checks if table is marked in specified state in ZK (using cache only).
`private void`	`populateTableStates()` Gets a list of all the tables set as disabled in zookeeper.
`void`	`setDeletedTable(TableName tableName)` Deletes the table in zookeeper.
`void`	`setTableState(TableName tableName, org.apache.hadoop.hbase.protobuf.generated.ZooKeeperProtos.Table.State state)` Sets table state in ZK.
`boolean`	`setTableStateIfInStates(TableName tableName, org.apache.hadoop.hbase.protobuf.generated.ZooKeeperProtos.Table.State newState, org.apache.hadoop.hbase.protobuf.generated.ZooKeeperProtos.Table.State... states)` Checks and sets table state in ZK.
`boolean`	`setTableStateIfNotInStates(TableName tableName, org.apache.hadoop.hbase.protobuf.generated.ZooKeeperProtos.Table.State newState, org.apache.hadoop.hbase.protobuf.generated.ZooKeeperProtos.Table.State... states)` Checks and sets table state in ZK.
`private void`	`setTableStateInZK(TableName tableName, org.apache.hadoop.hbase.protobuf.generated.ZooKeeperProtos.Table.State state)`

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
```
  - watcher
```
private final ZooKeeperWatcher watcher
```
  - cache
```
private final Map<TableName,org.apache.hadoop.hbase.protobuf.generated.ZooKeeperProtos.Table.State> cache
```
    Cache of what we found in zookeeper so we don't have to go to zk ensemble for every query. Synchronize access rather than use concurrent Map because synchronization needs to span query of zk.
- Constructor Detail
  - ZKTableStateManager
```
public ZKTableStateManager(ZooKeeperWatcher zkw)
                    throws org.apache.zookeeper.KeeperException,
                           InterruptedException
```
    Throws:
    
    org.apache.zookeeper.KeeperException
    
    InterruptedException
- Method Detail
  - populateTableStates
```
private void populateTableStates()
                          throws org.apache.zookeeper.KeeperException,
                                 InterruptedException
```
    Gets a list of all the tables set as disabled in zookeeper.
    
    Throws:
    
    KeeperException, - InterruptedException
    
    org.apache.zookeeper.KeeperException
    
    InterruptedException
  - setTableState
```
public void setTableState(TableName tableName,
                 org.apache.hadoop.hbase.protobuf.generated.ZooKeeperProtos.Table.State state)
                   throws CoordinatedStateException
```
    Sets table state in ZK. Sets no watches. Sets the table into desired state. Fails silently if the table is already in this state.
    
    Specified by:
    
    setTableState in interface TableStateManager
    
    Parameters:
    tableName - table to process
    state - new state of this table
    
    Throws:
    
    CoordinatedStateException - if error happened when trying to set table state
  - setTableStateIfInStates
```
public boolean setTableStateIfInStates(TableName tableName,
                              org.apache.hadoop.hbase.protobuf.generated.ZooKeeperProtos.Table.State newState,
                              org.apache.hadoop.hbase.protobuf.generated.ZooKeeperProtos.Table.State... states)
                                throws CoordinatedStateException
```
    Checks and sets table state in ZK. Sets no watches. Sets the specified table into the newState, but only if the table is already in one of the possibleCurrentStates (otherwise no operation is performed).
    
    Specified by:
    
    setTableStateIfInStates in interface TableStateManager
    
    Parameters:
    tableName - table to process
    newState - new state for the table
    states - table should be in one of these states for the operation to be performed
    
    Returns:
    true if operation succeeded, false otherwise
    
    Throws:
    
    CoordinatedStateException - if error happened while performing operation
  - setTableStateIfNotInStates
```
public boolean setTableStateIfNotInStates(TableName tableName,
                                 org.apache.hadoop.hbase.protobuf.generated.ZooKeeperProtos.Table.State newState,
                                 org.apache.hadoop.hbase.protobuf.generated.ZooKeeperProtos.Table.State... states)
                                   throws CoordinatedStateException
```
    Checks and sets table state in ZK. Sets no watches. Sets the specified table into the newState, but only if the table is NOT in one of the possibleCurrentStates (otherwise no operation is performed).
    
    Specified by:
    
    setTableStateIfNotInStates in interface TableStateManager
    
    Parameters:
    tableName - table to process
    newState - new state for the table
    states - table should NOT be in one of these states for the operation to be performed
    
    Returns:
    true if operation succeeded, false otherwise
    
    Throws:
    
    CoordinatedStateException - if error happened while performing operation
  - setTableStateInZK
```
private void setTableStateInZK(TableName tableName,
                     org.apache.hadoop.hbase.protobuf.generated.ZooKeeperProtos.Table.State state)
                        throws org.apache.zookeeper.KeeperException
```
    Throws:
    
    org.apache.zookeeper.KeeperException
  - isTableState
```
public boolean isTableState(TableName tableName,
                   org.apache.hadoop.hbase.protobuf.generated.ZooKeeperProtos.Table.State... states)
```
    Checks if table is marked in specified state in ZK (using cache only).
    
    Specified by:
    
    isTableState in interface TableStateManager
    
    Returns:
    true if the table is in any one of the listed states, false otherwise.
  - isTableState
```
public boolean isTableState(TableName tableName,
                   boolean checkSource,
                   org.apache.hadoop.hbase.protobuf.generated.ZooKeeperProtos.Table.State... states)
```
    Checks if table is marked in specified state in ZK.
    
    Specified by:
    
    isTableState in interface TableStateManager
    
    Returns:
    true if the table is in any one of the listed states, false otherwise.
  - setDeletedTable
```
public void setDeletedTable(TableName tableName)
                     throws CoordinatedStateException
```
    Deletes the table in zookeeper. Fails silently if the table is not currently disabled in zookeeper. Sets no watches. Mark table as deleted. Fails silently if the table is not currently marked as disabled.
    
    Specified by:
    
    setDeletedTable in interface TableStateManager
    
    Parameters:
    tableName - table to be deleted
    
    Throws:
    
    CoordinatedStateException - if error happened while performing operation
  - isTablePresent
```
public boolean isTablePresent(TableName tableName)
```
    check if table is present.
    
    Specified by:
    
    isTablePresent in interface TableStateManager
    
    Parameters:
    tableName - table we're working on
    
    Returns:
    true if the table is present
  - getTablesInStates
```
public Set<TableName> getTablesInStates(org.apache.hadoop.hbase.protobuf.generated.ZooKeeperProtos.Table.State... states)
                                 throws InterruptedIOException,
                                        CoordinatedStateException
```
    Gets a list of all the tables set as disabling in zookeeper.
    
    Specified by:
    
    getTablesInStates in interface TableStateManager
    
    Returns:
    Set of disabling tables, empty Set if none
    
    Throws:
    
    CoordinatedStateException - if error happened in underlying coordination engine
    
    InterruptedIOException
  - checkAndRemoveTableState
```
public void checkAndRemoveTableState(TableName tableName,
                            org.apache.hadoop.hbase.protobuf.generated.ZooKeeperProtos.Table.State states,
                            boolean deletePermanentState)
                              throws CoordinatedStateException
```
    If the table is found in the given state the in-memory state is removed. This helps in cases where CreateTable is to be retried by the client in case of failures. If deletePermanentState is true - the flag kept permanently is also reset.
    
    Specified by:
    
    checkAndRemoveTableState in interface TableStateManager
    
    Parameters:
    tableName - table we're working on
    states - if table isn't in any one of these states, operation aborts
    deletePermanentState - if true, reset the permanent flag
    
    Throws:
    
    CoordinatedStateException - if error happened in underlying coordination engine
  - getAllTables
```
Set<TableName> getAllTables(org.apache.hadoop.hbase.protobuf.generated.ZooKeeperProtos.Table.State... states)
                      throws org.apache.zookeeper.KeeperException,
                             InterruptedIOException
```
    Gets a list of all the tables of specified states in zookeeper.
    
    Returns:
    Set of tables of specified states, empty Set if none
    
    Throws:
    
    org.apache.zookeeper.KeeperException
    
    InterruptedIOException
  - getTableState
```
private org.apache.hadoop.hbase.protobuf.generated.ZooKeeperProtos.Table.State getTableState(ZooKeeperWatcher zkw,
                                                                                   TableName tableName)
                                                                                      throws org.apache.zookeeper.KeeperException,
                                                                                             InterruptedException
```
    Gets table state from ZK.
    
    Parameters:
    zkw - ZooKeeperWatcher instance to use
    tableName - table we're checking
    
    Returns:
    Null or ZooKeeperProtos.Table.State found in znode.
    
    Throws:
    
    org.apache.zookeeper.KeeperException
    
    InterruptedException
  - isTableInState
```
private boolean isTableInState(List<org.apache.hadoop.hbase.protobuf.generated.ZooKeeperProtos.Table.State> expectedStates,
                     org.apache.hadoop.hbase.protobuf.generated.ZooKeeperProtos.Table.State currentState)
```
    Returns:
    true if current state isn't null and is contained in the list of expected states.

Class ZKTableStateManager

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

LOG

watcher

cache

Constructor Detail

ZKTableStateManager

Method Detail

populateTableStates

setTableState

setTableStateIfInStates

setTableStateIfNotInStates

setTableStateInZK

isTableState

isTableState

setDeletedTable

isTablePresent

getTablesInStates

checkAndRemoveTableState

getAllTables

getTableState

isTableInState