blob: d127c423deff5c750412d1b8e7252a61c05df013 [file] [log] [blame]
<!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_221) on Wed Jan 29 15:38:00 PST 2020 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>ZKClientService (Apache Twill 0.14.0 API)</title>
<meta name="date" content="2020-01-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="ZKClientService (Apache Twill 0.14.0 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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/ZKClientService.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/twill/zookeeper/ZKClients.html" title="class in org.apache.twill.zookeeper"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/apache/twill/zookeeper/ZKClientService.Builder.html" title="class in org.apache.twill.zookeeper"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/twill/zookeeper/ZKClientService.html" target="_top">Frames</a></li>
<li><a href="ZKClientService.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</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.twill.zookeeper</div>
<h2 title="Interface ZKClientService" class="title">Interface ZKClientService</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Superinterfaces:</dt>
<dd>com.google.common.util.concurrent.Service, <a href="../../../../org/apache/twill/zookeeper/ZKClient.html" title="interface in org.apache.twill.zookeeper">ZKClient</a></dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../org/apache/twill/zookeeper/ForwardingZKClientService.html" title="class in org.apache.twill.zookeeper">ForwardingZKClientService</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">ZKClientService</span>
extends <a href="../../../../org/apache/twill/zookeeper/ZKClient.html" title="interface in org.apache.twill.zookeeper">ZKClient</a>, com.google.common.util.concurrent.Service</pre>
<div class="block">A <a href="../../../../org/apache/twill/zookeeper/ZKClient.html" title="interface in org.apache.twill.zookeeper"><code>ZKClient</code></a> that extends from <code>Service</code> to provide lifecycle management functions.
The <code>Service.start()</code> method needed to be called before calling any other method on this interface.
When the client is no longer needed, call <code>Service.stop()</code> to release any resources that it holds.</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">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Interface and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/twill/zookeeper/ZKClientService.Builder.html" title="class in org.apache.twill.zookeeper">ZKClientService.Builder</a></span></code>
<div class="block">Builder for creating an implementation of <a href="../../../../org/apache/twill/zookeeper/ZKClientService.html" title="interface in org.apache.twill.zookeeper"><code>ZKClientService</code></a>.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="nested.classes.inherited.from.class.com.google.common.util.concurrent.Service">
<!-- -->
</a>
<h3>Nested classes/interfaces inherited from interface&nbsp;com.google.common.util.concurrent.Service</h3>
<code>com.google.common.util.concurrent.Service.Listener, com.google.common.util.concurrent.Service.State</code></li>
</ul>
</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">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</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>com.google.common.base.Supplier&lt;org.apache.zookeeper.ZooKeeper&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/twill/zookeeper/ZKClientService.html#getZooKeeperSupplier--">getZooKeeperSupplier</a></span>()</code>
<div class="block">Returns a <code>Supplier</code> of <code>ZooKeeper</code> that gives the current <code>ZooKeeper</code> in use at the moment
when <code>Supplier.get()</code> get called.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.twill.zookeeper.ZKClient">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.twill.zookeeper.<a href="../../../../org/apache/twill/zookeeper/ZKClient.html" title="interface in org.apache.twill.zookeeper">ZKClient</a></h3>
<code><a href="../../../../org/apache/twill/zookeeper/ZKClient.html#addConnectionWatcher-org.apache.zookeeper.Watcher-">addConnectionWatcher</a>, <a href="../../../../org/apache/twill/zookeeper/ZKClient.html#create-java.lang.String-byte:A-org.apache.zookeeper.CreateMode-">create</a>, <a href="../../../../org/apache/twill/zookeeper/ZKClient.html#create-java.lang.String-byte:A-org.apache.zookeeper.CreateMode-boolean-">create</a>, <a href="../../../../org/apache/twill/zookeeper/ZKClient.html#create-java.lang.String-byte:A-org.apache.zookeeper.CreateMode-boolean-java.lang.Iterable-">create</a>, <a href="../../../../org/apache/twill/zookeeper/ZKClient.html#create-java.lang.String-byte:A-org.apache.zookeeper.CreateMode-java.lang.Iterable-">create</a>, <a href="../../../../org/apache/twill/zookeeper/ZKClient.html#delete-java.lang.String-">delete</a>, <a href="../../../../org/apache/twill/zookeeper/ZKClient.html#delete-java.lang.String-int-">delete</a>, <a href="../../../../org/apache/twill/zookeeper/ZKClient.html#exists-java.lang.String-">exists</a>, <a href="../../../../org/apache/twill/zookeeper/ZKClient.html#exists-java.lang.String-org.apache.zookeeper.Watcher-">exists</a>, <a href="../../../../org/apache/twill/zookeeper/ZKClient.html#getACL-java.lang.String-">getACL</a>, <a href="../../../../org/apache/twill/zookeeper/ZKClient.html#getChildren-java.lang.String-">getChildren</a>, <a href="../../../../org/apache/twill/zookeeper/ZKClient.html#getChildren-java.lang.String-org.apache.zookeeper.Watcher-">getChildren</a>, <a href="../../../../org/apache/twill/zookeeper/ZKClient.html#getConnectString--">getConnectString</a>, <a href="../../../../org/apache/twill/zookeeper/ZKClient.html#getData-java.lang.String-">getData</a>, <a href="../../../../org/apache/twill/zookeeper/ZKClient.html#getData-java.lang.String-org.apache.zookeeper.Watcher-">getData</a>, <a href="../../../../org/apache/twill/zookeeper/ZKClient.html#getSessionId--">getSessionId</a>, <a href="../../../../org/apache/twill/zookeeper/ZKClient.html#setACL-java.lang.String-java.lang.Iterable-">setACL</a>, <a href="../../../../org/apache/twill/zookeeper/ZKClient.html#setACL-java.lang.String-java.lang.Iterable-int-">setACL</a>, <a href="../../../../org/apache/twill/zookeeper/ZKClient.html#setData-java.lang.String-byte:A-">setData</a>, <a href="../../../../org/apache/twill/zookeeper/ZKClient.html#setData-java.lang.String-byte:A-int-">setData</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.com.google.common.util.concurrent.Service">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;com.google.common.util.concurrent.Service</h3>
<code>addListener, awaitRunning, awaitRunning, awaitTerminated, awaitTerminated, failureCause, isRunning, start, startAndWait, startAsync, state, stop, stopAndWait, stopAsync</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getZooKeeperSupplier--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getZooKeeperSupplier</h4>
<pre>com.google.common.base.Supplier&lt;org.apache.zookeeper.ZooKeeper&gt;&nbsp;getZooKeeperSupplier()</pre>
<div class="block">Returns a <code>Supplier</code> of <code>ZooKeeper</code> that gives the current <code>ZooKeeper</code> in use at the moment
when <code>Supplier.get()</code> get called.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>A <code>Supplier&lt;ZooKeeper&gt;</code></dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.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/ZKClientService.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/twill/zookeeper/ZKClients.html" title="class in org.apache.twill.zookeeper"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/apache/twill/zookeeper/ZKClientService.Builder.html" title="class in org.apache.twill.zookeeper"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/twill/zookeeper/ZKClientService.html" target="_top">Frames</a></li>
<li><a href="ZKClientService.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2013-2020 <a href="http://www.apache.org">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>