You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@samza.apache.org by cr...@apache.org on 2014/07/09 18:34:26 UTC
svn commit: r1609230 [5/9] - in /incubator/samza/site: ./ community/
contribute/ css/ learn/documentation/0.7.0/ learn/documentation/0.7.0/api/
learn/documentation/0.7.0/api/javadocs/
learn/documentation/0.7.0/api/javadocs/org/apache/samza/ learn/docum...
Modified: incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/OutgoingMessageEnvelope.html
URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/OutgoingMessageEnvelope.html?rev=1609230&r1=1609229&r2=1609230&view=diff
==============================================================================
--- incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/OutgoingMessageEnvelope.html (original)
+++ incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/OutgoingMessageEnvelope.html Wed Jul 9 16:34:23 2014
@@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
-<!-- Generated by javadoc (version 1.7.0_51) on Wed Jun 18 18:05:17 PDT 2014 -->
+<!-- Generated by javadoc (version 1.7.0_60) on Wed Jul 09 09:32:50 PDT 2014 -->
<title>OutgoingMessageEnvelope (samza-api 0.7.0 API)</title>
-<meta name="date" content="2014-06-18">
+<meta name="date" content="2014-07-09">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
</head>
<body>
@@ -97,9 +97,8 @@
<br>
<pre>public class <span class="strong">OutgoingMessageEnvelope</span>
extends java.lang.Object</pre>
-<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>. StreamTasks consume from their input streams via their
- process method and write to their output streams by sending OutgoingMessageEnvelopes via the provided <a href="../../../../org/apache/samza/task/MessageCollector.html" title="interface in org.apache.samza.task"><code>MessageCollector</code></a></div>
+<div class="block">This class represents a message envelope that is sent by a StreamTask. It can be thought of as a complement to the
+ IncomingMessageEnvelope class.</div>
</li>
</ul>
</div>
@@ -118,20 +117,20 @@ extends java.lang.Object</pre>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
-<td class="colOne"><code><strong><a href="../../../../org/apache/samza/system/OutgoingMessageEnvelope.html#OutgoingMessageEnvelope(org.apache.samza.system.SystemStream, java.lang.Object)">OutgoingMessageEnvelope</a></strong>(<a href="../../../../org/apache/samza/system/SystemStream.html" title="class in org.apache.samza.system">SystemStream</a> systemStream,
+<td class="colOne"><code><strong><a href="../../../../org/apache/samza/system/OutgoingMessageEnvelope.html#OutgoingMessageEnvelope(org.apache.samza.system.SystemStream,%20java.lang.Object)">OutgoingMessageEnvelope</a></strong>(<a href="../../../../org/apache/samza/system/SystemStream.html" title="class in org.apache.samza.system">SystemStream</a> systemStream,
java.lang.Object message)</code>
<div class="block">Constructs a new OutgoingMessageEnvelope from specified components.</div>
</td>
</tr>
<tr class="rowColor">
-<td class="colOne"><code><strong><a href="../../../../org/apache/samza/system/OutgoingMessageEnvelope.html#OutgoingMessageEnvelope(org.apache.samza.system.SystemStream, java.lang.Object, java.lang.Object)">OutgoingMessageEnvelope</a></strong>(<a href="../../../../org/apache/samza/system/SystemStream.html" title="class in org.apache.samza.system">SystemStream</a> systemStream,
+<td class="colOne"><code><strong><a href="../../../../org/apache/samza/system/OutgoingMessageEnvelope.html#OutgoingMessageEnvelope(org.apache.samza.system.SystemStream,%20java.lang.Object,%20java.lang.Object)">OutgoingMessageEnvelope</a></strong>(<a href="../../../../org/apache/samza/system/SystemStream.html" title="class in org.apache.samza.system">SystemStream</a> systemStream,
java.lang.Object key,
java.lang.Object message)</code>
<div class="block">Constructs a new OutgoingMessageEnvelope from specified components.</div>
</td>
</tr>
<tr class="altColor">
-<td class="colOne"><code><strong><a href="../../../../org/apache/samza/system/OutgoingMessageEnvelope.html#OutgoingMessageEnvelope(org.apache.samza.system.SystemStream, java.lang.Object, java.lang.Object, java.lang.Object)">OutgoingMessageEnvelope</a></strong>(<a href="../../../../org/apache/samza/system/SystemStream.html" title="class in org.apache.samza.system">SystemStream</a> systemStream,
+<td class="colOne"><code><strong><a href="../../../../org/apache/samza/system/OutgoingMessageEnvelope.html#OutgoingMessageEnvelope(org.apache.samza.system.SystemStream,%20java.lang.Object,%20java.lang.Object,%20java.lang.Object)">OutgoingMessageEnvelope</a></strong>(<a href="../../../../org/apache/samza/system/SystemStream.html" title="class in org.apache.samza.system">SystemStream</a> systemStream,
java.lang.Object partitionKey,
java.lang.Object key,
java.lang.Object message)</code>
@@ -139,7 +138,7 @@ extends java.lang.Object</pre>
</td>
</tr>
<tr class="rowColor">
-<td class="colOne"><code><strong><a href="../../../../org/apache/samza/system/OutgoingMessageEnvelope.html#OutgoingMessageEnvelope(org.apache.samza.system.SystemStream, java.lang.String, java.lang.String, java.lang.Object, java.lang.Object, java.lang.Object)">OutgoingMessageEnvelope</a></strong>(<a href="../../../../org/apache/samza/system/SystemStream.html" title="class in org.apache.samza.system">SystemStream</a> systemStream,
+<td class="colOne"><code><strong><a href="../../../../org/apache/samza/system/OutgoingMessageEnvelope.html#OutgoingMessageEnvelope(org.apache.samza.system.SystemStream,%20java.lang.String,%20java.lang.String,%20java.lang.Object,%20java.lang.Object,%20java.lang.Object)">OutgoingMessageEnvelope</a></strong>(<a href="../../../../org/apache/samza/system/SystemStream.html" title="class in org.apache.samza.system">SystemStream</a> systemStream,
java.lang.String keySerializerName,
java.lang.String messageSerializerName,
java.lang.Object partitionKey,
Modified: incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/SystemAdmin.html
URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/SystemAdmin.html?rev=1609230&r1=1609229&r2=1609230&view=diff
==============================================================================
--- incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/SystemAdmin.html (original)
+++ incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/SystemAdmin.html Wed Jul 9 16:34:23 2014
@@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
-<!-- Generated by javadoc (version 1.7.0_51) on Wed Jun 18 18:05:17 PDT 2014 -->
+<!-- Generated by javadoc (version 1.7.0_60) on Wed Jul 09 09:32:50 PDT 2014 -->
<title>SystemAdmin (samza-api 0.7.0 API)</title>
-<meta name="date" content="2014-06-18">
+<meta name="date" content="2014-07-09">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
</head>
<body>
@@ -92,7 +92,7 @@
<hr>
<br>
<pre>public interface <span class="strong">SystemAdmin</span></pre>
-<div class="block">Helper interface attached to an underlying system to fetch
+<div class="block">An interface that's use to interact with the underlying system to fetch
information about streams, partitions, offsets, etc. This interface is useful
for providing utility methods that Samza needs in order to interact with a
system.</div>
Modified: incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/SystemConsumer.html
URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/SystemConsumer.html?rev=1609230&r1=1609229&r2=1609230&view=diff
==============================================================================
--- incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/SystemConsumer.html (original)
+++ incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/SystemConsumer.html Wed Jul 9 16:34:23 2014
@@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
-<!-- Generated by javadoc (version 1.7.0_51) on Wed Jun 18 18:05:17 PDT 2014 -->
+<!-- Generated by javadoc (version 1.7.0_60) on Wed Jul 09 09:32:50 PDT 2014 -->
<title>SystemConsumer (samza-api 0.7.0 API)</title>
-<meta name="date" content="2014-06-18">
+<meta name="date" content="2014-07-09">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
</head>
<body>
@@ -206,7 +206,7 @@
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.util.List<<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/SystemConsumer.html#poll(java.util.Map, long)">poll</a></strong>(java.util.Map<<a href="../../../../org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system">SystemStreamPartition</a>,java.lang.Integer> systemStreamPartitions,
+<td class="colLast"><code><strong><a href="../../../../org/apache/samza/system/SystemConsumer.html#poll(java.util.Map,%20long)">poll</a></strong>(java.util.Map<<a href="../../../../org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system">SystemStreamPartition</a>,java.lang.Integer> systemStreamPartitions,
long timeout)</code>
<div class="block">Poll the SystemConsumer to get any available messages from the underlying
system.</div>
@@ -214,7 +214,7 @@
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
-<td class="colLast"><code><strong><a href="../../../../org/apache/samza/system/SystemConsumer.html#register(org.apache.samza.system.SystemStreamPartition, java.lang.String)">register</a></strong>(<a href="../../../../org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system">SystemStreamPartition</a> systemStreamPartition,
+<td class="colLast"><code><strong><a href="../../../../org/apache/samza/system/SystemConsumer.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">Register a SystemStreamPartition to this SystemConsumer.</div>
</td>
@@ -325,7 +325,7 @@
<div class="block">Poll the SystemConsumer to get any available messages from the underlying
system.
- <p>If the underlying implementation does not take care to adhere to the
+ If the underlying implementation does not take care to adhere to the
timeout parameter, the SamzaContainer's performance will suffer
drastically. Specifically, if poll blocks when it's not supposed to, it
will block the entire main thread in SamzaContainer, and no messages will
Modified: incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/SystemFactory.html
URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/SystemFactory.html?rev=1609230&r1=1609229&r2=1609230&view=diff
==============================================================================
--- incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/SystemFactory.html (original)
+++ incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/SystemFactory.html Wed Jul 9 16:34:23 2014
@@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
-<!-- Generated by javadoc (version 1.7.0_51) on Wed Jun 18 18:05:17 PDT 2014 -->
+<!-- Generated by javadoc (version 1.7.0_60) on Wed Jul 09 09:32:50 PDT 2014 -->
<title>SystemFactory (samza-api 0.7.0 API)</title>
-<meta name="date" content="2014-06-18">
+<meta name="date" content="2014-07-09">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
</head>
<body>
@@ -88,8 +88,6 @@
<hr>
<br>
<pre>public interface <span class="strong">SystemFactory</span></pre>
-<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>
</li>
</ul>
</div>
@@ -110,18 +108,18 @@
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../org/apache/samza/system/SystemAdmin.html" title="interface in org.apache.samza.system">SystemAdmin</a></code></td>
-<td class="colLast"><code><strong><a href="../../../../org/apache/samza/system/SystemFactory.html#getAdmin(java.lang.String, org.apache.samza.config.Config)">getAdmin</a></strong>(java.lang.String systemName,
+<td class="colLast"><code><strong><a href="../../../../org/apache/samza/system/SystemFactory.html#getAdmin(java.lang.String,%20org.apache.samza.config.Config)">getAdmin</a></strong>(java.lang.String systemName,
<a href="../../../../org/apache/samza/config/Config.html" title="class in org.apache.samza.config">Config</a> config)</code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../org/apache/samza/system/SystemConsumer.html" title="interface in org.apache.samza.system">SystemConsumer</a></code></td>
-<td class="colLast"><code><strong><a href="../../../../org/apache/samza/system/SystemFactory.html#getConsumer(java.lang.String, org.apache.samza.config.Config, org.apache.samza.metrics.MetricsRegistry)">getConsumer</a></strong>(java.lang.String systemName,
+<td class="colLast"><code><strong><a href="../../../../org/apache/samza/system/SystemFactory.html#getConsumer(java.lang.String,%20org.apache.samza.config.Config,%20org.apache.samza.metrics.MetricsRegistry)">getConsumer</a></strong>(java.lang.String systemName,
<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>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../org/apache/samza/system/SystemProducer.html" title="interface in org.apache.samza.system">SystemProducer</a></code></td>
-<td class="colLast"><code><strong><a href="../../../../org/apache/samza/system/SystemFactory.html#getProducer(java.lang.String, org.apache.samza.config.Config, org.apache.samza.metrics.MetricsRegistry)">getProducer</a></strong>(java.lang.String systemName,
+<td class="colLast"><code><strong><a href="../../../../org/apache/samza/system/SystemFactory.html#getProducer(java.lang.String,%20org.apache.samza.config.Config,%20org.apache.samza.metrics.MetricsRegistry)">getProducer</a></strong>(java.lang.String systemName,
<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>
Modified: incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/SystemProducer.html
URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/SystemProducer.html?rev=1609230&r1=1609229&r2=1609230&view=diff
==============================================================================
--- incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/SystemProducer.html (original)
+++ incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/SystemProducer.html Wed Jul 9 16:34:23 2014
@@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
-<!-- Generated by javadoc (version 1.7.0_51) on Wed Jun 18 18:05:17 PDT 2014 -->
+<!-- Generated by javadoc (version 1.7.0_60) on Wed Jul 09 09:32:50 PDT 2014 -->
<title>SystemProducer (samza-api 0.7.0 API)</title>
-<meta name="date" content="2014-06-18">
+<meta name="date" content="2014-07-09">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
</head>
<body>
@@ -88,9 +88,7 @@
<hr>
<br>
<pre>public interface <span class="strong">SystemProducer</span></pre>
-<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. Implementations are responsible for accepting messages
- and writing them to their backing systems.</div>
+<div class="block">Used as a standard interface for all producers of messages from a specified Samza source.</div>
</li>
</ul>
</div>
@@ -111,10 +109,7 @@
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
-<td class="colLast"><code><strong><a href="../../../../org/apache/samza/system/SystemProducer.html#flush(java.lang.String)">flush</a></strong>(java.lang.String source)</code>
-<div class="block">If the SystemProducer buffers messages before sending them to its underlying system, it should flush those
- messages and leave no messages remaining to be sent.</div>
-</td>
+<td class="colLast"><code><strong><a href="../../../../org/apache/samza/system/SystemProducer.html#flush(java.lang.String)">flush</a></strong>(java.lang.String source)</code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
@@ -124,22 +119,18 @@
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
-<td class="colLast"><code><strong><a href="../../../../org/apache/samza/system/SystemProducer.html#send(java.lang.String, org.apache.samza.system.OutgoingMessageEnvelope)">send</a></strong>(java.lang.String source,
+<td class="colLast"><code><strong><a href="../../../../org/apache/samza/system/SystemProducer.html#send(java.lang.String,%20org.apache.samza.system.OutgoingMessageEnvelope)">send</a></strong>(java.lang.String source,
<a href="../../../../org/apache/samza/system/OutgoingMessageEnvelope.html" title="class in org.apache.samza.system">OutgoingMessageEnvelope</a> envelope)</code>
<div class="block">Sends a specified message envelope from a specified Samza source.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
-<td class="colLast"><code><strong><a href="../../../../org/apache/samza/system/SystemProducer.html#start()">start</a></strong>()</code>
-<div class="block">Start the SystemProducer.</div>
-</td>
+<td class="colLast"><code><strong><a href="../../../../org/apache/samza/system/SystemProducer.html#start()">start</a></strong>()</code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
-<td class="colLast"><code><strong><a href="../../../../org/apache/samza/system/SystemProducer.html#stop()">stop</a></strong>()</code>
-<div class="block">Stop the SystemProducer.</div>
-</td>
+<td class="colLast"><code><strong><a href="../../../../org/apache/samza/system/SystemProducer.html#stop()">stop</a></strong>()</code> </td>
</tr>
</table>
</li>
@@ -163,7 +154,6 @@
<li class="blockList">
<h4>start</h4>
<pre>void start()</pre>
-<div class="block">Start the SystemProducer. After this method finishes it should be ready to accept messages received from the send method.</div>
</li>
</ul>
<a name="stop()">
@@ -173,8 +163,6 @@
<li class="blockList">
<h4>stop</h4>
<pre>void stop()</pre>
-<div class="block">Stop the SystemProducer. After this method finished, the system should have completed all necessary work, sent
- any remaining messages and will not receive any new calls to the send method.</div>
</li>
</ul>
<a name="register(java.lang.String)">
@@ -207,9 +195,6 @@
<li class="blockList">
<h4>flush</h4>
<pre>void flush(java.lang.String source)</pre>
-<div class="block">If the SystemProducer buffers messages before sending them to its underlying system, it should flush those
- messages and leave no messages remaining to be sent.</div>
-<dl><dt><span class="strong">Parameters:</span></dt><dd><code>source</code> - String representing the source of the message.</dd></dl>
</li>
</ul>
</li>
Modified: incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/SystemStream.html
URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/SystemStream.html?rev=1609230&r1=1609229&r2=1609230&view=diff
==============================================================================
--- incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/SystemStream.html (original)
+++ incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/SystemStream.html Wed Jul 9 16:34:23 2014
@@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
-<!-- Generated by javadoc (version 1.7.0_51) on Wed Jun 18 18:05:17 PDT 2014 -->
+<!-- Generated by javadoc (version 1.7.0_60) on Wed Jul 09 09:32:50 PDT 2014 -->
<title>SystemStream (samza-api 0.7.0 API)</title>
-<meta name="date" content="2014-06-18">
+<meta name="date" content="2014-07-09">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
</head>
<body>
@@ -101,11 +101,7 @@
<br>
<pre>public class <span class="strong">SystemStream</span>
extends java.lang.Object</pre>
-<div class="block">Streams in Samza consist of both the stream name and the system to which the stream belongs.
- Systems are defined through the job config and have corresponding serdes, producers and
- consumers in order to deserialize, send to and retrieve from them. A stream name is dependent
- on its system, and may be the topic, queue name, file name, etc. as makes sense for a
- particular system.</div>
+<div class="block">Used to represent a Samza stream.</div>
</li>
</ul>
</div>
@@ -147,7 +143,7 @@ extends java.lang.Object</pre>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
-<td class="colOne"><code><strong><a href="../../../../org/apache/samza/system/SystemStream.html#SystemStream(java.lang.String, java.lang.String)">SystemStream</a></strong>(java.lang.String system,
+<td class="colOne"><code><strong><a href="../../../../org/apache/samza/system/SystemStream.html#SystemStream(java.lang.String,%20java.lang.String)">SystemStream</a></strong>(java.lang.String system,
java.lang.String stream)</code>
<div class="block">Constructs a Samza stream object from specified components.</div>
</td>
Modified: incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/SystemStreamMetadata.OffsetType.html
URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/SystemStreamMetadata.OffsetType.html?rev=1609230&r1=1609229&r2=1609230&view=diff
==============================================================================
--- incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/SystemStreamMetadata.OffsetType.html (original)
+++ incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/SystemStreamMetadata.OffsetType.html Wed Jul 9 16:34:23 2014
@@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
-<!-- Generated by javadoc (version 1.7.0_51) on Wed Jun 18 18:05:17 PDT 2014 -->
+<!-- Generated by javadoc (version 1.7.0_60) on Wed Jul 09 09:32:50 PDT 2014 -->
<title>SystemStreamMetadata.OffsetType (samza-api 0.7.0 API)</title>
-<meta name="date" content="2014-06-18">
+<meta name="date" content="2014-07-09">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
</head>
<body>
@@ -257,8 +257,7 @@ over the constants as follows:
for (SystemStreamMetadata.OffsetType c : SystemStreamMetadata.OffsetType.values())
System.out.println(c);
</pre></div>
-<dl><dt><span class="strong">Returns:</span></dt><dd>an array containing the constants of this enum type, in
-the order they are declared</dd></dl>
+<dl><dt><span class="strong">Returns:</span></dt><dd>an array containing the constants of this enum type, in the order they are declared</dd></dl>
</li>
</ul>
<a name="valueOf(java.lang.String)">
@@ -275,8 +274,7 @@ not permitted.)</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - the name of the enum constant to be returned.</dd>
<dt><span class="strong">Returns:</span></dt><dd>the enum constant with the specified name</dd>
<dt><span class="strong">Throws:</span></dt>
-<dd><code>java.lang.IllegalArgumentException</code> - if this enum type has no constant
-with the specified name</dd>
+<dd><code>java.lang.IllegalArgumentException</code> - if this enum type has no constant with the specified name</dd>
<dd><code>java.lang.NullPointerException</code> - if the argument is null</dd></dl>
</li>
</ul>
Modified: incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/SystemStreamMetadata.SystemStreamPartitionMetadata.html
URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/SystemStreamMetadata.SystemStreamPartitionMetadata.html?rev=1609230&r1=1609229&r2=1609230&view=diff
==============================================================================
--- incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/SystemStreamMetadata.SystemStreamPartitionMetadata.html (original)
+++ incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/SystemStreamMetadata.SystemStreamPartitionMetadata.html Wed Jul 9 16:34:23 2014
@@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
-<!-- Generated by javadoc (version 1.7.0_51) on Wed Jun 18 18:05:17 PDT 2014 -->
+<!-- Generated by javadoc (version 1.7.0_60) on Wed Jul 09 09:32:50 PDT 2014 -->
<title>SystemStreamMetadata.SystemStreamPartitionMetadata (samza-api 0.7.0 API)</title>
-<meta name="date" content="2014-06-18">
+<meta name="date" content="2014-07-09">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
</head>
<body>
@@ -121,7 +121,7 @@ extends java.lang.Object</pre>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
-<td class="colOne"><code><strong><a href="../../../../org/apache/samza/system/SystemStreamMetadata.SystemStreamPartitionMetadata.html#SystemStreamMetadata.SystemStreamPartitionMetadata(java.lang.String, java.lang.String, java.lang.String)">SystemStreamMetadata.SystemStreamPartitionMetadata</a></strong>(java.lang.String oldestOffset,
+<td class="colOne"><code><strong><a href="../../../../org/apache/samza/system/SystemStreamMetadata.SystemStreamPartitionMetadata.html#SystemStreamMetadata.SystemStreamPartitionMetadata(java.lang.String,%20java.lang.String,%20java.lang.String)">SystemStreamMetadata.SystemStreamPartitionMetadata</a></strong>(java.lang.String oldestOffset,
java.lang.String newestOffset,
java.lang.String upcomingOffset)</code> </td>
</tr>
Modified: incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/SystemStreamMetadata.html
URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/SystemStreamMetadata.html?rev=1609230&r1=1609229&r2=1609230&view=diff
==============================================================================
--- incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/SystemStreamMetadata.html (original)
+++ incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/SystemStreamMetadata.html Wed Jul 9 16:34:23 2014
@@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
-<!-- Generated by javadoc (version 1.7.0_51) on Wed Jun 18 18:05:17 PDT 2014 -->
+<!-- Generated by javadoc (version 1.7.0_60) on Wed Jul 09 09:32:50 PDT 2014 -->
<title>SystemStreamMetadata (samza-api 0.7.0 API)</title>
-<meta name="date" content="2014-06-18">
+<meta name="date" content="2014-07-09">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
</head>
<body>
@@ -145,7 +145,7 @@ extends java.lang.Object</pre>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
-<td class="colOne"><code><strong><a href="../../../../org/apache/samza/system/SystemStreamMetadata.html#SystemStreamMetadata(java.lang.String, java.util.Map)">SystemStreamMetadata</a></strong>(java.lang.String streamName,
+<td class="colOne"><code><strong><a href="../../../../org/apache/samza/system/SystemStreamMetadata.html#SystemStreamMetadata(java.lang.String,%20java.util.Map)">SystemStreamMetadata</a></strong>(java.lang.String streamName,
java.util.Map<<a href="../../../../org/apache/samza/Partition.html" title="class in org.apache.samza">Partition</a>,<a href="../../../../org/apache/samza/system/SystemStreamMetadata.SystemStreamPartitionMetadata.html" title="class in org.apache.samza.system">SystemStreamMetadata.SystemStreamPartitionMetadata</a>> partitionMetadata)</code> </td>
</tr>
</table>
Modified: incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/SystemStreamPartition.html
URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/SystemStreamPartition.html?rev=1609230&r1=1609229&r2=1609230&view=diff
==============================================================================
--- incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/SystemStreamPartition.html (original)
+++ incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/SystemStreamPartition.html Wed Jul 9 16:34:23 2014
@@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
-<!-- Generated by javadoc (version 1.7.0_51) on Wed Jun 18 18:05:17 PDT 2014 -->
+<!-- Generated by javadoc (version 1.7.0_60) on Wed Jul 09 09:32:50 PDT 2014 -->
<title>SystemStreamPartition (samza-api 0.7.0 API)</title>
-<meta name="date" content="2014-06-18">
+<meta name="date" content="2014-07-09">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
</head>
<body>
@@ -102,7 +102,7 @@
<br>
<pre>public class <span class="strong">SystemStreamPartition</span>
extends <a href="../../../../org/apache/samza/system/SystemStream.html" title="class in org.apache.samza.system">SystemStream</a></pre>
-<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>
+<div class="block">Aggregate object representing a partition of a Samza stream.</div>
</li>
</ul>
</div>
@@ -151,7 +151,7 @@ extends <a href="../../../../org/apache/
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
-<td class="colOne"><code><strong><a href="../../../../org/apache/samza/system/SystemStreamPartition.html#SystemStreamPartition(java.lang.String, java.lang.String, org.apache.samza.Partition)">SystemStreamPartition</a></strong>(java.lang.String system,
+<td class="colOne"><code><strong><a href="../../../../org/apache/samza/system/SystemStreamPartition.html#SystemStreamPartition(java.lang.String,%20java.lang.String,%20org.apache.samza.Partition)">SystemStreamPartition</a></strong>(java.lang.String system,
java.lang.String stream,
<a href="../../../../org/apache/samza/Partition.html" title="class in org.apache.samza">Partition</a> partition)</code>
<div class="block">Constructs a Samza stream partition object from specified components.</div>
@@ -163,7 +163,7 @@ extends <a href="../../../../org/apache/
</td>
</tr>
<tr class="altColor">
-<td class="colOne"><code><strong><a href="../../../../org/apache/samza/system/SystemStreamPartition.html#SystemStreamPartition(org.apache.samza.system.SystemStream, org.apache.samza.Partition)">SystemStreamPartition</a></strong>(<a href="../../../../org/apache/samza/system/SystemStream.html" title="class in org.apache.samza.system">SystemStream</a> other,
+<td class="colOne"><code><strong><a href="../../../../org/apache/samza/system/SystemStreamPartition.html#SystemStreamPartition(org.apache.samza.system.SystemStream,%20org.apache.samza.Partition)">SystemStreamPartition</a></strong>(<a href="../../../../org/apache/samza/system/SystemStream.html" title="class in org.apache.samza.system">SystemStream</a> other,
<a href="../../../../org/apache/samza/Partition.html" title="class in org.apache.samza">Partition</a> partition)</code>
<div class="block">Constructs a Samza stream partition object based upon another Samza stream and a specified partition.</div>
</td>
Modified: incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/SystemStreamPartitionIterator.html
URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/SystemStreamPartitionIterator.html?rev=1609230&r1=1609229&r2=1609230&view=diff
==============================================================================
--- incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/SystemStreamPartitionIterator.html (original)
+++ incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/SystemStreamPartitionIterator.html Wed Jul 9 16:34:23 2014
@@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
-<!-- Generated by javadoc (version 1.7.0_51) on Wed Jun 18 18:05:17 PDT 2014 -->
+<!-- Generated by javadoc (version 1.7.0_60) on Wed Jul 09 09:32:50 PDT 2014 -->
<title>SystemStreamPartitionIterator (samza-api 0.7.0 API)</title>
-<meta name="date" content="2014-06-18">
+<meta name="date" content="2014-07-09">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
</head>
<body>
@@ -102,8 +102,6 @@
<pre>public class <span class="strong">SystemStreamPartitionIterator</span>
extends java.lang.Object
implements java.util.Iterator<<a href="../../../../org/apache/samza/system/IncomingMessageEnvelope.html" title="class in org.apache.samza.system">IncomingMessageEnvelope</a>></pre>
-<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>
</li>
</ul>
</div>
@@ -122,11 +120,11 @@ implements java.util.Iterator<<a href
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
-<td class="colOne"><code><strong><a href="../../../../org/apache/samza/system/SystemStreamPartitionIterator.html#SystemStreamPartitionIterator(org.apache.samza.system.SystemConsumer, org.apache.samza.system.SystemStreamPartition)">SystemStreamPartitionIterator</a></strong>(<a href="../../../../org/apache/samza/system/SystemConsumer.html" title="interface in org.apache.samza.system">SystemConsumer</a> systemConsumer,
+<td class="colOne"><code><strong><a href="../../../../org/apache/samza/system/SystemStreamPartitionIterator.html#SystemStreamPartitionIterator(org.apache.samza.system.SystemConsumer,%20org.apache.samza.system.SystemStreamPartition)">SystemStreamPartitionIterator</a></strong>(<a href="../../../../org/apache/samza/system/SystemConsumer.html" title="interface in org.apache.samza.system">SystemConsumer</a> systemConsumer,
<a href="../../../../org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system">SystemStreamPartition</a> systemStreamPartition)</code> </td>
</tr>
<tr class="rowColor">
-<td class="colOne"><code><strong><a href="../../../../org/apache/samza/system/SystemStreamPartitionIterator.html#SystemStreamPartitionIterator(org.apache.samza.system.SystemConsumer, org.apache.samza.system.SystemStreamPartition, int)">SystemStreamPartitionIterator</a></strong>(<a href="../../../../org/apache/samza/system/SystemConsumer.html" title="interface in org.apache.samza.system">SystemConsumer</a> systemConsumer,
+<td class="colOne"><code><strong><a href="../../../../org/apache/samza/system/SystemStreamPartitionIterator.html#SystemStreamPartitionIterator(org.apache.samza.system.SystemConsumer,%20org.apache.samza.system.SystemStreamPartition,%20int)">SystemStreamPartitionIterator</a></strong>(<a href="../../../../org/apache/samza/system/SystemConsumer.html" title="interface in org.apache.samza.system">SystemConsumer</a> systemConsumer,
<a href="../../../../org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system">SystemStreamPartition</a> systemStreamPartition,
int fetchSize)</code> </td>
</tr>
Modified: incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/chooser/BaseMessageChooser.html
URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/chooser/BaseMessageChooser.html?rev=1609230&r1=1609229&r2=1609230&view=diff
==============================================================================
--- incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/chooser/BaseMessageChooser.html (original)
+++ incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/chooser/BaseMessageChooser.html Wed Jul 9 16:34:23 2014
@@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
-<!-- Generated by javadoc (version 1.7.0_51) on Wed Jun 18 18:05:17 PDT 2014 -->
+<!-- Generated by javadoc (version 1.7.0_60) on Wed Jul 09 09:32:49 PDT 2014 -->
<title>BaseMessageChooser (samza-api 0.7.0 API)</title>
-<meta name="date" content="2014-06-18">
+<meta name="date" content="2014-07-09">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
</head>
<body>
@@ -141,7 +141,7 @@ implements <a href="../../../../../org/a
</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, java.lang.String)">register</a></strong>(<a href="../../../../../org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system">SystemStreamPartition</a> systemStreamPartition,
+<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>
@@ -245,13 +245,13 @@ implements <a href="../../../../../org/a
<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, java.lang.String)">MessageChooser</a></code></strong></div>
+<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, java.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>
+<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
Modified: incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/chooser/MessageChooser.html
URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/chooser/MessageChooser.html?rev=1609230&r1=1609229&r2=1609230&view=diff
==============================================================================
--- incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/chooser/MessageChooser.html (original)
+++ incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/chooser/MessageChooser.html Wed Jul 9 16:34:23 2014
@@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
-<!-- Generated by javadoc (version 1.7.0_51) on Wed Jun 18 18:05:17 PDT 2014 -->
+<!-- Generated by javadoc (version 1.7.0_60) on Wed Jul 09 09:32:50 PDT 2014 -->
<title>MessageChooser (samza-api 0.7.0 API)</title>
-<meta name="date" content="2014-06-18">
+<meta name="date" content="2014-07-09">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
</head>
<body>
@@ -94,46 +94,46 @@
<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
+
+ Consider the case of a Samza task is 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,
+
+ 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:
-
+ partitions if it chooses not to return messages even though they are
+ available when choose is invoked. The MessageChooser can also throttle the
+ entire SamzaContainer by performing a blocking operation, such as
+ Thread.sleep.
+
+ The manner in which MessageChooser is used is:
+
<ul>
- <li>SystemConsumers buffer messages from all SystemStreamPartitions as they
+ <li>SystemConsumers buffers 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,
+ SystemConsumers 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>
+ SystemConsumers.choose, which in-turn calls MessageChooser.choose.</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
+
+ Since the MessageChooser only receives one message at a time per
+ SystemStreamPartition, 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:
-
+
+ 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
+ <li>Update can be called multiple times before choose is called.</li>
+ <li>A null return from MessageChooser.choose 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 may elect to return null when choose 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
@@ -169,7 +169,7 @@
</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, java.lang.String)">register</a></strong>(<a href="../../../../../org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system">SystemStreamPartition</a> systemStreamPartition,
+<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>
@@ -190,7 +190,9 @@
<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>
+<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.</div>
</td>
</tr>
</table>
@@ -255,7 +257,7 @@
<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
+<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
Modified: incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/chooser/MessageChooserFactory.html
URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/chooser/MessageChooserFactory.html?rev=1609230&r1=1609229&r2=1609230&view=diff
==============================================================================
--- incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/chooser/MessageChooserFactory.html (original)
+++ incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/chooser/MessageChooserFactory.html Wed Jul 9 16:34:23 2014
@@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
-<!-- Generated by javadoc (version 1.7.0_51) on Wed Jun 18 18:05:17 PDT 2014 -->
+<!-- Generated by javadoc (version 1.7.0_60) on Wed Jul 09 09:32:50 PDT 2014 -->
<title>MessageChooserFactory (samza-api 0.7.0 API)</title>
-<meta name="date" content="2014-06-18">
+<meta name="date" content="2014-07-09">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
</head>
<body>
@@ -88,7 +88,6 @@
<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>
@@ -109,7 +108,7 @@
</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, org.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,
+<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>
Modified: incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/chooser/package-frame.html
URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/chooser/package-frame.html?rev=1609230&r1=1609229&r2=1609230&view=diff
==============================================================================
--- incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/chooser/package-frame.html (original)
+++ incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/chooser/package-frame.html Wed Jul 9 16:34:23 2014
@@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
-<!-- Generated by javadoc (version 1.7.0_51) on Wed Jun 18 18:05:17 PDT 2014 -->
+<!-- Generated by javadoc (version 1.7.0_60) on Wed Jul 09 09:32:50 PDT 2014 -->
<title>org.apache.samza.system.chooser (samza-api 0.7.0 API)</title>
-<meta name="date" content="2014-06-18">
+<meta name="date" content="2014-07-09">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
</head>
<body>
Modified: incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/chooser/package-summary.html
URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/chooser/package-summary.html?rev=1609230&r1=1609229&r2=1609230&view=diff
==============================================================================
--- incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/chooser/package-summary.html (original)
+++ incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/chooser/package-summary.html Wed Jul 9 16:34:23 2014
@@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
-<!-- Generated by javadoc (version 1.7.0_51) on Wed Jun 18 18:05:17 PDT 2014 -->
+<!-- Generated by javadoc (version 1.7.0_60) on Wed Jul 09 09:32:50 PDT 2014 -->
<title>org.apache.samza.system.chooser (samza-api 0.7.0 API)</title>
-<meta name="date" content="2014-06-18">
+<meta name="date" content="2014-07-09">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
</head>
<body>
@@ -83,9 +83,7 @@
</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>
+<td class="colLast"> </td>
</tr>
</tbody>
</table>
Modified: incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/chooser/package-tree.html
URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/chooser/package-tree.html?rev=1609230&r1=1609229&r2=1609230&view=diff
==============================================================================
--- incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/chooser/package-tree.html (original)
+++ incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/chooser/package-tree.html Wed Jul 9 16:34:23 2014
@@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
-<!-- Generated by javadoc (version 1.7.0_51) on Wed Jun 18 18:05:17 PDT 2014 -->
+<!-- Generated by javadoc (version 1.7.0_60) on Wed Jul 09 09:32:50 PDT 2014 -->
<title>org.apache.samza.system.chooser Class Hierarchy (samza-api 0.7.0 API)</title>
-<meta name="date" content="2014-06-18">
+<meta name="date" content="2014-07-09">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
</head>
<body>
Modified: incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/package-frame.html
URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/package-frame.html?rev=1609230&r1=1609229&r2=1609230&view=diff
==============================================================================
--- incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/package-frame.html (original)
+++ incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/package-frame.html Wed Jul 9 16:34:23 2014
@@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
-<!-- Generated by javadoc (version 1.7.0_51) on Wed Jun 18 18:05:17 PDT 2014 -->
+<!-- Generated by javadoc (version 1.7.0_60) on Wed Jul 09 09:32:50 PDT 2014 -->
<title>org.apache.samza.system (samza-api 0.7.0 API)</title>
-<meta name="date" content="2014-06-18">
+<meta name="date" content="2014-07-09">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
</head>
<body>
Modified: incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/package-summary.html
URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/package-summary.html?rev=1609230&r1=1609229&r2=1609230&view=diff
==============================================================================
--- incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/package-summary.html (original)
+++ incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/package-summary.html Wed Jul 9 16:34:23 2014
@@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
-<!-- Generated by javadoc (version 1.7.0_51) on Wed Jun 18 18:05:17 PDT 2014 -->
+<!-- Generated by javadoc (version 1.7.0_60) on Wed Jul 09 09:32:50 PDT 2014 -->
<title>org.apache.samza.system (samza-api 0.7.0 API)</title>
-<meta name="date" content="2014-06-18">
+<meta name="date" content="2014-07-09">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
</head>
<body>
@@ -77,7 +77,7 @@
<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
+<div class="block">An interface that's use to interact with the underlying system to fetch
information about streams, partitions, offsets, etc.</div>
</td>
</tr>
@@ -91,16 +91,12 @@
</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>
+<td class="colLast"> </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>
+<div class="block">Used as a standard interface for all producers of messages from a specified Samza source.</div>
</td>
</tr>
</tbody>
@@ -124,14 +120,13 @@
<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>
+<div class="block">This class represents a message envelope that is sent by a StreamTask.</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>
+<div class="block">Used to represent a Samza stream.</div>
</td>
</tr>
<tr class="rowColor">
@@ -150,15 +145,12 @@
<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>
+<div class="block">Aggregate object representing a partition of a Samza stream.</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>
+<td class="colLast"> </td>
</tr>
</tbody>
</table>
Modified: incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/package-tree.html
URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/package-tree.html?rev=1609230&r1=1609229&r2=1609230&view=diff
==============================================================================
--- incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/package-tree.html (original)
+++ incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/system/package-tree.html Wed Jul 9 16:34:23 2014
@@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
-<!-- Generated by javadoc (version 1.7.0_51) on Wed Jun 18 18:05:17 PDT 2014 -->
+<!-- Generated by javadoc (version 1.7.0_60) on Wed Jul 09 09:32:50 PDT 2014 -->
<title>org.apache.samza.system Class Hierarchy (samza-api 0.7.0 API)</title>
-<meta name="date" content="2014-06-18">
+<meta name="date" content="2014-07-09">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
</head>
<body>
Modified: incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/task/ClosableTask.html
URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/task/ClosableTask.html?rev=1609230&r1=1609229&r2=1609230&view=diff
==============================================================================
--- incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/task/ClosableTask.html (original)
+++ incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/task/ClosableTask.html Wed Jul 9 16:34:23 2014
@@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
-<!-- Generated by javadoc (version 1.7.0_51) on Wed Jun 18 18:05:17 PDT 2014 -->
+<!-- Generated by javadoc (version 1.7.0_60) on Wed Jul 09 09:32:49 PDT 2014 -->
<title>ClosableTask (samza-api 0.7.0 API)</title>
-<meta name="date" content="2014-06-18">
+<meta name="date" content="2014-07-09">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
</head>
<body>
@@ -88,10 +88,6 @@
<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>
Modified: incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/task/InitableTask.html
URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/task/InitableTask.html?rev=1609230&r1=1609229&r2=1609230&view=diff
==============================================================================
--- incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/task/InitableTask.html (original)
+++ incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/task/InitableTask.html Wed Jul 9 16:34:23 2014
@@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
-<!-- Generated by javadoc (version 1.7.0_51) on Wed Jun 18 18:05:17 PDT 2014 -->
+<!-- Generated by javadoc (version 1.7.0_60) on Wed Jul 09 09:32:49 PDT 2014 -->
<title>InitableTask (samza-api 0.7.0 API)</title>
-<meta name="date" content="2014-06-18">
+<meta name="date" content="2014-07-09">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
</head>
<body>
@@ -110,7 +110,7 @@
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
-<td class="colLast"><code><strong><a href="../../../../org/apache/samza/task/InitableTask.html#init(org.apache.samza.config.Config, org.apache.samza.task.TaskContext)">init</a></strong>(<a href="../../../../org/apache/samza/config/Config.html" title="class in org.apache.samza.config">Config</a> config,
+<td class="colLast"><code><strong><a href="../../../../org/apache/samza/task/InitableTask.html#init(org.apache.samza.config.Config,%20org.apache.samza.task.TaskContext)">init</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/task/TaskContext.html" title="interface in org.apache.samza.task">TaskContext</a> context)</code>
<div class="block">Called by TaskRunner each time an implementing task is created.</div>
</td>
Modified: incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/task/MessageCollector.html
URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/task/MessageCollector.html?rev=1609230&r1=1609229&r2=1609230&view=diff
==============================================================================
--- incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/task/MessageCollector.html (original)
+++ incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/task/MessageCollector.html Wed Jul 9 16:34:23 2014
@@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
-<!-- Generated by javadoc (version 1.7.0_51) on Wed Jun 18 18:05:17 PDT 2014 -->
+<!-- Generated by javadoc (version 1.7.0_60) on Wed Jul 09 09:32:49 PDT 2014 -->
<title>MessageCollector (samza-api 0.7.0 API)</title>
-<meta name="date" content="2014-06-18">
+<meta name="date" content="2014-07-09">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
</head>
<body>
@@ -90,8 +90,8 @@
<pre>public interface <span class="strong">MessageCollector</span></pre>
<div class="block">Used as an interface for the means of sending message envelopes to an output stream.
- <p>A MessageCollector is provided on every call to <a href="../../../../org/apache/samza/task/StreamTask.html#process(org.apache.samza.system.IncomingMessageEnvelope, org.apache.samza.task.MessageCollector, org.apache.samza.task.TaskCoordinator)"><code>StreamTask.process(org.apache.samza.system.IncomingMessageEnvelope, org.apache.samza.task.MessageCollector, org.apache.samza.task.TaskCoordinator)</code></a> and
- <a href="../../../../org/apache/samza/task/WindowableTask.html#window(org.apache.samza.task.MessageCollector, org.apache.samza.task.TaskCoordinator)"><code>WindowableTask.window(org.apache.samza.task.MessageCollector, org.apache.samza.task.TaskCoordinator)</code></a>. You must use those MessageCollector objects only within
+ <p>A MessageCollector is provided on every call to <a href="../../../../org/apache/samza/task/StreamTask.html#process(org.apache.samza.system.IncomingMessageEnvelope,%20org.apache.samza.task.MessageCollector,%20org.apache.samza.task.TaskCoordinator)"><code>StreamTask.process(org.apache.samza.system.IncomingMessageEnvelope, org.apache.samza.task.MessageCollector, org.apache.samza.task.TaskCoordinator)</code></a> and
+ <a href="../../../../org/apache/samza/task/WindowableTask.html#window(org.apache.samza.task.MessageCollector,%20org.apache.samza.task.TaskCoordinator)"><code>WindowableTask.window(org.apache.samza.task.MessageCollector, org.apache.samza.task.TaskCoordinator)</code></a>. You must use those MessageCollector objects only within
those method calls, and not hold on to a reference for use at any other time.</div>
</li>
</ul>
Modified: incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/task/StreamTask.html
URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/task/StreamTask.html?rev=1609230&r1=1609229&r2=1609230&view=diff
==============================================================================
--- incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/task/StreamTask.html (original)
+++ incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/task/StreamTask.html Wed Jul 9 16:34:23 2014
@@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
-<!-- Generated by javadoc (version 1.7.0_51) on Wed Jun 18 18:05:17 PDT 2014 -->
+<!-- Generated by javadoc (version 1.7.0_60) on Wed Jul 09 09:32:49 PDT 2014 -->
<title>StreamTask (samza-api 0.7.0 API)</title>
-<meta name="date" content="2014-06-18">
+<meta name="date" content="2014-07-09">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
</head>
<body>
@@ -88,17 +88,8 @@
<hr>
<br>
<pre>public interface <span class="strong">StreamTask</span></pre>
-<div class="block">A StreamTask is the basic class on which Samza jobs are implemented. Developers writing Samza jobs begin by
- implementing this class, which processes messages from the job's input streams and writes messages out to
- streams via the provided <a href="../../../../org/apache/samza/task/MessageCollector.html" title="interface in org.apache.samza.task"><code>MessageCollector</code></a>. A StreamTask may be augmented by
- implementing other interfaces, such as <a href="../../../../org/apache/samza/task/InitableTask.html" title="interface in org.apache.samza.task"><code>InitableTask</code></a>, <a href="../../../../org/apache/samza/task/WindowableTask.html" title="interface in org.apache.samza.task"><code>WindowableTask</code></a>,
- or <a href="../../../../org/apache/samza/task/ClosableTask.html" title="interface in org.apache.samza.task"><code>ClosableTask</code></a>.
- <p>
- The methods of StreamTasks and associated other tasks are guaranteed to be called in a single-threaded fashion;
- no extra synchronization is necessary on the part of the class implementer. References to instances of
- <a href="../../../../org/apache/samza/system/IncomingMessageEnvelope.html" title="class in org.apache.samza.system"><code>IncomingMessageEnvelope</code></a>s,<a href="../../../../org/apache/samza/task/MessageCollector.html" title="interface in org.apache.samza.task"><code>MessageCollector</code></a>s, and
- <a href="../../../../org/apache/samza/task/TaskCoordinator.html" title="interface in org.apache.samza.task"><code>TaskCoordinator</code></a> should not be held onto between calls; there is no guarantee that
- these will not be invalidated or otherwise used by the framework.</div>
+<div class="block">Used as a standard interface for all user processing tasks. Receives messages from a partition of a specified input
+ stream.</div>
</li>
</ul>
</div>
@@ -119,7 +110,7 @@
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
-<td class="colLast"><code><strong><a href="../../../../org/apache/samza/task/StreamTask.html#process(org.apache.samza.system.IncomingMessageEnvelope, org.apache.samza.task.MessageCollector, org.apache.samza.task.TaskCoordinator)">process</a></strong>(<a href="../../../../org/apache/samza/system/IncomingMessageEnvelope.html" title="class in org.apache.samza.system">IncomingMessageEnvelope</a> envelope,
+<td class="colLast"><code><strong><a href="../../../../org/apache/samza/task/StreamTask.html#process(org.apache.samza.system.IncomingMessageEnvelope,%20org.apache.samza.task.MessageCollector,%20org.apache.samza.task.TaskCoordinator)">process</a></strong>(<a href="../../../../org/apache/samza/system/IncomingMessageEnvelope.html" title="class in org.apache.samza.system">IncomingMessageEnvelope</a> envelope,
<a href="../../../../org/apache/samza/task/MessageCollector.html" title="interface in org.apache.samza.task">MessageCollector</a> collector,
<a href="../../../../org/apache/samza/task/TaskCoordinator.html" title="interface in org.apache.samza.task">TaskCoordinator</a> coordinator)</code>
<div class="block">Called once for each message that this StreamTask receives.</div>
Modified: incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/task/TaskContext.html
URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/task/TaskContext.html?rev=1609230&r1=1609229&r2=1609230&view=diff
==============================================================================
--- incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/task/TaskContext.html (original)
+++ incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/task/TaskContext.html Wed Jul 9 16:34:23 2014
@@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
-<!-- Generated by javadoc (version 1.7.0_51) on Wed Jun 18 18:05:17 PDT 2014 -->
+<!-- Generated by javadoc (version 1.7.0_60) on Wed Jul 09 09:32:49 PDT 2014 -->
<title>TaskContext (samza-api 0.7.0 API)</title>
-<meta name="date" content="2014-06-18">
+<meta name="date" content="2014-07-09">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
</head>
<body>
@@ -88,8 +88,6 @@
<hr>
<br>
<pre>public interface <span class="strong">TaskContext</span></pre>
-<div class="block">A TaskContext provides resources about the <a href="../../../../org/apache/samza/task/StreamTask.html" title="interface in org.apache.samza.task"><code>StreamTask</code></a>, particularly during
- initialization in an <a href="../../../../org/apache/samza/task/InitableTask.html" title="interface in org.apache.samza.task"><code>InitableTask</code></a> and during calls to <a href="../../../../org/apache/samza/task/TaskLifecycleListener.html" title="interface in org.apache.samza.task"><code>TaskLifecycleListener</code></a>s.</div>
</li>
</ul>
</div>
Modified: incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/task/TaskCoordinator.RequestScope.html
URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/task/TaskCoordinator.RequestScope.html?rev=1609230&r1=1609229&r2=1609230&view=diff
==============================================================================
--- incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/task/TaskCoordinator.RequestScope.html (original)
+++ incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/task/TaskCoordinator.RequestScope.html Wed Jul 9 16:34:23 2014
@@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
-<!-- Generated by javadoc (version 1.7.0_51) on Wed Jun 18 18:05:17 PDT 2014 -->
+<!-- Generated by javadoc (version 1.7.0_60) on Wed Jul 09 09:32:49 PDT 2014 -->
<title>TaskCoordinator.RequestScope (samza-api 0.7.0 API)</title>
-<meta name="date" content="2014-06-18">
+<meta name="date" content="2014-07-09">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
</head>
<body>
@@ -241,8 +241,7 @@ over the constants as follows:
for (TaskCoordinator.RequestScope c : TaskCoordinator.RequestScope.values())
System.out.println(c);
</pre></div>
-<dl><dt><span class="strong">Returns:</span></dt><dd>an array containing the constants of this enum type, in
-the order they are declared</dd></dl>
+<dl><dt><span class="strong">Returns:</span></dt><dd>an array containing the constants of this enum type, in the order they are declared</dd></dl>
</li>
</ul>
<a name="valueOf(java.lang.String)">
@@ -259,8 +258,7 @@ not permitted.)</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - the name of the enum constant to be returned.</dd>
<dt><span class="strong">Returns:</span></dt><dd>the enum constant with the specified name</dd>
<dt><span class="strong">Throws:</span></dt>
-<dd><code>java.lang.IllegalArgumentException</code> - if this enum type has no constant
-with the specified name</dd>
+<dd><code>java.lang.IllegalArgumentException</code> - if this enum type has no constant with the specified name</dd>
<dd><code>java.lang.NullPointerException</code> - if the argument is null</dd></dl>
</li>
</ul>
Modified: incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/task/TaskCoordinator.html
URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/task/TaskCoordinator.html?rev=1609230&r1=1609229&r2=1609230&view=diff
==============================================================================
--- incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/task/TaskCoordinator.html (original)
+++ incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/task/TaskCoordinator.html Wed Jul 9 16:34:23 2014
@@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
-<!-- Generated by javadoc (version 1.7.0_51) on Wed Jun 18 18:05:17 PDT 2014 -->
+<!-- Generated by javadoc (version 1.7.0_60) on Wed Jul 09 09:32:49 PDT 2014 -->
<title>TaskCoordinator (samza-api 0.7.0 API)</title>
-<meta name="date" content="2014-06-18">
+<meta name="date" content="2014-07-09">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
</head>
<body>
@@ -88,13 +88,6 @@
<hr>
<br>
<pre>public interface <span class="strong">TaskCoordinator</span></pre>
-<div class="block">TaskCoordinators are provided to the process methods of <a href="../../../../org/apache/samza/task/StreamTask.html" title="interface in org.apache.samza.task"><code>StreamTask</code></a> implementations
- to allow the user code to request actions from the Samza framework, including committing the current checkpoints
- to configured <a href="../../../../org/apache/samza/checkpoint/CheckpointManager.html" title="interface in org.apache.samza.checkpoint"><code>CheckpointManager</code></a>s or shutting down the task or all tasks within
- a container.
- <p>
- This interface may evolve over time.
- </p></div>
</li>
</ul>
</div>