http://git-wip-us.apache.org/repos/asf/zookeeper/blob/ec4ec140/content/doc/r3.5.4-beta/api/org/apache/zookeeper/ZooKeeper.html ---------------------------------------------------------------------- diff --git a/content/doc/r3.5.4-beta/api/org/apache/zookeeper/ZooKeeper.html b/content/doc/r3.5.4-beta/api/org/apache/zookeeper/ZooKeeper.html new file mode 100644 index 0000000..a19390f --- /dev/null +++ b/content/doc/r3.5.4-beta/api/org/apache/zookeeper/ZooKeeper.html @@ -0,0 +1,3013 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc (1.8.0_144) on Fri May 11 16:29:19 UTC 2018 --> +<title>ZooKeeper (ZooKeeper 3.5.4-beta API)</title> +<meta name="date" content="2018-05-11"> +<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style"> +<script type="text/javascript" src="../../../script.js"></script> +</head> +<body> +<script type="text/javascript"><!-- + try { + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="ZooKeeper (ZooKeeper 3.5.4-beta API)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10,"i21":10,"i22":10,"i23":10,"i24":10,"i25":10,"i26":10,"i27":10,"i28":10,"i29":10,"i30":10,"i31":10,"i32":10,"i33":10,"i34":10,"i35":10,"i36":10,"i37":10,"i38":10,"i39":10,"i40":10,"i41":10,"i42":42,"i43":42,"i44":42,"i45":42,"i46":10,"i47":10,"i48":10,"i49":10,"i50":10,"i51":10,"i52":10,"i53":10,"i54":10,"i55":10,"i56":10,"i57":10,"i58":10}; +var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"],32:["t6","Deprecated Methods"]}; +var altColor = "altColor"; +var rowColor = "rowColor"; +var tableTab = "tableTab"; +var activeTableTab = "activeTableTab"; +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar.top"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.top.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/ZooKeeper.html">Use</a></li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../index-all.html">Index</a></li> +<li><a href="../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../org/apache/zookeeper/ZooDefs.Perms.html" title="interface in org.apache.zookeeper"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../org/apache/zookeeper/ZooKeeper.States.html" title="enum in org.apache.zookeeper"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?org/apache/zookeeper/ZooKeeper.html" target="_top">Frames</a></li> +<li><a href="ZooKeeper.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li><a href="#nested.class.summary">Nested</a> | </li> +<li><a href="#field.summary">Field</a> | </li> +<li><a href="#constructor.summary">Constr</a> | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#field.detail">Field</a> | </li> +<li><a href="#constructor.detail">Constr</a> | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">org.apache.zookeeper</div> +<h2 title="Class ZooKeeper" class="title">Class ZooKeeper</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>org.apache.zookeeper.ZooKeeper</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd>java.lang.AutoCloseable</dd> +</dl> +<dl> +<dt>Direct Known Subclasses:</dt> +<dd><a href="../../../org/apache/zookeeper/admin/ZooKeeperAdmin.html" title="class in org.apache.zookeeper.admin">ZooKeeperAdmin</a></dd> +</dl> +<hr> +<br> +<pre>@InterfaceAudience.Public +public class <span class="typeNameLabel">ZooKeeper</span> +extends java.lang.Object +implements java.lang.AutoCloseable</pre> +<div class="block">This is the main class of ZooKeeper client library. To use a ZooKeeper + service, an application must first instantiate an object of ZooKeeper class. + All the iterations will be done by calling the methods of ZooKeeper class. + The methods of this class are thread-safe unless otherwise noted. + <p> + Once a connection to a server is established, a session ID is assigned to the + client. The client will send heart beats to the server periodically to keep + the session valid. + <p> + The application can call ZooKeeper APIs through a client as long as the + session ID of the client remains valid. + <p> + If for some reason, the client fails to send heart beats to the server for a + prolonged period of time (exceeding the sessionTimeout value, for instance), + the server will expire the session, and the session ID will become invalid. + The client object will no longer be usable. To make ZooKeeper API calls, the + application must create a new client object. + <p> + If the ZooKeeper server the client currently connects to fails or otherwise + does not respond, the client will automatically try to connect to another + server before its session ID expires. If successful, the application can + continue to use the client. + <p> + The ZooKeeper API methods are either synchronous or asynchronous. Synchronous + methods blocks until the server has responded. Asynchronous methods just queue + the request for sending and return immediately. They take a callback object that + will be executed either on successful execution of the request or on error with + an appropriate return code (rc) indicating the error. + <p> + Some successful ZooKeeper API calls can leave watches on the "data nodes" in + the ZooKeeper server. Other successful ZooKeeper API calls can trigger those + watches. Once a watch is triggered, an event will be delivered to the client + which left the watch at the first place. Each watch can be triggered only + once. Thus, up to one event will be delivered to a client for every watch it + leaves. + <p> + A client needs an object of a class implementing Watcher interface for + processing the events delivered to the client. + + When a client drops the current connection and re-connects to a server, all the + existing watches are considered as being triggered but the undelivered events + are lost. To emulate this, the client will generate a special event to tell + the event handler a connection has been dropped. This special event has + EventType None and KeeperState Disconnected.</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== NESTED CLASS SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="nested.class.summary"> +<!-- --> +</a> +<h3>Nested Class Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> +<caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Class and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static class </code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/zookeeper/ZooKeeper.States.html" title="enum in org.apache.zookeeper">ZooKeeper.States</a></span></code> </td> +</tr> +</table> +</li> +</ul> +<!-- =========== FIELD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field.summary"> +<!-- --> +</a> +<h3>Field Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> +<caption><span>Fields</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Field and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/zookeeper/ZooKeeper.html#SECURE_CLIENT">SECURE_CLIENT</a></span></code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> +<div class="block"><span class="deprecationComment">Use <a href="../../../org/apache/zookeeper/client/ZKClientConfig.html#SECURE_CLIENT"><code>ZKClientConfig.SECURE_CLIENT</code></a> + instead.</span></div> +</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/zookeeper/ZooKeeper.html#ZOOKEEPER_CLIENT_CNXN_SOCKET">ZOOKEEPER_CLIENT_CNXN_SOCKET</a></span></code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> +<div class="block"><span class="deprecationComment">Use <a href="../../../org/apache/zookeeper/client/ZKClientConfig.html#ZOOKEEPER_CLIENT_CNXN_SOCKET"><code>ZKClientConfig.ZOOKEEPER_CLIENT_CNXN_SOCKET</code></a> + instead.</span></div> +</div> +</td> +</tr> +</table> +</li> +</ul> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> +<caption><span>Constructors</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../org/apache/zookeeper/ZooKeeper.html#ZooKeeper-java.lang.String-int-org.apache.zookeeper.Watcher-">ZooKeeper</a></span>(java.lang.String connectString, + int sessionTimeout, + <a href="../../../org/apache/zookeeper/Watcher.html" title="interface in org.apache.zookeeper">Watcher</a> watcher)</code> +<div class="block">To create a ZooKeeper client object, the application needs to pass a + connection string containing a comma separated list of host:port pairs, + each corresponding to a ZooKeeper server.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../org/apache/zookeeper/ZooKeeper.html#ZooKeeper-java.lang.String-int-org.apache.zookeeper.Watcher-boolean-">ZooKeeper</a></span>(java.lang.String connectString, + int sessionTimeout, + <a href="../../../org/apache/zookeeper/Watcher.html" title="interface in org.apache.zookeeper">Watcher</a> watcher, + boolean canBeReadOnly)</code> +<div class="block">To create a ZooKeeper client object, the application needs to pass a + connection string containing a comma separated list of host:port pairs, + each corresponding to a ZooKeeper server.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../org/apache/zookeeper/ZooKeeper.html#ZooKeeper-java.lang.String-int-org.apache.zookeeper.Watcher-boolean-org.apache.zookeeper.client.HostProvider-">ZooKeeper</a></span>(java.lang.String connectString, + int sessionTimeout, + <a href="../../../org/apache/zookeeper/Watcher.html" title="interface in org.apache.zookeeper">Watcher</a> watcher, + boolean canBeReadOnly, + <a href="../../../org/apache/zookeeper/client/HostProvider.html" title="interface in org.apache.zookeeper.client">HostProvider</a> aHostProvider)</code> +<div class="block">To create a ZooKeeper client object, the application needs to pass a + connection string containing a comma separated list of host:port pairs, + each corresponding to a ZooKeeper server.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../org/apache/zookeeper/ZooKeeper.html#ZooKeeper-java.lang.String-int-org.apache.zookeeper.Watcher-boolean-org.apache.zookeeper.client.HostProvider-org.apache.zookeeper.client.ZKClientConfig-">ZooKeeper</a></span>(java.lang.String connectString, + int sessionTimeout, + <a href="../../../org/apache/zookeeper/Watcher.html" title="interface in org.apache.zookeeper">Watcher</a> watcher, + boolean canBeReadOnly, + <a href="../../../org/apache/zookeeper/client/HostProvider.html" title="interface in org.apache.zookeeper.client">HostProvider</a> aHostProvider, + <a href="../../../org/apache/zookeeper/client/ZKClientConfig.html" title="class in org.apache.zookeeper.client">ZKClientConfig</a> clientConfig)</code> +<div class="block">To create a ZooKeeper client object, the application needs to pass a + connection string containing a comma separated list of host:port pairs, + each corresponding to a ZooKeeper server.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../org/apache/zookeeper/ZooKeeper.html#ZooKeeper-java.lang.String-int-org.apache.zookeeper.Watcher-boolean-org.apache.zookeeper.client.ZKClientConfig-">ZooKeeper</a></span>(java.lang.String connectString, + int sessionTimeout, + <a href="../../../org/apache/zookeeper/Watcher.html" title="interface in org.apache.zookeeper">Watcher</a> watcher, + boolean canBeReadOnly, + <a href="../../../org/apache/zookeeper/client/ZKClientConfig.html" title="class in org.apache.zookeeper.client">ZKClientConfig</a> conf)</code> +<div class="block">To create a ZooKeeper client object, the application needs to pass a + connection string containing a comma separated list of host:port pairs, + each corresponding to a ZooKeeper server.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../org/apache/zookeeper/ZooKeeper.html#ZooKeeper-java.lang.String-int-org.apache.zookeeper.Watcher-long-byte:A-">ZooKeeper</a></span>(java.lang.String connectString, + int sessionTimeout, + <a href="../../../org/apache/zookeeper/Watcher.html" title="interface in org.apache.zookeeper">Watcher</a> watcher, + long sessionId, + byte[] sessionPasswd)</code> +<div class="block">To create a ZooKeeper client object, the application needs to pass a + connection string containing a comma separated list of host:port pairs, + each corresponding to a ZooKeeper server.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../org/apache/zookeeper/ZooKeeper.html#ZooKeeper-java.lang.String-int-org.apache.zookeeper.Watcher-long-byte:A-boolean-">ZooKeeper</a></span>(java.lang.String connectString, + int sessionTimeout, + <a href="../../../org/apache/zookeeper/Watcher.html" title="interface in org.apache.zookeeper">Watcher</a> watcher, + long sessionId, + byte[] sessionPasswd, + boolean canBeReadOnly)</code> +<div class="block">To create a ZooKeeper client object, the application needs to pass a + connection string containing a comma separated list of host:port pairs, + each corresponding to a ZooKeeper server.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../org/apache/zookeeper/ZooKeeper.html#ZooKeeper-java.lang.String-int-org.apache.zookeeper.Watcher-long-byte:A-boolean-org.apache.zookeeper.client.HostProvider-">ZooKeeper</a></span>(java.lang.String connectString, + int sessionTimeout, + <a href="../../../org/apache/zookeeper/Watcher.html" title="interface in org.apache.zookeeper">Watcher</a> watcher, + long sessionId, + byte[] sessionPasswd, + boolean canBeReadOnly, + <a href="../../../org/apache/zookeeper/client/HostProvider.html" title="interface in org.apache.zookeeper.client">HostProvider</a> aHostProvider)</code> +<div class="block">To create a ZooKeeper client object, the application needs to pass a + connection string containing a comma separated list of host:port pairs, + each corresponding to a ZooKeeper server.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../org/apache/zookeeper/ZooKeeper.html#ZooKeeper-java.lang.String-int-org.apache.zookeeper.Watcher-org.apache.zookeeper.client.ZKClientConfig-">ZooKeeper</a></span>(java.lang.String connectString, + int sessionTimeout, + <a href="../../../org/apache/zookeeper/Watcher.html" title="interface in org.apache.zookeeper">Watcher</a> watcher, + <a href="../../../org/apache/zookeeper/client/ZKClientConfig.html" title="class in org.apache.zookeeper.client">ZKClientConfig</a> conf)</code> +<div class="block">To create a ZooKeeper client object, the application needs to pass a + connection string containing a comma separated list of host:port pairs, + each corresponding to a ZooKeeper server.</div> +</td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated Methods</a></span><span class="tabEnd"> </span></span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr id="i0" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/zookeeper/ZooKeeper.html#addAuthInfo-java.lang.String-byte:A-">addAuthInfo</a></span>(java.lang.String scheme, + byte[] auth)</code> +<div class="block">Add the specified scheme:auth information to this connection.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/zookeeper/ZooKeeper.html#close--">close</a></span>()</code> +<div class="block">Close this client object.</div> +</td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/zookeeper/ZooKeeper.html#close-int-">close</a></span>(int waitForShutdownTimeoutMs)</code> +<div class="block">Close this client object as the <a href="../../../org/apache/zookeeper/ZooKeeper.html#close--"><code>close()</code></a> method.</div> +</td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/zookeeper/ZooKeeper.html#create-java.lang.String-byte:A-java.util.List-org.apache.zookeeper.CreateMode-">create</a></span>(java.lang.String path, + byte[] data, + java.util.List<<a href="../../../org/apache/zookeeper/data/ACL.html" title="class in org.apache.zookeeper.data">ACL</a>> acl, + <a href="../../../org/apache/zookeeper/CreateMode.html" title="enum in org.apache.zookeeper">CreateMode</a> createMode)</code> +<div class="block">Create a node with the given path.</div> +</td> +</tr> +<tr id="i4" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/zookeeper/ZooKeeper.html#create-java.lang.String-byte:A-java.util.List-org.apache.zookeeper.CreateMode-org.apache.zookeeper.AsyncCallback.Create2Callback-java.lang.Object-">create</a></span>(java.lang.String path, + byte[] data, + java.util.List<<a href="../../../org/apache/zookeeper/data/ACL.html" title="class in org.apache.zookeeper.data">ACL</a>> acl, + <a href="../../../org/apache/zookeeper/CreateMode.html" title="enum in org.apache.zookeeper">CreateMode</a> createMode, + <a href="../../../org/apache/zookeeper/AsyncCallback.Create2Callback.html" title="interface in org.apache.zookeeper">AsyncCallback.Create2Callback</a> cb, + java.lang.Object ctx)</code> +<div class="block">The asynchronous version of create.</div> +</td> +</tr> +<tr id="i5" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/zookeeper/ZooKeeper.html#create-java.lang.String-byte:A-java.util.List-org.apache.zookeeper.CreateMode-org.apache.zookeeper.AsyncCallback.Create2Callback-java.lang.Object-long-">create</a></span>(java.lang.String path, + byte[] data, + java.util.List<<a href="../../../org/apache/zookeeper/data/ACL.html" title="class in org.apache.zookeeper.data">ACL</a>> acl, + <a href="../../../org/apache/zookeeper/CreateMode.html" title="enum in org.apache.zookeeper">CreateMode</a> createMode, + <a href="../../../org/apache/zookeeper/AsyncCallback.Create2Callback.html" title="interface in org.apache.zookeeper">AsyncCallback.Create2Callback</a> cb, + java.lang.Object ctx, + long ttl)</code> +<div class="block">The asynchronous version of create with ttl.</div> +</td> +</tr> +<tr id="i6" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/zookeeper/ZooKeeper.html#create-java.lang.String-byte:A-java.util.List-org.apache.zookeeper.CreateMode-org.apache.zookeeper.AsyncCallback.StringCallback-java.lang.Object-">create</a></span>(java.lang.String path, + byte[] data, + java.util.List<<a href="../../../org/apache/zookeeper/data/ACL.html" title="class in org.apache.zookeeper.data">ACL</a>> acl, + <a href="../../../org/apache/zookeeper/CreateMode.html" title="enum in org.apache.zookeeper">CreateMode</a> createMode, + <a href="../../../org/apache/zookeeper/AsyncCallback.StringCallback.html" title="interface in org.apache.zookeeper">AsyncCallback.StringCallback</a> cb, + java.lang.Object ctx)</code> +<div class="block">The asynchronous version of create.</div> +</td> +</tr> +<tr id="i7" class="rowColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/zookeeper/ZooKeeper.html#create-java.lang.String-byte:A-java.util.List-org.apache.zookeeper.CreateMode-org.apache.zookeeper.data.Stat-">create</a></span>(java.lang.String path, + byte[] data, + java.util.List<<a href="../../../org/apache/zookeeper/data/ACL.html" title="class in org.apache.zookeeper.data">ACL</a>> acl, + <a href="../../../org/apache/zookeeper/CreateMode.html" title="enum in org.apache.zookeeper">CreateMode</a> createMode, + <a href="../../../org/apache/zookeeper/data/Stat.html" title="class in org.apache.zookeeper.data">Stat</a> stat)</code> +<div class="block">Create a node with the given path and returns the Stat of that node.</div> +</td> +</tr> +<tr id="i8" class="altColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/zookeeper/ZooKeeper.html#create-java.lang.String-byte:A-java.util.List-org.apache.zookeeper.CreateMode-org.apache.zookeeper.data.Stat-long-">create</a></span>(java.lang.String path, + byte[] data, + java.util.List<<a href="../../../org/apache/zookeeper/data/ACL.html" title="class in org.apache.zookeeper.data">ACL</a>> acl, + <a href="../../../org/apache/zookeeper/CreateMode.html" title="enum in org.apache.zookeeper">CreateMode</a> createMode, + <a href="../../../org/apache/zookeeper/data/Stat.html" title="class in org.apache.zookeeper.data">Stat</a> stat, + long ttl)</code> +<div class="block">same as <a href="../../../org/apache/zookeeper/ZooKeeper.html#create-java.lang.String-byte:A-java.util.List-org.apache.zookeeper.CreateMode-org.apache.zookeeper.data.Stat-"><code>create(String, byte[], List, CreateMode, Stat)</code></a> but + allows for specifying a TTL when mode is <a href="../../../org/apache/zookeeper/CreateMode.html#PERSISTENT_WITH_TTL"><code>CreateMode.PERSISTENT_WITH_TTL</code></a> + or <a href="../../../org/apache/zookeeper/CreateMode.html#PERSISTENT_SEQUENTIAL_WITH_TTL"><code>CreateMode.PERSISTENT_SEQUENTIAL_WITH_TTL</code></a>.</div> +</td> +</tr> +<tr id="i9" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/zookeeper/ZooKeeper.html#delete-java.lang.String-int-">delete</a></span>(java.lang.String path, + int version)</code> +<div class="block">Delete the node with the given path.</div> +</td> +</tr> +<tr id="i10" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/zookeeper/ZooKeeper.html#delete-java.lang.String-int-org.apache.zookeeper.AsyncCallback.VoidCallback-java.lang.Object-">delete</a></span>(java.lang.String path, + int version, + <a href="../../../org/apache/zookeeper/AsyncCallback.VoidCallback.html" title="interface in org.apache.zookeeper">AsyncCallback.VoidCallback</a> cb, + java.lang.Object ctx)</code> +<div class="block">The asynchronous version of delete.</div> +</td> +</tr> +<tr id="i11" class="rowColor"> +<td class="colFirst"><code><a href="../../../org/apache/zookeeper/data/Stat.html" title="class in org.apache.zookeeper.data">Stat</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/zookeeper/ZooKeeper.html#exists-java.lang.String-boolean-">exists</a></span>(java.lang.String path, + boolean watch)</code> +<div class="block">Return the stat of the node of the given path.</div> +</td> +</tr> +<tr id="i12" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/zookeeper/ZooKeeper.html#exists-java.lang.String-boolean-org.apache.zookeeper.AsyncCallback.StatCallback-java.lang.Object-">exists</a></span>(java.lang.String path, + boolean watch, + <a href="../../../org/apache/zookeeper/AsyncCallback.StatCallback.html" title="interface in org.apache.zookeeper">AsyncCallback.StatCallback</a> cb, + java.lang.Object ctx)</code> +<div class="block">The asynchronous version of exists.</div> +</td> +</tr> +<tr id="i13" class="rowColor"> +<td class="colFirst"><code><a href="../../../org/apache/zookeeper/data/Stat.html" title="class in org.apache.zookeeper.data">Stat</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/zookeeper/ZooKeeper.html#exists-java.lang.String-org.apache.zookeeper.Watcher-">exists</a></span>(java.lang.String path, + <a href="../../../org/apache/zookeeper/Watcher.html" title="interface in org.apache.zookeeper">Watcher</a> watcher)</code> +<div class="block">Return the stat of the node of the given path.</div> +</td> +</tr> +<tr id="i14" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/zookeeper/ZooKeeper.html#exists-java.lang.String-org.apache.zookeeper.Watcher-org.apache.zookeeper.AsyncCallback.StatCallback-java.lang.Object-">exists</a></span>(java.lang.String path, + <a href="../../../org/apache/zookeeper/Watcher.html" title="interface in org.apache.zookeeper">Watcher</a> watcher, + <a href="../../../org/apache/zookeeper/AsyncCallback.StatCallback.html" title="interface in org.apache.zookeeper">AsyncCallback.StatCallback</a> cb, + java.lang.Object ctx)</code> +<div class="block">The asynchronous version of exists.</div> +</td> +</tr> +<tr id="i15" class="rowColor"> +<td class="colFirst"><code>java.util.List<<a href="../../../org/apache/zookeeper/data/ACL.html" title="class in org.apache.zookeeper.data">ACL</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/zookeeper/ZooKeeper.html#getACL-java.lang.String-org.apache.zookeeper.data.Stat-">getACL</a></span>(java.lang.String path, + <a href="../../../org/apache/zookeeper/data/Stat.html" title="class in org.apache.zookeeper.data">Stat</a> stat)</code> +<div class="block">Return the ACL and stat of the node of the given path.</div> +</td> +</tr> +<tr id="i16" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/zookeeper/ZooKeeper.html#getACL-java.lang.String-org.apache.zookeeper.data.Stat-org.apache.zookeeper.AsyncCallback.ACLCallback-java.lang.Object-">getACL</a></span>(java.lang.String path, + <a href="../../../org/apache/zookeeper/data/Stat.html" title="class in org.apache.zookeeper.data">Stat</a> stat, + <a href="../../../org/apache/zookeeper/AsyncCallback.ACLCallback.html" title="interface in org.apache.zookeeper">AsyncCallback.ACLCallback</a> cb, + java.lang.Object ctx)</code> +<div class="block">The asynchronous version of getACL.</div> +</td> +</tr> +<tr id="i17" class="rowColor"> +<td class="colFirst"><code>java.util.List<java.lang.String></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/zookeeper/ZooKeeper.html#getChildren-java.lang.String-boolean-">getChildren</a></span>(java.lang.String path, + boolean watch)</code> +<div class="block">Return the list of the children of the node of the given path.</div> +</td> +</tr> +<tr id="i18" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/zookeeper/ZooKeeper.html#getChildren-java.lang.String-boolean-org.apache.zookeeper.AsyncCallback.Children2Callback-java.lang.Object-">getChildren</a></span>(java.lang.String path, + boolean watch, + <a href="../../../org/apache/zookeeper/AsyncCallback.Children2Callback.html" title="interface in org.apache.zookeeper">AsyncCallback.Children2Callback</a> cb, + java.lang.Object ctx)</code> +<div class="block">The asynchronous version of getChildren.</div> +</td> +</tr> +<tr id="i19" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/zookeeper/ZooKeeper.html#getChildren-java.lang.String-boolean-org.apache.zookeeper.AsyncCallback.ChildrenCallback-java.lang.Object-">getChildren</a></span>(java.lang.String path, + boolean watch, + <a href="../../../org/apache/zookeeper/AsyncCallback.ChildrenCallback.html" title="interface in org.apache.zookeeper">AsyncCallback.ChildrenCallback</a> cb, + java.lang.Object ctx)</code> +<div class="block">The asynchronous version of getChildren.</div> +</td> +</tr> +<tr id="i20" class="altColor"> +<td class="colFirst"><code>java.util.List<java.lang.String></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/zookeeper/ZooKeeper.html#getChildren-java.lang.String-boolean-org.apache.zookeeper.data.Stat-">getChildren</a></span>(java.lang.String path, + boolean watch, + <a href="../../../org/apache/zookeeper/data/Stat.html" title="class in org.apache.zookeeper.data">Stat</a> stat)</code> +<div class="block">For the given znode path return the stat and children list.</div> +</td> +</tr> +<tr id="i21" class="rowColor"> +<td class="colFirst"><code>java.util.List<java.lang.String></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/zookeeper/ZooKeeper.html#getChildren-java.lang.String-org.apache.zookeeper.Watcher-">getChildren</a></span>(java.lang.String path, + <a href="../../../org/apache/zookeeper/Watcher.html" title="interface in org.apache.zookeeper">Watcher</a> watcher)</code> +<div class="block">Return the list of the children of the node of the given path.</div> +</td> +</tr> +<tr id="i22" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/zookeeper/ZooKeeper.html#getChildren-java.lang.String-org.apache.zookeeper.Watcher-org.apache.zookeeper.AsyncCallback.Children2Callback-java.lang.Object-">getChildren</a></span>(java.lang.String path, + <a href="../../../org/apache/zookeeper/Watcher.html" title="interface in org.apache.zookeeper">Watcher</a> watcher, + <a href="../../../org/apache/zookeeper/AsyncCallback.Children2Callback.html" title="interface in org.apache.zookeeper">AsyncCallback.Children2Callback</a> cb, + java.lang.Object ctx)</code> +<div class="block">The asynchronous version of getChildren.</div> +</td> +</tr> +<tr id="i23" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/zookeeper/ZooKeeper.html#getChildren-java.lang.String-org.apache.zookeeper.Watcher-org.apache.zookeeper.AsyncCallback.ChildrenCallback-java.lang.Object-">getChildren</a></span>(java.lang.String path, + <a href="../../../org/apache/zookeeper/Watcher.html" title="interface in org.apache.zookeeper">Watcher</a> watcher, + <a href="../../../org/apache/zookeeper/AsyncCallback.ChildrenCallback.html" title="interface in org.apache.zookeeper">AsyncCallback.ChildrenCallback</a> cb, + java.lang.Object ctx)</code> +<div class="block">The asynchronous version of getChildren.</div> +</td> +</tr> +<tr id="i24" class="altColor"> +<td class="colFirst"><code>java.util.List<java.lang.String></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/zookeeper/ZooKeeper.html#getChildren-java.lang.String-org.apache.zookeeper.Watcher-org.apache.zookeeper.data.Stat-">getChildren</a></span>(java.lang.String path, + <a href="../../../org/apache/zookeeper/Watcher.html" title="interface in org.apache.zookeeper">Watcher</a> watcher, + <a href="../../../org/apache/zookeeper/data/Stat.html" title="class in org.apache.zookeeper.data">Stat</a> stat)</code> +<div class="block">For the given znode path return the stat and children list.</div> +</td> +</tr> +<tr id="i25" class="rowColor"> +<td class="colFirst"><code><a href="../../../org/apache/zookeeper/client/ZKClientConfig.html" title="class in org.apache.zookeeper.client">ZKClientConfig</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/zookeeper/ZooKeeper.html#getClientConfig--">getClientConfig</a></span>()</code> </td> +</tr> +<tr id="i26" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/zookeeper/ZooKeeper.html#getConfig-boolean-org.apache.zookeeper.AsyncCallback.DataCallback-java.lang.Object-">getConfig</a></span>(boolean watch, + <a href="../../../org/apache/zookeeper/AsyncCallback.DataCallback.html" title="interface in org.apache.zookeeper">AsyncCallback.DataCallback</a> cb, + java.lang.Object ctx)</code> +<div class="block">The Asynchronous version of getConfig.</div> +</td> +</tr> +<tr id="i27" class="rowColor"> +<td class="colFirst"><code>byte[]</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/zookeeper/ZooKeeper.html#getConfig-boolean-org.apache.zookeeper.data.Stat-">getConfig</a></span>(boolean watch, + <a href="../../../org/apache/zookeeper/data/Stat.html" title="class in org.apache.zookeeper.data">Stat</a> stat)</code> +<div class="block">Return the last committed configuration (as known to the server to which the client is connected) + and the stat of the configuration.</div> +</td> +</tr> +<tr id="i28" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/zookeeper/ZooKeeper.html#getConfig-org.apache.zookeeper.Watcher-org.apache.zookeeper.AsyncCallback.DataCallback-java.lang.Object-">getConfig</a></span>(<a href="../../../org/apache/zookeeper/Watcher.html" title="interface in org.apache.zookeeper">Watcher</a> watcher, + <a href="../../../org/apache/zookeeper/AsyncCallback.DataCallback.html" title="interface in org.apache.zookeeper">AsyncCallback.DataCallback</a> cb, + java.lang.Object ctx)</code> +<div class="block">The asynchronous version of getConfig.</div> +</td> +</tr> +<tr id="i29" class="rowColor"> +<td class="colFirst"><code>byte[]</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/zookeeper/ZooKeeper.html#getConfig-org.apache.zookeeper.Watcher-org.apache.zookeeper.data.Stat-">getConfig</a></span>(<a href="../../../org/apache/zookeeper/Watcher.html" title="interface in org.apache.zookeeper">Watcher</a> watcher, + <a href="../../../org/apache/zookeeper/data/Stat.html" title="class in org.apache.zookeeper.data">Stat</a> stat)</code> +<div class="block">Return the last committed configuration (as known to the server to which the client is connected) + and the stat of the configuration.</div> +</td> +</tr> +<tr id="i30" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/zookeeper/ZooKeeper.html#getData-java.lang.String-boolean-org.apache.zookeeper.AsyncCallback.DataCallback-java.lang.Object-">getData</a></span>(java.lang.String path, + boolean watch, + <a href="../../../org/apache/zookeeper/AsyncCallback.DataCallback.html" title="interface in org.apache.zookeeper">AsyncCallback.DataCallback</a> cb, + java.lang.Object ctx)</code> +<div class="block">The asynchronous version of getData.</div> +</td> +</tr> +<tr id="i31" class="rowColor"> +<td class="colFirst"><code>byte[]</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/zookeeper/ZooKeeper.html#getData-java.lang.String-boolean-org.apache.zookeeper.data.Stat-">getData</a></span>(java.lang.String path, + boolean watch, + <a href="../../../org/apache/zookeeper/data/Stat.html" title="class in org.apache.zookeeper.data">Stat</a> stat)</code> +<div class="block">Return the data and the stat of the node of the given path.</div> +</td> +</tr> +<tr id="i32" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/zookeeper/ZooKeeper.html#getData-java.lang.String-org.apache.zookeeper.Watcher-org.apache.zookeeper.AsyncCallback.DataCallback-java.lang.Object-">getData</a></span>(java.lang.String path, + <a href="../../../org/apache/zookeeper/Watcher.html" title="interface in org.apache.zookeeper">Watcher</a> watcher, + <a href="../../../org/apache/zookeeper/AsyncCallback.DataCallback.html" title="interface in org.apache.zookeeper">AsyncCallback.DataCallback</a> cb, + java.lang.Object ctx)</code> +<div class="block">The asynchronous version of getData.</div> +</td> +</tr> +<tr id="i33" class="rowColor"> +<td class="colFirst"><code>byte[]</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/zookeeper/ZooKeeper.html#getData-java.lang.String-org.apache.zookeeper.Watcher-org.apache.zookeeper.data.Stat-">getData</a></span>(java.lang.String path, + <a href="../../../org/apache/zookeeper/Watcher.html" title="interface in org.apache.zookeeper">Watcher</a> watcher, + <a href="../../../org/apache/zookeeper/data/Stat.html" title="class in org.apache.zookeeper.data">Stat</a> stat)</code> +<div class="block">Return the data and the stat of the node of the given path.</div> +</td> +</tr> +<tr id="i34" class="altColor"> +<td class="colFirst"><code>org.apache.zookeeper.client.ZooKeeperSaslClient</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/zookeeper/ZooKeeper.html#getSaslClient--">getSaslClient</a></span>()</code> </td> +</tr> +<tr id="i35" class="rowColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/zookeeper/ZooKeeper.html#getSessionId--">getSessionId</a></span>()</code> +<div class="block">The session id for this ZooKeeper client instance.</div> +</td> +</tr> +<tr id="i36" class="altColor"> +<td class="colFirst"><code>byte[]</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/zookeeper/ZooKeeper.html#getSessionPasswd--">getSessionPasswd</a></span>()</code> +<div class="block">The session password for this ZooKeeper client instance.</div> +</td> +</tr> +<tr id="i37" class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/zookeeper/ZooKeeper.html#getSessionTimeout--">getSessionTimeout</a></span>()</code> +<div class="block">The negotiated session timeout for this ZooKeeper client instance.</div> +</td> +</tr> +<tr id="i38" class="altColor"> +<td class="colFirst"><code><a href="../../../org/apache/zookeeper/ZooKeeper.States.html" title="enum in org.apache.zookeeper">ZooKeeper.States</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/zookeeper/ZooKeeper.html#getState--">getState</a></span>()</code> </td> +</tr> +<tr id="i39" class="rowColor"> +<td class="colFirst"><code>org.apache.zookeeper.Testable</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/zookeeper/ZooKeeper.html#getTestable--">getTestable</a></span>()</code> </td> +</tr> +<tr id="i40" class="altColor"> +<td class="colFirst"><code>java.util.List<org.apache.zookeeper.OpResult></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/zookeeper/ZooKeeper.html#multi-java.lang.Iterable-">multi</a></span>(java.lang.Iterable<org.apache.zookeeper.Op> ops)</code> +<div class="block">Executes multiple ZooKeeper operations or none of them.</div> +</td> +</tr> +<tr id="i41" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/zookeeper/ZooKeeper.html#multi-java.lang.Iterable-org.apache.zookeeper.AsyncCallback.MultiCallback-java.lang.Object-">multi</a></span>(java.lang.Iterable<org.apache.zookeeper.Op> ops, + <a href="../../../org/apache/zookeeper/AsyncCallback.MultiCallback.html" title="interface in org.apache.zookeeper">AsyncCallback.MultiCallback</a> cb, + java.lang.Object ctx)</code> +<div class="block">The asynchronous version of multi.</div> +</td> +</tr> +<tr id="i42" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/zookeeper/ZooKeeper.html#reconfig-java.util.List-java.util.List-java.util.List-long-org.apache.zookeeper.AsyncCallback.DataCallback-java.lang.Object-">reconfig</a></span>(java.util.List<java.lang.String> joiningServers, + java.util.List<java.lang.String> leavingServers, + java.util.List<java.lang.String> newMembers, + long fromConfig, + <a href="../../../org/apache/zookeeper/AsyncCallback.DataCallback.html" title="interface in org.apache.zookeeper">AsyncCallback.DataCallback</a> cb, + java.lang.Object ctx)</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> +<div class="block"><span class="deprecationComment">instead use the reconfigure() methods instead in <a href="../../../org/apache/zookeeper/admin/ZooKeeperAdmin.html" title="class in org.apache.zookeeper.admin"><code>ZooKeeperAdmin</code></a></span></div> +</div> +</td> +</tr> +<tr id="i43" class="rowColor"> +<td class="colFirst"><code>byte[]</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/zookeeper/ZooKeeper.html#reconfig-java.util.List-java.util.List-java.util.List-long-org.apache.zookeeper.data.Stat-">reconfig</a></span>(java.util.List<java.lang.String> joiningServers, + java.util.List<java.lang.String> leavingServers, + java.util.List<java.lang.String> newMembers, + long fromConfig, + <a href="../../../org/apache/zookeeper/data/Stat.html" title="class in org.apache.zookeeper.data">Stat</a> stat)</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> +<div class="block"><span class="deprecationComment">instead use the reconfigure() methods instead in <a href="../../../org/apache/zookeeper/admin/ZooKeeperAdmin.html" title="class in org.apache.zookeeper.admin"><code>ZooKeeperAdmin</code></a></span></div> +</div> +</td> +</tr> +<tr id="i44" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/zookeeper/ZooKeeper.html#reconfig-java.lang.String-java.lang.String-java.lang.String-long-org.apache.zookeeper.AsyncCallback.DataCallback-java.lang.Object-">reconfig</a></span>(java.lang.String joiningServers, + java.lang.String leavingServers, + java.lang.String newMembers, + long fromConfig, + <a href="../../../org/apache/zookeeper/AsyncCallback.DataCallback.html" title="interface in org.apache.zookeeper">AsyncCallback.DataCallback</a> cb, + java.lang.Object ctx)</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> +<div class="block"><span class="deprecationComment">instead use the reconfigure() methods instead in <a href="../../../org/apache/zookeeper/admin/ZooKeeperAdmin.html" title="class in org.apache.zookeeper.admin"><code>ZooKeeperAdmin</code></a></span></div> +</div> +</td> +</tr> +<tr id="i45" class="rowColor"> +<td class="colFirst"><code>byte[]</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/zookeeper/ZooKeeper.html#reconfig-java.lang.String-java.lang.String-java.lang.String-long-org.apache.zookeeper.data.Stat-">reconfig</a></span>(java.lang.String joiningServers, + java.lang.String leavingServers, + java.lang.String newMembers, + long fromConfig, + <a href="../../../org/apache/zookeeper/data/Stat.html" title="class in org.apache.zookeeper.data">Stat</a> stat)</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> +<div class="block"><span class="deprecationComment">instead use the reconfigure() methods instead in <a href="../../../org/apache/zookeeper/admin/ZooKeeperAdmin.html" title="class in org.apache.zookeeper.admin"><code>ZooKeeperAdmin</code></a></span></div> +</div> +</td> +</tr> +<tr id="i46" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/zookeeper/ZooKeeper.html#register-org.apache.zookeeper.Watcher-">register</a></span>(<a href="../../../org/apache/zookeeper/Watcher.html" title="interface in org.apache.zookeeper">Watcher</a> watcher)</code> +<div class="block">Specify the default watcher for the connection (overrides the one + specified during construction).</div> +</td> +</tr> +<tr id="i47" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/zookeeper/ZooKeeper.html#removeAllWatches-java.lang.String-org.apache.zookeeper.Watcher.WatcherType-boolean-">removeAllWatches</a></span>(java.lang.String path, + <a href="../../../org/apache/zookeeper/Watcher.WatcherType.html" title="enum in org.apache.zookeeper">Watcher.WatcherType</a> watcherType, + boolean local)</code> +<div class="block">For the given znode path, removes all the registered watchers of given + watcherType.</div> +</td> +</tr> +<tr id="i48" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/zookeeper/ZooKeeper.html#removeAllWatches-java.lang.String-org.apache.zookeeper.Watcher.WatcherType-boolean-org.apache.zookeeper.AsyncCallback.VoidCallback-java.lang.Object-">removeAllWatches</a></span>(java.lang.String path, + <a href="../../../org/apache/zookeeper/Watcher.WatcherType.html" title="enum in org.apache.zookeeper">Watcher.WatcherType</a> watcherType, + boolean local, + <a href="../../../org/apache/zookeeper/AsyncCallback.VoidCallback.html" title="interface in org.apache.zookeeper">AsyncCallback.VoidCallback</a> cb, + java.lang.Object ctx)</code> +<div class="block">The asynchronous version of removeAllWatches.</div> +</td> +</tr> +<tr id="i49" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/zookeeper/ZooKeeper.html#removeWatches-java.lang.String-org.apache.zookeeper.Watcher-org.apache.zookeeper.Watcher.WatcherType-boolean-">removeWatches</a></span>(java.lang.String path, + <a href="../../../org/apache/zookeeper/Watcher.html" title="interface in org.apache.zookeeper">Watcher</a> watcher, + <a href="../../../org/apache/zookeeper/Watcher.WatcherType.html" title="enum in org.apache.zookeeper">Watcher.WatcherType</a> watcherType, + boolean local)</code> +<div class="block">For the given znode path, removes the specified watcher of given + watcherType.</div> +</td> +</tr> +<tr id="i50" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/zookeeper/ZooKeeper.html#removeWatches-java.lang.String-org.apache.zookeeper.Watcher-org.apache.zookeeper.Watcher.WatcherType-boolean-org.apache.zookeeper.AsyncCallback.VoidCallback-java.lang.Object-">removeWatches</a></span>(java.lang.String path, + <a href="../../../org/apache/zookeeper/Watcher.html" title="interface in org.apache.zookeeper">Watcher</a> watcher, + <a href="../../../org/apache/zookeeper/Watcher.WatcherType.html" title="enum in org.apache.zookeeper">Watcher.WatcherType</a> watcherType, + boolean local, + <a href="../../../org/apache/zookeeper/AsyncCallback.VoidCallback.html" title="interface in org.apache.zookeeper">AsyncCallback.VoidCallback</a> cb, + java.lang.Object ctx)</code> +<div class="block">The asynchronous version of removeWatches.</div> +</td> +</tr> +<tr id="i51" class="rowColor"> +<td class="colFirst"><code><a href="../../../org/apache/zookeeper/data/Stat.html" title="class in org.apache.zookeeper.data">Stat</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/zookeeper/ZooKeeper.html#setACL-java.lang.String-java.util.List-int-">setACL</a></span>(java.lang.String path, + java.util.List<<a href="../../../org/apache/zookeeper/data/ACL.html" title="class in org.apache.zookeeper.data">ACL</a>> acl, + int aclVersion)</code> +<div class="block">Set the ACL for the node of the given path if such a node exists and the + given aclVersion matches the acl version of the node.</div> +</td> +</tr> +<tr id="i52" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/zookeeper/ZooKeeper.html#setACL-java.lang.String-java.util.List-int-org.apache.zookeeper.AsyncCallback.StatCallback-java.lang.Object-">setACL</a></span>(java.lang.String path, + java.util.List<<a href="../../../org/apache/zookeeper/data/ACL.html" title="class in org.apache.zookeeper.data">ACL</a>> acl, + int version, + <a href="../../../org/apache/zookeeper/AsyncCallback.StatCallback.html" title="interface in org.apache.zookeeper">AsyncCallback.StatCallback</a> cb, + java.lang.Object ctx)</code> +<div class="block">The asynchronous version of setACL.</div> +</td> +</tr> +<tr id="i53" class="rowColor"> +<td class="colFirst"><code><a href="../../../org/apache/zookeeper/data/Stat.html" title="class in org.apache.zookeeper.data">Stat</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/zookeeper/ZooKeeper.html#setData-java.lang.String-byte:A-int-">setData</a></span>(java.lang.String path, + byte[] data, + int version)</code> +<div class="block">Set the data for the node of the given path if such a node exists and the + given version matches the version of the node (if the given version is + -1, it matches any node's versions).</div> +</td> +</tr> +<tr id="i54" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/zookeeper/ZooKeeper.html#setData-java.lang.String-byte:A-int-org.apache.zookeeper.AsyncCallback.StatCallback-java.lang.Object-">setData</a></span>(java.lang.String path, + byte[] data, + int version, + <a href="../../../org/apache/zookeeper/AsyncCallback.StatCallback.html" title="interface in org.apache.zookeeper">AsyncCallback.StatCallback</a> cb, + java.lang.Object ctx)</code> +<div class="block">The asynchronous version of setData.</div> +</td> +</tr> +<tr id="i55" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/zookeeper/ZooKeeper.html#sync-java.lang.String-org.apache.zookeeper.AsyncCallback.VoidCallback-java.lang.Object-">sync</a></span>(java.lang.String path, + <a href="../../../org/apache/zookeeper/AsyncCallback.VoidCallback.html" title="interface in org.apache.zookeeper">AsyncCallback.VoidCallback</a> cb, + java.lang.Object ctx)</code> +<div class="block">Asynchronous sync.</div> +</td> +</tr> +<tr id="i56" class="altColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/zookeeper/ZooKeeper.html#toString--">toString</a></span>()</code> +<div class="block">String representation of this ZooKeeper client.</div> +</td> +</tr> +<tr id="i57" class="rowColor"> +<td class="colFirst"><code><a href="../../../org/apache/zookeeper/Transaction.html" title="class in org.apache.zookeeper">Transaction</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/zookeeper/ZooKeeper.html#transaction--">transaction</a></span>()</code> +<div class="block">A Transaction is a thin wrapper on the <a href="../../../org/apache/zookeeper/ZooKeeper.html#multi-java.lang.Iterable-"><code>multi(java.lang.Iterable<org.apache.zookeeper.Op>)</code></a> method + which provides a builder object that can be used to construct + and commit an atomic set of operations.</div> +</td> +</tr> +<tr id="i58" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/zookeeper/ZooKeeper.html#updateServerList-java.lang.String-">updateServerList</a></span>(java.lang.String connectString)</code> +<div class="block">This function allows a client to update the connection string by providing + a new comma separated list of host:port pairs, each corresponding to a + ZooKeeper server.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.Object</h3> +<code>equals, getClass, hashCode, notify, notifyAll, wait, wait, wait</code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ FIELD DETAIL =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field.detail"> +<!-- --> +</a> +<h3>Field Detail</h3> +<a name="ZOOKEEPER_CLIENT_CNXN_SOCKET"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>ZOOKEEPER_CLIENT_CNXN_SOCKET</h4> +<pre>@Deprecated +public static final java.lang.String ZOOKEEPER_CLIENT_CNXN_SOCKET</pre> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">Use <a href="../../../org/apache/zookeeper/client/ZKClientConfig.html#ZOOKEEPER_CLIENT_CNXN_SOCKET"><code>ZKClientConfig.ZOOKEEPER_CLIENT_CNXN_SOCKET</code></a> + instead.</span></div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../constant-values.html#org.apache.zookeeper.ZooKeeper.ZOOKEEPER_CLIENT_CNXN_SOCKET">Constant Field Values</a></dd> +</dl> +</li> +</ul> +<a name="SECURE_CLIENT"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>SECURE_CLIENT</h4> +<pre>@Deprecated +public static final java.lang.String SECURE_CLIENT</pre> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">Use <a href="../../../org/apache/zookeeper/client/ZKClientConfig.html#SECURE_CLIENT"><code>ZKClientConfig.SECURE_CLIENT</code></a> + instead.</span></div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../constant-values.html#org.apache.zookeeper.ZooKeeper.SECURE_CLIENT">Constant Field Values</a></dd> +</dl> +</li> +</ul> +</li> +</ul> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="ZooKeeper-java.lang.String-int-org.apache.zookeeper.Watcher-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>ZooKeeper</h4> +<pre>public ZooKeeper(java.lang.String connectString, + int sessionTimeout, + <a href="../../../org/apache/zookeeper/Watcher.html" title="interface in org.apache.zookeeper">Watcher</a> watcher) + throws java.io.IOException</pre> +<div class="block">To create a ZooKeeper client object, the application needs to pass a + connection string containing a comma separated list of host:port pairs, + each corresponding to a ZooKeeper server. + <p> + Session establishment is asynchronous. This constructor will initiate + connection to the server and return immediately - potentially (usually) + before the session is fully established. The watcher argument specifies + the watcher that will be notified of any changes in state. This + notification can come at any point before or after the constructor call + has returned. + <p> + The instantiated ZooKeeper client object will pick an arbitrary server + from the connectString and attempt to connect to it. If establishment of + the connection fails, another server in the connect string will be tried + (the order is non-deterministic, as we random shuffle the list), until a + connection is established. The client will continue attempts until the + session is explicitly closed. + <p> + Added in 3.2.0: An optional "chroot" suffix may also be appended to the + connection string. This will run the client commands while interpreting + all paths relative to this root (similar to the unix chroot command).</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>connectString</code> - 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).</dd> +<dd><code>sessionTimeout</code> - session timeout in milliseconds</dd> +<dd><code>watcher</code> - a watcher object which will be notified of state changes, may + also be notified for node events</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>java.io.IOException</code> - in cases of network failure</dd> +<dd><code>java.lang.IllegalArgumentException</code> - if an invalid chroot path is specified</dd> +</dl> +</li> +</ul> +<a name="ZooKeeper-java.lang.String-int-org.apache.zookeeper.Watcher-org.apache.zookeeper.client.ZKClientConfig-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>ZooKeeper</h4> +<pre>public ZooKeeper(java.lang.String connectString, + int sessionTimeout, + <a href="../../../org/apache/zookeeper/Watcher.html" title="interface in org.apache.zookeeper">Watcher</a> watcher, + <a href="../../../org/apache/zookeeper/client/ZKClientConfig.html" title="class in org.apache.zookeeper.client">ZKClientConfig</a> conf) + throws java.io.IOException</pre> +<div class="block">To create a ZooKeeper client object, the application needs to pass a + connection string containing a comma separated list of host:port pairs, + each corresponding to a ZooKeeper server. + <p> + Session establishment is asynchronous. This constructor will initiate + connection to the server and return immediately - potentially (usually) + before the session is fully established. The watcher argument specifies + the watcher that will be notified of any changes in state. This + notification can come at any point before or after the constructor call + has returned. + <p> + The instantiated ZooKeeper client object will pick an arbitrary server + from the connectString and attempt to connect to it. If establishment of + the connection fails, another server in the connect string will be tried + (the order is non-deterministic, as we random shuffle the list), until a + connection is established. The client will continue attempts until the + session is explicitly closed. + <p> + Added in 3.2.0: An optional "chroot" suffix may also be appended to the + connection string. This will run the client commands while interpreting + all paths relative to this root (similar to the unix chroot command).</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>connectString</code> - 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).</dd> +<dd><code>sessionTimeout</code> - session timeout in milliseconds</dd> +<dd><code>watcher</code> - a watcher object which will be notified of state changes, may + also be notified for node events</dd> +<dd><code>conf</code> - (added in 3.5.2) passing this conf object gives each client the flexibility of + configuring properties differently compared to other instances</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>java.io.IOException</code> - in cases of network failure</dd> +<dd><code>java.lang.IllegalArgumentException</code> - if an invalid chroot path is specified</dd> +</dl> +</li> +</ul> +<a name="ZooKeeper-java.lang.String-int-org.apache.zookeeper.Watcher-boolean-org.apache.zookeeper.client.HostProvider-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>ZooKeeper</h4> +<pre>public ZooKeeper(java.lang.String connectString, + int sessionTimeout, + <a href="../../../org/apache/zookeeper/Watcher.html" title="interface in org.apache.zookeeper">Watcher</a> watcher, + boolean canBeReadOnly, + <a href="../../../org/apache/zookeeper/client/HostProvider.html" title="interface in org.apache.zookeeper.client">HostProvider</a> aHostProvider) + throws java.io.IOException</pre> +<div class="block">To create a ZooKeeper client object, the application needs to pass a + connection string containing a comma separated list of host:port pairs, + each corresponding to a ZooKeeper server. + <p> + Session establishment is asynchronous. This constructor will initiate + connection to the server and return immediately - potentially (usually) + before the session is fully established. The watcher argument specifies + the watcher that will be notified of any changes in state. This + notification can come at any point before or after the constructor call + has returned. + <p> + The instantiated ZooKeeper client object will pick an arbitrary server + from the connectString and attempt to connect to it. If establishment of + the connection fails, another server in the connect string will be tried + (the order is non-deterministic, as we random shuffle the list), until a + connection is established. The client will continue attempts until the + session is explicitly closed. + <p> + Added in 3.2.0: An optional "chroot" suffix may also be appended to the + connection string. This will run the client commands while interpreting + all paths relative to this root (similar to the unix chroot command). + <p> + For backward compatibility, there is another version + <a href="../../../org/apache/zookeeper/ZooKeeper.html#ZooKeeper-java.lang.String-int-org.apache.zookeeper.Watcher-boolean-"><code>ZooKeeper(String, int, Watcher, boolean)</code></a> which uses + default <a href="../../../org/apache/zookeeper/client/StaticHostProvider.html" title="class in org.apache.zookeeper.client"><code>StaticHostProvider</code></a></div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>connectString</code> - 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).</dd> +<dd><code>sessionTimeout</code> - session timeout in milliseconds</dd> +<dd><code>watcher</code> - a watcher object which will be notified of state changes, may + also be notified for node events</dd> +<dd><code>canBeReadOnly</code> - (added in 3.4) whether the created client is allowed to go to + read-only mode in case of partitioning. Read-only mode + basically means that if the client can't find any majority + servers but there's partitioned server it could reach, it + connects to one in read-only mode, i.e. read requests are + allowed while write requests are not. It continues seeking for + majority in the background.</dd> +<dd><code>aHostProvider</code> - use this as HostProvider to enable custom behaviour.</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>java.io.IOException</code> - in cases of network failure</dd> +<dd><code>java.lang.IllegalArgumentException</code> - if an invalid chroot path is specified</dd> +</dl> +</li> +</ul> +<a name="ZooKeeper-java.lang.String-int-org.apache.zookeeper.Watcher-boolean-org.apache.zookeeper.client.HostProvider-org.apache.zookeeper.client.ZKClientConfig-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>ZooKeeper</h4> +<pre>public ZooKeeper(java.lang.String connectString, + int sessionTimeout, + <a href="../../../org/apache/zookeeper/Watcher.html" title="interface in org.apache.zookeeper">Watcher</a> watcher, + boolean canBeReadOnly, + <a href="../../../org/apache/zookeeper/client/HostProvider.html" title="interface in org.apache.zookeeper.client">HostProvider</a> aHostProvider, + <a href="../../../org/apache/zookeeper/client/ZKClientConfig.html" title="class in org.apache.zookeeper.client">ZKClientConfig</a> clientConfig) + throws java.io.IOException</pre> +<div class="block">To create a ZooKeeper client object, the application needs to pass a + connection string containing a comma separated list of host:port pairs, + each corresponding to a ZooKeeper server. + <p> + Session establishment is asynchronous. This constructor will initiate + connection to the server and return immediately - potentially (usually) + before the session is fully established. The watcher argument specifies + the watcher that will be notified of any changes in state. This + notification can come at any point before or after the constructor call + has returned. + <p> + The instantiated ZooKeeper client object will pick an arbitrary server + from the connectString and attempt to connect to it. If establishment of + the connection fails, another server in the connect string will be tried + (the order is non-deterministic, as we random shuffle the list), until a + connection is established. The client will continue attempts until the + session is explicitly closed. + <p> + Added in 3.2.0: An optional "chroot" suffix may also be appended to the + connection string. This will run the client commands while interpreting + all paths relative to this root (similar to the unix chroot command). + <p> + For backward compatibility, there is another version + <a href="../../../org/apache/zookeeper/ZooKeeper.html#ZooKeeper-java.lang.String-int-org.apache.zookeeper.Watcher-boolean-"><code>ZooKeeper(String, int, Watcher, boolean)</code></a> which uses default + <a href="../../../org/apache/zookeeper/client/StaticHostProvider.html" title="class in org.apache.zookeeper.client"><code>StaticHostProvider</code></a></div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>connectString</code> - 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).</dd> +<dd><code>sessionTimeout</code> - session timeout in milliseconds</dd> +<dd><code>watcher</code> - a watcher object which will be notified of state changes, may + also be notified for node events</dd> +<dd><code>canBeReadOnly</code> - (added in 3.4) whether the created client is allowed to go to + read-only mode in case of partitioning. Read-only mode + basically means that if the client can't find any majority + servers but there's partitioned server it could reach, it + connects to one in read-only mode, i.e. read requests are + allowed while write requests are not. It continues seeking for + majority in the background.</dd> +<dd><code>aHostProvider</code> - use this as HostProvider to enable custom behaviour.</dd> +<dd><code>clientConfig</code> - (added in 3.5.2) passing this conf object gives each client the flexibility of + configuring properties differently compared to other instances</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>java.io.IOException</code> - in cases of network failure</dd> +<dd><code>java.lang.IllegalArgumentException</code> - if an invalid chroot path is specified</dd> +</dl> +</li> +</ul> +<a name="ZooKeeper-java.lang.String-int-org.apache.zookeeper.Watcher-boolean-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>ZooKeeper</h4> +<pre>public ZooKeeper(java.lang.String connectString, + int sessionTimeout, + <a href="../../../org/apache/zookeeper/Watcher.html" title="interface in org.apache.zookeeper">Watcher</a> watcher, + boolean canBeReadOnly) + throws java.io.IOException</pre> +<div class="block">To create a ZooKeeper client object, the application needs to pass a + connection string containing a comma separated list of host:port pairs, + each corresponding to a ZooKeeper server. + <p> + Session establishment is asynchronous. This constructor will initiate + connection to the server and return immediately - potentially (usually) + before the session is fully established. The watcher argument specifies + the watcher that will be notified of any changes in state. This + notification can come at any point before or after the constructor call + has returned. + <p> + The instantiated ZooKeeper client object will pick an arbitrary server + from the connectString and attempt to connect to it. If establishment of + the connection fails, another server in the connect string will be tried + (the order is non-deterministic, as we random shuffle the list), until a + connection is established. The client will continue attempts until the + session is explicitly closed. + <p> + Added in 3.2.0: An optional "chroot" suffix may also be appended to the + connection string. This will run the client commands while interpreting + all paths relative to this root (similar to the unix chroot command). + <p></div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>connectString</code> - 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).</dd> +<dd><code>sessionTimeout</code> - session timeout in milliseconds</dd> +<dd><code>watcher</code> - a watcher object which will be notified of state changes, may + also be notified for node events</dd> +<dd><code>canBeReadOnly</code> - (added in 3.4) whether the created client is allowed to go to + read-only mode in case of partitioning. Read-only mode + basically means that if the client can't find any majority + servers but there's partitioned server it could reach, it + connects to one in read-only mode, i.e. read requests are + allowed while write requests are not. It continues seeking for + majority in the background.</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>java.io.IOException</code> - in cases of network failure</dd> +<dd><code>java.lang.IllegalArgumentException</code> - if an invalid chroot path is specified</dd> +</dl> +</li> +</ul> +<a name="ZooKeeper-java.lang.String-int-org.apache.zookeeper.Watcher-boolean-org.apache.zookeeper.client.ZKClientConfig-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>ZooKeeper</h4> +<pre>public ZooKeeper(java.lang.String connectString, + int sessionTimeout, + <a href="../../../org/apache/zookeeper/Watcher.html" title="interface in org.apache.zookeeper">Watcher</a> watcher, + boolean canBeReadOnly, + <a href="../../../org/apache/zookeeper/client/ZKClientConfig.html" title="class in org.apache.zookeeper.client">ZKClientConfig</a> conf) + throws java.io.IOException</pre> +<div class="block">To create a ZooKeeper client object, the application needs to pass a + connection string containing a comma separated list of host:port pairs, + each corresponding to a ZooKeeper server. + <p> + Session establishment is asynchronous. This constructor will initiate + connection to the server and return immediately - potentially (usually) + before the session is fully established. The watcher argument specifies + the watcher that will be notified of any changes in state. This + notification can come at any point before or after the constructor call + has returned. + <p> + The instantiated ZooKeeper client object will pick an arbitrary server + from the connectString and attempt to connect to it. If establishment of + the connection fails, another server in the connect string will be tried + (the order is non-deterministic, as we random shuffle the list), until a + connection is established. The client will continue attempts until the + session is explicitly closed. + <p> + Added in 3.2.0: An optional "chroot" suffix may also be appended to the + connection string. This will run the client commands while interpreting + all paths relative to this root (similar to the unix chroot command). + <p></div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>connectString</code> - 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).</dd> +<dd><code>sessionTimeout</code> - session timeout in milliseconds</dd> +<dd><code>watcher</code> - a watcher object which will be notified of state changes, may + also be notified for node events</dd> +<dd><code>canBeReadOnly</code> - (added in 3.4) whether the created client is allowed to go to + read-only mode in case of partitioning. Read-only mode + basically means that if the client can't find any majority + servers but there's partitioned server it could reach, it + connects to one in read-only mode, i.e. read requests are + allowed while write requests are not. It continues seeking for + majority in the background.</dd> +<dd><code>conf</code> - (added in 3.5.2) passing this conf object gives each client the flexibility of + configuring properties differently compared to other instances</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>java.io.IOException</code> - in cases of network failure</dd> +<dd><code>java.lang.IllegalArgumentException</code> - if an invalid chroot path is specified</dd> +</dl> +</li> +</ul> +<a name="ZooKeeper-java.lang.String-int-org.apache.zookeeper.Watcher-long-byte:A-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>ZooKeeper</h4> +<pre>public ZooKeeper(java.lang.String connectString, + int sessionTimeout, + <a href="../../../org/apache/zookeeper/Watcher.html" title="interface in org.apache.zookeeper">Watcher</a> watcher, + long sessionId, + byte[] sessionPasswd) + throws java.io.IOException</pre> +<div class="block">To create a ZooKeeper client object, the application needs to pass a + connection string containing a comma separated list of host:port pairs, + each corresponding to a ZooKeeper server. + <p> + Session establishment is asynchronous. This constructor will initiate + connection to the server and return immediately - potentially (usually) + before the session is fully established. The watcher argument specifies + the watcher that will be notified of any changes in state. This + notification can come at any point before or after the constructor call + has returned. + <p> + The instantiated ZooKeeper client object will pick an arbitrary server + from the connectString and attempt to connect to it. If establishment of + the connection fails, another server in the connect string will be tried + (the order is non-deterministic, as we random shuffle the list), until a + connection is established. The client will continue attempts until the + session is explicitly closed (or the session is expired by the server). + <p> + Added in 3.2.0: An optional "chroot" suffix may also be appended to the + connection string. This will run the client commands while interpreting + all paths relative to this root (similar to the unix chroot command). + <p> + Use <a href="../../../org/apache/zookeeper/ZooKeeper.html#getSessionId--"><code>getSessionId()</code></a> and <a href="../../../org/apache/zookeeper/ZooKeeper.html#getSessionPasswd--"><code>getSessionPasswd()</code></a> on an established + client connection, these values must be passed as sessionId and + sessionPasswd respectively if reconnecting. Otherwise, if not + reconnecting, use the other constructor which does not require these + parameters.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>connectString</code> - 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).</dd> +<dd><code>sessionTimeout</code> - session timeout in milliseconds</dd> +<dd><code>watcher</code> - a watcher object which will be notified of state changes, may + also be notified for node events</dd> +<dd><code>sessionId</code> - specific session id to use if reconnecting</dd> +<dd><code>sessionPasswd</code> - password for this session</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>java.io.IOException</code> - in cases of network failure</dd> +<dd><code>java.lang.IllegalArgumentException</code> - if an invalid chroot path is specified</dd> +<dd><code>java.lang.IllegalArgumentException</code> - for an invalid list of ZooKeeper hosts</dd> +</dl> +</li> +</ul> +<a name="ZooKeeper-java.lang.String-int-org.apache.zookeeper.Watcher-long-byte:A-boolean-org.apache.zookeeper.client.HostProvider-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>ZooKeeper</h4> +<pre>public ZooKeeper(java.lang.String connectString, + int sessionTimeout, + <a href="../../../org/apache/zookeeper/Watcher.html" title="interface in org.apache.zookeeper">Watcher</a> watcher, + long sessionId, + byte[] sessionPasswd, + boolean canBeReadOnly, + <a href="../../../org/apache/zookeeper/client/HostProvider.html" title="interface in org.apache.zookeeper.client">HostProvider</a> aHostProvider) + throws java.io.IOException</pre> +<div class="block">To create a ZooKeeper client object, the application needs to pass a + connection string containing a comma separated list of host:port pairs, + each corresponding to a ZooKeeper server. + <p> + Session establishment is asynchronous. This constructor will initiate + connection to the server and return immediately - potentially (usually) + before the session is fully established. The watcher argument specifies + the watcher that will be notified of any changes in state. This + notification can come at any point before or after the constructor call + has returned. + <p> + The instantiated ZooKeeper client object will pick an arbitrary server + from the connectString and attempt to connect to it. If establishment of + the connection fails, another server in the connect string will be tried + (the order is non-deterministic, as we random shuffle the list), until a + connection is established. The client will continue attempts until the + session is explicitly closed (or the session is expired by the server). + <p> + Added in 3.2.0: An optional "chroot" suffix may also be appended to the + connection string. This will run the client commands while interpreting + all paths relative to this root (similar to the unix chroot command). + <p> + Use <a href="../../../org/apache/zookeeper/ZooKeeper.html#getSessionId--"><code>getSessionId()</code></a> and <a href="../../../org/apache/zookeeper/ZooKeeper.html#getSessionPasswd--"><code>getSessionPasswd()</code></a> on an established + client connection, these values must be passed as sessionId and + sessionPasswd respectively if reconnecting. Otherwise, if not + reconnecting, use the other constructor which does not require these + parameters. + <p> + For backward compatibility, there is another version + <a href="../../../org/apache/zookeeper/ZooKeeper.html#ZooKeeper-java.lang.String-int-org.apache.zookeeper.Watcher-long-byte:A-boolean-"><code>ZooKeeper(String, int, Watcher, long, byte[], boolean)</code></a> which uses + default <a href="../../../org/apache/zookeeper/client/StaticHostProvider.html" title="class in org.apache.zookeeper.client"><code>StaticHostProvider</code></a></div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>connectString</code> - 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... +
<TRUNCATED>
