ZooKeeperWatcher (Apache HBase 1.2.12 API)

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

All Implemented Interfaces:

Closeable, AutoCloseable, Abortable, org.apache.zookeeper.Watcher

Direct Known Subclasses:

ZooKeeperKeepAliveConnection
```
@InterfaceAudience.Private
public class ZooKeeperWatcher
extends Object
implements org.apache.zookeeper.Watcher, Abortable, Closeable
```
Acts as the single ZooKeeper Watcher. One instance of this is instantiated for each Master, RegionServer, and client process.
This is the only class that implements Watcher. Other internal classes which need to be notified of ZooKeeper events must register with the local instance of this watcher via registerListener(org.apache.hadoop.hbase.zookeeper.ZooKeeperListener).
This class also holds and manages the connection to ZooKeeper. Code to deal with connection related events and exceptions are handled here.

Nested Class Summary
- Nested classes/interfaces inherited from interface org.apache.zookeeper.Watcher
  org.apache.zookeeper.Watcher.Event

Field Summary

Fields
Modifier and Type	Field and Description
`protected Abortable`	`abortable`
`private boolean`	`aborted`
`String`	`assignmentZNode`
`String`	`backupMasterAddressesZNode`
`String`	`balancerZNode`
`String`	`baseZNode`
`String`	`clusterIdZNode`
`String`	`clusterStateZNode`
`private org.apache.hadoop.conf.Configuration`	`conf`
`private Exception`	`constructorCaller`
`static ArrayList<org.apache.zookeeper.data.ACL>`	`CREATOR_ALL_AND_WORLD_READABLE`
`String`	`drainingZNode`
`private String`	`identifier`
`private List<ZooKeeperListener>`	`listeners`
`private static org.apache.commons.logging.Log`	`LOG`
`private String`	`masterAddressZNode`
`static String`	`META_ZNODE_PREFIX`
`private Map<Integer,String>`	`metaReplicaZnodes`
`private static Pattern`	`NAME_PATTERN`
`static String`	`namespaceZNode`
`private String`	`prefix`
`private String`	`quorum`
`private RecoverableZooKeeper`	`recoverableZooKeeper`
`String`	`recoveringRegionsZNode`
`private String`	`regionNormalizerZNode`
`String`	`rsZNode`
`CountDownLatch`	`saslLatch`
`String`	`splitLogZNode`
`String`	`tableLockZNode`
`String`	`tableZNode`

Constructor Summary

Constructors
Constructor and Description
`ZooKeeperWatcher(org.apache.hadoop.conf.Configuration conf, String identifier, Abortable abortable)` Instantiate a ZooKeeper connection and watcher.
`ZooKeeperWatcher(org.apache.hadoop.conf.Configuration conf, String identifier, Abortable abortable, boolean canCreateBaseZNode)` Instantiate a ZooKeeper connection and watcher.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`abort(String why, Throwable e)` Abort the server or client.
`private boolean`	`checkACLForSuperUsers(String[] superUsers, List<org.apache.zookeeper.data.ACL> acls)`
`void`	`checkAndSetZNodeAcls()` On master start, we check the znode ACLs under the root directory and set the ACLs properly if needed.
`void`	`close()` Close the connection to ZooKeeper.
`private void`	`connectionEvent(org.apache.zookeeper.WatchedEvent event)` Called when there is a connection-related event via the Watcher callback.
`private void`	`createBaseZNodes()`
`String`	`getBaseZNode()`
`org.apache.hadoop.conf.Configuration`	`getConfiguration()`
`List<ZooKeeperListener>`	`getListeners()` Get a copy of current registered listeners
`String`	`getMasterAddressZNode()`
`int`	`getMetaReplicaIdFromZnode(String znode)` Parse the meta replicaId from the passed znode
`List<String>`	`getMetaReplicaNodes()` Get the znodes corresponding to the meta replicas from ZK
`int`	`getNumberOfListeners()`
`String`	`getQuorum()` Get the quorum address of this instance.
`RecoverableZooKeeper`	`getRecoverableZooKeeper()` Get the connection to ZooKeeper.
`String`	`getRegionNormalizerZNode()`
`String`	`getZNodeForReplica(int replicaId)` Get the znode string corresponding to a replicaId
`void`	`interruptedException(InterruptedException ie)` Handles InterruptedExceptions in client calls.
`void`	`interruptedExceptionNoThrow(InterruptedException ie, boolean throwLater)` Log the InterruptedException and interrupt current thread
`boolean`	`isAborted()` Check if the server or client was aborted.
`boolean`	`isAnyMetaReplicaZnode(String node)` Is the znode of any meta replica
`private boolean`	`isBaseZnodeAclSetup(List<org.apache.zookeeper.data.ACL> acls)` Checks whether the ACLs returned from the base znode (/hbase) is set for secure setup.
`boolean`	`isClientReadable(String node)` Returns whether the znode is supposed to be readable by the client and DOES NOT contain sensitive information (world readable).
`boolean`	`isDefaultMetaReplicaZnode(String node)` Is it the default meta replica's znode
`static boolean`	`isSuperUserId(String[] superUsers, org.apache.zookeeper.data.Id id)`
`void`	`keeperException(org.apache.zookeeper.KeeperException ke)` Handles KeeperExceptions in client calls.
`String`	`prefix(String str)` Adds this instance's identifier as a prefix to the passed `str`
`void`	`process(org.apache.zookeeper.WatchedEvent event)` Method called from ZooKeeper for events and connection status.
`void`	`reconnectAfterExpiration()`
`void`	`registerListener(ZooKeeperListener listener)` Register the specified listener to receive ZooKeeper events.
`void`	`registerListenerFirst(ZooKeeperListener listener)` Register the specified listener to receive ZooKeeper events and add it as the first in the list of current listeners.
`private void`	`setNodeNames(org.apache.hadoop.conf.Configuration conf)` Set the local variable node names using the specified configuration.
`private void`	`setZnodeAclsRecursive(String znode)` Set the znode perms recursively.
`void`	`sync(String path)` Forces a synchronization of this ZooKeeper client connection.
`String`	`toString()`
`void`	`unregisterAllListeners()` Clean all existing listeners
`void`	`unregisterListener(ZooKeeperListener listener)`

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

- Field Detail
  - LOG
```
private static final org.apache.commons.logging.Log LOG
```
  - prefix
```
private String prefix
```
  - identifier
```
private String identifier
```
  - quorum
```
private String quorum
```
  - recoverableZooKeeper
```
private RecoverableZooKeeper recoverableZooKeeper
```
  - abortable
```
protected Abortable abortable
```
  - aborted
```
private boolean aborted
```
  - listeners
```
private final List<ZooKeeperListener> listeners
```
  - saslLatch
```
public CountDownLatch saslLatch
```
  - baseZNode
```
public String baseZNode
```
  - metaReplicaZnodes
```
private Map<Integer,String> metaReplicaZnodes
```
  - rsZNode
```
public String rsZNode
```
  - drainingZNode
```
public String drainingZNode
```
  - masterAddressZNode
```
private String masterAddressZNode
```
  - backupMasterAddressesZNode
```
public String backupMasterAddressesZNode
```
  - clusterStateZNode
```
public String clusterStateZNode
```
  - assignmentZNode
```
public String assignmentZNode
```
  - tableZNode
```
public String tableZNode
```
  - clusterIdZNode
```
public String clusterIdZNode
```
  - splitLogZNode
```
public String splitLogZNode
```
  - balancerZNode
```
public String balancerZNode
```
  - regionNormalizerZNode
```
private String regionNormalizerZNode
```
  - tableLockZNode
```
public String tableLockZNode
```
  - recoveringRegionsZNode
```
public String recoveringRegionsZNode
```
  - namespaceZNode
```
public static String namespaceZNode
```
  - CREATOR_ALL_AND_WORLD_READABLE
```
public static final ArrayList<org.apache.zookeeper.data.ACL> CREATOR_ALL_AND_WORLD_READABLE
```
  - META_ZNODE_PREFIX
```
public static final String META_ZNODE_PREFIX
```
    See Also:
    Constant Field Values
  - conf
```
private final org.apache.hadoop.conf.Configuration conf
```
  - constructorCaller
```
private final Exception constructorCaller
```
  - NAME_PATTERN
```
private static final Pattern NAME_PATTERN
```
- Constructor Detail
  - ZooKeeperWatcher
```
public ZooKeeperWatcher(org.apache.hadoop.conf.Configuration conf,
                String identifier,
                Abortable abortable)
                 throws ZooKeeperConnectionException,
                        IOException
```
    Instantiate a ZooKeeper connection and watcher.
    
    Parameters:
    identifier - string that is passed to RecoverableZookeeper to be used as identifier for this instance. Use null for default.
    
    Throws:
    
    IOException
    
    ZooKeeperConnectionException
  - ZooKeeperWatcher
```
public ZooKeeperWatcher(org.apache.hadoop.conf.Configuration conf,
                String identifier,
                Abortable abortable,
                boolean canCreateBaseZNode)
                 throws IOException,
                        ZooKeeperConnectionException
```
    Instantiate a ZooKeeper connection and watcher.
    
    Parameters:
    conf -
    identifier - string that is passed to RecoverableZookeeper to be used as identifier for this instance. Use null for default.
    abortable - Can be null if there is on error there is no host to abort: e.g. client context.
    canCreateBaseZNode -
    
    Throws:
    
    IOException
    
    ZooKeeperConnectionException
- Method Detail
  - createBaseZNodes
```
private void createBaseZNodes()
                       throws ZooKeeperConnectionException
```
    Throws:
    
    ZooKeeperConnectionException
  - isClientReadable
```
public boolean isClientReadable(String node)
```
    Returns whether the znode is supposed to be readable by the client and DOES NOT contain sensitive information (world readable).
  - checkAndSetZNodeAcls
```
public void checkAndSetZNodeAcls()
```
    On master start, we check the znode ACLs under the root directory and set the ACLs properly if needed. If the cluster goes from an unsecure setup to a secure setup, this step is needed so that the existing znodes created with open permissions are now changed with restrictive perms.
  - setZnodeAclsRecursive
```
private void setZnodeAclsRecursive(String znode)
                            throws org.apache.zookeeper.KeeperException,
                                   InterruptedException
```
    Set the znode perms recursively. This will do post-order recursion, so that baseZnode ACLs will be set last in case the master fails in between.
    
    Parameters:
    znode -
    
    Throws:
    
    org.apache.zookeeper.KeeperException
    
    InterruptedException
  - isBaseZnodeAclSetup
```
private boolean isBaseZnodeAclSetup(List<org.apache.zookeeper.data.ACL> acls)
                             throws IOException
```
    Checks whether the ACLs returned from the base znode (/hbase) is set for secure setup.
    
    Parameters:
    acls - acls from zookeeper
    
    Returns:
    whether ACLs are set for the base znode
    
    Throws:
    
    IOException
  - checkACLForSuperUsers
```
private boolean checkACLForSuperUsers(String[] superUsers,
                            List<org.apache.zookeeper.data.ACL> acls)
```
  - isSuperUserId
```
public static boolean isSuperUserId(String[] superUsers,
                    org.apache.zookeeper.data.Id id)
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - prefix
```
public String prefix(String str)
```
    Adds this instance's identifier as a prefix to the passed str
    
    Parameters:
    str - String to amend.
    
    Returns:
    A new string with this instance's identifier as prefix: e.g. if passed 'hello world', the returned string could be
  - setNodeNames
```
private void setNodeNames(org.apache.hadoop.conf.Configuration conf)
```
    Set the local variable node names using the specified configuration.
  - isAnyMetaReplicaZnode
```
public boolean isAnyMetaReplicaZnode(String node)
```
    Is the znode of any meta replica
    
    Parameters:
    node -
    
    Returns:
    true or false
  - isDefaultMetaReplicaZnode
```
public boolean isDefaultMetaReplicaZnode(String node)
```
    Is it the default meta replica's znode
    
    Parameters:
    node -
    
    Returns:
    true or false
  - getMetaReplicaNodes
```
public List<String> getMetaReplicaNodes()
                                 throws org.apache.zookeeper.KeeperException
```
    Get the znodes corresponding to the meta replicas from ZK
    
    Returns:
    list of znodes
    
    Throws:
    
    org.apache.zookeeper.KeeperException
  - getZNodeForReplica
```
public String getZNodeForReplica(int replicaId)
```
    Get the znode string corresponding to a replicaId
    
    Parameters:
    replicaId -
    
    Returns:
    znode
  - getMetaReplicaIdFromZnode
```
public int getMetaReplicaIdFromZnode(String znode)
```
    Parse the meta replicaId from the passed znode
    
    Parameters:
    znode -
    
    Returns:
    replicaId
  - registerListener
```
public void registerListener(ZooKeeperListener listener)
```
    Register the specified listener to receive ZooKeeper events.
    
    Parameters:
    listener -
  - registerListenerFirst
```
public void registerListenerFirst(ZooKeeperListener listener)
```
    Register the specified listener to receive ZooKeeper events and add it as the first in the list of current listeners.
    
    Parameters:
    listener -
  - unregisterListener
```
public void unregisterListener(ZooKeeperListener listener)
```
  - unregisterAllListeners
```
public void unregisterAllListeners()
```
    Clean all existing listeners
  - getListeners
```
public List<ZooKeeperListener> getListeners()
```
    Get a copy of current registered listeners
  - getNumberOfListeners
```
public int getNumberOfListeners()
```
    Returns:
    The number of currently registered listeners
  - getRecoverableZooKeeper
```
public RecoverableZooKeeper getRecoverableZooKeeper()
```
    Get the connection to ZooKeeper.
    
    Returns:
    connection reference to zookeeper
  - reconnectAfterExpiration
```
public void reconnectAfterExpiration()
                              throws IOException,
                                     org.apache.zookeeper.KeeperException,
                                     InterruptedException
```
    Throws:
    
    IOException
    
    org.apache.zookeeper.KeeperException
    
    InterruptedException
  - getQuorum
```
public String getQuorum()
```
    Get the quorum address of this instance.
    
    Returns:
    quorum string of this zookeeper connection instance
  - getBaseZNode
```
public String getBaseZNode()
```
    Returns:
    the base znode of this zookeeper connection instance.
  - process
```
public void process(org.apache.zookeeper.WatchedEvent event)
```
    Method called from ZooKeeper for events and connection status.
    Valid events are passed along to listeners. Connection status changes are dealt with locally.
    
    Specified by:
    
    process in interface org.apache.zookeeper.Watcher
  - connectionEvent
```
private void connectionEvent(org.apache.zookeeper.WatchedEvent event)
```
    Called when there is a connection-related event via the Watcher callback.
    If Disconnected or Expired, this should shutdown the cluster. But, since we send a KeeperException.SessionExpiredException along with the abort call, it's possible for the Abortable to catch it and try to create a new session with ZooKeeper. This is what the client does in HCM.
    
    Parameters:
    event -
  - sync
```
public void sync(String path)
          throws org.apache.zookeeper.KeeperException
```
    Forces a synchronization of this ZooKeeper client connection.
    Executing this method before running other methods will ensure that the subsequent operations are up-to-date and consistent as of the time that the sync is complete.
    This is used for compareAndSwap type operations where we need to read the data of an existing node and delete or transition that node, utilizing the previously read version and data. We want to ensure that the version read is up-to-date from when we begin the operation.
    
    Throws:
    
    org.apache.zookeeper.KeeperException
  - keeperException
```
public void keeperException(org.apache.zookeeper.KeeperException ke)
                     throws org.apache.zookeeper.KeeperException
```
    Handles KeeperExceptions in client calls.
    This may be temporary but for now this gives one place to deal with these.
    TODO: Currently this method rethrows the exception to let the caller handle
    
    Parameters:
    ke -
    
    Throws:
    
    org.apache.zookeeper.KeeperException
  - interruptedException
```
public void interruptedException(InterruptedException ie)
                          throws org.apache.zookeeper.KeeperException
```
    Handles InterruptedExceptions in client calls.
    
    Parameters:
    ie - the InterruptedException instance thrown
    
    Throws:
    
    org.apache.zookeeper.KeeperException - the exception to throw, transformed from the InterruptedException
  - interruptedExceptionNoThrow
```
public void interruptedExceptionNoThrow(InterruptedException ie,
                               boolean throwLater)
```
    Log the InterruptedException and interrupt current thread
    
    Parameters:
    ie - The IterruptedException to log
    throwLater - Whether we will throw the exception latter
  - close
```
public void close()
```
    Close the connection to ZooKeeper.
    
    Specified by:
    
    close in interface Closeable
    
    Specified by:
    
    close in interface AutoCloseable
  - getConfiguration
```
public org.apache.hadoop.conf.Configuration getConfiguration()
```
  - 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
  - getMasterAddressZNode
```
public String getMasterAddressZNode()
```
    Returns:
    Path to the currently active master.
  - getRegionNormalizerZNode
```
public String getRegionNormalizerZNode()
```
    Returns:
    ZooKeeper znode for region normalizer state

Class ZooKeeperWatcher

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.zookeeper.Watcher

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

LOG

prefix

identifier

quorum

recoverableZooKeeper

abortable

aborted

listeners

saslLatch

baseZNode

metaReplicaZnodes

rsZNode

drainingZNode

masterAddressZNode

backupMasterAddressesZNode

clusterStateZNode

assignmentZNode

tableZNode

clusterIdZNode

splitLogZNode

balancerZNode

regionNormalizerZNode

tableLockZNode

recoveringRegionsZNode

namespaceZNode

CREATOR_ALL_AND_WORLD_READABLE

META_ZNODE_PREFIX

conf

constructorCaller

NAME_PATTERN

Constructor Detail

ZooKeeperWatcher

ZooKeeperWatcher

Method Detail

createBaseZNodes

isClientReadable

checkAndSetZNodeAcls

setZnodeAclsRecursive

isBaseZnodeAclSetup

checkACLForSuperUsers

isSuperUserId

toString

prefix

setNodeNames

isAnyMetaReplicaZnode

isDefaultMetaReplicaZnode

getMetaReplicaNodes

getZNodeForReplica

getMetaReplicaIdFromZnode

registerListener

registerListenerFirst

unregisterListener

unregisterAllListeners

getListeners

getNumberOfListeners

getRecoverableZooKeeper

reconnectAfterExpiration

getQuorum

getBaseZNode

process

connectionEvent

sync

keeperException

interruptedException

interruptedExceptionNoThrow

close

getConfiguration

abort

isAborted

getMasterAddressZNode

getRegionNormalizerZNode