Package com.linecorp.armeria.server.zookeeper

Class ZooKeeperUpdatingListener

java.lang.Object

com.linecorp.armeria.server.ServerListenerAdapter

com.linecorp.armeria.server.zookeeper.ZooKeeperUpdatingListener

All Implemented Interfaces:

ServerListener

public final class ZooKeeperUpdatingListener
extends ServerListenerAdapter

A ServerListener which registers the current Server to ZooKeeper as an ephemeral node. When server stops, or a network partition occurs, the underlying ZooKeeper session will be closed, and the node will be automatically removed. As a result, the clients that use a ZooKeeperEndpointGroup will be notified, and they will update their endpoint list automatically so that they do not attempt to connect to the unreachable servers.

Method Summary

Modifier and Type	Method	Description
static ZooKeeperUpdatingListenerBuilder	builder(String zkConnectionStr, String znodePath, ZooKeeperRegistrationSpec spec)	Returns a ZooKeeperUpdatingListenerBuilder with a ZooKeeper connection string and a znode path.
static ZooKeeperUpdatingListenerBuilder	builder(CuratorFramework client, String znodePath, ZooKeeperRegistrationSpec spec)	Returns a ZooKeeperUpdatingListenerBuilder with a CuratorFramework instance and a znode path.
static ZooKeeperUpdatingListener	of(String zkConnectionStr, String znodePath, ZooKeeperRegistrationSpec spec)	Creates a ZooKeeper server listener, which registers the Server into ZooKeeper.
static ZooKeeperUpdatingListener	of(CuratorFramework client, String znodePath, ZooKeeperRegistrationSpec spec)	Creates a ZooKeeper server listener, which registers the Server into ZooKeeper.
void	serverStarted(Server server)	Invoked when a Server finished its startup procedure successfully and it started to serve incoming requests.
void	serverStopping(Server server)	Invoked when a Server begins its shutdown procedure.

Methods inherited from class com.linecorp.armeria.server.ServerListenerAdapter

serverStarting, serverStopped

Methods inherited from class java.lang.Object

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

Method Details

of

public static ZooKeeperUpdatingListener of(String zkConnectionStr,
 String znodePath,
 ZooKeeperRegistrationSpec spec)

Creates a ZooKeeper server listener, which registers the Server into ZooKeeper.

If you need a fully customized ZooKeeperUpdatingListener instance, use builder(String, String, ZooKeeperRegistrationSpec) instead.

Parameters:

zkConnectionStr - the ZooKeeper connection string

znodePath - the ZooKeeper node to register

spec - the ZooKeeperRegistrationSpec to encode and register the Server

of

public static ZooKeeperUpdatingListener of(CuratorFramework client,
 String znodePath,
 ZooKeeperRegistrationSpec spec)

Creates a ZooKeeper server listener, which registers the Server into ZooKeeper.

If you need a fully customized ZooKeeperUpdatingListener instance, use builder(CuratorFramework, String, ZooKeeperRegistrationSpec) instead.

Parameters:

client - the curator framework instance

znodePath - the ZooKeeper node to register

spec - the ZooKeeperRegistrationSpec to encode and register the Server

builder

public static ZooKeeperUpdatingListenerBuilder builder(CuratorFramework client,
 String znodePath,
 ZooKeeperRegistrationSpec spec)

Returns a ZooKeeperUpdatingListenerBuilder with a CuratorFramework instance and a znode path.

Parameters:

client - the curator framework instance

znodePath - the ZooKeeper node to register

spec - the ZooKeeperRegistrationSpec to encode and register the Server

builder

public static ZooKeeperUpdatingListenerBuilder builder(String zkConnectionStr,
 String znodePath,
 ZooKeeperRegistrationSpec spec)

Returns a ZooKeeperUpdatingListenerBuilder with a ZooKeeper connection string and a znode path.

Parameters:

zkConnectionStr - the ZooKeeper connection string

znodePath - the ZooKeeper node to register

spec - the ZooKeeperRegistrationSpec to encode and register the Server

serverStarted

public void serverStarted(Server server)
                   throws Exception

Description copied from interface: ServerListener

Invoked when a Server finished its startup procedure successfully and it started to serve incoming requests.

Specified by:

serverStarted in interface ServerListener

Overrides:

serverStarted in class ServerListenerAdapter

Throws:

Exception

serverStopping

public void serverStopping(Server server)

Description copied from interface: ServerListener

Invoked when a Server begins its shutdown procedure.

Specified by:

serverStopping in interface ServerListener

Overrides:

serverStopping in class ServerListenerAdapter