You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@samza.apache.org by ya...@apache.org on 2014/12/05 19:52:35 UTC
svn commit: r1643389 [15/27] - in /incubator/samza/site: ./ archive/
community/ contribute/ img/0.8/ img/0.8/learn/ img/0.8/learn/documentation/
img/0.8/learn/documentation/comparisons/
img/0.8/learn/documentation/container/ img/0.8/learn/documentation...
Added: incubator/samza/site/learn/documentation/0.8/api/javadocs/org/apache/samza/system/chooser/BaseMessageChooser.html
URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.8/api/javadocs/org/apache/samza/system/chooser/BaseMessageChooser.html?rev=1643389&view=auto
==============================================================================
--- incubator/samza/site/learn/documentation/0.8/api/javadocs/org/apache/samza/system/chooser/BaseMessageChooser.html (added)
+++ incubator/samza/site/learn/documentation/0.8/api/javadocs/org/apache/samza/system/chooser/BaseMessageChooser.html Fri Dec 5 18:52:32 2014
@@ -0,0 +1,329 @@
+<!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 (version 1.7.0_65) on Fri Dec 05 10:51:42 PST 2014 -->
+<title>BaseMessageChooser (samza-api 0.8.0 API)</title>
+<meta name="date" content="2014-12-05">
+<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
+</head>
+<body>
+<script type="text/javascript"><!--
+ if (location.href.indexOf('is-external=true') == -1) {
+ parent.document.title="BaseMessageChooser (samza-api 0.8.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="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>Prev Class</li>
+<li><a href="../../../../../org/apache/samza/system/chooser/MessageChooser.html" title="interface in org.apache.samza.system.chooser"><span class="strong">Next Class</span></a></li>
+</ul>
+<ul class="navList">
+<li><a href="../../../../../index.html?org/apache/samza/system/chooser/BaseMessageChooser.html" target="_top">Frames</a></li>
+<li><a href="BaseMessageChooser.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>Nested | </li>
+<li>Field | </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>Field | </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.samza.system.chooser</div>
+<h2 title="Class BaseMessageChooser" class="title">Class BaseMessageChooser</h2>
+</div>
+<div class="contentContainer">
+<ul class="inheritance">
+<li>java.lang.Object</li>
+<li>
+<ul class="inheritance">
+<li>org.apache.samza.system.chooser.BaseMessageChooser</li>
+</ul>
+</li>
+</ul>
+<div class="description">
+<ul class="blockList">
+<li class="blockList">
+<dl>
+<dt>All Implemented Interfaces:</dt>
+<dd><a href="../../../../../org/apache/samza/system/chooser/MessageChooser.html" title="interface in org.apache.samza.system.chooser">MessageChooser</a></dd>
+</dl>
+<hr>
+<br>
+<pre>public abstract class <span class="strong">BaseMessageChooser</span>
+extends java.lang.Object
+implements <a href="../../../../../org/apache/samza/system/chooser/MessageChooser.html" title="interface in org.apache.samza.system.chooser">MessageChooser</a></pre>
+<div class="block">An abstract MessageChooser that implements start/stop/register for choosers
+ that don't use them.</div>
+</li>
+</ul>
+</div>
+<div class="summary">
+<ul class="blockList">
+<li class="blockList">
+<!-- ======== CONSTRUCTOR SUMMARY ======== -->
+<ul class="blockList">
+<li class="blockList"><a name="constructor_summary">
+<!-- -->
+</a>
+<h3>Constructor Summary</h3>
+<table class="overviewSummary" 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><strong><a href="../../../../../org/apache/samza/system/chooser/BaseMessageChooser.html#BaseMessageChooser()">BaseMessageChooser</a></strong>()</code> </td>
+</tr>
+</table>
+</li>
+</ul>
+<!-- ========== METHOD SUMMARY =========== -->
+<ul class="blockList">
+<li class="blockList"><a name="method_summary">
+<!-- -->
+</a>
+<h3>Method Summary</h3>
+<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
+<caption><span>Methods</span><span class="tabEnd"> </span></caption>
+<tr>
+<th class="colFirst" scope="col">Modifier and Type</th>
+<th class="colLast" scope="col">Method and Description</th>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><strong><a href="../../../../../org/apache/samza/system/chooser/BaseMessageChooser.html#register(org.apache.samza.system.SystemStreamPartition,%20java.lang.String)">register</a></strong>(<a href="../../../../../org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system">SystemStreamPartition</a> systemStreamPartition,
+ java.lang.String offset)</code>
+<div class="block">Called before start, to let the chooser know that it will be handling
+ envelopes from the given SystemStreamPartition.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><strong><a href="../../../../../org/apache/samza/system/chooser/BaseMessageChooser.html#start()">start</a></strong>()</code>
+<div class="block">Called after all SystemStreamPartitions have been registered.</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><strong><a href="../../../../../org/apache/samza/system/chooser/BaseMessageChooser.html#stop()">stop</a></strong>()</code>
+<div class="block">Called when the chooser is about to be discarded.</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>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
+</ul>
+<ul class="blockList">
+<li class="blockList"><a name="methods_inherited_from_class_org.apache.samza.system.chooser.MessageChooser">
+<!-- -->
+</a>
+<h3>Methods inherited from interface org.apache.samza.system.chooser.<a href="../../../../../org/apache/samza/system/chooser/MessageChooser.html" title="interface in org.apache.samza.system.chooser">MessageChooser</a></h3>
+<code><a href="../../../../../org/apache/samza/system/chooser/MessageChooser.html#choose()">choose</a>, <a href="../../../../../org/apache/samza/system/chooser/MessageChooser.html#update(org.apache.samza.system.IncomingMessageEnvelope)">update</a></code></li>
+</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="BaseMessageChooser()">
+<!-- -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>BaseMessageChooser</h4>
+<pre>public BaseMessageChooser()</pre>
+</li>
+</ul>
+</li>
+</ul>
+<!-- ============ METHOD DETAIL ========== -->
+<ul class="blockList">
+<li class="blockList"><a name="method_detail">
+<!-- -->
+</a>
+<h3>Method Detail</h3>
+<a name="start()">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>start</h4>
+<pre>public void start()</pre>
+<div class="block"><strong>Description copied from interface: <code><a href="../../../../../org/apache/samza/system/chooser/MessageChooser.html#start()">MessageChooser</a></code></strong></div>
+<div class="block">Called after all SystemStreamPartitions have been registered. Start is used
+ to notify the chooser that it will start receiving update and choose calls.</div>
+<dl>
+<dt><strong>Specified by:</strong></dt>
+<dd><code><a href="../../../../../org/apache/samza/system/chooser/MessageChooser.html#start()">start</a></code> in interface <code><a href="../../../../../org/apache/samza/system/chooser/MessageChooser.html" title="interface in org.apache.samza.system.chooser">MessageChooser</a></code></dd>
+</dl>
+</li>
+</ul>
+<a name="stop()">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>stop</h4>
+<pre>public void stop()</pre>
+<div class="block"><strong>Description copied from interface: <code><a href="../../../../../org/apache/samza/system/chooser/MessageChooser.html#stop()">MessageChooser</a></code></strong></div>
+<div class="block">Called when the chooser is about to be discarded. No more messages will be
+ given to the chooser after it is stopped.</div>
+<dl>
+<dt><strong>Specified by:</strong></dt>
+<dd><code><a href="../../../../../org/apache/samza/system/chooser/MessageChooser.html#stop()">stop</a></code> in interface <code><a href="../../../../../org/apache/samza/system/chooser/MessageChooser.html" title="interface in org.apache.samza.system.chooser">MessageChooser</a></code></dd>
+</dl>
+</li>
+</ul>
+<a name="register(org.apache.samza.system.SystemStreamPartition, java.lang.String)">
+<!-- -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>register</h4>
+<pre>public void register(<a href="../../../../../org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system">SystemStreamPartition</a> systemStreamPartition,
+ java.lang.String offset)</pre>
+<div class="block"><strong>Description copied from interface: <code><a href="../../../../../org/apache/samza/system/chooser/MessageChooser.html#register(org.apache.samza.system.SystemStreamPartition,%20java.lang.String)">MessageChooser</a></code></strong></div>
+<div class="block">Called before start, to let the chooser know that it will be handling
+ envelopes from the given SystemStreamPartition. Register will only be
+ called before start.</div>
+<dl>
+<dt><strong>Specified by:</strong></dt>
+<dd><code><a href="../../../../../org/apache/samza/system/chooser/MessageChooser.html#register(org.apache.samza.system.SystemStreamPartition,%20java.lang.String)">register</a></code> in interface <code><a href="../../../../../org/apache/samza/system/chooser/MessageChooser.html" title="interface in org.apache.samza.system.chooser">MessageChooser</a></code></dd>
+<dt><span class="strong">Parameters:</span></dt><dd><code>systemStreamPartition</code> - A SystemStreamPartition that envelopes will be coming from.</dd><dd><code>offset</code> - The offset of the first message expected for the
+ system/stream/partition that's being registered. If "7" were
+ supplied as the offset, then the MessageChooser can expect the
+ first message it is updated with for the system/stream/partition
+ will have an offset of "7".</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><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="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>Prev Class</li>
+<li><a href="../../../../../org/apache/samza/system/chooser/MessageChooser.html" title="interface in org.apache.samza.system.chooser"><span class="strong">Next Class</span></a></li>
+</ul>
+<ul class="navList">
+<li><a href="../../../../../index.html?org/apache/samza/system/chooser/BaseMessageChooser.html" target="_top">Frames</a></li>
+<li><a href="BaseMessageChooser.html" target="_top">No Frames</a></li>
+</ul>
+<ul class="navList" id="allclasses_navbar_bottom">
+<li><a href="../../../../../allclasses-noframe.html">All 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: </li>
+<li>Nested | </li>
+<li>Field | </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>Field | </li>
+<li><a href="#constructor_detail">Constr</a> | </li>
+<li><a href="#method_detail">Method</a></li>
+</ul>
+</div>
+<a name="skip-navbar_bottom">
+<!-- -->
+</a></div>
+<!-- ======== END OF BOTTOM NAVBAR ======= -->
+</body>
+</html>
Added: incubator/samza/site/learn/documentation/0.8/api/javadocs/org/apache/samza/system/chooser/MessageChooser.html
URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.8/api/javadocs/org/apache/samza/system/chooser/MessageChooser.html?rev=1643389&view=auto
==============================================================================
--- incubator/samza/site/learn/documentation/0.8/api/javadocs/org/apache/samza/system/chooser/MessageChooser.html (added)
+++ incubator/samza/site/learn/documentation/0.8/api/javadocs/org/apache/samza/system/chooser/MessageChooser.html Fri Dec 5 18:52:32 2014
@@ -0,0 +1,350 @@
+<!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 (version 1.7.0_65) on Fri Dec 05 10:51:42 PST 2014 -->
+<title>MessageChooser (samza-api 0.8.0 API)</title>
+<meta name="date" content="2014-12-05">
+<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
+</head>
+<body>
+<script type="text/javascript"><!--
+ if (location.href.indexOf('is-external=true') == -1) {
+ parent.document.title="MessageChooser (samza-api 0.8.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="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/samza/system/chooser/BaseMessageChooser.html" title="class in org.apache.samza.system.chooser"><span class="strong">Prev Class</span></a></li>
+<li><a href="../../../../../org/apache/samza/system/chooser/MessageChooserFactory.html" title="interface in org.apache.samza.system.chooser"><span class="strong">Next Class</span></a></li>
+</ul>
+<ul class="navList">
+<li><a href="../../../../../index.html?org/apache/samza/system/chooser/MessageChooser.html" target="_top">Frames</a></li>
+<li><a href="MessageChooser.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>Nested | </li>
+<li>Field | </li>
+<li>Constr | </li>
+<li><a href="#method_summary">Method</a></li>
+</ul>
+<ul class="subNavList">
+<li>Detail: </li>
+<li>Field | </li>
+<li>Constr | </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.samza.system.chooser</div>
+<h2 title="Interface MessageChooser" class="title">Interface MessageChooser</h2>
+</div>
+<div class="contentContainer">
+<div class="description">
+<ul class="blockList">
+<li class="blockList">
+<dl>
+<dt>All Known Implementing Classes:</dt>
+<dd><a href="../../../../../org/apache/samza/system/chooser/BaseMessageChooser.html" title="class in org.apache.samza.system.chooser">BaseMessageChooser</a></dd>
+</dl>
+<hr>
+<br>
+<pre>public interface <span class="strong">MessageChooser</span></pre>
+<div class="block">MessageChooser is an interface for programmatic fine-grain control over
+ stream consumption.
+
+ <p>Consider the case of a Samza task consuming multiple streams, where some
+ streams may be from live systems that have stricter SLA requirements and must
+ always be prioritized over other streams that may be from batch systems.
+ MessageChooser allows developers to inject message prioritization logic into
+ the SamzaContainer.
+
+ <p>In general, the MessageChooser can be used to prioritize certain systems,
+ streams or partitions over others. It can also be used to throttle certain
+ partitions, by choosing not to return messages even though they are
+ available. The MessageChooser can also throttle the entire SamzaContainer by
+ performing a blocking operation, such as Thread.sleep.
+
+ <p>The manner in which MessageChooser is used is:
+
+ <ul>
+ <li>SystemConsumers buffer messages from all SystemStreamPartitions as they
+ become available.</li>
+ <li>If MessageChooser has no messages for a given SystemStreamPartition, and
+ a SystemConsumer has a message in its buffer for the SystemStreamPartition,
+ the MessageChooser will be updated once with the next message in the buffer.</li>
+ <li>When SamzaContainer is ready to process another message, it calls
+ SystemConsumers.choose, which in turn calls <a href="../../../../../org/apache/samza/system/chooser/MessageChooser.html#choose()"><code>choose()</code></a>.</li>
+ </ul>
+
+ <p>Since the MessageChooser only receives one message at a time per
+ <a href="../../../../../org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system"><code>SystemStreamPartition</code></a>, it can be used to order messages between different
+ SystemStreamPartitions, but it can't be used to re-order messages within a
+ single SystemStreamPartition (a buffered sort). This must be done within a
+ StreamTask.
+
+ <p>The contract between the MessageChooser and the SystemConsumers is:
+
+ <ul>
+ <li><a href="../../../../../org/apache/samza/system/chooser/MessageChooser.html#update(org.apache.samza.system.IncomingMessageEnvelope)"><code>update(IncomingMessageEnvelope)</code></a> can be called multiple times
+ before <a href="../../../../../org/apache/samza/system/chooser/MessageChooser.html#choose()"><code>choose()</code></a> is called.</li>
+ <li>If <a href="../../../../../org/apache/samza/system/chooser/MessageChooser.html#choose()"><code>choose()</code></a> returns null, that means no envelopes should be
+ processed at the moment.</li>
+ <li>A MessageChooser may elect to return null when <a href="../../../../../org/apache/samza/system/chooser/MessageChooser.html#choose()"><code>choose()</code></a> is
+ called, even if unprocessed messages have been given by the update method.</li>
+ <li>A MessageChooser will not have any of its in-memory state restored in the
+ event of a failure.</li>
+ <li>Blocking operations (such as Thread.sleep) will block all processing in
+ the entire SamzaContainer.</li>
+ <li>A MessageChooser should never return the same envelope more than once.</li>
+ <li>Non-deterministic (e.g. time-based) MessageChoosers are allowed.</li>
+ <li>A MessageChooser does not need to be thread-safe.</li>
+ </ul></div>
+</li>
+</ul>
+</div>
+<div class="summary">
+<ul class="blockList">
+<li class="blockList">
+<!-- ========== METHOD SUMMARY =========== -->
+<ul class="blockList">
+<li class="blockList"><a name="method_summary">
+<!-- -->
+</a>
+<h3>Method Summary</h3>
+<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
+<caption><span>Methods</span><span class="tabEnd"> </span></caption>
+<tr>
+<th class="colFirst" scope="col">Modifier and Type</th>
+<th class="colLast" scope="col">Method and Description</th>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code><a href="../../../../../org/apache/samza/system/IncomingMessageEnvelope.html" title="class in org.apache.samza.system">IncomingMessageEnvelope</a></code></td>
+<td class="colLast"><code><strong><a href="../../../../../org/apache/samza/system/chooser/MessageChooser.html#choose()">choose</a></strong>()</code>
+<div class="block">The choose method is invoked when the SamzaContainer is ready to process a
+ new message.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><strong><a href="../../../../../org/apache/samza/system/chooser/MessageChooser.html#register(org.apache.samza.system.SystemStreamPartition,%20java.lang.String)">register</a></strong>(<a href="../../../../../org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system">SystemStreamPartition</a> systemStreamPartition,
+ java.lang.String offset)</code>
+<div class="block">Called before start, to let the chooser know that it will be handling
+ envelopes from the given SystemStreamPartition.</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><strong><a href="../../../../../org/apache/samza/system/chooser/MessageChooser.html#start()">start</a></strong>()</code>
+<div class="block">Called after all SystemStreamPartitions have been registered.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><strong><a href="../../../../../org/apache/samza/system/chooser/MessageChooser.html#stop()">stop</a></strong>()</code>
+<div class="block">Called when the chooser is about to be discarded.</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><strong><a href="../../../../../org/apache/samza/system/chooser/MessageChooser.html#update(org.apache.samza.system.IncomingMessageEnvelope)">update</a></strong>(<a href="../../../../../org/apache/samza/system/IncomingMessageEnvelope.html" title="class in org.apache.samza.system">IncomingMessageEnvelope</a> envelope)</code>
+<div class="block">Notify the chooser that a new envelope is available for a processing.</div>
+</td>
+</tr>
+</table>
+</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="start()">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>start</h4>
+<pre>void start()</pre>
+<div class="block">Called after all SystemStreamPartitions have been registered. Start is used
+ to notify the chooser that it will start receiving update and choose calls.</div>
+</li>
+</ul>
+<a name="stop()">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>stop</h4>
+<pre>void stop()</pre>
+<div class="block">Called when the chooser is about to be discarded. No more messages will be
+ given to the chooser after it is stopped.</div>
+</li>
+</ul>
+<a name="register(org.apache.samza.system.SystemStreamPartition, java.lang.String)">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>register</h4>
+<pre>void register(<a href="../../../../../org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system">SystemStreamPartition</a> systemStreamPartition,
+ java.lang.String offset)</pre>
+<div class="block">Called before start, to let the chooser know that it will be handling
+ envelopes from the given SystemStreamPartition. Register will only be
+ called before start.</div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>systemStreamPartition</code> - A SystemStreamPartition that envelopes will be coming from.</dd><dd><code>offset</code> - The offset of the first message expected for the
+ system/stream/partition that's being registered. If "7" were
+ supplied as the offset, then the MessageChooser can expect the
+ first message it is updated with for the system/stream/partition
+ will have an offset of "7".</dd></dl>
+</li>
+</ul>
+<a name="update(org.apache.samza.system.IncomingMessageEnvelope)">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>update</h4>
+<pre>void update(<a href="../../../../../org/apache/samza/system/IncomingMessageEnvelope.html" title="class in org.apache.samza.system">IncomingMessageEnvelope</a> envelope)</pre>
+<div class="block">Notify the chooser that a new envelope is available for a processing. A
+ MessageChooser will receive, at most, one outstanding envelope per
+ system/stream/partition combination. For example, if update is called for
+ partition 7 of kafka.mystream, then update will not be called with an
+ envelope from partition 7 of kafka.mystream until the previous envelope has
+ been returned via the choose method. Update will only be invoked after the
+ chooser has been started.</div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>envelope</code> - An unprocessed envelope.</dd></dl>
+</li>
+</ul>
+<a name="choose()">
+<!-- -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>choose</h4>
+<pre><a href="../../../../../org/apache/samza/system/IncomingMessageEnvelope.html" title="class in org.apache.samza.system">IncomingMessageEnvelope</a> choose()</pre>
+<div class="block">The choose method is invoked when the SamzaContainer is ready to process a
+ new message. The chooser may elect to return any envelope that it's been
+ given via the update method, which hasn't yet been returned. Choose will
+ only be called after the chooser has been started.</div>
+<dl><dt><span class="strong">Returns:</span></dt><dd>The next envelope to process, or null if the chooser has no
+ messages or doesn't want to process any at the moment.</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><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="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/samza/system/chooser/BaseMessageChooser.html" title="class in org.apache.samza.system.chooser"><span class="strong">Prev Class</span></a></li>
+<li><a href="../../../../../org/apache/samza/system/chooser/MessageChooserFactory.html" title="interface in org.apache.samza.system.chooser"><span class="strong">Next Class</span></a></li>
+</ul>
+<ul class="navList">
+<li><a href="../../../../../index.html?org/apache/samza/system/chooser/MessageChooser.html" target="_top">Frames</a></li>
+<li><a href="MessageChooser.html" target="_top">No Frames</a></li>
+</ul>
+<ul class="navList" id="allclasses_navbar_bottom">
+<li><a href="../../../../../allclasses-noframe.html">All 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: </li>
+<li>Nested | </li>
+<li>Field | </li>
+<li>Constr | </li>
+<li><a href="#method_summary">Method</a></li>
+</ul>
+<ul class="subNavList">
+<li>Detail: </li>
+<li>Field | </li>
+<li>Constr | </li>
+<li><a href="#method_detail">Method</a></li>
+</ul>
+</div>
+<a name="skip-navbar_bottom">
+<!-- -->
+</a></div>
+<!-- ======== END OF BOTTOM NAVBAR ======= -->
+</body>
+</html>
Added: incubator/samza/site/learn/documentation/0.8/api/javadocs/org/apache/samza/system/chooser/MessageChooserFactory.html
URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.8/api/javadocs/org/apache/samza/system/chooser/MessageChooserFactory.html?rev=1643389&view=auto
==============================================================================
--- incubator/samza/site/learn/documentation/0.8/api/javadocs/org/apache/samza/system/chooser/MessageChooserFactory.html (added)
+++ incubator/samza/site/learn/documentation/0.8/api/javadocs/org/apache/samza/system/chooser/MessageChooserFactory.html Fri Dec 5 18:52:32 2014
@@ -0,0 +1,207 @@
+<!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 (version 1.7.0_65) on Fri Dec 05 10:51:42 PST 2014 -->
+<title>MessageChooserFactory (samza-api 0.8.0 API)</title>
+<meta name="date" content="2014-12-05">
+<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
+</head>
+<body>
+<script type="text/javascript"><!--
+ if (location.href.indexOf('is-external=true') == -1) {
+ parent.document.title="MessageChooserFactory (samza-api 0.8.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="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/samza/system/chooser/MessageChooser.html" title="interface in org.apache.samza.system.chooser"><span class="strong">Prev Class</span></a></li>
+<li>Next Class</li>
+</ul>
+<ul class="navList">
+<li><a href="../../../../../index.html?org/apache/samza/system/chooser/MessageChooserFactory.html" target="_top">Frames</a></li>
+<li><a href="MessageChooserFactory.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>Nested | </li>
+<li>Field | </li>
+<li>Constr | </li>
+<li><a href="#method_summary">Method</a></li>
+</ul>
+<ul class="subNavList">
+<li>Detail: </li>
+<li>Field | </li>
+<li>Constr | </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.samza.system.chooser</div>
+<h2 title="Interface MessageChooserFactory" class="title">Interface MessageChooserFactory</h2>
+</div>
+<div class="contentContainer">
+<div class="description">
+<ul class="blockList">
+<li class="blockList">
+<hr>
+<br>
+<pre>public interface <span class="strong">MessageChooserFactory</span></pre>
+<div class="block">Build an instance of a <a href="../../../../../org/apache/samza/system/chooser/MessageChooser.html" title="interface in org.apache.samza.system.chooser"><code>MessageChooser</code></a></div>
+</li>
+</ul>
+</div>
+<div class="summary">
+<ul class="blockList">
+<li class="blockList">
+<!-- ========== METHOD SUMMARY =========== -->
+<ul class="blockList">
+<li class="blockList"><a name="method_summary">
+<!-- -->
+</a>
+<h3>Method Summary</h3>
+<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
+<caption><span>Methods</span><span class="tabEnd"> </span></caption>
+<tr>
+<th class="colFirst" scope="col">Modifier and Type</th>
+<th class="colLast" scope="col">Method and Description</th>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code><a href="../../../../../org/apache/samza/system/chooser/MessageChooser.html" title="interface in org.apache.samza.system.chooser">MessageChooser</a></code></td>
+<td class="colLast"><code><strong><a href="../../../../../org/apache/samza/system/chooser/MessageChooserFactory.html#getChooser(org.apache.samza.config.Config,%20org.apache.samza.metrics.MetricsRegistry)">getChooser</a></strong>(<a href="../../../../../org/apache/samza/config/Config.html" title="class in org.apache.samza.config">Config</a> config,
+ <a href="../../../../../org/apache/samza/metrics/MetricsRegistry.html" title="interface in org.apache.samza.metrics">MetricsRegistry</a> registry)</code> </td>
+</tr>
+</table>
+</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="getChooser(org.apache.samza.config.Config, org.apache.samza.metrics.MetricsRegistry)">
+<!-- -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>getChooser</h4>
+<pre><a href="../../../../../org/apache/samza/system/chooser/MessageChooser.html" title="interface in org.apache.samza.system.chooser">MessageChooser</a> getChooser(<a href="../../../../../org/apache/samza/config/Config.html" title="class in org.apache.samza.config">Config</a> config,
+ <a href="../../../../../org/apache/samza/metrics/MetricsRegistry.html" title="interface in org.apache.samza.metrics">MetricsRegistry</a> registry)</pre>
+</li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+</div>
+</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="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/samza/system/chooser/MessageChooser.html" title="interface in org.apache.samza.system.chooser"><span class="strong">Prev Class</span></a></li>
+<li>Next Class</li>
+</ul>
+<ul class="navList">
+<li><a href="../../../../../index.html?org/apache/samza/system/chooser/MessageChooserFactory.html" target="_top">Frames</a></li>
+<li><a href="MessageChooserFactory.html" target="_top">No Frames</a></li>
+</ul>
+<ul class="navList" id="allclasses_navbar_bottom">
+<li><a href="../../../../../allclasses-noframe.html">All 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: </li>
+<li>Nested | </li>
+<li>Field | </li>
+<li>Constr | </li>
+<li><a href="#method_summary">Method</a></li>
+</ul>
+<ul class="subNavList">
+<li>Detail: </li>
+<li>Field | </li>
+<li>Constr | </li>
+<li><a href="#method_detail">Method</a></li>
+</ul>
+</div>
+<a name="skip-navbar_bottom">
+<!-- -->
+</a></div>
+<!-- ======== END OF BOTTOM NAVBAR ======= -->
+</body>
+</html>
Added: incubator/samza/site/learn/documentation/0.8/api/javadocs/org/apache/samza/system/chooser/package-frame.html
URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.8/api/javadocs/org/apache/samza/system/chooser/package-frame.html?rev=1643389&view=auto
==============================================================================
--- incubator/samza/site/learn/documentation/0.8/api/javadocs/org/apache/samza/system/chooser/package-frame.html (added)
+++ incubator/samza/site/learn/documentation/0.8/api/javadocs/org/apache/samza/system/chooser/package-frame.html Fri Dec 5 18:52:32 2014
@@ -0,0 +1,24 @@
+<!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 (version 1.7.0_65) on Fri Dec 05 10:51:42 PST 2014 -->
+<title>org.apache.samza.system.chooser (samza-api 0.8.0 API)</title>
+<meta name="date" content="2014-12-05">
+<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
+</head>
+<body>
+<h1 class="bar"><a href="../../../../../org/apache/samza/system/chooser/package-summary.html" target="classFrame">org.apache.samza.system.chooser</a></h1>
+<div class="indexContainer">
+<h2 title="Interfaces">Interfaces</h2>
+<ul title="Interfaces">
+<li><a href="MessageChooser.html" title="interface in org.apache.samza.system.chooser" target="classFrame"><i>MessageChooser</i></a></li>
+<li><a href="MessageChooserFactory.html" title="interface in org.apache.samza.system.chooser" target="classFrame"><i>MessageChooserFactory</i></a></li>
+</ul>
+<h2 title="Classes">Classes</h2>
+<ul title="Classes">
+<li><a href="BaseMessageChooser.html" title="class in org.apache.samza.system.chooser" target="classFrame">BaseMessageChooser</a></li>
+</ul>
+</div>
+</body>
+</html>
Added: incubator/samza/site/learn/documentation/0.8/api/javadocs/org/apache/samza/system/chooser/package-summary.html
URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.8/api/javadocs/org/apache/samza/system/chooser/package-summary.html?rev=1643389&view=auto
==============================================================================
--- incubator/samza/site/learn/documentation/0.8/api/javadocs/org/apache/samza/system/chooser/package-summary.html (added)
+++ incubator/samza/site/learn/documentation/0.8/api/javadocs/org/apache/samza/system/chooser/package-summary.html Fri Dec 5 18:52:32 2014
@@ -0,0 +1,158 @@
+<!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 (version 1.7.0_65) on Fri Dec 05 10:51:42 PST 2014 -->
+<title>org.apache.samza.system.chooser (samza-api 0.8.0 API)</title>
+<meta name="date" content="2014-12-05">
+<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
+</head>
+<body>
+<script type="text/javascript"><!--
+ if (location.href.indexOf('is-external=true') == -1) {
+ parent.document.title="org.apache.samza.system.chooser (samza-api 0.8.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 class="navBarCell1Rev">Package</li>
+<li>Class</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/samza/system/package-summary.html">Prev Package</a></li>
+<li><a href="../../../../../org/apache/samza/task/package-summary.html">Next Package</a></li>
+</ul>
+<ul class="navList">
+<li><a href="../../../../../index.html?org/apache/samza/system/chooser/package-summary.html" target="_top">Frames</a></li>
+<li><a href="package-summary.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>
+<a name="skip-navbar_top">
+<!-- -->
+</a></div>
+<!-- ========= END OF TOP NAVBAR ========= -->
+<div class="header">
+<h1 title="Package" class="title">Package org.apache.samza.system.chooser</h1>
+</div>
+<div class="contentContainer">
+<ul class="blockList">
+<li class="blockList">
+<table class="packageSummary" border="0" cellpadding="3" cellspacing="0" summary="Interface Summary table, listing interfaces, and an explanation">
+<caption><span>Interface Summary</span><span class="tabEnd"> </span></caption>
+<tr>
+<th class="colFirst" scope="col">Interface</th>
+<th class="colLast" scope="col">Description</th>
+</tr>
+<tbody>
+<tr class="altColor">
+<td class="colFirst"><a href="../../../../../org/apache/samza/system/chooser/MessageChooser.html" title="interface in org.apache.samza.system.chooser">MessageChooser</a></td>
+<td class="colLast">
+<div class="block">MessageChooser is an interface for programmatic fine-grain control over
+ stream consumption.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><a href="../../../../../org/apache/samza/system/chooser/MessageChooserFactory.html" title="interface in org.apache.samza.system.chooser">MessageChooserFactory</a></td>
+<td class="colLast">
+<div class="block">Build an instance of a <a href="../../../../../org/apache/samza/system/chooser/MessageChooser.html" title="interface in org.apache.samza.system.chooser"><code>MessageChooser</code></a></div>
+</td>
+</tr>
+</tbody>
+</table>
+</li>
+<li class="blockList">
+<table class="packageSummary" border="0" cellpadding="3" cellspacing="0" summary="Class Summary table, listing classes, and an explanation">
+<caption><span>Class Summary</span><span class="tabEnd"> </span></caption>
+<tr>
+<th class="colFirst" scope="col">Class</th>
+<th class="colLast" scope="col">Description</th>
+</tr>
+<tbody>
+<tr class="altColor">
+<td class="colFirst"><a href="../../../../../org/apache/samza/system/chooser/BaseMessageChooser.html" title="class in org.apache.samza.system.chooser">BaseMessageChooser</a></td>
+<td class="colLast">
+<div class="block">An abstract MessageChooser that implements start/stop/register for choosers
+ that don't use them.</div>
+</td>
+</tr>
+</tbody>
+</table>
+</li>
+</ul>
+</div>
+<!-- ======= 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 class="navBarCell1Rev">Package</li>
+<li>Class</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/samza/system/package-summary.html">Prev Package</a></li>
+<li><a href="../../../../../org/apache/samza/task/package-summary.html">Next Package</a></li>
+</ul>
+<ul class="navList">
+<li><a href="../../../../../index.html?org/apache/samza/system/chooser/package-summary.html" target="_top">Frames</a></li>
+<li><a href="package-summary.html" target="_top">No Frames</a></li>
+</ul>
+<ul class="navList" id="allclasses_navbar_bottom">
+<li><a href="../../../../../allclasses-noframe.html">All 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>
+<a name="skip-navbar_bottom">
+<!-- -->
+</a></div>
+<!-- ======== END OF BOTTOM NAVBAR ======= -->
+</body>
+</html>
Added: incubator/samza/site/learn/documentation/0.8/api/javadocs/org/apache/samza/system/chooser/package-tree.html
URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.8/api/javadocs/org/apache/samza/system/chooser/package-tree.html?rev=1643389&view=auto
==============================================================================
--- incubator/samza/site/learn/documentation/0.8/api/javadocs/org/apache/samza/system/chooser/package-tree.html (added)
+++ incubator/samza/site/learn/documentation/0.8/api/javadocs/org/apache/samza/system/chooser/package-tree.html Fri Dec 5 18:52:32 2014
@@ -0,0 +1,131 @@
+<!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 (version 1.7.0_65) on Fri Dec 05 10:51:42 PST 2014 -->
+<title>org.apache.samza.system.chooser Class Hierarchy (samza-api 0.8.0 API)</title>
+<meta name="date" content="2014-12-05">
+<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
+</head>
+<body>
+<script type="text/javascript"><!--
+ if (location.href.indexOf('is-external=true') == -1) {
+ parent.document.title="org.apache.samza.system.chooser Class Hierarchy (samza-api 0.8.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</li>
+<li class="navBarCell1Rev">Tree</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/samza/system/package-tree.html">Prev</a></li>
+<li><a href="../../../../../org/apache/samza/task/package-tree.html">Next</a></li>
+</ul>
+<ul class="navList">
+<li><a href="../../../../../index.html?org/apache/samza/system/chooser/package-tree.html" target="_top">Frames</a></li>
+<li><a href="package-tree.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>
+<a name="skip-navbar_top">
+<!-- -->
+</a></div>
+<!-- ========= END OF TOP NAVBAR ========= -->
+<div class="header">
+<h1 class="title">Hierarchy For Package org.apache.samza.system.chooser</h1>
+<span class="strong">Package Hierarchies:</span>
+<ul class="horizontal">
+<li><a href="../../../../../overview-tree.html">All Packages</a></li>
+</ul>
+</div>
+<div class="contentContainer">
+<h2 title="Class Hierarchy">Class Hierarchy</h2>
+<ul>
+<li type="circle">java.lang.Object
+<ul>
+<li type="circle">org.apache.samza.system.chooser.<a href="../../../../../org/apache/samza/system/chooser/BaseMessageChooser.html" title="class in org.apache.samza.system.chooser"><span class="strong">BaseMessageChooser</span></a> (implements org.apache.samza.system.chooser.<a href="../../../../../org/apache/samza/system/chooser/MessageChooser.html" title="interface in org.apache.samza.system.chooser">MessageChooser</a>)</li>
+</ul>
+</li>
+</ul>
+<h2 title="Interface Hierarchy">Interface Hierarchy</h2>
+<ul>
+<li type="circle">org.apache.samza.system.chooser.<a href="../../../../../org/apache/samza/system/chooser/MessageChooser.html" title="interface in org.apache.samza.system.chooser"><span class="strong">MessageChooser</span></a></li>
+<li type="circle">org.apache.samza.system.chooser.<a href="../../../../../org/apache/samza/system/chooser/MessageChooserFactory.html" title="interface in org.apache.samza.system.chooser"><span class="strong">MessageChooserFactory</span></a></li>
+</ul>
+</div>
+<!-- ======= 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</li>
+<li class="navBarCell1Rev">Tree</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/samza/system/package-tree.html">Prev</a></li>
+<li><a href="../../../../../org/apache/samza/task/package-tree.html">Next</a></li>
+</ul>
+<ul class="navList">
+<li><a href="../../../../../index.html?org/apache/samza/system/chooser/package-tree.html" target="_top">Frames</a></li>
+<li><a href="package-tree.html" target="_top">No Frames</a></li>
+</ul>
+<ul class="navList" id="allclasses_navbar_bottom">
+<li><a href="../../../../../allclasses-noframe.html">All 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>
+<a name="skip-navbar_bottom">
+<!-- -->
+</a></div>
+<!-- ======== END OF BOTTOM NAVBAR ======= -->
+</body>
+</html>
Added: incubator/samza/site/learn/documentation/0.8/api/javadocs/org/apache/samza/system/package-frame.html
URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.8/api/javadocs/org/apache/samza/system/package-frame.html?rev=1643389&view=auto
==============================================================================
--- incubator/samza/site/learn/documentation/0.8/api/javadocs/org/apache/samza/system/package-frame.html (added)
+++ incubator/samza/site/learn/documentation/0.8/api/javadocs/org/apache/samza/system/package-frame.html Fri Dec 5 18:52:32 2014
@@ -0,0 +1,36 @@
+<!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 (version 1.7.0_65) on Fri Dec 05 10:51:42 PST 2014 -->
+<title>org.apache.samza.system (samza-api 0.8.0 API)</title>
+<meta name="date" content="2014-12-05">
+<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
+</head>
+<body>
+<h1 class="bar"><a href="../../../../org/apache/samza/system/package-summary.html" target="classFrame">org.apache.samza.system</a></h1>
+<div class="indexContainer">
+<h2 title="Interfaces">Interfaces</h2>
+<ul title="Interfaces">
+<li><a href="SystemAdmin.html" title="interface in org.apache.samza.system" target="classFrame"><i>SystemAdmin</i></a></li>
+<li><a href="SystemConsumer.html" title="interface in org.apache.samza.system" target="classFrame"><i>SystemConsumer</i></a></li>
+<li><a href="SystemFactory.html" title="interface in org.apache.samza.system" target="classFrame"><i>SystemFactory</i></a></li>
+<li><a href="SystemProducer.html" title="interface in org.apache.samza.system" target="classFrame"><i>SystemProducer</i></a></li>
+</ul>
+<h2 title="Classes">Classes</h2>
+<ul title="Classes">
+<li><a href="IncomingMessageEnvelope.html" title="class in org.apache.samza.system" target="classFrame">IncomingMessageEnvelope</a></li>
+<li><a href="OutgoingMessageEnvelope.html" title="class in org.apache.samza.system" target="classFrame">OutgoingMessageEnvelope</a></li>
+<li><a href="SystemStream.html" title="class in org.apache.samza.system" target="classFrame">SystemStream</a></li>
+<li><a href="SystemStreamMetadata.html" title="class in org.apache.samza.system" target="classFrame">SystemStreamMetadata</a></li>
+<li><a href="SystemStreamMetadata.SystemStreamPartitionMetadata.html" title="class in org.apache.samza.system" target="classFrame">SystemStreamMetadata.SystemStreamPartitionMetadata</a></li>
+<li><a href="SystemStreamPartition.html" title="class in org.apache.samza.system" target="classFrame">SystemStreamPartition</a></li>
+<li><a href="SystemStreamPartitionIterator.html" title="class in org.apache.samza.system" target="classFrame">SystemStreamPartitionIterator</a></li>
+</ul>
+<h2 title="Enums">Enums</h2>
+<ul title="Enums">
+<li><a href="SystemStreamMetadata.OffsetType.html" title="enum in org.apache.samza.system" target="classFrame">SystemStreamMetadata.OffsetType</a></li>
+</ul>
+</div>
+</body>
+</html>
Added: incubator/samza/site/learn/documentation/0.8/api/javadocs/org/apache/samza/system/package-summary.html
URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.8/api/javadocs/org/apache/samza/system/package-summary.html?rev=1643389&view=auto
==============================================================================
--- incubator/samza/site/learn/documentation/0.8/api/javadocs/org/apache/samza/system/package-summary.html (added)
+++ incubator/samza/site/learn/documentation/0.8/api/javadocs/org/apache/samza/system/package-summary.html Fri Dec 5 18:52:32 2014
@@ -0,0 +1,233 @@
+<!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 (version 1.7.0_65) on Fri Dec 05 10:51:42 PST 2014 -->
+<title>org.apache.samza.system (samza-api 0.8.0 API)</title>
+<meta name="date" content="2014-12-05">
+<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
+</head>
+<body>
+<script type="text/javascript"><!--
+ if (location.href.indexOf('is-external=true') == -1) {
+ parent.document.title="org.apache.samza.system (samza-api 0.8.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 class="navBarCell1Rev">Package</li>
+<li>Class</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/samza/storage/package-summary.html">Prev Package</a></li>
+<li><a href="../../../../org/apache/samza/system/chooser/package-summary.html">Next Package</a></li>
+</ul>
+<ul class="navList">
+<li><a href="../../../../index.html?org/apache/samza/system/package-summary.html" target="_top">Frames</a></li>
+<li><a href="package-summary.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>
+<a name="skip-navbar_top">
+<!-- -->
+</a></div>
+<!-- ========= END OF TOP NAVBAR ========= -->
+<div class="header">
+<h1 title="Package" class="title">Package org.apache.samza.system</h1>
+</div>
+<div class="contentContainer">
+<ul class="blockList">
+<li class="blockList">
+<table class="packageSummary" border="0" cellpadding="3" cellspacing="0" summary="Interface Summary table, listing interfaces, and an explanation">
+<caption><span>Interface Summary</span><span class="tabEnd"> </span></caption>
+<tr>
+<th class="colFirst" scope="col">Interface</th>
+<th class="colLast" scope="col">Description</th>
+</tr>
+<tbody>
+<tr class="altColor">
+<td class="colFirst"><a href="../../../../org/apache/samza/system/SystemAdmin.html" title="interface in org.apache.samza.system">SystemAdmin</a></td>
+<td class="colLast">
+<div class="block">Helper interface attached to an underlying system to fetch
+ information about streams, partitions, offsets, etc.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><a href="../../../../org/apache/samza/system/SystemConsumer.html" title="interface in org.apache.samza.system">SystemConsumer</a></td>
+<td class="colLast">
+<div class="block">
+ SystemConsumer is the interface that must be implemented by any system that
+ wishes to integrate with Samza.</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><a href="../../../../org/apache/samza/system/SystemFactory.html" title="interface in org.apache.samza.system">SystemFactory</a></td>
+<td class="colLast">
+<div class="block">Build the <a href="../../../../org/apache/samza/system/SystemConsumer.html" title="interface in org.apache.samza.system"><code>SystemConsumer</code></a> and <a href="../../../../org/apache/samza/system/SystemProducer.html" title="interface in org.apache.samza.system"><code>SystemProducer</code></a> for
+ a particular system, as well as the accompanying <a href="../../../../org/apache/samza/system/SystemAdmin.html" title="interface in org.apache.samza.system"><code>SystemAdmin</code></a>.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><a href="../../../../org/apache/samza/system/SystemProducer.html" title="interface in org.apache.samza.system">SystemProducer</a></td>
+<td class="colLast">
+<div class="block">SystemProducers are how Samza writes messages from <a href="../../../../org/apache/samza/task/StreamTask.html" title="interface in org.apache.samza.task"><code>StreamTask</code></a>s to outside systems,
+ such as messaging systems like Kafka, or file systems.</div>
+</td>
+</tr>
+</tbody>
+</table>
+</li>
+<li class="blockList">
+<table class="packageSummary" border="0" cellpadding="3" cellspacing="0" summary="Class Summary table, listing classes, and an explanation">
+<caption><span>Class Summary</span><span class="tabEnd"> </span></caption>
+<tr>
+<th class="colFirst" scope="col">Class</th>
+<th class="colLast" scope="col">Description</th>
+</tr>
+<tbody>
+<tr class="altColor">
+<td class="colFirst"><a href="../../../../org/apache/samza/system/IncomingMessageEnvelope.html" title="class in org.apache.samza.system">IncomingMessageEnvelope</a></td>
+<td class="colLast">
+<div class="block">This class represents a message envelope that is received by a StreamTask for each message that is received from a
+ partition of a specific input stream.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><a href="../../../../org/apache/samza/system/OutgoingMessageEnvelope.html" title="class in org.apache.samza.system">OutgoingMessageEnvelope</a></td>
+<td class="colLast">
+<div class="block">An OutgoingMessageEnvelope is sent to a specified <a href="../../../../org/apache/samza/system/SystemStream.html" title="class in org.apache.samza.system"><code>SystemStream</code></a> via the appropriate <a href="../../../../org/apache/samza/system/SystemProducer.html" title="interface in org.apache.samza.system"><code>SystemProducer</code></a>
+ from the user's <a href="../../../../org/apache/samza/task/StreamTask.html" title="interface in org.apache.samza.task"><code>StreamTask</code></a>.</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><a href="../../../../org/apache/samza/system/SystemStream.html" title="class in org.apache.samza.system">SystemStream</a></td>
+<td class="colLast">
+<div class="block">Streams in Samza consist of both the stream name and the system to which the stream belongs.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><a href="../../../../org/apache/samza/system/SystemStreamMetadata.html" title="class in org.apache.samza.system">SystemStreamMetadata</a></td>
+<td class="colLast">
+<div class="block">SystemAdmins use this class to return useful metadata about a stream's offset
+ and partition information.</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><a href="../../../../org/apache/samza/system/SystemStreamMetadata.SystemStreamPartitionMetadata.html" title="class in org.apache.samza.system">SystemStreamMetadata.SystemStreamPartitionMetadata</a></td>
+<td class="colLast">
+<div class="block">Provides offset information for a given SystemStreamPartition.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><a href="../../../../org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system">SystemStreamPartition</a></td>
+<td class="colLast">
+<div class="block">Aggregate object representing a both the <a href="../../../../org/apache/samza/system/SystemStream.html" title="class in org.apache.samza.system"><code>SystemStream</code></a> and <a href="../../../../org/apache/samza/Partition.html" title="class in org.apache.samza"><code>Partition</code></a>.</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><a href="../../../../org/apache/samza/system/SystemStreamPartitionIterator.html" title="class in org.apache.samza.system">SystemStreamPartitionIterator</a></td>
+<td class="colLast">
+<div class="block"><code>Iterator</code> that wraps a
+ <a href="../../../../org/apache/samza/system/SystemConsumer.html" title="interface in org.apache.samza.system"><code>SystemConsumer</code></a> to iterate over the messages
+ the consumer provides for the specified
+ <a href="../../../../org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system"><code>SystemStreamPartition</code></a>.</div>
+</td>
+</tr>
+</tbody>
+</table>
+</li>
+<li class="blockList">
+<table class="packageSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Summary table, listing enums, and an explanation">
+<caption><span>Enum Summary</span><span class="tabEnd"> </span></caption>
+<tr>
+<th class="colFirst" scope="col">Enum</th>
+<th class="colLast" scope="col">Description</th>
+</tr>
+<tbody>
+<tr class="altColor">
+<td class="colFirst"><a href="../../../../org/apache/samza/system/SystemStreamMetadata.OffsetType.html" title="enum in org.apache.samza.system">SystemStreamMetadata.OffsetType</a></td>
+<td class="colLast">
+<div class="block">OffsetType is an enum used to define which offset should be used when
+ reading from a SystemStreamPartition for the first time.</div>
+</td>
+</tr>
+</tbody>
+</table>
+</li>
+</ul>
+</div>
+<!-- ======= 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 class="navBarCell1Rev">Package</li>
+<li>Class</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/samza/storage/package-summary.html">Prev Package</a></li>
+<li><a href="../../../../org/apache/samza/system/chooser/package-summary.html">Next Package</a></li>
+</ul>
+<ul class="navList">
+<li><a href="../../../../index.html?org/apache/samza/system/package-summary.html" target="_top">Frames</a></li>
+<li><a href="package-summary.html" target="_top">No Frames</a></li>
+</ul>
+<ul class="navList" id="allclasses_navbar_bottom">
+<li><a href="../../../../allclasses-noframe.html">All 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>
+<a name="skip-navbar_bottom">
+<!-- -->
+</a></div>
+<!-- ======== END OF BOTTOM NAVBAR ======= -->
+</body>
+</html>
Added: incubator/samza/site/learn/documentation/0.8/api/javadocs/org/apache/samza/system/package-tree.html
URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.8/api/javadocs/org/apache/samza/system/package-tree.html?rev=1643389&view=auto
==============================================================================
--- incubator/samza/site/learn/documentation/0.8/api/javadocs/org/apache/samza/system/package-tree.html (added)
+++ incubator/samza/site/learn/documentation/0.8/api/javadocs/org/apache/samza/system/package-tree.html Fri Dec 5 18:52:32 2014
@@ -0,0 +1,154 @@
+<!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 (version 1.7.0_65) on Fri Dec 05 10:51:42 PST 2014 -->
+<title>org.apache.samza.system Class Hierarchy (samza-api 0.8.0 API)</title>
+<meta name="date" content="2014-12-05">
+<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
+</head>
+<body>
+<script type="text/javascript"><!--
+ if (location.href.indexOf('is-external=true') == -1) {
+ parent.document.title="org.apache.samza.system Class Hierarchy (samza-api 0.8.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</li>
+<li class="navBarCell1Rev">Tree</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/samza/storage/package-tree.html">Prev</a></li>
+<li><a href="../../../../org/apache/samza/system/chooser/package-tree.html">Next</a></li>
+</ul>
+<ul class="navList">
+<li><a href="../../../../index.html?org/apache/samza/system/package-tree.html" target="_top">Frames</a></li>
+<li><a href="package-tree.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>
+<a name="skip-navbar_top">
+<!-- -->
+</a></div>
+<!-- ========= END OF TOP NAVBAR ========= -->
+<div class="header">
+<h1 class="title">Hierarchy For Package org.apache.samza.system</h1>
+<span class="strong">Package Hierarchies:</span>
+<ul class="horizontal">
+<li><a href="../../../../overview-tree.html">All Packages</a></li>
+</ul>
+</div>
+<div class="contentContainer">
+<h2 title="Class Hierarchy">Class Hierarchy</h2>
+<ul>
+<li type="circle">java.lang.Object
+<ul>
+<li type="circle">org.apache.samza.system.<a href="../../../../org/apache/samza/system/IncomingMessageEnvelope.html" title="class in org.apache.samza.system"><span class="strong">IncomingMessageEnvelope</span></a></li>
+<li type="circle">org.apache.samza.system.<a href="../../../../org/apache/samza/system/OutgoingMessageEnvelope.html" title="class in org.apache.samza.system"><span class="strong">OutgoingMessageEnvelope</span></a></li>
+<li type="circle">org.apache.samza.system.<a href="../../../../org/apache/samza/system/SystemStream.html" title="class in org.apache.samza.system"><span class="strong">SystemStream</span></a>
+<ul>
+<li type="circle">org.apache.samza.system.<a href="../../../../org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system"><span class="strong">SystemStreamPartition</span></a> (implements java.lang.Comparable<T>)</li>
+</ul>
+</li>
+<li type="circle">org.apache.samza.system.<a href="../../../../org/apache/samza/system/SystemStreamMetadata.html" title="class in org.apache.samza.system"><span class="strong">SystemStreamMetadata</span></a></li>
+<li type="circle">org.apache.samza.system.<a href="../../../../org/apache/samza/system/SystemStreamMetadata.SystemStreamPartitionMetadata.html" title="class in org.apache.samza.system"><span class="strong">SystemStreamMetadata.SystemStreamPartitionMetadata</span></a></li>
+<li type="circle">org.apache.samza.system.<a href="../../../../org/apache/samza/system/SystemStreamPartitionIterator.html" title="class in org.apache.samza.system"><span class="strong">SystemStreamPartitionIterator</span></a> (implements java.util.Iterator<E>)</li>
+</ul>
+</li>
+</ul>
+<h2 title="Interface Hierarchy">Interface Hierarchy</h2>
+<ul>
+<li type="circle">org.apache.samza.system.<a href="../../../../org/apache/samza/system/SystemAdmin.html" title="interface in org.apache.samza.system"><span class="strong">SystemAdmin</span></a></li>
+<li type="circle">org.apache.samza.system.<a href="../../../../org/apache/samza/system/SystemConsumer.html" title="interface in org.apache.samza.system"><span class="strong">SystemConsumer</span></a></li>
+<li type="circle">org.apache.samza.system.<a href="../../../../org/apache/samza/system/SystemFactory.html" title="interface in org.apache.samza.system"><span class="strong">SystemFactory</span></a></li>
+<li type="circle">org.apache.samza.system.<a href="../../../../org/apache/samza/system/SystemProducer.html" title="interface in org.apache.samza.system"><span class="strong">SystemProducer</span></a></li>
+</ul>
+<h2 title="Enum Hierarchy">Enum Hierarchy</h2>
+<ul>
+<li type="circle">java.lang.Object
+<ul>
+<li type="circle">java.lang.Enum<E> (implements java.lang.Comparable<T>, java.io.Serializable)
+<ul>
+<li type="circle">org.apache.samza.system.<a href="../../../../org/apache/samza/system/SystemStreamMetadata.OffsetType.html" title="enum in org.apache.samza.system"><span class="strong">SystemStreamMetadata.OffsetType</span></a></li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+</div>
+<!-- ======= 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</li>
+<li class="navBarCell1Rev">Tree</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/samza/storage/package-tree.html">Prev</a></li>
+<li><a href="../../../../org/apache/samza/system/chooser/package-tree.html">Next</a></li>
+</ul>
+<ul class="navList">
+<li><a href="../../../../index.html?org/apache/samza/system/package-tree.html" target="_top">Frames</a></li>
+<li><a href="package-tree.html" target="_top">No Frames</a></li>
+</ul>
+<ul class="navList" id="allclasses_navbar_bottom">
+<li><a href="../../../../allclasses-noframe.html">All 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>
+<a name="skip-navbar_bottom">
+<!-- -->
+</a></div>
+<!-- ======== END OF BOTTOM NAVBAR ======= -->
+</body>
+</html>
Added: incubator/samza/site/learn/documentation/0.8/api/javadocs/org/apache/samza/task/ClosableTask.html
URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.8/api/javadocs/org/apache/samza/task/ClosableTask.html?rev=1643389&view=auto
==============================================================================
--- incubator/samza/site/learn/documentation/0.8/api/javadocs/org/apache/samza/task/ClosableTask.html (added)
+++ incubator/samza/site/learn/documentation/0.8/api/javadocs/org/apache/samza/task/ClosableTask.html Fri Dec 5 18:52:32 2014
@@ -0,0 +1,211 @@
+<!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 (version 1.7.0_65) on Fri Dec 05 10:51:42 PST 2014 -->
+<title>ClosableTask (samza-api 0.8.0 API)</title>
+<meta name="date" content="2014-12-05">
+<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
+</head>
+<body>
+<script type="text/javascript"><!--
+ if (location.href.indexOf('is-external=true') == -1) {
+ parent.document.title="ClosableTask (samza-api 0.8.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="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>Prev Class</li>
+<li><a href="../../../../org/apache/samza/task/InitableTask.html" title="interface in org.apache.samza.task"><span class="strong">Next Class</span></a></li>
+</ul>
+<ul class="navList">
+<li><a href="../../../../index.html?org/apache/samza/task/ClosableTask.html" target="_top">Frames</a></li>
+<li><a href="ClosableTask.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>Nested | </li>
+<li>Field | </li>
+<li>Constr | </li>
+<li><a href="#method_summary">Method</a></li>
+</ul>
+<ul class="subNavList">
+<li>Detail: </li>
+<li>Field | </li>
+<li>Constr | </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.samza.task</div>
+<h2 title="Interface ClosableTask" class="title">Interface ClosableTask</h2>
+</div>
+<div class="contentContainer">
+<div class="description">
+<ul class="blockList">
+<li class="blockList">
+<hr>
+<br>
+<pre>public interface <span class="strong">ClosableTask</span></pre>
+<div class="block">A ClosableTask augments <a href="../../../../org/apache/samza/task/StreamTask.html" title="interface in org.apache.samza.task"><code>StreamTask</code></a>, allowing the method implementer to specify
+ code that will be called when the StreamTask is being shut down by the framework, providing to emit final metrics,
+ clean or close resources, etc. The close method is not guaranteed to be called in event of crash or hard kill
+ of the process.</div>
+</li>
+</ul>
+</div>
+<div class="summary">
+<ul class="blockList">
+<li class="blockList">
+<!-- ========== METHOD SUMMARY =========== -->
+<ul class="blockList">
+<li class="blockList"><a name="method_summary">
+<!-- -->
+</a>
+<h3>Method Summary</h3>
+<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
+<caption><span>Methods</span><span class="tabEnd"> </span></caption>
+<tr>
+<th class="colFirst" scope="col">Modifier and Type</th>
+<th class="colLast" scope="col">Method and Description</th>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><strong><a href="../../../../org/apache/samza/task/ClosableTask.html#close()">close</a></strong>()</code> </td>
+</tr>
+</table>
+</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="close()">
+<!-- -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>close</h4>
+<pre>void close()
+ throws java.lang.Exception</pre>
+<dl><dt><span class="strong">Throws:</span></dt>
+<dd><code>java.lang.Exception</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><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="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>Prev Class</li>
+<li><a href="../../../../org/apache/samza/task/InitableTask.html" title="interface in org.apache.samza.task"><span class="strong">Next Class</span></a></li>
+</ul>
+<ul class="navList">
+<li><a href="../../../../index.html?org/apache/samza/task/ClosableTask.html" target="_top">Frames</a></li>
+<li><a href="ClosableTask.html" target="_top">No Frames</a></li>
+</ul>
+<ul class="navList" id="allclasses_navbar_bottom">
+<li><a href="../../../../allclasses-noframe.html">All 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: </li>
+<li>Nested | </li>
+<li>Field | </li>
+<li>Constr | </li>
+<li><a href="#method_summary">Method</a></li>
+</ul>
+<ul class="subNavList">
+<li>Detail: </li>
+<li>Field | </li>
+<li>Constr | </li>
+<li><a href="#method_detail">Method</a></li>
+</ul>
+</div>
+<a name="skip-navbar_bottom">
+<!-- -->
+</a></div>
+<!-- ======== END OF BOTTOM NAVBAR ======= -->
+</body>
+</html>