TableLockManager.ZKTableLockManager (Apache HBase 1.2.12 API)

java.lang.Object
- org.apache.hadoop.hbase.master.TableLockManager
- - org.apache.hadoop.hbase.master.TableLockManager.ZKTableLockManager

Enclosing class:: TableLockManager

@InterfaceAudience.Private
private static class TableLockManager.ZKTableLockManager
extends TableLockManager

ZooKeeper based TableLockManager

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

private static class TableLockManager.ZKTableLockManager.TableLockImpl
- Nested classes/interfaces inherited from class org.apache.hadoop.hbase.master.TableLockManager
  TableLockManager.NullTableLockManager, TableLockManager.TableLock

Nested Classes
Modifier and Type	Class and Description
`private static class`	`TableLockManager.ZKTableLockManager.TableLockImpl`

Field Summary

Fields
Modifier and Type	Field and Description
`private long`	`lockExpireTimeoutMs`
`private static InterProcessLock.MetadataHandler`	`METADATA_HANDLER`
`private long`	`readLockTimeoutMs`
`private ServerName`	`serverName`
`private long`	`writeLockTimeoutMs`
`private ZooKeeperWatcher`	`zkWatcher`

Fields inherited from class org.apache.hadoop.hbase.master.TableLockManager
DEFAULT_TABLE_LOCK_EXPIRE_TIMEOUT_MS, DEFAULT_TABLE_READ_LOCK_TIMEOUT_MS, DEFAULT_TABLE_WRITE_LOCK_TIMEOUT_MS, TABLE_LOCK_ENABLE, TABLE_LOCK_EXPIRE_TIMEOUT, TABLE_READ_LOCK_TIMEOUT_MS, TABLE_WRITE_LOCK_TIMEOUT_MS

Constructor Summary

Constructors
Constructor and Description
`TableLockManager.ZKTableLockManager(ZooKeeperWatcher zkWatcher, ServerName serverName, long writeLockTimeoutMs, long readLockTimeoutMs, long lockExpireTimeoutMs)` Initialize a new manager for table-level locks.

Method Summary

Methods
Modifier and Type	Method and Description
`private List<String>`	`getTableNames()`
`TableLockManager.TableLock`	`readLock(TableName tableName, String purpose)` Returns a TableLock for locking the table for shared access among read-lock holders
`void`	`reapAllExpiredLocks()` Force releases all table locks(read and write) that have been held longer than "hbase.table.lock.expire.ms".
`void`	`reapWriteLocks()` Force releases table write locks and lock attempts even if this thread does not own the lock.
`void`	`tableDeleted(TableName tableName)` Called after a table has been deleted, and after the table lock is released.
`private static byte[]`	`toBytes(org.apache.hadoop.hbase.protobuf.generated.ZooKeeperProtos.TableLock data)`
`void`	`visitAllLocks(InterProcessLock.MetadataHandler handler)` Visits all table locks(read and write), and lock attempts with the given callback MetadataHandler.
`TableLockManager.TableLock`	`writeLock(TableName tableName, String purpose)` Returns a TableLock for locking the table for exclusive access

Methods inherited from class org.apache.hadoop.hbase.master.TableLockManager
createTableLockManager, fromBytes

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

- Field Detail
  - METADATA_HANDLER
```
private static final InterProcessLock.MetadataHandler METADATA_HANDLER
```
  - serverName
```
private final ServerName serverName
```
  - zkWatcher
```
private final ZooKeeperWatcher zkWatcher
```
  - writeLockTimeoutMs
```
private final long writeLockTimeoutMs
```
  - readLockTimeoutMs
```
private final long readLockTimeoutMs
```
  - lockExpireTimeoutMs
```
private final long lockExpireTimeoutMs
```
- Constructor Detail
  - TableLockManager.ZKTableLockManager
```
public TableLockManager.ZKTableLockManager(ZooKeeperWatcher zkWatcher,
                                   ServerName serverName,
                                   long writeLockTimeoutMs,
                                   long readLockTimeoutMs,
                                   long lockExpireTimeoutMs)
```
    Initialize a new manager for table-level locks.
    
    Parameters:
    zkWatcher -
    serverName - Address of the server responsible for acquiring and releasing the table-level locks
    writeLockTimeoutMs - Timeout (in milliseconds) for acquiring a write lock for a given table, or -1 for no timeout
    readLockTimeoutMs - Timeout (in milliseconds) for acquiring a read lock for a given table, or -1 for no timeout
- Method Detail
  - toBytes
```
private static byte[] toBytes(org.apache.hadoop.hbase.protobuf.generated.ZooKeeperProtos.TableLock data)
```
  - writeLock
```
public TableLockManager.TableLock writeLock(TableName tableName,
                                   String purpose)
```
    Description copied from class: TableLockManager
    
    Returns a TableLock for locking the table for exclusive access
    
    Specified by:
    
    writeLock in class TableLockManager
    
    Parameters:
    tableName - Table to lock
    purpose - Human readable reason for locking the table
    
    Returns:
    A new TableLock object for acquiring a write lock
  - readLock
```
public TableLockManager.TableLock readLock(TableName tableName,
                                  String purpose)
```
    Description copied from class: TableLockManager
    
    Returns a TableLock for locking the table for shared access among read-lock holders
    
    Specified by:
    
    readLock in class TableLockManager
    
    Parameters:
    tableName - Table to lock
    purpose - Human readable reason for locking the table
    
    Returns:
    A new TableLock object for acquiring a read lock
  - visitAllLocks
```
public void visitAllLocks(InterProcessLock.MetadataHandler handler)
                   throws IOException
```
    Description copied from class: TableLockManager
    
    Visits all table locks(read and write), and lock attempts with the given callback MetadataHandler.
    
    Specified by:
    
    visitAllLocks in class TableLockManager
    
    Parameters:
    handler - the metadata handler to call
    
    Throws:
    
    IOException - If there is an unrecoverable error
  - getTableNames
```
private List<String> getTableNames()
                            throws IOException
```
    Throws:
    
    IOException
  - reapWriteLocks
```
public void reapWriteLocks()
                    throws IOException
```
    Description copied from class: TableLockManager
    
    Force releases table write locks and lock attempts even if this thread does not own the lock. The behavior of the lock holders still thinking that they have the lock is undefined. This should be used carefully and only when we can ensure that all write-lock holders have died. For example if only the master can hold write locks, then we can reap it's locks when the backup master starts.
    
    Specified by:
    
    reapWriteLocks in class TableLockManager
    
    Throws:
    
    IOException - If there is an unrecoverable error
  - reapAllExpiredLocks
```
public void reapAllExpiredLocks()
                         throws IOException
```
    Description copied from class: TableLockManager
    
    Force releases all table locks(read and write) that have been held longer than "hbase.table.lock.expire.ms". Assumption is that the clock skew between zookeeper and this servers is negligible. The behavior of the lock holders still thinking that they have the lock is undefined.
    
    Specified by:
    
    reapAllExpiredLocks in class TableLockManager
    
    Throws:
    
    IOException - If there is an unrecoverable error
  - tableDeleted
```
public void tableDeleted(TableName tableName)
                  throws IOException
```
    Description copied from class: TableLockManager
    
    Called after a table has been deleted, and after the table lock is released. TableLockManager should do cleanup for the table state.
    
    Specified by:
    
    tableDeleted in class TableLockManager
    
    Parameters:
    tableName - name of the table
    
    Throws:
    
    IOException - If there is an unrecoverable error releasing the lock

Class TableLockManager.ZKTableLockManager

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.hadoop.hbase.master.TableLockManager

Field Summary

Fields inherited from class org.apache.hadoop.hbase.master.TableLockManager

Constructor Summary

Method Summary

Methods inherited from class org.apache.hadoop.hbase.master.TableLockManager

Methods inherited from class java.lang.Object

Field Detail

METADATA_HANDLER

serverName

zkWatcher

writeLockTimeoutMs

readLockTimeoutMs

lockExpireTimeoutMs

Constructor Detail

TableLockManager.ZKTableLockManager

Method Detail

toBytes

writeLock

readLock

visitAllLocks

getTableNames

reapWriteLocks

reapAllExpiredLocks

tableDeleted