verspaetung/groovydoc/com/github/lookout/verspaetung/zk/AbstractConsumerTreeWatcher...

443 lines
23 KiB
HTML

<!--
Copyright 2003-2015 the original author or authors.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- **************************************************************** -->
<!-- * PLEASE KEEP COMPLICATED EXPRESSIONS OUT OF THESE TEMPLATES, * -->
<!-- * i.e. only iterate & print data where possible. Thanks, Jez. * -->
<!-- **************************************************************** -->
<html>
<head>
<!-- Generated by groovydoc (2.4.3) on Sat Jul 04 14:47:56 PDT 2015 -->
<title>AbstractConsumerTreeWatcher (verspaetung 0.3.0 API)</title>
<meta name="date" content="2015-07-04">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link href="../../../../../groovy.ico" type="image/x-icon" rel="shortcut icon">
<link href="../../../../../groovy.ico" type="image/x-icon" rel="icon">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<body class="center">
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="AbstractConsumerTreeWatcher (verspaetung 0.3.0 API)";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><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="../../../../../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">
<div>
<ul class="navList">
<li><a href="../../../../../index.html?com/github/lookout/verspaetung/zk/AbstractConsumerTreeWatcher" target="_top">Frames</a></li>
<li><a href="AbstractConsumerTreeWatcher.html" target="_top">No Frames</a></li>
</ul>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
Nested&nbsp;&nbsp;&nbsp;<li><a href="#field_summary">Field</a></li>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<li><a href="#constructor_summary">Constructor</a></li>&nbsp;&nbsp;&nbsp;<li><a href="#method_summary">Method</a></li>&nbsp;&nbsp;&nbsp;
</ul>
<ul class="subNavList">
<li>&nbsp;|&nbsp;Detail:&nbsp;</li>
<li><a href="#field_detail">Field</a></li>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<li><a href="#constructor_detail">Constructor</a></li>&nbsp;&nbsp;&nbsp;<li><a href="#method_detail">Method</a></li>&nbsp;&nbsp;&nbsp;
</ul>
</div>
<a name="skip-navbar_top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">Package: <strong>com.github.lookout.verspaetung.zk</strong></div>
<h2 title="[Groovy] Class AbstractConsumerTreeWatcher" class="title">[Groovy] Class AbstractConsumerTreeWatcher</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><ul class="inheritance"></ul></li><li><ul class="inheritance"></ul></li><li>com.github.lookout.verspaetung.zk.AbstractConsumerTreeWatcher
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== NESTED CLASS SUMMARY =========== -->
<!-- =========== ENUM CONSTANT SUMMARY =========== -->
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_summary"><!-- --></a>
<h3>Field Summary</h3>
<ul class="blockList">
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum constants summary table">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifiers</th>
<th class="colLast" scope="col">Name</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code><strong>protected&nbsp;java.util.AbstractMap&lt;<a href='../../../../../com/github/lookout/verspaetung/KafkaConsumer.html' title='KafkaConsumer'>KafkaConsumer</a>, java.lang.Integer&gt;</strong></code>&nbsp;</td>
<td class="colLast"><code><a href="#consumerOffsets">consumerOffsets</a></code></td>
<td class="colLast"></code></td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><strong>protected&nbsp;java.util.List&lt;groovy.lang.Closure&gt;</strong></code>&nbsp;</td>
<td class="colLast"><code><a href="#onConsumerData">onConsumerData</a></code></td>
<td class="colLast"></code></td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><strong>protected&nbsp;java.util.AbstractSet&lt;java.lang.String&gt;</strong></code>&nbsp;</td>
<td class="colLast"><code><a href="#watchedTopics">watchedTopics</a></code></td>
<td class="colLast"></code></td>
</tr>
</table>
</ul>
</li>
<li class="blockList"><a name="field_summary"><!-- --></a>
<ul class="blockList">
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Inherited fields summary table">
<caption><span>Inherited fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Fields inherited from class</th>
<th class="colLast" scope="col">Fields</th>
</tr>
<tr class="altColor">
<td class="colFirst"><strong><code>class <a href='../../../../../com/github/lookout/verspaetung/zk/AbstractTreeWatcher.html'>AbstractTreeWatcher</a></code></strong></td>
<td class="colLast"><code><a href='../../../../../com/github/lookout/verspaetung/zk/AbstractTreeWatcher.html#cache'>cache</a>, <a href='../../../../../com/github/lookout/verspaetung/zk/AbstractTreeWatcher.html#client'>client</a>, <a href='../../../../../com/github/lookout/verspaetung/zk/AbstractTreeWatcher.html#logger'>logger</a>, <a href='../../../../../com/github/lookout/verspaetung/zk/AbstractTreeWatcher.html#onInitComplete'>onInitComplete</a></code></td>
</tr>
</table>
</ul>
</li>
</ul>
<!-- =========== PROPERTY SUMMARY =========== -->
<!-- =========== ELEMENT SUMMARY =========== -->
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_summary"><!-- --></a>
<h3>Constructor Summary</h3>
<ul class="blockList">
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructors Summary table">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Constructor and description</th>
</tr>
<tr class="altColor">
<td class="colFirst">
<code><a href="#AbstractConsumerTreeWatcher(org.apache.curator.framework.CuratorFramework, java.util.AbstractSet, java.util.AbstractMap)">AbstractConsumerTreeWatcher</a></strong>
(org.apache.curator.framework.CuratorFramework client, java.util.AbstractSet topics, java.util.AbstractMap offsets)</code><br></td>
</tr>
</table>
</ul>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary"><!-- --></a>
<h3>Methods Summary</h3>
<ul class="blockList">
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Methods Summary table">
<caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Type</th>
<th class="colLast" scope="col">Name and description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</strong></code></td>
<td class="colLast"><code><strong><a href="#childEvent(org.apache.curator.framework.CuratorFramework, org.apache.curator.framework.recipes.cache.TreeCacheEvent)">childEvent</a></strong>(org.apache.curator.framework.CuratorFramework client, org.apache.curator.framework.recipes.cache.TreeCacheEvent event)</code><br>Primary TreeCache event processing callback</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.Boolean</strong></code></td>
<td class="colLast"><code><strong><a href="#isNodeEvent(org.apache.curator.framework.recipes.cache.TreeCacheEvent)">isNodeEvent</a></strong>(org.apache.curator.framework.recipes.cache.TreeCacheEvent event)</code><br>Return true if the TreeCacheEvent received pertains to a node event that
we're interested in</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.Boolean</strong></code></td>
<td class="colLast"><code><strong><a href="#isOffsetSubtree(java.lang.String)">isOffsetSubtree</a></strong>(java.lang.String path)</code><br>Determine whether a given path is of interest, i.e. path which contains
offset data</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href='../../../../../com/github/lookout/verspaetung/zk/ConsumerOffset.html'>ConsumerOffset</a></strong></code></td>
<td class="colLast"><code><strong><a href="#processChildData(org.apache.curator.framework.recipes.cache.ChildData)">processChildData</a></strong>(org.apache.curator.framework.recipes.cache.ChildData data)</code><br>Process the ChildData associated with an event</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</strong></code></td>
<td class="colLast"><code><strong><a href="#trackConsumerOffset(com.github.lookout.verspaetung.zk.ConsumerOffset)">trackConsumerOffset</a></strong>(<a href='../../../../../com/github/lookout/verspaetung/zk/ConsumerOffset.html'>ConsumerOffset</a> offset)</code><br>Keep track of a ConsumerOffset in the consumersMap that was passed into
this class on instantiation</td>
</tr>
</table>
</ul>
</li>
<li class="blockList"><a name="method_summary"><!-- --></a>
<h3>Inherited Methods Summary</h3>
<ul class="blockList">
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Inherited Methods Summary table">
<caption><span>Inherited Methods</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Methods inherited from class</th>
<th class="colLast" scope="col">Name</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>class <a href='../../../../../com/github/lookout/verspaetung/zk/AbstractTreeWatcher.html'>AbstractTreeWatcher</a></strong></code></td>
<td class="colLast"><code><a href='../../../../../com/github/lookout/verspaetung/zk/AbstractTreeWatcher.html#childEvent(org.apache.curator.framework.CuratorFramework, org.apache.curator.framework.recipes.cache.TreeCacheEvent)'>childEvent</a>, <a href='../../../../../com/github/lookout/verspaetung/zk/AbstractTreeWatcher.html#start()'>start</a>, <a href='../../../../../com/github/lookout/verspaetung/zk/AbstractTreeWatcher.html#zookeeperPath()'>zookeeperPath</a></code></td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>class java.lang.Object</strong></code></td>
<td class="colLast"><code>java.lang.Object#wait(long, int), java.lang.Object#wait(long), java.lang.Object#wait(), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll()</code></td>
</tr>
</table>
</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="consumerOffsets"><!-- --></a>
<ul class="blockListLast">
<li class="blockList">
<h4>protected&nbsp;java.util.AbstractMap&lt;<a href='../../../../../com/github/lookout/verspaetung/KafkaConsumer.html' title='KafkaConsumer'>KafkaConsumer</a>, java.lang.Integer&gt; <strong>consumerOffsets</strong></h4>
<p></p>
</li>
</ul>
<a name="onConsumerData"><!-- --></a>
<ul class="blockListLast">
<li class="blockList">
<h4>protected&nbsp;java.util.List&lt;groovy.lang.Closure&gt; <strong>onConsumerData</strong></h4>
<p></p>
</li>
</ul>
<a name="watchedTopics"><!-- --></a>
<ul class="blockListLast">
<li class="blockList">
<h4>protected&nbsp;java.util.AbstractSet&lt;java.lang.String&gt; <strong>watchedTopics</strong></h4>
<p></p>
</li>
</ul>
</li>
</ul>
<!-- =========== CONSTRUCTOR DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="AbstractConsumerTreeWatcher(org.apache.curator.framework.CuratorFramework, java.util.AbstractSet, java.util.AbstractMap)"><!-- --></a>
<ul class="blockListLast">
<li class="blockList">
<h4><strong>AbstractConsumerTreeWatcher</strong>(org.apache.curator.framework.CuratorFramework client, java.util.AbstractSet topics, java.util.AbstractMap offsets)</h4>
<p></p>
</li>
</ul>
</li>
</ul>
<!-- =========== METHOD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="childEvent(org.apache.curator.framework.CuratorFramework, org.apache.curator.framework.recipes.cache.TreeCacheEvent)"><!-- --></a>
<ul class="blockListLast">
<li class="blockList">
<h4>void <strong>childEvent</strong>(org.apache.curator.framework.CuratorFramework client, org.apache.curator.framework.recipes.cache.TreeCacheEvent event)</h4>
<p> Primary TreeCache event processing callback
</p>
</li>
</ul>
<a name="isNodeEvent(org.apache.curator.framework.recipes.cache.TreeCacheEvent)"><!-- --></a>
<ul class="blockListLast">
<li class="blockList">
<h4>java.lang.Boolean <strong>isNodeEvent</strong>(org.apache.curator.framework.recipes.cache.TreeCacheEvent event)</h4>
<p> Return true if the TreeCacheEvent received pertains to a node event that
we're interested in
</p>
</li>
</ul>
<a name="isOffsetSubtree(java.lang.String)"><!-- --></a>
<ul class="blockListLast">
<li class="blockList">
<h4>java.lang.Boolean <strong>isOffsetSubtree</strong>(java.lang.String path)</h4>
<p> Determine whether a given path is of interest, i.e. path which contains
offset data
</p>
</li>
</ul>
<a name="processChildData(org.apache.curator.framework.recipes.cache.ChildData)"><!-- --></a>
<ul class="blockListLast">
<li class="blockList">
<h4><a href='../../../../../com/github/lookout/verspaetung/zk/ConsumerOffset.html'>ConsumerOffset</a> <strong>processChildData</strong>(org.apache.curator.framework.recipes.cache.ChildData data)</h4>
<p> Process the ChildData associated with an event
</p>
</li>
</ul>
<a name="trackConsumerOffset(com.github.lookout.verspaetung.zk.ConsumerOffset)"><!-- --></a>
<ul class="blockListLast">
<li class="blockList">
<h4>void <strong>trackConsumerOffset</strong>(<a href='../../../../../com/github/lookout/verspaetung/zk/ConsumerOffset.html'>ConsumerOffset</a> offset)</h4>
<p> Keep track of a ConsumerOffset in the consumersMap that was passed into
this class on instantiation
</p>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!-- -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><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="../../../../../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">
<div>
<ul class="navList">
<li><a href="../../../../../index.html?com/github/lookout/verspaetung/zk/AbstractConsumerTreeWatcher" target="_top">Frames</a></li>
<li><a href="AbstractConsumerTreeWatcher.html" target="_top">No Frames</a></li>
</ul>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
Nested&nbsp;&nbsp;&nbsp;<li><a href="#field_summary">Field</a></li>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<li><a href="#constructor_summary">Constructor</a></li>&nbsp;&nbsp;&nbsp;<li><a href="#method_summary">Method</a></li>&nbsp;&nbsp;&nbsp;
</ul>
<ul class="subNavList">
<li>&nbsp;|&nbsp;Detail:&nbsp;</li>
<li><a href="#field_detail">Field</a></li>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<li><a href="#constructor_detail">Constructor</a></li>&nbsp;&nbsp;&nbsp;<li><a href="#method_detail">Method</a></li>&nbsp;&nbsp;&nbsp;
</ul>
</div>
<p>Groovy Documentation</p>
<a name="skip-navbar_bottom">
<!-- -->
</a>
</div>
</div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>