Package com.linecorp.armeria.client.zookeeper

Class ZooKeeperEndpointGroup

java.lang.Object

com.linecorp.armeria.common.util.AbstractListenable<List<Endpoint>>

com.linecorp.armeria.client.endpoint.DynamicEndpointGroup

com.linecorp.armeria.client.zookeeper.ZooKeeperEndpointGroup

All Implemented Interfaces:

EndpointGroup, EndpointSelector, AsyncCloseable, Listenable<List<Endpoint>>, ListenableAsyncCloseable, AutoCloseable

public final class ZooKeeperEndpointGroup
extends DynamicEndpointGroup

A ZooKeeper-based EndpointGroup implementation. This EndpointGroup retrieves the list of Endpoints from a ZooKeeper and updates it when the children of the znode changes.

See Also:

• ZooKeeperUpdatingListener

Method Summary

Modifier and Type	Method	Description
static ZooKeeperEndpointGroupBuilder	builder(String zkConnectionStr, String znodePath, ZooKeeperDiscoverySpec spec)	Returns a new ZooKeeperEndpointGroupBuilder created with the specified ZooKeeper connection string and ZNode path.
static ZooKeeperEndpointGroupBuilder	builder(CuratorFramework client, String znodePath, ZooKeeperDiscoverySpec spec)	Returns a new ZooKeeperEndpointGroupBuilder created with the specified CuratorFramework and ZNode path.
protected void	doCloseAsync(CompletableFuture<?> future)	Override this method to release the resources held by this EndpointGroup and complete the specified CompletableFuture.
protected final List<Endpoint>	latestValue()	Returns the latest value notified before.
static ZooKeeperEndpointGroup	of(String zkConnectionStr, String znodePath, ZooKeeperDiscoverySpec spec)	Returns a new ZooKeeperEndpointGroup that retrieves the Endpoint list from the ZNode at the specified connection string and path.
static ZooKeeperEndpointGroup	of(CuratorFramework client, String znodePath, ZooKeeperDiscoverySpec spec)	Returns a new ZooKeeperEndpointGroup that retrieves the Endpoint list from the ZNode at the specified path using the specified CuratorFramework.

Methods inherited from class com.linecorp.armeria.client.endpoint.DynamicEndpointGroup

addEndpoint, allowsEmptyEndpoints, builder, close, closeAsync, endpoints, isClosed, isClosing, removeEndpoint, select, select, selectionStrategy, selectionTimeoutMillis, selectNow, setEndpoints, toString, toStringHelper, whenClosed, whenReady

Methods inherited from class com.linecorp.armeria.common.util.AbstractListenable

addListener, addListener, notifyListeners, removeListener

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.linecorp.armeria.client.endpoint.EndpointGroup

addListener, addListener, orElse, removeListener

Method Details

of

public static ZooKeeperEndpointGroup of(String zkConnectionStr,
 String znodePath,
 ZooKeeperDiscoverySpec spec)

Returns a new ZooKeeperEndpointGroup that retrieves the Endpoint list from the ZNode at the specified connection string and path. A new ZooKeeper client will be created internally. The ZooKeeper client will be destroyed when the returned ZooKeeperEndpointGroup is closed.

Parameters:

zkConnectionStr - the ZooKeeper connection string

znodePath - the ZooKeeper node to register

spec - the ZooKeeperDiscoverySpec to find and decode the registered instances

of

public static ZooKeeperEndpointGroup of(CuratorFramework client,
 String znodePath,
 ZooKeeperDiscoverySpec spec)

Returns a new ZooKeeperEndpointGroup that retrieves the Endpoint list from the ZNode at the specified path using the specified CuratorFramework. Note that the specified CuratorFramework will not be destroyed when the returned ZooKeeperEndpointGroup is closed.

Parameters:

client - the curator framework instance

znodePath - the ZooKeeper node to register

spec - the ZooKeeperDiscoverySpec to find and decode the registered instances

builder

public static ZooKeeperEndpointGroupBuilder builder(String zkConnectionStr,
 String znodePath,
 ZooKeeperDiscoverySpec spec)

Returns a new ZooKeeperEndpointGroupBuilder created with the specified ZooKeeper connection string and ZNode path. The ZooKeeperEndpointGroup built by the returned builder will create a new ZooKeeper client internally. The ZooKeeper client will be destroyed when the ZooKeeperEndpointGroup is closed.

Parameters:

zkConnectionStr - the ZooKeeper connection string

znodePath - the ZooKeeper node to register

spec - the ZooKeeperDiscoverySpec to find and decode the registered instances

builder

public static ZooKeeperEndpointGroupBuilder builder(CuratorFramework client,
 String znodePath,
 ZooKeeperDiscoverySpec spec)

Returns a new ZooKeeperEndpointGroupBuilder created with the specified CuratorFramework and ZNode path. Note that the specified CuratorFramework will not be destroyed when the ZooKeeperEndpointGroup built by the returned builder is closed.

Parameters:

client - the curator framework instance

znodePath - the ZooKeeper node to register

spec - the ZooKeeperDiscoverySpec to find and decode the registered instances

doCloseAsync

protected void doCloseAsync(CompletableFuture<?> future)

Description copied from class: DynamicEndpointGroup

Override this method to release the resources held by this EndpointGroup and complete the specified CompletableFuture.

Overrides:

doCloseAsync in class DynamicEndpointGroup

latestValue

protected final List<Endpoint> latestValue()

Description copied from class: AbstractListenable

Returns the latest value notified before. null if the value has not been initialized yet or the implementation of this class cannot cache it.

Overrides:

latestValue in class AbstractListenable<List<Endpoint>>