verspaetung/groovydoc/com/github/reiseburo/verspaetung/zk/KafkaSpoutTreeWatcher.html

372 lines
19 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 Nov 07 12:48:42 PST 2015 -->
<title>KafkaSpoutTreeWatcher (verspaetung 0.5.0 API)</title>
<meta name="date" content="2015-11-07">
<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="KafkaSpoutTreeWatcher (verspaetung 0.5.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/reiseburo/verspaetung/zk/KafkaSpoutTreeWatcher" target="_top">Frames</a></li>
<li><a href="KafkaSpoutTreeWatcher.html" target="_top">No Frames</a></li>
</ul>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
Nested&nbsp;&nbsp;&nbsp;Field&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>
Field&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.reiseburo.verspaetung.zk</strong></div>
<h2 title="[Groovy] Class KafkaSpoutTreeWatcher" class="title">[Groovy] Class KafkaSpoutTreeWatcher</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><ul class="inheritance"></ul></li><li><ul class="inheritance"></ul></li><li><ul class="inheritance"></ul></li><li>com.github.reiseburo.verspaetung.zk.KafkaSpoutTreeWatcher
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<p> KafkaSpoutTreeWatcher process Zookeeper paths normally associated with Storm
KafkaSpout based consumers
</p>
</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>
<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/reiseburo/verspaetung/zk/AbstractConsumerTreeWatcher.html'>AbstractConsumerTreeWatcher</a></code></strong></td>
<td class="colLast"><code><a href='../../../../../com/github/reiseburo/verspaetung/zk/AbstractConsumerTreeWatcher.html#consumerOffsets'>consumerOffsets</a>, <a href='../../../../../com/github/reiseburo/verspaetung/zk/AbstractConsumerTreeWatcher.html#onConsumerData'>onConsumerData</a>, <a href='../../../../../com/github/reiseburo/verspaetung/zk/AbstractConsumerTreeWatcher.html#watchedTopics'>watchedTopics</a></code></td>
</tr>
<tr class="altColor">
<td class="colFirst"><strong><code>class <a href='../../../../../com/github/reiseburo/verspaetung/zk/AbstractTreeWatcher.html'>AbstractTreeWatcher</a></code></strong></td>
<td class="colLast"><code><a href='../../../../../com/github/reiseburo/verspaetung/zk/AbstractTreeWatcher.html#cache'>cache</a>, <a href='../../../../../com/github/reiseburo/verspaetung/zk/AbstractTreeWatcher.html#client'>client</a>, <a href='../../../../../com/github/reiseburo/verspaetung/zk/AbstractTreeWatcher.html#logger'>logger</a>, <a href='../../../../../com/github/reiseburo/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="#KafkaSpoutTreeWatcher(org.apache.curator.framework.CuratorFramework, java.util.AbstractSet, java.util.AbstractMap)">KafkaSpoutTreeWatcher</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>java.lang.String</strong></code></td>
<td class="colLast"><code><strong><a href="#consumerNameFromPath(java.lang.String)">consumerNameFromPath</a></strong>(java.lang.String path)</code><br>Extract the given name for a KafkaSpout consumer based on the path in
Zookeeper</td>
</tr>
<tr class="rowColor">
<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>We're expecting things to look like:
/kafka_spout/topologyname/partition_0</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href='../../../../../com/github/reiseburo/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 nodeData)</code><br></td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.String</strong></code></td>
<td class="colLast"><code><strong><a href="#zookeeperPath()">zookeeperPath</a></strong>()</code><br></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/reiseburo/verspaetung/zk/AbstractConsumerTreeWatcher.html'>AbstractConsumerTreeWatcher</a></strong></code></td>
<td class="colLast"><code><a href='../../../../../com/github/reiseburo/verspaetung/zk/AbstractConsumerTreeWatcher.html#childEvent(org.apache.curator.framework.CuratorFramework, org.apache.curator.framework.recipes.cache.TreeCacheEvent)'>childEvent</a>, <a href='../../../../../com/github/reiseburo/verspaetung/zk/AbstractConsumerTreeWatcher.html#isNodeEvent(org.apache.curator.framework.recipes.cache.TreeCacheEvent)'>isNodeEvent</a>, <a href='../../../../../com/github/reiseburo/verspaetung/zk/AbstractConsumerTreeWatcher.html#isOffsetSubtree(java.lang.String)'>isOffsetSubtree</a>, <a href='../../../../../com/github/reiseburo/verspaetung/zk/AbstractConsumerTreeWatcher.html#processChildData(org.apache.curator.framework.recipes.cache.ChildData)'>processChildData</a>, <a href='../../../../../com/github/reiseburo/verspaetung/zk/AbstractConsumerTreeWatcher.html#trackConsumerOffset(com.github.reiseburo.verspaetung.zk.ConsumerOffset)'>trackConsumerOffset</a></code></td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>class <a href='../../../../../com/github/reiseburo/verspaetung/zk/AbstractTreeWatcher.html'>AbstractTreeWatcher</a></strong></code></td>
<td class="colLast"><code><a href='../../../../../com/github/reiseburo/verspaetung/zk/AbstractTreeWatcher.html#childEvent(org.apache.curator.framework.CuratorFramework, org.apache.curator.framework.recipes.cache.TreeCacheEvent)'>childEvent</a>, <a href='../../../../../com/github/reiseburo/verspaetung/zk/AbstractTreeWatcher.html#close()'>close</a>, <a href='../../../../../com/github/reiseburo/verspaetung/zk/AbstractTreeWatcher.html#start()'>start</a>, <a href='../../../../../com/github/reiseburo/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">
<!-- =========== CONSTRUCTOR DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="KafkaSpoutTreeWatcher(org.apache.curator.framework.CuratorFramework, java.util.AbstractSet, java.util.AbstractMap)"><!-- --></a>
<ul class="blockListLast">
<li class="blockList">
<h4><strong>KafkaSpoutTreeWatcher</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="consumerNameFromPath(java.lang.String)"><!-- --></a>
<ul class="blockListLast">
<li class="blockList">
<h4>java.lang.String <strong>consumerNameFromPath</strong>(java.lang.String path)</h4>
<p> Extract the given name for a KafkaSpout consumer based on the path in
Zookeeper
</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> We're expecting things to look like:
/kafka_spout/topologyname/partition_0
</p>
</li>
</ul>
<a name="processChildData(org.apache.curator.framework.recipes.cache.ChildData)"><!-- --></a>
<ul class="blockListLast">
<li class="blockList">
<h4>@groovy.transform.TypeChecked(TypeCheckingMode.SKIP)
@java.lang.SuppressWarnings(['LineLength'])
<a href='../../../../../com/github/reiseburo/verspaetung/zk/ConsumerOffset.html'>ConsumerOffset</a> <strong>processChildData</strong>(org.apache.curator.framework.recipes.cache.ChildData nodeData)</h4>
<p></p>
</li>
</ul>
<a name="zookeeperPath()"><!-- --></a>
<ul class="blockListLast">
<li class="blockList">
<h4>java.lang.String <strong>zookeeperPath</strong>()</h4>
<p></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/reiseburo/verspaetung/zk/KafkaSpoutTreeWatcher" target="_top">Frames</a></li>
<li><a href="KafkaSpoutTreeWatcher.html" target="_top">No Frames</a></li>
</ul>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
Nested&nbsp;&nbsp;&nbsp;Field&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>
Field&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>