http://git-wip-us.apache.org/repos/asf/zookeeper/blob/4e0e3f02/content/doc/r3.4.13/api/org/apache/zookeeper/ZooKeeper.html ---------------------------------------------------------------------- diff --git a/content/doc/r3.4.13/api/org/apache/zookeeper/ZooKeeper.html b/content/doc/r3.4.13/api/org/apache/zookeeper/ZooKeeper.html new file mode 100644 index 0000000..11d3fa4 --- /dev/null +++ b/content/doc/r3.4.13/api/org/apache/zookeeper/ZooKeeper.html @@ -0,0 +1,1900 @@ +<!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_171) on Fri Jun 29 17:05:01 UTC 2018 --> +<title>ZooKeeper (ZooKeeper 3.4.13 API)</title> +<meta name="date" content="2018-06-29"> +<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.4.13 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}; +var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete 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"> +<hr> +<br> +<pre>@InterfaceAudience.Public +public class <span class="typeNameLabel">ZooKeeper</span> +extends java.lang.Object</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#ZOOKEEPER_CLIENT_CNXN_SOCKET">ZOOKEEPER_CLIENT_CNXN_SOCKET</a></span></code> </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-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="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-">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> +</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></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>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="i3" 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.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="i4" 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-">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="i5" 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-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="i6" class="altColor"> +<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="i7" class="rowColor"> +<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="i8" class="altColor"> +<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="i9" class="rowColor"> +<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="i10" class="altColor"> +<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="i11" class="rowColor"> +<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="i12" 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-">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="i13" 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.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="i14" 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.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="i15" 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-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="i16" 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-">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="i17" 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.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="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-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="i19" 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-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="i20" 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="i21" 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="i22" 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="i23" 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="i24" 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="i25" 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="i26" 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="i27" 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="i28" 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="i29" 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="i30" 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="i31" 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="i32" 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="i33" 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="i34" 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="i35" 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="i36" 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="i37" 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="i38" 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="i39" 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> +</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="blockListLast"> +<li class="blockList"> +<h4>ZOOKEEPER_CLIENT_CNXN_SOCKET</h4> +<pre>public static final java.lang.String ZOOKEEPER_CLIENT_CNXN_SOCKET</pre> +<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> +</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-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).</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-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-"> +<!-- --> +</a> +<ul class="blockListLast"> +<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) + 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> +<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> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="getSaslClient--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getSaslClient</h4> +<pre>public org.apache.zookeeper.client.ZooKeeperSaslClient getSaslClient()</pre> +</li> +</ul> +<a name="getTestable--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getTestable</h4> +<pre>public org.apache.zookeeper.Testable getTestable()</pre> +</li> +</ul> +<a name="getSessionId--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getSessionId</h4> +<pre>public long getSessionId()</pre> +<div class="block">The session id for this ZooKeeper client instance. The value returned is + not valid until the client connects to a server and may change after a + re-connect. + + This method is NOT thread safe</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>current session id</dd> +</dl> +</li> +</ul> +<a name="getSessionPasswd--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getSessionPasswd</h4> +<pre>public byte[] getSessionPasswd()</pre> +<div class="block">The session password for this ZooKeeper client instance. The value + returned is not valid until the client connects to a server and may + change after a re-connect. + + This method is NOT thread safe</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>current session password</dd> +</dl> +</li> +</ul> +<a name="getSessionTimeout--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getSessionTimeout</h4> +<pre>public int getSessionTimeout()</pre> +<div class="block">The negotiated session timeout for this ZooKeeper client instance. The + value returned is not valid until the client connects to a server and + may change after a re-connect. + + This method is NOT thread safe</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>current session timeout</dd> +</dl> +</li> +</ul> +<a name="addAuthInfo-java.lang.String-byte:A-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addAuthInfo</h4> +<pre>public void addAuthInfo(java.lang.String scheme, + byte[] auth)</pre> +<div class="block">Add the specified scheme:auth information to this connection. + + This method is NOT thread safe</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>scheme</code> - </dd> +<dd><code>auth</code> - </dd> +</dl> +</li> +</ul> +<a name="register-org.apache.zookeeper.Watcher-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>register</h4> +<pre>public void register(<a href="../../../org/apache/zookeeper/Watcher.html" title="interface in org.apache.zookeeper">Watcher</a> watcher)</pre> +<div class="block">Specify the default watcher for the connection (overrides the one + specified during construction).</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>watcher</code> - </dd> +</dl> +</li> +</ul> +<a name="close--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>close</h4> +<pre>public void close() + throws java.lang.InterruptedException</pre> +<div class="block">Close this client object. Once the client is closed, its session becomes + invalid. All the ephemeral nodes in the ZooKeeper server associated with + the session will be removed. The watches left on those nodes (and on + their parents) will be triggered.</div> +<dl> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>java.lang.InterruptedException</code></dd> +</dl> +</li> +</ul> +<a name="create-java.lang.String-byte:A-java.util.List-org.apache.zookeeper.CreateMode-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>create</h4> +<pre>public java.lang.String create(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) + throws <a href="../../../org/apache/zookeeper/KeeperException.html" title="class in org.apache.zookeeper">KeeperException</a>, + java.lang.InterruptedException</pre> +<div class="block">Create a node with the given path. The node data will be the given data, + and node acl will be the given acl. + <p> + The flags argument specifies whether the created node will be ephemeral + or not. + <p> + An ephemeral node will be removed by the ZooKeeper automatically when the + session associated with the creation of the node expires. + <p> + The flags argument can also specify to create a sequential node. The + actual path name of a sequential node will be the given path plus a + suffix "i" where i is the current sequential number of the node. The sequence + number is always fixed length of 10 digits, 0 padded. Once + such a node is created, the sequential number will be incremented by one. + <p> + If a node with the same actual path already exists in the ZooKeeper, a + KeeperException with error code KeeperException.NodeExists will be + thrown. Note that since a different actual path is used for each + invocation of creating sequential node with the same path argument, the + call will never throw "file exists" KeeperException. + <p> + If the parent node does not exist in the ZooKeeper, a KeeperException + with error code KeeperException.NoNode will be thrown. + <p> + An ephemeral node cannot have children. If the parent node of the given + path is ephemeral, a KeeperException with error code + KeeperException.NoChildrenForEphemerals will be thrown. + <p> + This operation, if successful, will trigger all the watches left on the + node of the given path by exists and getData API calls, and the watches + left on the parent node by getChildren API calls. + <p> + If a node is created successfully, the ZooKeeper server will trigger the + watches on the path left by exists calls, and the watches on the parent + of the node by getChildren calls. + <p> + The maximum allowable size of the data array is 1 MB (1,048,576 bytes). + Arrays larger than this will cause a KeeperExecption to be thrown.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>path</code> - the path for the node</dd> +<dd><code>data</code> - the initial data for the node</dd> +<dd><code>acl</code> - the acl for the node</dd> +<dd><code>createMode</code> - specifying whether the node to be created is ephemeral + and/or sequential</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the actual path of the created node</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="../../../org/apache/zookeeper/KeeperException.html" title="class in org.apache.zookeeper">KeeperException</a></code> - if the server returns a non-zero error code</dd> +<dd><code><a href="../../../org/apache/zookeeper/KeeperException.InvalidACLException.html" title="class in org.apache.zookeeper">KeeperException.InvalidACLException</a></code> - if the ACL is invalid, null, or empty</dd> +<dd><code>java.lang.InterruptedException</code> - if the transaction is interrupted</dd> +<dd><code>java.lang.IllegalArgumentException</code> - if an invalid path is specified</dd> +</dl> +</li> +</ul> +<a name="create-java.lang.String-byte:A-java.util.List-org.apache.zookeeper.CreateMode-org.apache.zookeeper.AsyncCallback.StringCallback-java.lang.Object-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>create</h4> +<pre>public void create(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)</pre> +<div class="block">The asynchronous version of create.</div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../org/apache/zookeeper/ZooKeeper.html#create-java.lang.String-byte:A-java.util.List-org.apache.zookeeper.CreateMode-"><code>create(String, byte[], List, CreateMode)</code></a></dd> +</dl> +</li> +</ul> +<a name="delete-java.lang.String-int-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>delete</h4> +<pre>public void delete(java.lang.String path, + int version) + throws java.lang.InterruptedException, + <a href="../../../org/apache/zookeeper/KeeperException.html" title="class in org.apache.zookeeper">KeeperException</a></pre> +<div class="block">Delete the node with the given path. The call will succeed if such a node + exists, and the given version matches the node's version (if the given + version is -1, it matches any node's versions). + <p> + A KeeperException with error code KeeperException.NoNode will be thrown + if the nodes does not exist. + <p> + A KeeperException with error code KeeperException.BadVersion will be + thrown if the given version does not match the node's version. + <p> + A KeeperException with error code KeeperException.NotEmpty will be thrown + if the node has children. + <p> + This operation, if successful, will trigger all the watches on the node + of the given path left by exists API calls, and the watches on the parent + node left by getChildren API calls.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>path</code> - the path of the node to be deleted.</dd> +<dd><code>version</code> - the expected node version.</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>java.lang.InterruptedException</code> - IF the server transaction is interrupted</dd> +<dd><code><a href="../../../org/apache/zookeeper/KeeperException.html" title="class in org.apache.zookeeper">KeeperException</a></code> - If the server signals an error with a non-zero + return code.</dd> +<dd><code>java.lang.IllegalArgumentException</code> - if an invalid path is specified</dd> +</dl> +</li> +</ul> +<a name="multi-java.lang.Iterable-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>multi</h4> +<pre>public java.util.List<org.apache.zookeeper.OpResult> multi(java.lang.Iterable<org.apache.zookeeper.Op> ops) + throws java.lang.InterruptedException, + <a href="../../../org/apache/zookeeper/KeeperException.html" title="class in org.apache.zookeeper">KeeperException</a></pre> +<div class="block">Executes multiple ZooKeeper operations or none of them. + <p> + On success, a list of results is returned. + On failure, an exception is raised which contains partial results and + error details, see <a href="../../../org/apache/zookeeper/KeeperException.html#getResults--"><code>KeeperException.getResults()</code></a> + <p> + Note: The maximum allowable size of all of the data arrays in all of + the setData operations in this single request is typically 1 MB + (1,048,576 bytes). This limit is specified on the server via + <a href="http://zookeeper.apache.org/doc/current/zookeeperAdmin.html#Unsafe+Options">jute.maxbuffer</a>. + Requests larger than this will cause a KeeperException to be + thrown.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>ops</code> - An iterable that contains the operations to be done. + These should be created using the factory methods on <code>Op</code>.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>A list of results, one for each input Op, the order of + which exactly matches the order of the <code>ops</code> input + operations.</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>java.lang.InterruptedException</code> - If the operation was interrupted. + The operation may or may not have succeeded, but will not have + partially succeeded if this exception is thrown.</dd> +<dd><code><a href="../../../org/apache/zookeeper/KeeperException.html" title="class in org.apache.zookeeper">KeeperException</a></code> - If the operation could not be completed + due to some error in doing one of the specified ops.</dd> +<dd><code>java.lang.IllegalArgumentException</code> - if an invalid path is specified</dd> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>3.4.0</dd> +</dl> +</li> +</ul> +<a name="multi-java.lang.Iterable-org.apache.zookeeper.AsyncCallback.MultiCallback-java.lang.Object-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>multi</h4> +<pre>public void multi(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)</pre> +<div class="block">The asynchronous version of multi.</div> +<dl> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>3.4.7</dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../org/apache/zookeeper/ZooKeeper.html#multi-java.lang.Iterable-"><code>multi(Iterable)</code></a></dd> +</dl> +</li> +</ul> +<a name="transaction--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>transaction</h4> +<pre>public <a href="../../../org/apache/zookeeper/Transaction.html" title="class in org.apache.zookeeper">Transaction</a> transaction()</pre> +<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> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>a Transaction builder object</dd> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>3.4.0</dd> +</dl> +</li> +</ul> +<a name="delete-java.lang.String-int-org.apache.zookeeper.AsyncCallback.VoidCallback-java.lang.Object-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>delete</h4> +<pre>public void delete(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)</pre> +<div class="block">The asynchronous version of delete.</div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../org/apache/zookeeper/ZooKeeper.html#delete-java.lang.String-int-"><code>delete(String, int)</code></a></dd> +</dl> +</li> +</ul> +<a name="exists-java.lang.String-org.apache.zookeeper.Watcher-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>exists</h4> +<pre>public <a href="../../../org/apache/zookeeper/data/Stat.html" title="class in org.apache.zookeeper.data">Stat</a> exists(java.lang.String path, + <a href="../../../org/apache/zookeeper/Watcher.html" title="interface in org.apache.zookeeper">Watcher</a> watcher) + throws <a href="../../../org/apache/zookeeper/KeeperException.html" title="class in org.apache.zookeeper">KeeperException</a>, + java.lang.InterruptedException</pre> +<div class="block">Return the stat of the node of the given path. Return null if no such a + node exists. + <p> + If the watch is non-null and the call is successful (no exception is thrown), + a watch will be left on the node with the given path. The watch will be + triggered by a successful operation that creates/delete the node or sets + the data on the node.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>path</code> - the node path</dd> +<dd><code>watcher</code> - explicit watcher</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the stat of the node of the given path; return null if no such a + node exists.</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="../../../org/apache/zookeeper/KeeperException.html" title="class in org.apache.zookeeper">KeeperException</a></code> - If the server signals an error</dd> +<dd><code>java.lang.InterruptedException</code> - If the server transaction is interrupted.</dd> +<dd><code>java.lang.IllegalArgumentException</code> - if an invalid path is specified</dd> +</dl> +</li> +</ul> +<a name="exists-java.lang.String-boolean-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>exists</h4> +<pre>public <a href="../../../org/apache/zookeeper/data/Stat.html" title="class in org.apache.zookeeper.data">Stat</a> exists(java.lang.String path, + boolean watch) + throws <a href="../../../org/apache/zookeeper/KeeperException.html" title="class in org.apache.zookeeper">KeeperException</a>, + java.lang.InterruptedException</pre> +<div class="block">Return the stat of the node of the given path. Return null if no such a + node exists. + <p> + If the watch is true and the call is successful (no exception is thrown), + a watch will be left on the node with the given path. The watch will be + triggered by a successful operation that creates/delete the node or sets + the data on the node.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>path</code> - the node path</dd> +<dd><code>watch</code> - whether need to watch this node</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the stat of the node of the given path; return null if no such a + node exists.</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="../../../org/apache/zookeeper/KeeperException.html" title="class in org.apache.zookeeper">KeeperException</a></code> - If the server signals an error</dd> +<dd><code>java.lang.InterruptedException</code> - If the server transaction is interrupted.</dd> +</dl> +</li> +</ul> +<a name="exists-java.lang.String-org.apache.zookeeper.Watcher-org.apache.zookeeper.AsyncCallback.StatCallback-java.lang.Object-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>exists</h4> +<pre>public void exists(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)</pre> +<div class="block">The asynchronous version of exists.</div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../org/apache/zookeeper/ZooKeeper.html#exists-java.lang.String-org.apache.zookeeper.Watcher-"><code>exists(String, Watcher)</code></a></dd> +</dl> +</li> +</ul> +<a name="exists-java.lang.String-boolean-org.apache.zookeeper.AsyncCallback.StatCallback-java.lang.Object-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>exists</h4> +<pre>public void exists(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)</pre> +<div class="block">The asynchronous version of exists.</div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../org/apache/zookeeper/ZooKeeper.html#exists-java.lang.String-boolean-"><code>exists(String, boolean)</code></a></dd> +</dl> +</li> +</ul> +<a name="getData-java.lang.String-org.apache.zookeeper.Watcher-org.apache.zookeeper.data.Stat-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getData</h4> +<pre>public byte[] getData(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) + throws <a href="../../../org/apache/zookeeper/KeeperException.html" title="class in org.apache.zookeeper">KeeperException</a>, + java.lang.InterruptedException</pre> +<div class="block">Return the data and the stat of the node of the given path. + <p> + If the watch is non-null and the call is successful (no exception is + thrown), a watch will be left on the node with the given path. The watch + will be triggered by a successful operation that sets data on the node, or + deletes the node. + <p> + A KeeperException with error code KeeperException.NoNode will be thrown + if no node with the given path exists.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>path</code> - the given path</dd> +<dd><code>watcher</code> - explicit watcher</dd> +<dd><code>stat</code> - the stat of the node</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the data of the node</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="../../../org/apache/zookeeper/KeeperException.html" title="class in org.apache.zookeeper">KeeperException</a></code> - If the server signals an error with a non-zero error code</dd> +<dd><code>java.lang.InterruptedException</code> - If the server transaction is interrupted.</dd> +<dd><code>java.lang.IllegalArgumentException</code> - if an invalid path is specified</dd> +</dl> +</li> +</ul> +<a name="getData-java.lang.String-boolean-org.apache.zookeeper.data.Stat-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getData</h4> +<pre>public byte[] getData(java.lang.String path, + boolean watch, + <a href="../../../org/apache/zookeeper/data/Stat.html" title="class in org.apache.zookeeper.data">Stat</a> stat) + throws <a href="../../../org/apache/zookeeper/KeeperException.html" title="class in org.apache.zookeeper">KeeperException</a>, + java.lang.InterruptedException</pre> +<div class="block">Return the data and the stat of the node of the given path. + <p> + If the watch is true and the call is successful (no exception is + thrown), a watch will be left on the node with the given path. The watch + will be triggered by a successful operation that sets data on the node, or + deletes the node. + <p> + A KeeperException with error code KeeperException.NoNode will be thrown + if no node with the given path exists.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>path</code> - the given path</dd> +<dd><code>watch</code> - whether need to watch this node</dd> +<dd><code>stat</code> - the stat of the node</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the data of the node</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="../../../org/apache/zookeeper/KeeperException.html" title="class in org.apache.zookeeper">KeeperException</a></code> - If the server signals an error with a non-zero error code</dd> +<dd><code>java.lang.InterruptedException</code> - If the server transaction is interrupted.</dd> +</dl> +</li> +</ul> +<a name="getData-java.lang.String-org.apache.zookeeper.Watcher-org.apache.zookeeper.AsyncCallback.DataCallback-java.lang.Object-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getData</h4> +<pre>public void getData(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)</pre> +<div class="block">The asynchronous version of getData.</div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../org/apache/zookeeper/ZooKeeper.html#getData-java.lang.String-org.apache.zookeeper.Watcher-org.apache.zookeeper.data.Stat-"><code>getData(String, Watcher, Stat)</code></a></dd> +</dl> +</li> +</ul> +<a name="getData-java.lang.String-boolean-org.apache.zookeeper.AsyncCallback.DataCallback-java.lang.Object-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getData</h4> +<pre>public void getData(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)</pre> +<div class="block">The asynchronous version of getData.</div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../org/apache/zookeeper/ZooKeeper.html#getData-java.lang.String-boolean-org.apache.zookeeper.data.Stat-"><code>getData(String, boolean, Stat)</code></a></dd> +</dl> +</li> +</ul> +<a name="setData-java.lang.String-byte:A-int-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setData</h4> +<pre>public <a href="../../../org/apache/zookeeper/data/Stat.html" title="class in org.apache.zookeeper.data">Stat</a> setData(java.lang.String path, + byte[] data, + int version) + throws <a href="../../../org/apache/zookeeper/KeeperException.html" title="class in org.apache.zookeeper">KeeperException</a>, + java.lang.InterruptedException</pre> +<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). Return the stat of the node. + <p> + This operation, if successful, will trigger all the watches on the node + of the given path left by getData calls. + <p> + A KeeperException with error code KeeperException.NoNode will be thrown + if no node with the given path exists. + <p> + A KeeperException with error code KeeperException.BadVersion will be + thrown if the given version does not match the node's version. + <p> + The maximum allowable size of the data array is 1 MB (1,048,576 bytes). + Arrays larger than this will cause a KeeperException to be thrown.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>path</code> - the path of the node</dd> +<dd><code>data</code> - the data to set</dd> +<dd><code>version</code> - the expected matching version</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the state of the node</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>java.lang.InterruptedException</code> - If the server transaction is interrupted.</dd> +<dd><code><a href="../../../org/apache/zookeeper/KeeperException.html" title="class in org.apache.zookeeper">KeeperException</a></code> - If the server signals an error with a non-zero error code.</dd> +<dd><code>java.lang.IllegalArgumentException</code> - if an invalid path is specified</dd> +</dl> +</li> +</ul> +<a name="setData-java.lang.String-byte:A-int-org.apache.zookeeper.AsyncCallback.StatCallback-java.lang.Object-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setData</h4> +<pre>public void setData(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)</pre> +<div class="block">The asynchronous version of setData.</div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../org/apache/zookeeper/ZooKeeper.html#setData-java.lang.String-byte:A-int-"><code>setData(String, byte[], int)</code></a></dd> +</dl> +</li> +</ul> +<a name="getACL-java.lang.String-org.apache.zookeeper.data.Stat-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getACL</h4> +<pre>public java.util.List<<a href="../../../org/apache/zookeeper/data/ACL.html" title="class in org.apache.zookeeper.data">ACL</a>> getACL(java.lang.String path, + <a href="../../../org/apache/zookeeper/data/Stat.html" title="class in org.apache.zookeeper.data">Stat</a> stat) + throws <a href="../../../org/apache/zookeeper/KeeperException.html" title="class in org.apache.zookeeper">KeeperException</a>, + java.lang.InterruptedException</pre> +<div class="block">Return the ACL and stat of the node of the given path. + <p> + A KeeperException with error code KeeperException.NoNode will be thrown + if no node with the given path exists.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>path</code> - the given path for the node</dd> +<dd><code>stat</code> - the stat of the node will be copied to this parameter if + not null.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the ACL array of the given node.</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>java.lang.InterruptedException</code> - If the server transaction is interrupted.</dd> +<dd><code><a href="../../../org/apache/zookeeper/KeeperException.html" title="class in org.apache.zookeeper">KeeperException</a></code> - If the server signals an error with a non-zero error code.</dd> +<dd><code>java.lang.IllegalArgumentException</code> - if an invalid path is specified</dd> +</dl> +</li> +</ul> +<a name="getACL-java.lang.String-org.apache.zookeeper.data.Stat-org.apache.zookeeper.AsyncCallback.ACLCallback-java.lang.Object-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getACL</h4> +<pre>public void getACL(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)</pre> +<div class="block">The asynchronous version of getACL.</div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../org/apache/zookeeper/ZooKeeper.html#getACL-java.lang.String-org.apache.zookeeper.data.Stat-"><code>getACL(String, Stat)</code></a></dd> +</dl> +</li> +</ul> +<a name="setACL-java.lang.String-java.util.List-int-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setACL</h4> +<pre>public <a href="../../../org/apache/zookeeper/data/Stat.html" title="class in org.apache.zookeeper.data">Stat</a> setACL(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) + throws <a href="../../../org/apache/zookeeper/KeeperException.html" title="class in org.apache.zookeeper">KeeperException</a>, + java.lang.InterruptedException</pre> +<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. Return the stat of the + node. + <p> + A KeeperException with error code KeeperException.NoNode will be thrown + if no node with the given path exists. + <p> + A KeeperException with error code KeeperException.BadVersion will be + thrown if the given aclVersion does not match the node's aclVersion.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>path</code> - the given path for the node</dd> +<dd><code>acl</code> - the given acl for the node</dd> +<dd><code>aclVersion</code> - the given acl version of the node</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the stat of the node.</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>java.lang.InterruptedException</code> - If the server transaction is interrupted.</dd> +<dd><code><a href="../../../org/apache/zookeeper/KeeperException.html" title="class in org.apache.zookeeper">KeeperException</a></code> - If the server signals an error with a non-zero error code.</dd> +<dd><code><a href="../../../org/apache/zookeeper/KeeperException.InvalidACLException.html" title="class in org.apache.zookeeper">KeeperException.InvalidACLException</a></code> - If the acl is invalide.</dd> +<dd><code>java.lang.IllegalArgumentException</code> - if an invalid path is specified</dd> +</dl> +</li> +</ul> +<a name="setACL-java.lang.String-java.util.List-int-org.apache.zookeeper.AsyncCallback.StatCallback-java.lang.Object-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setACL</h4> +<pre>public void setACL(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)</pre> +<div class="block">The asynchronous version of setACL.</div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../org/apache/zookeeper/ZooKeeper.html#setACL-java.lang.String-java.util.List-int-"><code>setACL(String, List, int)</code></a></dd> +</dl> +</li> +</ul> +<a name="getChildren-java.lang.String-org.apache.zookeeper.Watcher-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getChildren</h4> +<pre>public java.util.List<java.lang.String> getChildren(java.lang.String path, + <a href="../../../org/apache/zookeeper/Watcher.html" title="interface in org.apache.zookeeper">Watcher</a> watcher) + throws <a href="../../../org/apache/zookeeper/KeeperException.html" title="class in org.apache.zookeeper">KeeperException</a>, + java.lang.InterruptedException</pre> +<div class="block">Return the list of the children of the node of the given path. + <p> + If the watch is non-null and the call is successful (no exception is thrown), + a watch will be left on the node with the given path. The watch willbe + triggered by a successful operation that deletes the node of the given + path or creates/delete a child under the node. + <p> + The list of children returned is not sorted and no guarantee is provided + as to its natural or lexical order. + <p> + A KeeperException with error code KeeperException.NoNode will be thrown + if no node with the given path exists.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>path</code> - </dd> +<dd><code>watcher</code> - explicit watcher</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>an unordered array of children of the node with the given path</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>java.lang.InterruptedException</code> - If the server transaction is interrupted.</dd> +<dd><code><a href="../../../org/apache/zookeeper/KeeperException.html" title="class in org.apache.zookeeper">KeeperException</a></code> - If the server signals an error with a non-zero error code.</dd> +<dd><code>java.lang.IllegalArgumentException</code> - if an invalid path is specified</dd> +</dl> +</li> +</ul> +<a name="getChildren-java.lang.String-boolean-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getChildren</h4> +<pre>public java.util.List<java.lang.String> getChildren(java.lang.String path, + boolean watch) + throws <a href="../../../org/apache/zookeeper/KeeperException.html" title="class in org.apache.zookeeper">KeeperException</a>, + java.lang.InterruptedException</pre> +<div class="block">Return the list of the children of the node of the given path. + <p> + If the watch is true and the call is successful (no exception is thrown), + a watch will be left on the node with the given path. The watch willbe + triggered by a successful operation that deletes the node of the given + path or creates/delete a child under the node. + <p> +
<TRUNCATED>