Skip to content

ZOOKEEPER-4963: Add ZooKeeper::builder to replace new ZooKeeperBuilder #2301

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 23, 2025
Merged

ZOOKEEPER-4963: Add ZooKeeper::builder to replace new ZooKeeperBuilder #2301

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
61 changes: 51 additions & 10 deletions zookeeper-server/src/main/java/org/apache/zookeeper/ZooKeeper.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -419,6 +419,25 @@ public boolean isConnected() {
}
}

/**
* Creates a builder with given connect string and session timeout.
*
* @param connectString
* comma separated host:port pairs, each corresponding to a zk
* server. e.g. "127.0.0.1:3000,127.0.0.1:3001,127.0.0.1:3002"
* If the optional chroot suffix is used the example would look
* like: "127.0.0.1:3000,127.0.0.1:3001,127.0.0.1:3002/app/a"
* where the client would be rooted at "/app/a" and all paths
* would be relative to this root - ie getting/setting/etc...
* "/foo/bar" would result in operations being run on
* "/app/a/foo/bar" (from the server perspective).
* @param sessionTimeout
* session timeout
*/
public static ZooKeeperBuilder builder(String connectString, Duration sessionTimeout) {
return new ZooKeeperBuilder(connectString, sessionTimeout);
}

/**
* To create a ZooKeeper client object, the application needs to pass a
* connection string containing a comma separated list of host:port pairs,
Expand Down Expand Up @@ -461,9 +480,11 @@ public boolean isConnected() {
* in cases of network failure
* @throws IllegalArgumentException
* if an invalid chroot path is specified
*
* @see #builder(String, Duration) for builder style construction
*/
public ZooKeeper(String connectString, int sessionTimeout, Watcher watcher) throws IOException {
this(new ZooKeeperBuilder(connectString, Duration.ofMillis(sessionTimeout))
this(builder(connectString, Duration.ofMillis(sessionTimeout))
.withDefaultWatcher(watcher)
.toOptions());
}
Expand Down Expand Up @@ -512,13 +533,15 @@ public ZooKeeper(String connectString, int sessionTimeout, Watcher watcher) thro
* in cases of network failure
* @throws IllegalArgumentException
* if an invalid chroot path is specified
*
* @see #builder(String, Duration) for builder style construction
*/
public ZooKeeper(
String connectString,
int sessionTimeout,
Watcher watcher,
ZKClientConfig conf) throws IOException {
this(new ZooKeeperBuilder(connectString, Duration.ofMillis(sessionTimeout))
this(builder(connectString, Duration.ofMillis(sessionTimeout))
.withDefaultWatcher(watcher)
.withClientConfig(conf)
.toOptions());
Expand Down Expand Up @@ -580,14 +603,16 @@ public ZooKeeper(
* in cases of network failure
* @throws IllegalArgumentException
* if an invalid chroot path is specified
*
* @see #builder(String, Duration) for builder style construction
*/
public ZooKeeper(
String connectString,
int sessionTimeout,
Watcher watcher,
boolean canBeReadOnly,
HostProvider aHostProvider) throws IOException {
this(new ZooKeeperBuilder(connectString, Duration.ofMillis(sessionTimeout))
this(builder(connectString, Duration.ofMillis(sessionTimeout))
.withDefaultWatcher(watcher)
.withCanBeReadOnly(canBeReadOnly)
.withHostProvider(ignored -> aHostProvider)
Expand Down Expand Up @@ -652,6 +677,8 @@ public ZooKeeper(
* in cases of network failure
* @throws IllegalArgumentException
* if an invalid chroot path is specified
*
* @see #builder(String, Duration) for builder style construction
*/
public ZooKeeper(
String connectString,
Expand All @@ -661,7 +688,7 @@ public ZooKeeper(
HostProvider hostProvider,
ZKClientConfig clientConfig
) throws IOException {
this(new ZooKeeperBuilder(connectString, Duration.ofMillis(sessionTimeout))
this(builder(connectString, Duration.ofMillis(sessionTimeout))
.withDefaultWatcher(watcher)
.withCanBeReadOnly(canBeReadOnly)
.withHostProvider(ignored -> hostProvider)
Expand Down Expand Up @@ -741,13 +768,15 @@ ClientCnxn createConnection(
* in cases of network failure
* @throws IllegalArgumentException
* if an invalid chroot path is specified
*
* @see #builder(String, Duration) for builder style construction
*/
public ZooKeeper(
String connectString,
int sessionTimeout,
Watcher watcher,
boolean canBeReadOnly) throws IOException {
this(new ZooKeeperBuilder(connectString, Duration.ofMillis(sessionTimeout))
this(builder(connectString, Duration.ofMillis(sessionTimeout))
.withDefaultWatcher(watcher)
.withCanBeReadOnly(canBeReadOnly)
.toOptions());
Expand Down Expand Up @@ -806,14 +835,16 @@ public ZooKeeper(
* in cases of network failure
* @throws IllegalArgumentException
* if an invalid chroot path is specified
*
* @see #builder(String, Duration) for builder style construction
*/
public ZooKeeper(
String connectString,
int sessionTimeout,
Watcher watcher,
boolean canBeReadOnly,
ZKClientConfig conf) throws IOException {
this(new ZooKeeperBuilder(connectString, Duration.ofMillis(sessionTimeout))
this(builder(connectString, Duration.ofMillis(sessionTimeout))
.withDefaultWatcher(watcher)
.withCanBeReadOnly(canBeReadOnly)
.withClientConfig(conf)
Expand Down Expand Up @@ -871,14 +902,16 @@ public ZooKeeper(
* @throws IOException in cases of network failure
* @throws IllegalArgumentException if an invalid chroot path is specified
* @throws IllegalArgumentException for an invalid list of ZooKeeper hosts
*
* @see #builder(String, Duration) for builder style construction
*/
public ZooKeeper(
String connectString,
int sessionTimeout,
Watcher watcher,
long sessionId,
byte[] sessionPasswd) throws IOException {
this(new ZooKeeperBuilder(connectString, Duration.ofMillis(sessionTimeout))
this(builder(connectString, Duration.ofMillis(sessionTimeout))
.withDefaultWatcher(watcher)
.withSession(sessionId, sessionPasswd)
.toOptions());
Expand Down Expand Up @@ -947,6 +980,8 @@ public ZooKeeper(
* use this as HostProvider to enable custom behaviour.
* @throws IOException in cases of network failure
* @throws IllegalArgumentException if an invalid chroot path is specified
*
* @see #builder(String, Duration) for builder style construction
*/
public ZooKeeper(
String connectString,
Expand All @@ -956,7 +991,7 @@ public ZooKeeper(
byte[] sessionPasswd,
boolean canBeReadOnly,
HostProvider aHostProvider) throws IOException {
this(new ZooKeeperBuilder(connectString, Duration.ofMillis(sessionTimeout))
this(builder(connectString, Duration.ofMillis(sessionTimeout))
.withDefaultWatcher(watcher)
.withSession(sessionId, sessionPasswd)
.withCanBeReadOnly(canBeReadOnly)
Expand Down Expand Up @@ -1032,6 +1067,8 @@ public ZooKeeper(
* @throws IllegalArgumentException if an invalid chroot path is specified
*
* @since 3.5.5
*
* @see #builder(String, Duration) for builder style construction
*/
public ZooKeeper(
String connectString,
Expand All @@ -1042,7 +1079,7 @@ public ZooKeeper(
boolean canBeReadOnly,
HostProvider hostProvider,
ZKClientConfig clientConfig) throws IOException {
this(new ZooKeeperBuilder(connectString, Duration.ofMillis(sessionTimeout))
this(builder(connectString, Duration.ofMillis(sessionTimeout))
.withSession(sessionId, sessionPasswd)
.withDefaultWatcher(watcher)
.withCanBeReadOnly(canBeReadOnly)
Expand All @@ -1054,6 +1091,8 @@ public ZooKeeper(
/**
* Create a ZooKeeper client and establish session asynchronously.
*
* <p>This is private and export for internal usage.
*
* <p>This constructor will initiate connection to the server and return
* immediately - potentially (usually) before the session is fully established.
* The watcher from options will be notified of any changes in state. This
Expand Down Expand Up @@ -1181,6 +1220,8 @@ public ZooKeeper(ZooKeeperOptions options) throws IOException {
* majority in the background.
* @throws IOException in cases of network failure
* @throws IllegalArgumentException if an invalid chroot path is specified
*
* @see #builder(String, Duration) for builder style construction
*/
public ZooKeeper(
String connectString,
Expand All @@ -1189,7 +1230,7 @@ public ZooKeeper(
long sessionId,
byte[] sessionPasswd,
boolean canBeReadOnly) throws IOException {
this(new ZooKeeperBuilder(connectString, Duration.ofMillis(sessionTimeout))
this(builder(connectString, Duration.ofMillis(sessionTimeout))
.withDefaultWatcher(watcher)
.withSession(sessionId, sessionPasswd)
.withCanBeReadOnly(canBeReadOnly)
Expand Down
19 changes: 5 additions & 14 deletions zookeeper-server/src/main/java/org/apache/zookeeper/client/ZooKeeperBuilder.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,22 +47,11 @@ public class ZooKeeperBuilder {
private ZKClientConfig clientConfig;

/**
* Creates a builder with given connect string and session timeout.
*
* @param connectString
* comma separated host:port pairs, each corresponding to a zk
* server. e.g. "127.0.0.1:3000,127.0.0.1:3001,127.0.0.1:3002"
* If the optional chroot suffix is used the example would look
* like: "127.0.0.1:3000,127.0.0.1:3001,127.0.0.1:3002/app/a"
* where the client would be rooted at "/app/a" and all paths
* would be relative to this root - ie getting/setting/etc...
* "/foo/bar" would result in operations being run on
* "/app/a/foo/bar" (from the server perspective).
* @param sessionTimeout
* session timeout
* This is private and export for internal usage. Use {@link ZooKeeper#builder(String, Duration)} instead.
*/
@InterfaceAudience.Private
public ZooKeeperBuilder(String connectString, Duration sessionTimeout) {
this.connectString = connectString;
this.connectString = Objects.requireNonNull(connectString, "connect string must not be null");
this.sessionTimeout = Objects.requireNonNull(sessionTimeout, "session timeout must not be null");
}

Expand Down Expand Up @@ -145,6 +134,8 @@ public ZooKeeperBuilder withClientConfig(ZKClientConfig clientConfig) {
/**
* Creates a {@link ZooKeeperOptions} with configured options.
*
* <p>This is private and export for internal usage.
*
* @apiNote helper to delegate existing constructors to {@link ZooKeeper#ZooKeeper(ZooKeeperOptions)}
*/
@InterfaceAudience.Private
Expand Down
5 changes: 3 additions & 2 deletions zookeeper-server/src/test/java/org/apache/zookeeper/client/ZooKeeperBuilderTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@
import org.apache.zookeeper.Watcher;
import org.apache.zookeeper.ZooDefs;
import org.apache.zookeeper.ZooKeeper;
import org.apache.zookeeper.admin.ZooKeeperAdmin;
import org.apache.zookeeper.common.Time;
import org.apache.zookeeper.test.ClientBase;
import org.junit.jupiter.api.Test;
Expand Down Expand Up @@ -70,7 +71,7 @@ private void testClient(BlockingQueue<WatchedEvent> events, ZooKeeper zk) throws
@Test
public void testBuildClient() throws Exception {
BlockingQueue<WatchedEvent> events = new LinkedBlockingQueue<>();
ZooKeeper zk = new ZooKeeperBuilder(hostPort, Duration.ofMillis(1000))
ZooKeeper zk = ZooKeeper.builder(hostPort, Duration.ofMillis(1000))
.withDefaultWatcher(events::offer)
.build();
testClient(events, zk);
Expand All @@ -79,7 +80,7 @@ public void testBuildClient() throws Exception {
@Test
public void testBuildAdminClient() throws Exception {
BlockingQueue<WatchedEvent> events = new LinkedBlockingQueue<>();
ZooKeeper zk = new ZooKeeperBuilder(hostPort, Duration.ofMillis(1000))
ZooKeeperAdmin zk = ZooKeeper.builder(hostPort, Duration.ofMillis(1000))
.withDefaultWatcher(events::offer)
.buildAdmin();
testClient(events, zk);
Expand Down