Package org.apache.hadoop.hbase.zookeeper

Class MiniZooKeeperCluster

java.lang.Object

org.apache.hadoop.hbase.zookeeper.MiniZooKeeperCluster

@Public
public class MiniZooKeeperCluster
extends Object

TODO: Most of the code in this class is ripped from ZooKeeper tests. Instead of redoing it, we should contribute updates to their code which let us more easily access testing helper objects.

Field Summary

Fields

Modifier and Type	Field	Description
private int	activeZKServerIndex
private final List<Integer>	clientPortList
private final org.apache.hadoop.conf.Configuration	configuration
private int	connectionTimeout
private static final int	DEFAULT_CONNECTION_TIMEOUT
private int	defaultClientPort	The default port.
static final String	HOST
private static final org.slf4j.Logger	LOG
static final String	LOOPBACK_HOST
private final List<org.apache.zookeeper.server.NIOServerCnxnFactory>	standaloneServerFactoryList
private boolean	started
private static final int	TICK_TIME
private int	tickTime
private static final int	TIMEOUT
private final List<org.apache.zookeeper.server.ZooKeeperServer>	zooKeeperServers

Constructor Summary

Constructors

Constructor	Description
MiniZooKeeperCluster()
MiniZooKeeperCluster(org.apache.hadoop.conf.Configuration configuration)

Method Summary

Modifier and Type	Method	Description
void	addClientPort(int clientPort)	Add a client port to the list.
private void	createDir(File dir)
Address	getAddress()	Returns Address for this cluster instance.
int	getBackupZooKeeperServerNum()
int	getClientPort()
List<Integer>	getClientPortList()	Get the list of client ports.
private String	getServerConfigurationOnOneLine(org.apache.zookeeper.server.ZooKeeperServer server)
int	getZooKeeperServerNum()
(package private) List<org.apache.zookeeper.server.ZooKeeperServer>	getZooKeeperServers()
private boolean	hasValidClientPortInList(int index)	Check whether the client port in a specific position of the client port list is valid.
int	killCurrentActiveZooKeeperServer()
void	killOneBackupZooKeeperServer()	Kill one back up ZK servers.
private int	selectClientPort(int seedPort)	Selects a ZK client port.
void	setDefaultClientPort(int clientPort)
void	setTickTime(int tickTime)
private static void	setupTestEnv()
void	shutdown()
int	startup(File baseDir)
int	startup(File baseDir, int numZooKeeperServers)
private static boolean	waitForServerDown(int port, long timeout)
private static boolean	waitForServerUp(int port, long timeout)

Methods inherited from class java.lang.Object

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

Field Details

LOG

private static final org.slf4j.Logger LOG

TICK_TIME

private static final int TICK_TIME

See Also:

• Constant Field Values

TIMEOUT

private static final int TIMEOUT

See Also:

• Constant Field Values

DEFAULT_CONNECTION_TIMEOUT

private static final int DEFAULT_CONNECTION_TIMEOUT

See Also:

• Constant Field Values

connectionTimeout

private int connectionTimeout

LOOPBACK_HOST

public static final String LOOPBACK_HOST

HOST

public static final String HOST

started

private boolean started

defaultClientPort

private int defaultClientPort

The default port. If zero, we use a random port.

standaloneServerFactoryList

private final List<org.apache.zookeeper.server.NIOServerCnxnFactory> standaloneServerFactoryList

zooKeeperServers

private final List<org.apache.zookeeper.server.ZooKeeperServer> zooKeeperServers

clientPortList

private final List<Integer> clientPortList

activeZKServerIndex

private int activeZKServerIndex

tickTime

private int tickTime

configuration

private final org.apache.hadoop.conf.Configuration configuration

Constructor Details

MiniZooKeeperCluster

public MiniZooKeeperCluster()

MiniZooKeeperCluster

public MiniZooKeeperCluster(org.apache.hadoop.conf.Configuration configuration)

Method Details

addClientPort

public void addClientPort(int clientPort)

Add a client port to the list.

Parameters:

clientPort - the specified port

getClientPortList

@Private
public List<Integer> getClientPortList()

Get the list of client ports.

Returns:

clientPortList the client port list

hasValidClientPortInList

private boolean hasValidClientPortInList(int index)

Check whether the client port in a specific position of the client port list is valid.

Parameters:

index - the specified position

setDefaultClientPort

public void setDefaultClientPort(int clientPort)

selectClientPort

private int selectClientPort(int seedPort)

Selects a ZK client port.

Parameters:

seedPort - the seed port to start with; -1 means first time.

Returns:

a valid and unused client port

setTickTime

public void setTickTime(int tickTime)

getBackupZooKeeperServerNum

public int getBackupZooKeeperServerNum()

getZooKeeperServerNum

public int getZooKeeperServerNum()

setupTestEnv

private static void setupTestEnv()

startup

public int startup(File baseDir)
            throws IOException,
InterruptedException

Throws:

IOException

InterruptedException

startup

public int startup(File baseDir,
 int numZooKeeperServers)
            throws IOException,
InterruptedException

Parameters:

baseDir - the base directory to use

numZooKeeperServers - the number of ZooKeeper servers

Returns:

ClientPort server bound to, -1 if there was a binding problem and we couldn't pick another port.

Throws:

IOException - if an operation fails during the startup

InterruptedException - if the startup fails

getServerConfigurationOnOneLine

private String getServerConfigurationOnOneLine(org.apache.zookeeper.server.ZooKeeperServer server)

createDir

private void createDir(File dir)
                throws IOException

Throws:

IOException

shutdown

public void shutdown()
              throws IOException

Throws:

IOException - if waiting for the shutdown of a server fails

killCurrentActiveZooKeeperServer

public int killCurrentActiveZooKeeperServer()
                                     throws IOException,
InterruptedException

Returns:

clientPort return clientPort if there is another ZK backup can run when killing the current active; return -1, if there is no backups.

Throws:

IOException - if waiting for the shutdown of a server fails

InterruptedException

killOneBackupZooKeeperServer

public void killOneBackupZooKeeperServer()
                                  throws IOException,
InterruptedException

Kill one back up ZK servers.

Throws:

IOException - if waiting for the shutdown of a server fails

InterruptedException

waitForServerDown

private static boolean waitForServerDown(int port,
 long timeout)
                                  throws IOException

Throws:

IOException

waitForServerUp

private static boolean waitForServerUp(int port,
 long timeout)
                                throws IOException

Throws:

IOException

getClientPort

public int getClientPort()

getAddress

public Address getAddress()

Returns Address for this cluster instance.

getZooKeeperServers

List<org.apache.zookeeper.server.ZooKeeperServer> getZooKeeperServers()