org.springframework.xd.dirt.zookeeper

Class EmbeddedZooKeeper

java.lang.Object

org.springframework.xd.dirt.zookeeper.EmbeddedZooKeeper

All Implemented Interfaces:

org.springframework.context.Lifecycle, org.springframework.context.Phased, org.springframework.context.SmartLifecycle

public class EmbeddedZooKeeper
extends java.lang.Object
implements org.springframework.context.SmartLifecycle

Helper class to start an embedded instance of standalone (non clustered) ZooKeeper. NOTE: at least an external standalone server (if not an ensemble) are recommended, even for SingleNodeApplication

Author:

Patrick Peralta, Mark Fisher, David Turanski

Constructor Summary

Constructors

Constructor and Description
EmbeddedZooKeeper() Construct an EmbeddedZooKeeper with a random port.
EmbeddedZooKeeper(int clientPort) Construct an EmbeddedZooKeeper with the provided port.

Method Summary

Methods

Modifier and Type	Method and Description
int	getClientPort() Returns the port that clients should use to connect to this embedded server.
int	getPhase()
boolean	isAutoStartup()
boolean	isRunning()
void	setAutoStartup(boolean autoStartup) Specify whether to start automatically.
void	setErrorHandler(org.springframework.util.ErrorHandler errorHandler) Provide an ErrorHandler to be invoked if an Exception is thrown from the ZooKeeper server thread.
void	setPhase(int phase) Specify the lifecycle phase for the embedded server.
void	start() Start the ZooKeeper server in a background thread.
void	stop() Shutdown the ZooKeeper server.
void	stop(java.lang.Runnable callback) Stop the server if running and invoke the callback when complete.

Methods inherited from class java.lang.Object

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

Constructor Detail

EmbeddedZooKeeper

public EmbeddedZooKeeper()

Construct an EmbeddedZooKeeper with a random port.

EmbeddedZooKeeper

public EmbeddedZooKeeper(int clientPort)

Construct an EmbeddedZooKeeper with the provided port.

Parameters:

clientPort - port for ZooKeeper server to bind to

Method Detail

getClientPort

public int getClientPort()

Returns the port that clients should use to connect to this embedded server.

Returns:

dynamically determined client port

setAutoStartup

public void setAutoStartup(boolean autoStartup)

Specify whether to start automatically. Default is true.

Parameters:

autoStartup - whether to start automatically

isAutoStartup

public boolean isAutoStartup()

Specified by:

isAutoStartup in interface org.springframework.context.SmartLifecycle

setPhase

public void setPhase(int phase)

Specify the lifecycle phase for the embedded server.

Parameters:

phase - the lifecycle phase

getPhase

public int getPhase()

Specified by:

getPhase in interface org.springframework.context.Phased

isRunning

public boolean isRunning()

Specified by:

isRunning in interface org.springframework.context.Lifecycle

start

public void start()

Start the ZooKeeper server in a background thread.

Register an error handler via setErrorHandler(org.springframework.util.ErrorHandler) in order to handle any exceptions thrown during startup or execution.

Specified by:

start in interface org.springframework.context.Lifecycle

stop

public void stop()

Shutdown the ZooKeeper server.

Specified by:

stop in interface org.springframework.context.Lifecycle

stop

public void stop(java.lang.Runnable callback)

Stop the server if running and invoke the callback when complete.

Specified by:

stop in interface org.springframework.context.SmartLifecycle

setErrorHandler

public void setErrorHandler(org.springframework.util.ErrorHandler errorHandler)

Provide an ErrorHandler to be invoked if an Exception is thrown from the ZooKeeper server thread. If none is provided, only error-level logging will occur.

Parameters:

errorHandler - the ErrorHandler to be invoked