org.apache.hadoop.hbase.zookeeper

Class MetaTableLocator

java.lang.Object

org.apache.hadoop.hbase.zookeeper.MetaTableLocator

@InterfaceAudience.Private
public final class MetaTableLocator
extends Object

Utility class to perform operation (get/wait for/verify/set/delete) on znode in ZooKeeper which keeps hbase:meta region server location.

Stateless class with a bunch of static methods. Doesn't manage resources passed in (e.g. Connection, ZKWatcher etc).

Meta region location is set by RegionServerServices. This class doesn't use ZK watchers, rather accesses ZK directly.

TODO: rewrite using RPC calls to master to find out about hbase:meta.

Method Summary

Modifier and Type	Method and Description
static org.apache.hadoop.hbase.ServerName	blockUntilAvailable(ZKWatcher zkw, int replicaId, long timeout) Wait until the meta region is available and is not in transition.
static org.apache.hadoop.hbase.ServerName	blockUntilAvailable(ZKWatcher zkw, long timeout) Wait until the meta region is available and is not in transition.
static List<org.apache.hadoop.hbase.ServerName>	blockUntilAvailable(ZKWatcher zkw, long timeout, org.apache.hadoop.conf.Configuration conf) Wait until the primary meta region is available.
static void	deleteMetaLocation(ZKWatcher zookeeper) Deletes the location of hbase:meta in ZooKeeper.
static void	deleteMetaLocation(ZKWatcher zookeeper, int replicaId)
static org.apache.hadoop.hbase.ServerName	getMetaRegionLocation(ZKWatcher zkw) Gets the meta region location, if available.
static org.apache.hadoop.hbase.ServerName	getMetaRegionLocation(ZKWatcher zkw, int replicaId) Gets the meta region location, if available.
static List<org.apache.hadoop.hbase.client.RegionInfo>	getMetaRegions(ZKWatcher zkw) Gets the meta regions for the given path with the default replica ID.
static List<org.apache.hadoop.hbase.client.RegionInfo>	getMetaRegions(ZKWatcher zkw, int replicaId) Gets the meta regions for the given path and replica ID.
static List<org.apache.hadoop.hbase.util.Pair<org.apache.hadoop.hbase.client.RegionInfo,org.apache.hadoop.hbase.ServerName>>	getMetaRegionsAndLocations(ZKWatcher zkw)
static List<org.apache.hadoop.hbase.util.Pair<org.apache.hadoop.hbase.client.RegionInfo,org.apache.hadoop.hbase.ServerName>>	getMetaRegionsAndLocations(ZKWatcher zkw, int replicaId) Gets the meta regions and their locations for the given path and replica ID.
static org.apache.hadoop.hbase.master.RegionState	getMetaRegionState(ZKWatcher zkw) Load the meta region state from the meta server ZNode.
static org.apache.hadoop.hbase.master.RegionState	getMetaRegionState(ZKWatcher zkw, int replicaId) Load the meta region state from the meta server ZNode.
static boolean	isLocationAvailable(ZKWatcher zkw) Checks if the meta region location is available.
static void	setMetaLocation(ZKWatcher zookeeper, org.apache.hadoop.hbase.ServerName serverName, int replicaId, org.apache.hadoop.hbase.master.RegionState.State state) Sets the location of hbase:meta in ZooKeeper to the specified server address.
static void	setMetaLocation(ZKWatcher zookeeper, org.apache.hadoop.hbase.ServerName serverName, org.apache.hadoop.hbase.master.RegionState.State state) Sets the location of hbase:meta in ZooKeeper to the specified server address.
static org.apache.hadoop.hbase.ServerName	waitMetaRegionLocation(ZKWatcher zkw, int replicaId, long timeout) Gets the meta region location, if available, and waits for up to the specified timeout if not immediately available.
static org.apache.hadoop.hbase.ServerName	waitMetaRegionLocation(ZKWatcher zkw, long timeout) Gets the meta region location, if available, and waits for up to the specified timeout if not immediately available.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

isLocationAvailable

public static boolean isLocationAvailable(ZKWatcher zkw)

Checks if the meta region location is available.

Returns:

true if meta region location is available, false if not

getMetaRegionsAndLocations

public static List<org.apache.hadoop.hbase.util.Pair<org.apache.hadoop.hbase.client.RegionInfo,org.apache.hadoop.hbase.ServerName>> getMetaRegionsAndLocations(ZKWatcher zkw)

Parameters:

zkw - ZooKeeper watcher to be used

Returns:

meta table regions and their locations.

getMetaRegionsAndLocations

public static List<org.apache.hadoop.hbase.util.Pair<org.apache.hadoop.hbase.client.RegionInfo,org.apache.hadoop.hbase.ServerName>> getMetaRegionsAndLocations(ZKWatcher zkw,
                                                                                                                                                               int replicaId)

Gets the meta regions and their locations for the given path and replica ID.

Parameters:

zkw - reference to the ZKWatcher which also contains configuration and operation

replicaId - the ID of the replica

Returns:

meta table regions and their locations.

getMetaRegions

public static List<org.apache.hadoop.hbase.client.RegionInfo> getMetaRegions(ZKWatcher zkw)

Gets the meta regions for the given path with the default replica ID.

Parameters:

zkw - ZooKeeper watcher to be used

Returns:

List of meta regions

getMetaRegions

public static List<org.apache.hadoop.hbase.client.RegionInfo> getMetaRegions(ZKWatcher zkw,
                                                                             int replicaId)

Gets the meta regions for the given path and replica ID.

Parameters:

zkw - reference to the ZKWatcher which also contains configuration and operation

replicaId - the ID of the replica

Returns:

List of meta regions

getMetaRegionLocation

public static org.apache.hadoop.hbase.ServerName getMetaRegionLocation(ZKWatcher zkw)

Gets the meta region location, if available. Does not block.

Parameters:

zkw - zookeeper connection to use

Returns:

server name or null if we failed to get the data.

getMetaRegionLocation

public static org.apache.hadoop.hbase.ServerName getMetaRegionLocation(ZKWatcher zkw,
                                                                       int replicaId)

Gets the meta region location, if available. Does not block.

Parameters:

zkw - reference to the ZKWatcher which also contains configuration and operation

replicaId - the ID of the replica

Returns:

server name

waitMetaRegionLocation

public static org.apache.hadoop.hbase.ServerName waitMetaRegionLocation(ZKWatcher zkw,
                                                                        long timeout)
                                                                 throws InterruptedException,
                                                                        org.apache.hadoop.hbase.NotAllMetaRegionsOnlineException

Gets the meta region location, if available, and waits for up to the specified timeout if not immediately available. Given the zookeeper notification could be delayed, we will try to get the latest data.

Parameters:

zkw - reference to the ZKWatcher which also contains configuration and operation

timeout - maximum time to wait, in millis

Returns:

server name for server hosting meta region formatted as per ServerName, or null if none available

Throws:

InterruptedException - if interrupted while waiting

org.apache.hadoop.hbase.NotAllMetaRegionsOnlineException - if a meta or root region is not online

waitMetaRegionLocation

public static org.apache.hadoop.hbase.ServerName waitMetaRegionLocation(ZKWatcher zkw,
                                                                        int replicaId,
                                                                        long timeout)
                                                                 throws InterruptedException,
                                                                        org.apache.hadoop.hbase.NotAllMetaRegionsOnlineException

Gets the meta region location, if available, and waits for up to the specified timeout if not immediately available. Given the zookeeper notification could be delayed, we will try to get the latest data.

Parameters:

zkw - reference to the ZKWatcher which also contains configuration and operation

replicaId - the ID of the replica

timeout - maximum time to wait, in millis

Returns:

server name for server hosting meta region formatted as per ServerName, or null if none available

Throws:

InterruptedException - if waiting for the socket operation fails

org.apache.hadoop.hbase.NotAllMetaRegionsOnlineException - if a meta or root region is not online

setMetaLocation

public static void setMetaLocation(ZKWatcher zookeeper,
                                   org.apache.hadoop.hbase.ServerName serverName,
                                   org.apache.hadoop.hbase.master.RegionState.State state)
                            throws org.apache.zookeeper.KeeperException

Sets the location of hbase:meta in ZooKeeper to the specified server address.

Parameters:

zookeeper - zookeeper reference

serverName - The server hosting hbase:meta

state - The region transition state

Throws:

org.apache.zookeeper.KeeperException - unexpected zookeeper exception

setMetaLocation

public static void setMetaLocation(ZKWatcher zookeeper,
                                   org.apache.hadoop.hbase.ServerName serverName,
                                   int replicaId,
                                   org.apache.hadoop.hbase.master.RegionState.State state)
                            throws org.apache.zookeeper.KeeperException

Sets the location of hbase:meta in ZooKeeper to the specified server address.

Parameters:

zookeeper - reference to the ZKWatcher which also contains configuration and operation

serverName - the name of the server

replicaId - the ID of the replica

state - the state of the region

Throws:

org.apache.zookeeper.KeeperException - if a ZooKeeper operation fails

getMetaRegionState

public static org.apache.hadoop.hbase.master.RegionState getMetaRegionState(ZKWatcher zkw)
                                                                     throws org.apache.zookeeper.KeeperException

Load the meta region state from the meta server ZNode.

Throws:

org.apache.zookeeper.KeeperException

getMetaRegionState

public static org.apache.hadoop.hbase.master.RegionState getMetaRegionState(ZKWatcher zkw,
                                                                            int replicaId)
                                                                     throws org.apache.zookeeper.KeeperException

Load the meta region state from the meta server ZNode.

Parameters:

zkw - reference to the ZKWatcher which also contains configuration and operation

replicaId - the ID of the replica

Returns:

regionstate

Throws:

org.apache.zookeeper.KeeperException - if a ZooKeeper operation fails

deleteMetaLocation

public static void deleteMetaLocation(ZKWatcher zookeeper)
                               throws org.apache.zookeeper.KeeperException

Deletes the location of hbase:meta in ZooKeeper.

Parameters:

zookeeper - zookeeper reference

Throws:

org.apache.zookeeper.KeeperException - unexpected zookeeper exception

deleteMetaLocation

public static void deleteMetaLocation(ZKWatcher zookeeper,
                                      int replicaId)
                               throws org.apache.zookeeper.KeeperException

Throws:

org.apache.zookeeper.KeeperException

blockUntilAvailable

public static List<org.apache.hadoop.hbase.ServerName> blockUntilAvailable(ZKWatcher zkw,
                                                                           long timeout,
                                                                           org.apache.hadoop.conf.Configuration conf)
                                                                    throws InterruptedException

Wait until the primary meta region is available. Get the secondary locations as well but don't block for those.

Parameters:

zkw - reference to the ZKWatcher which also contains configuration and operation

timeout - maximum time to wait in millis

conf - the Configuration to use

Returns:

ServerName or null if we timed out.

Throws:

InterruptedException - if waiting for the socket operation fails

blockUntilAvailable

public static org.apache.hadoop.hbase.ServerName blockUntilAvailable(ZKWatcher zkw,
                                                                     long timeout)
                                                              throws InterruptedException

Wait until the meta region is available and is not in transition.

Parameters:

zkw - zookeeper connection to use

timeout - maximum time to wait, in millis

Returns:

ServerName or null if we timed out.

Throws:

InterruptedException - if waiting for the socket operation fails

blockUntilAvailable

public static org.apache.hadoop.hbase.ServerName blockUntilAvailable(ZKWatcher zkw,
                                                                     int replicaId,
                                                                     long timeout)
                                                              throws InterruptedException

Wait until the meta region is available and is not in transition.

Parameters:

zkw - reference to the ZKWatcher which also contains configuration and constants

replicaId - the ID of the replica

timeout - maximum time to wait in millis

Returns:

ServerName or null if we timed out.

Throws:

InterruptedException - if waiting for the socket operation fails