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 [6/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/task/TaskLifecycleListener.html
URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/task/TaskLifecycleListener.html?rev=1609230&r1=1609229&r2=1609230&view=diff
==============================================================================
--- incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/task/TaskLifecycleListener.html (original)
+++ incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/task/TaskLifecycleListener.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>TaskLifecycleListener (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,21 +110,21 @@
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
-<td class="colLast"><code><strong><a href="../../../../org/apache/samza/task/TaskLifecycleListener.html#afterClose(org.apache.samza.config.Config, org.apache.samza.task.TaskContext)">afterClose</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/TaskLifecycleListener.html#afterClose(org.apache.samza.config.Config,%20org.apache.samza.task.TaskContext)">afterClose</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 after all tasks in TaskRunner are closed.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
-<td class="colLast"><code><strong><a href="../../../../org/apache/samza/task/TaskLifecycleListener.html#afterInit(org.apache.samza.config.Config, org.apache.samza.task.TaskContext)">afterInit</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/TaskLifecycleListener.html#afterInit(org.apache.samza.config.Config,%20org.apache.samza.task.TaskContext)">afterInit</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 after all tasks in TaskRunner are initialized.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
-<td class="colLast"><code><strong><a href="../../../../org/apache/samza/task/TaskLifecycleListener.html#afterProcess(org.apache.samza.system.IncomingMessageEnvelope, org.apache.samza.config.Config, org.apache.samza.task.TaskContext)">afterProcess</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/TaskLifecycleListener.html#afterProcess(org.apache.samza.system.IncomingMessageEnvelope,%20org.apache.samza.config.Config,%20org.apache.samza.task.TaskContext)">afterProcess</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/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 after a message is processed by a task.</div>
@@ -132,21 +132,21 @@
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
-<td class="colLast"><code><strong><a href="../../../../org/apache/samza/task/TaskLifecycleListener.html#beforeClose(org.apache.samza.config.Config, org.apache.samza.task.TaskContext)">beforeClose</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/TaskLifecycleListener.html#beforeClose(org.apache.samza.config.Config,%20org.apache.samza.task.TaskContext)">beforeClose</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 before all tasks in TaskRunner are closed.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
-<td class="colLast"><code><strong><a href="../../../../org/apache/samza/task/TaskLifecycleListener.html#beforeInit(org.apache.samza.config.Config, org.apache.samza.task.TaskContext)">beforeInit</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/TaskLifecycleListener.html#beforeInit(org.apache.samza.config.Config,%20org.apache.samza.task.TaskContext)">beforeInit</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 before all tasks in TaskRunner are initialized.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
-<td class="colLast"><code><strong><a href="../../../../org/apache/samza/task/TaskLifecycleListener.html#beforeProcess(org.apache.samza.system.IncomingMessageEnvelope, org.apache.samza.config.Config, org.apache.samza.task.TaskContext)">beforeProcess</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/TaskLifecycleListener.html#beforeProcess(org.apache.samza.system.IncomingMessageEnvelope,%20org.apache.samza.config.Config,%20org.apache.samza.task.TaskContext)">beforeProcess</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/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 before a message is processed by a task.</div>
Modified: incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/task/TaskLifecycleListenerFactory.html
URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/task/TaskLifecycleListenerFactory.html?rev=1609230&r1=1609229&r2=1609230&view=diff
==============================================================================
--- incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/task/TaskLifecycleListenerFactory.html (original)
+++ incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/task/TaskLifecycleListenerFactory.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>TaskLifecycleListenerFactory (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">TaskLifecycleListenerFactory</span></pre>
-<div class="block">Build a <a href="../../../../org/apache/samza/task/TaskLifecycleListener.html" title="interface in org.apache.samza.task"><code>TaskLifecycleListener</code></a></div>
</li>
</ul>
</div>
@@ -109,7 +108,7 @@
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../org/apache/samza/task/TaskLifecycleListener.html" title="interface in org.apache.samza.task">TaskLifecycleListener</a></code></td>
-<td class="colLast"><code><strong><a href="../../../../org/apache/samza/task/TaskLifecycleListenerFactory.html#getLifecyleListener(java.lang.String, org.apache.samza.config.Config)">getLifecyleListener</a></strong>(java.lang.String name,
+<td class="colLast"><code><strong><a href="../../../../org/apache/samza/task/TaskLifecycleListenerFactory.html#getLifecyleListener(java.lang.String,%20org.apache.samza.config.Config)">getLifecyleListener</a></strong>(java.lang.String name,
<a href="../../../../org/apache/samza/config/Config.html" title="class in org.apache.samza.config">Config</a> config)</code> </td>
</tr>
</table>
Modified: incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/task/WindowableTask.html
URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/task/WindowableTask.html?rev=1609230&r1=1609229&r2=1609230&view=diff
==============================================================================
--- incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/task/WindowableTask.html (original)
+++ incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/task/WindowableTask.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>WindowableTask (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,7 @@
<hr>
<br>
<pre>public interface <span class="strong">WindowableTask</span></pre>
-<div class="block">Add-on interface to <a href="../../../../org/apache/samza/task/StreamTask.html" title="interface in org.apache.samza.task"><code>StreamTask</code></a> implementations to add code which will be run on
- a specified time interval (via configuration). This can be used to implement direct time-based windowing or,
- with a frequent window interval, windowing based on some other condition which is checked during the call to
- window. The window method will be called even if no messages are received for a particular StreamTask.</div>
+<div class="block">Used as a standard interface to allow user processing tasks to operate on specified time intervals, or "windows".</div>
</li>
</ul>
</div>
@@ -112,7 +109,7 @@
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
-<td class="colLast"><code><strong><a href="../../../../org/apache/samza/task/WindowableTask.html#window(org.apache.samza.task.MessageCollector, org.apache.samza.task.TaskCoordinator)">window</a></strong>(<a href="../../../../org/apache/samza/task/MessageCollector.html" title="interface in org.apache.samza.task">MessageCollector</a> collector,
+<td class="colLast"><code><strong><a href="../../../../org/apache/samza/task/WindowableTask.html#window(org.apache.samza.task.MessageCollector,%20org.apache.samza.task.TaskCoordinator)">window</a></strong>(<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 by TaskRunner for each implementing task at the end of every specified window.</div>
</td>
Modified: incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/task/package-frame.html
URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/task/package-frame.html?rev=1609230&r1=1609229&r2=1609230&view=diff
==============================================================================
--- incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/task/package-frame.html (original)
+++ incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/task/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.task (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/package-summary.html
URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/task/package-summary.html?rev=1609230&r1=1609229&r2=1609230&view=diff
==============================================================================
--- incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/task/package-summary.html (original)
+++ incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/task/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.task (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>
@@ -76,11 +76,7 @@
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/samza/task/ClosableTask.html" title="interface in org.apache.samza.task">ClosableTask</a></td>
-<td class="colLast">
-<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.</div>
-</td>
+<td class="colLast"> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/samza/task/InitableTask.html" title="interface in org.apache.samza.task">InitableTask</a></td>
@@ -98,24 +94,16 @@
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/samza/task/StreamTask.html" title="interface in org.apache.samza.task">StreamTask</a></td>
<td class="colLast">
-<div class="block">A StreamTask is the basic class on which Samza jobs are implemented.</div>
+<div class="block">Used as a standard interface for all user processing tasks.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/samza/task/TaskContext.html" title="interface in org.apache.samza.task">TaskContext</a></td>
-<td class="colLast">
-<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>
-</td>
+<td class="colLast"> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/samza/task/TaskCoordinator.html" title="interface in org.apache.samza.task">TaskCoordinator</a></td>
-<td class="colLast">
-<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.</div>
-</td>
+<td class="colLast"> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/samza/task/TaskLifecycleListener.html" title="interface in org.apache.samza.task">TaskLifecycleListener</a></td>
@@ -126,15 +114,12 @@
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/samza/task/TaskLifecycleListenerFactory.html" title="interface in org.apache.samza.task">TaskLifecycleListenerFactory</a></td>
-<td class="colLast">
-<div class="block">Build a <a href="../../../../org/apache/samza/task/TaskLifecycleListener.html" title="interface in org.apache.samza.task"><code>TaskLifecycleListener</code></a></div>
-</td>
+<td class="colLast"> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/samza/task/WindowableTask.html" title="interface in org.apache.samza.task">WindowableTask</a></td>
<td class="colLast">
-<div class="block">Add-on interface to <a href="../../../../org/apache/samza/task/StreamTask.html" title="interface in org.apache.samza.task"><code>StreamTask</code></a> implementations to add code which will be run on
- a specified time interval (via configuration).</div>
+<div class="block">Used as a standard interface to allow user processing tasks to operate on specified time intervals, or "windows".</div>
</td>
</tr>
</tbody>
Modified: incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/task/package-tree.html
URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/task/package-tree.html?rev=1609230&r1=1609229&r2=1609230&view=diff
==============================================================================
--- incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/task/package-tree.html (original)
+++ incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/task/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.task 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/util/BlockingEnvelopeMap.BlockingEnvelopeMapMetrics.html
URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/util/BlockingEnvelopeMap.BlockingEnvelopeMapMetrics.html?rev=1609230&r1=1609229&r2=1609230&view=diff
==============================================================================
--- incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/util/BlockingEnvelopeMap.BlockingEnvelopeMapMetrics.html (original)
+++ incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/util/BlockingEnvelopeMap.BlockingEnvelopeMapMetrics.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>BlockingEnvelopeMap.BlockingEnvelopeMapMetrics (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>
@@ -119,7 +119,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/util/BlockingEnvelopeMap.BlockingEnvelopeMapMetrics.html#BlockingEnvelopeMap.BlockingEnvelopeMapMetrics(java.lang.String, org.apache.samza.metrics.MetricsRegistry)">BlockingEnvelopeMap.BlockingEnvelopeMapMetrics</a></strong>(java.lang.String group,
+<td class="colOne"><code><strong><a href="../../../../org/apache/samza/util/BlockingEnvelopeMap.BlockingEnvelopeMapMetrics.html#BlockingEnvelopeMap.BlockingEnvelopeMapMetrics(java.lang.String,%20org.apache.samza.metrics.MetricsRegistry)">BlockingEnvelopeMap.BlockingEnvelopeMapMetrics</a></strong>(java.lang.String group,
<a href="../../../../org/apache/samza/metrics/MetricsRegistry.html" title="interface in org.apache.samza.metrics">MetricsRegistry</a> metricsRegistry)</code> </td>
</tr>
</table>
@@ -155,7 +155,7 @@ extends java.lang.Object</pre>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
-<td class="colLast"><code><strong><a href="../../../../org/apache/samza/util/BlockingEnvelopeMap.BlockingEnvelopeMapMetrics.html#setNoMoreMessages(org.apache.samza.system.SystemStreamPartition, boolean)">setNoMoreMessages</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/util/BlockingEnvelopeMap.BlockingEnvelopeMapMetrics.html#setNoMoreMessages(org.apache.samza.system.SystemStreamPartition,%20boolean)">setNoMoreMessages</a></strong>(<a href="../../../../org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system">SystemStreamPartition</a> systemStreamPartition,
boolean noMoreMessages)</code> </td>
</tr>
</table>
Modified: incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/util/BlockingEnvelopeMap.BufferGauge.html
URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/util/BlockingEnvelopeMap.BufferGauge.html?rev=1609230&r1=1609229&r2=1609230&view=diff
==============================================================================
--- incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/util/BlockingEnvelopeMap.BufferGauge.html (original)
+++ incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/util/BlockingEnvelopeMap.BufferGauge.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>BlockingEnvelopeMap.BufferGauge (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>
@@ -128,7 +128,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/util/BlockingEnvelopeMap.BufferGauge.html#BlockingEnvelopeMap.BufferGauge(org.apache.samza.system.SystemStreamPartition, java.lang.String)">BlockingEnvelopeMap.BufferGauge</a></strong>(<a href="../../../../org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system">SystemStreamPartition</a> systemStreamPartition,
+<td class="colOne"><code><strong><a href="../../../../org/apache/samza/util/BlockingEnvelopeMap.BufferGauge.html#BlockingEnvelopeMap.BufferGauge(org.apache.samza.system.SystemStreamPartition,%20java.lang.String)">BlockingEnvelopeMap.BufferGauge</a></strong>(<a href="../../../../org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system">SystemStreamPartition</a> systemStreamPartition,
java.lang.String name)</code> </td>
</tr>
</table>
@@ -156,7 +156,7 @@ extends <a href="../../../../org/apache/
<!-- -->
</a>
<h3>Methods inherited from class org.apache.samza.metrics.<a href="../../../../org/apache/samza/metrics/Gauge.html" title="class in org.apache.samza.metrics">Gauge</a></h3>
-<code><a href="../../../../org/apache/samza/metrics/Gauge.html#compareAndSet(T, T)">compareAndSet</a>, <a href="../../../../org/apache/samza/metrics/Gauge.html#getName()">getName</a>, <a href="../../../../org/apache/samza/metrics/Gauge.html#set(T)">set</a>, <a href="../../../../org/apache/samza/metrics/Gauge.html#toString()">toString</a>, <a href="../../../../org/apache/samza/metrics/Gauge.html#visit(org.apache.samza.metrics.MetricsVisitor)">visit</a></code></li>
+<code><a href="../../../../org/apache/samza/metrics/Gauge.html#compareAndSet(T,%20T)">compareAndSet</a>, <a href="../../../../org/apache/samza/metrics/Gauge.html#getName()">getName</a>, <a href="../../../../org/apache/samza/metrics/Gauge.html#set(T)">set</a>, <a href="../../../../org/apache/samza/metrics/Gauge.html#toString()">toString</a>, <a href="../../../../org/apache/samza/metrics/Gauge.html#visit(org.apache.samza.metrics.MetricsVisitor)">visit</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
Modified: incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/util/BlockingEnvelopeMap.html
URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/util/BlockingEnvelopeMap.html?rev=1609230&r1=1609229&r2=1609230&view=diff
==============================================================================
--- incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/util/BlockingEnvelopeMap.html (original)
+++ incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/util/BlockingEnvelopeMap.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>BlockingEnvelopeMap (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>
@@ -106,9 +106,7 @@ implements <a href="../../../../org/apac
BlockingEnvelopeMap is a helper class for SystemConsumer implementations.
Samza's poll() requirements make implementing SystemConsumers somewhat
tricky. BlockingEnvelopeMap is provided to help other developers write
- SystemConsumers. The intended audience is not those writing Samza jobs,
- but rather those extending Samza to consume from new types of stream providers
- and other systems.
+ SystemConsumers.
</p>
<p>
@@ -185,11 +183,11 @@ implements <a href="../../../../org/apac
<td class="colOne"><code><strong><a href="../../../../org/apache/samza/util/BlockingEnvelopeMap.html#BlockingEnvelopeMap(org.apache.samza.metrics.MetricsRegistry)">BlockingEnvelopeMap</a></strong>(<a href="../../../../org/apache/samza/metrics/MetricsRegistry.html" title="interface in org.apache.samza.metrics">MetricsRegistry</a> metricsRegistry)</code> </td>
</tr>
<tr class="rowColor">
-<td class="colOne"><code><strong><a href="../../../../org/apache/samza/util/BlockingEnvelopeMap.html#BlockingEnvelopeMap(org.apache.samza.metrics.MetricsRegistry, org.apache.samza.util.Clock)">BlockingEnvelopeMap</a></strong>(<a href="../../../../org/apache/samza/metrics/MetricsRegistry.html" title="interface in org.apache.samza.metrics">MetricsRegistry</a> metricsRegistry,
+<td class="colOne"><code><strong><a href="../../../../org/apache/samza/util/BlockingEnvelopeMap.html#BlockingEnvelopeMap(org.apache.samza.metrics.MetricsRegistry,%20org.apache.samza.util.Clock)">BlockingEnvelopeMap</a></strong>(<a href="../../../../org/apache/samza/metrics/MetricsRegistry.html" title="interface in org.apache.samza.metrics">MetricsRegistry</a> metricsRegistry,
<a href="../../../../org/apache/samza/util/Clock.html" title="interface in org.apache.samza.util">Clock</a> clock)</code> </td>
</tr>
<tr class="altColor">
-<td class="colOne"><code><strong><a href="../../../../org/apache/samza/util/BlockingEnvelopeMap.html#BlockingEnvelopeMap(org.apache.samza.metrics.MetricsRegistry, org.apache.samza.util.Clock, java.lang.String)">BlockingEnvelopeMap</a></strong>(<a href="../../../../org/apache/samza/metrics/MetricsRegistry.html" title="interface in org.apache.samza.metrics">MetricsRegistry</a> metricsRegistry,
+<td class="colOne"><code><strong><a href="../../../../org/apache/samza/util/BlockingEnvelopeMap.html#BlockingEnvelopeMap(org.apache.samza.metrics.MetricsRegistry,%20org.apache.samza.util.Clock,%20java.lang.String)">BlockingEnvelopeMap</a></strong>(<a href="../../../../org/apache/samza/metrics/MetricsRegistry.html" title="interface in org.apache.samza.metrics">MetricsRegistry</a> metricsRegistry,
<a href="../../../../org/apache/samza/util/Clock.html" title="interface in org.apache.samza.util">Clock</a> clock,
java.lang.String metricsGroupName)</code> </td>
</tr>
@@ -222,7 +220,7 @@ implements <a href="../../../../org/apac
</tr>
<tr class="rowColor">
<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/util/BlockingEnvelopeMap.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> systemStreamPartitionAndMaxPerStream,
+<td class="colLast"><code><strong><a href="../../../../org/apache/samza/util/BlockingEnvelopeMap.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> systemStreamPartitionAndMaxPerStream,
long timeout)</code>
<div class="block">Poll the SystemConsumer to get any available messages from the underlying
system.</div>
@@ -230,24 +228,24 @@ implements <a href="../../../../org/apac
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected void</code></td>
-<td class="colLast"><code><strong><a href="../../../../org/apache/samza/util/BlockingEnvelopeMap.html#put(org.apache.samza.system.SystemStreamPartition, org.apache.samza.system.IncomingMessageEnvelope)">put</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/util/BlockingEnvelopeMap.html#put(org.apache.samza.system.SystemStreamPartition,%20org.apache.samza.system.IncomingMessageEnvelope)">put</a></strong>(<a href="../../../../org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system">SystemStreamPartition</a> systemStreamPartition,
<a href="../../../../org/apache/samza/system/IncomingMessageEnvelope.html" title="class in org.apache.samza.system">IncomingMessageEnvelope</a> envelope)</code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected void</code></td>
-<td class="colLast"><code><strong><a href="../../../../org/apache/samza/util/BlockingEnvelopeMap.html#putAll(org.apache.samza.system.SystemStreamPartition, java.util.List)">putAll</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/util/BlockingEnvelopeMap.html#putAll(org.apache.samza.system.SystemStreamPartition,%20java.util.List)">putAll</a></strong>(<a href="../../../../org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system">SystemStreamPartition</a> systemStreamPartition,
java.util.List<<a href="../../../../org/apache/samza/system/IncomingMessageEnvelope.html" title="class in org.apache.samza.system">IncomingMessageEnvelope</a>> envelopes)</code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
-<td class="colLast"><code><strong><a href="../../../../org/apache/samza/util/BlockingEnvelopeMap.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/util/BlockingEnvelopeMap.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>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected java.lang.Boolean</code></td>
-<td class="colLast"><code><strong><a href="../../../../org/apache/samza/util/BlockingEnvelopeMap.html#setIsAtHead(org.apache.samza.system.SystemStreamPartition, boolean)">setIsAtHead</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/util/BlockingEnvelopeMap.html#setIsAtHead(org.apache.samza.system.SystemStreamPartition,%20boolean)">setIsAtHead</a></strong>(<a href="../../../../org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system">SystemStreamPartition</a> systemStreamPartition,
boolean isAtHead)</code> </td>
</tr>
</table>
@@ -343,14 +341,14 @@ implements <a href="../../../../org/apac
<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/SystemConsumer.html#register(org.apache.samza.system.SystemStreamPartition, java.lang.String)">SystemConsumer</a></code></strong></div>
+<div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/samza/system/SystemConsumer.html#register(org.apache.samza.system.SystemStreamPartition,%20java.lang.String)">SystemConsumer</a></code></strong></div>
<div class="block">Register a SystemStreamPartition to this SystemConsumer. The SystemConsumer
should try and read messages from all SystemStreamPartitions that are
registered to it. SystemStreamPartitions should only be registered before
start is called.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
-<dd><code><a href="../../../../org/apache/samza/system/SystemConsumer.html#register(org.apache.samza.system.SystemStreamPartition, java.lang.String)">register</a></code> in interface <code><a href="../../../../org/apache/samza/system/SystemConsumer.html" title="interface in org.apache.samza.system">SystemConsumer</a></code></dd>
+<dd><code><a href="../../../../org/apache/samza/system/SystemConsumer.html#register(org.apache.samza.system.SystemStreamPartition,%20java.lang.String)">register</a></code> in interface <code><a href="../../../../org/apache/samza/system/SystemConsumer.html" title="interface in org.apache.samza.system">SystemConsumer</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>systemStreamPartition</code> - The SystemStreamPartition object representing the Samza
SystemStreamPartition to receive messages from.</dd><dd><code>offset</code> - String representing the offset of the point in the stream to start
reading messages from. This is an inclusive parameter; if "7" were
@@ -376,18 +374,18 @@ implements <a href="../../../../org/apac
<pre>public java.util.List<<a href="../../../../org/apache/samza/system/IncomingMessageEnvelope.html" title="class in org.apache.samza.system">IncomingMessageEnvelope</a>> poll(java.util.Map<<a href="../../../../org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system">SystemStreamPartition</a>,java.lang.Integer> systemStreamPartitionAndMaxPerStream,
long timeout)
throws java.lang.InterruptedException</pre>
-<div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/samza/system/SystemConsumer.html#poll(java.util.Map, long)">SystemConsumer</a></code></strong></div>
+<div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/samza/system/SystemConsumer.html#poll(java.util.Map,%20long)">SystemConsumer</a></code></strong></div>
<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
be processed while blocking is occurring.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
-<dd><code><a href="../../../../org/apache/samza/system/SystemConsumer.html#poll(java.util.Map, long)">poll</a></code> in interface <code><a href="../../../../org/apache/samza/system/SystemConsumer.html" title="interface in org.apache.samza.system">SystemConsumer</a></code></dd>
+<dd><code><a href="../../../../org/apache/samza/system/SystemConsumer.html#poll(java.util.Map,%20long)">poll</a></code> in interface <code><a href="../../../../org/apache/samza/system/SystemConsumer.html" title="interface in org.apache.samza.system">SystemConsumer</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>systemStreamPartitionAndMaxPerStream</code> - A map from SystemStreamPartition to maximum number of messages to
return for the SystemStreamPartition. Polling with {stream1: 100,
stream2: 1000} tells the SystemConsumer that it can return between
Modified: incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/util/Clock.html
URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/util/Clock.html?rev=1609230&r1=1609229&r2=1609230&view=diff
==============================================================================
--- incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/util/Clock.html (original)
+++ incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/util/Clock.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>Clock (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">Clock</span></pre>
-<div class="block">Mockable interface for tracking time.</div>
</li>
</ul>
</div>
Modified: incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/util/NoOpMetricsRegistry.html
URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/util/NoOpMetricsRegistry.html?rev=1609230&r1=1609229&r2=1609230&view=diff
==============================================================================
--- incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/util/NoOpMetricsRegistry.html (original)
+++ incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/util/NoOpMetricsRegistry.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>NoOpMetricsRegistry (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">NoOpMetricsRegistry</span>
extends java.lang.Object
implements <a href="../../../../org/apache/samza/metrics/MetricsRegistry.html" title="interface in org.apache.samza.metrics">MetricsRegistry</a></pre>
-<div class="block"><a href="../../../../org/apache/samza/metrics/MetricsRegistry.html" title="interface in org.apache.samza.metrics"><code>MetricsRegistry</code></a> implementation for when no actual metrics need to be
- recorded but a registry is still required.</div>
</li>
</ul>
</div>
@@ -141,32 +139,24 @@ implements <a href="../../../../org/apac
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../org/apache/samza/metrics/Counter.html" title="class in org.apache.samza.metrics">Counter</a></code></td>
-<td class="colLast"><code><strong><a href="../../../../org/apache/samza/util/NoOpMetricsRegistry.html#newCounter(java.lang.String, org.apache.samza.metrics.Counter)">newCounter</a></strong>(java.lang.String group,
- <a href="../../../../org/apache/samza/metrics/Counter.html" title="class in org.apache.samza.metrics">Counter</a> counter)</code>
-<div class="block">Register existing <a href="../../../../org/apache/samza/metrics/Counter.html" title="class in org.apache.samza.metrics"><code>Counter</code></a> with this registry</div>
-</td>
+<td class="colLast"><code><strong><a href="../../../../org/apache/samza/util/NoOpMetricsRegistry.html#newCounter(java.lang.String,%20org.apache.samza.metrics.Counter)">newCounter</a></strong>(java.lang.String group,
+ <a href="../../../../org/apache/samza/metrics/Counter.html" title="class in org.apache.samza.metrics">Counter</a> counter)</code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../org/apache/samza/metrics/Counter.html" title="class in org.apache.samza.metrics">Counter</a></code></td>
-<td class="colLast"><code><strong><a href="../../../../org/apache/samza/util/NoOpMetricsRegistry.html#newCounter(java.lang.String, java.lang.String)">newCounter</a></strong>(java.lang.String group,
- java.lang.String name)</code>
-<div class="block">Create and register a new <a href="../../../../org/apache/samza/metrics/Counter.html" title="class in org.apache.samza.metrics"><code>Counter</code></a></div>
-</td>
+<td class="colLast"><code><strong><a href="../../../../org/apache/samza/util/NoOpMetricsRegistry.html#newCounter(java.lang.String,%20java.lang.String)">newCounter</a></strong>(java.lang.String group,
+ java.lang.String name)</code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><T> <a href="../../../../org/apache/samza/metrics/Gauge.html" title="class in org.apache.samza.metrics">Gauge</a><T></code></td>
-<td class="colLast"><code><strong><a href="../../../../org/apache/samza/util/NoOpMetricsRegistry.html#newGauge(java.lang.String, org.apache.samza.metrics.Gauge)">newGauge</a></strong>(java.lang.String group,
- <a href="../../../../org/apache/samza/metrics/Gauge.html" title="class in org.apache.samza.metrics">Gauge</a><T> gauge)</code>
-<div class="block">Register an existing <a href="../../../../org/apache/samza/metrics/Gauge.html" title="class in org.apache.samza.metrics"><code>Gauge</code></a></div>
-</td>
+<td class="colLast"><code><strong><a href="../../../../org/apache/samza/util/NoOpMetricsRegistry.html#newGauge(java.lang.String,%20org.apache.samza.metrics.Gauge)">newGauge</a></strong>(java.lang.String group,
+ <a href="../../../../org/apache/samza/metrics/Gauge.html" title="class in org.apache.samza.metrics">Gauge</a><T> gauge)</code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><T> <a href="../../../../org/apache/samza/metrics/Gauge.html" title="class in org.apache.samza.metrics">Gauge</a><T></code></td>
-<td class="colLast"><code><strong><a href="../../../../org/apache/samza/util/NoOpMetricsRegistry.html#newGauge(java.lang.String, java.lang.String, T)">newGauge</a></strong>(java.lang.String group,
+<td class="colLast"><code><strong><a href="../../../../org/apache/samza/util/NoOpMetricsRegistry.html#newGauge(java.lang.String,%20java.lang.String,%20T)">newGauge</a></strong>(java.lang.String group,
java.lang.String name,
- T value)</code>
-<div class="block">Create and register a new <a href="../../../../org/apache/samza/metrics/Gauge.html" title="class in org.apache.samza.metrics"><code>Gauge</code></a></div>
-</td>
+ T value)</code> </td>
</tr>
</table>
<ul class="blockList">
@@ -215,13 +205,10 @@ implements <a href="../../../../org/apac
<h4>newCounter</h4>
<pre>public <a href="../../../../org/apache/samza/metrics/Counter.html" title="class in org.apache.samza.metrics">Counter</a> newCounter(java.lang.String group,
java.lang.String name)</pre>
-<div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/samza/metrics/MetricsRegistry.html#newCounter(java.lang.String, java.lang.String)">MetricsRegistry</a></code></strong></div>
-<div class="block">Create and register a new <a href="../../../../org/apache/samza/metrics/Counter.html" title="class in org.apache.samza.metrics"><code>Counter</code></a></div>
<dl>
<dt><strong>Specified by:</strong></dt>
-<dd><code><a href="../../../../org/apache/samza/metrics/MetricsRegistry.html#newCounter(java.lang.String, java.lang.String)">newCounter</a></code> in interface <code><a href="../../../../org/apache/samza/metrics/MetricsRegistry.html" title="interface in org.apache.samza.metrics">MetricsRegistry</a></code></dd>
-<dt><span class="strong">Parameters:</span></dt><dd><code>group</code> - Group for this Counter</dd><dd><code>name</code> - Name of to-be-created Counter</dd>
-<dt><span class="strong">Returns:</span></dt><dd>New Counter instance</dd></dl>
+<dd><code><a href="../../../../org/apache/samza/metrics/MetricsRegistry.html#newCounter(java.lang.String,%20java.lang.String)">newCounter</a></code> in interface <code><a href="../../../../org/apache/samza/metrics/MetricsRegistry.html" title="interface in org.apache.samza.metrics">MetricsRegistry</a></code></dd>
+</dl>
</li>
</ul>
<a name="newCounter(java.lang.String, org.apache.samza.metrics.Counter)">
@@ -232,13 +219,10 @@ implements <a href="../../../../org/apac
<h4>newCounter</h4>
<pre>public <a href="../../../../org/apache/samza/metrics/Counter.html" title="class in org.apache.samza.metrics">Counter</a> newCounter(java.lang.String group,
<a href="../../../../org/apache/samza/metrics/Counter.html" title="class in org.apache.samza.metrics">Counter</a> counter)</pre>
-<div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/samza/metrics/MetricsRegistry.html#newCounter(java.lang.String, org.apache.samza.metrics.Counter)">MetricsRegistry</a></code></strong></div>
-<div class="block">Register existing <a href="../../../../org/apache/samza/metrics/Counter.html" title="class in org.apache.samza.metrics"><code>Counter</code></a> with this registry</div>
<dl>
<dt><strong>Specified by:</strong></dt>
-<dd><code><a href="../../../../org/apache/samza/metrics/MetricsRegistry.html#newCounter(java.lang.String, org.apache.samza.metrics.Counter)">newCounter</a></code> in interface <code><a href="../../../../org/apache/samza/metrics/MetricsRegistry.html" title="interface in org.apache.samza.metrics">MetricsRegistry</a></code></dd>
-<dt><span class="strong">Parameters:</span></dt><dd><code>group</code> - Group for this Counter</dd><dd><code>counter</code> - Existing Counter to register</dd>
-<dt><span class="strong">Returns:</span></dt><dd>Counter that was registered</dd></dl>
+<dd><code><a href="../../../../org/apache/samza/metrics/MetricsRegistry.html#newCounter(java.lang.String,%20org.apache.samza.metrics.Counter)">newCounter</a></code> in interface <code><a href="../../../../org/apache/samza/metrics/MetricsRegistry.html" title="interface in org.apache.samza.metrics">MetricsRegistry</a></code></dd>
+</dl>
</li>
</ul>
<a name="newGauge(java.lang.String,java.lang.String,java.lang.Object)">
@@ -252,13 +236,10 @@ implements <a href="../../../../org/apac
<pre>public <T> <a href="../../../../org/apache/samza/metrics/Gauge.html" title="class in org.apache.samza.metrics">Gauge</a><T> newGauge(java.lang.String group,
java.lang.String name,
T value)</pre>
-<div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/samza/metrics/MetricsRegistry.html#newGauge(java.lang.String, java.lang.String, T)">MetricsRegistry</a></code></strong></div>
-<div class="block">Create and register a new <a href="../../../../org/apache/samza/metrics/Gauge.html" title="class in org.apache.samza.metrics"><code>Gauge</code></a></div>
<dl>
<dt><strong>Specified by:</strong></dt>
-<dd><code><a href="../../../../org/apache/samza/metrics/MetricsRegistry.html#newGauge(java.lang.String, java.lang.String, T)">newGauge</a></code> in interface <code><a href="../../../../org/apache/samza/metrics/MetricsRegistry.html" title="interface in org.apache.samza.metrics">MetricsRegistry</a></code></dd>
-<dt><span class="strong">Type Parameters:</span></dt><dd><code>T</code> - Type the Gauge will be wrapping</dd><dt><span class="strong">Parameters:</span></dt><dd><code>group</code> - Group for this Gauge</dd><dd><code>name</code> - Name of to-be-created Gauge</dd><dd><code>value</code> - Initial value for the Gauge</dd>
-<dt><span class="strong">Returns:</span></dt><dd>Gauge was created and registered</dd></dl>
+<dd><code><a href="../../../../org/apache/samza/metrics/MetricsRegistry.html#newGauge(java.lang.String,%20java.lang.String,%20T)">newGauge</a></code> in interface <code><a href="../../../../org/apache/samza/metrics/MetricsRegistry.html" title="interface in org.apache.samza.metrics">MetricsRegistry</a></code></dd>
+</dl>
</li>
</ul>
<a name="newGauge(java.lang.String, org.apache.samza.metrics.Gauge)">
@@ -269,13 +250,10 @@ implements <a href="../../../../org/apac
<h4>newGauge</h4>
<pre>public <T> <a href="../../../../org/apache/samza/metrics/Gauge.html" title="class in org.apache.samza.metrics">Gauge</a><T> newGauge(java.lang.String group,
<a href="../../../../org/apache/samza/metrics/Gauge.html" title="class in org.apache.samza.metrics">Gauge</a><T> gauge)</pre>
-<div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/samza/metrics/MetricsRegistry.html#newGauge(java.lang.String, org.apache.samza.metrics.Gauge)">MetricsRegistry</a></code></strong></div>
-<div class="block">Register an existing <a href="../../../../org/apache/samza/metrics/Gauge.html" title="class in org.apache.samza.metrics"><code>Gauge</code></a></div>
<dl>
<dt><strong>Specified by:</strong></dt>
-<dd><code><a href="../../../../org/apache/samza/metrics/MetricsRegistry.html#newGauge(java.lang.String, org.apache.samza.metrics.Gauge)">newGauge</a></code> in interface <code><a href="../../../../org/apache/samza/metrics/MetricsRegistry.html" title="interface in org.apache.samza.metrics">MetricsRegistry</a></code></dd>
-<dt><span class="strong">Type Parameters:</span></dt><dd><code>T</code> - Type the Gauge will be wrapping</dd><dt><span class="strong">Parameters:</span></dt><dd><code>group</code> - Group for this Gauge</dd><dd><code>gauge</code> - Initial value for the Gauge</dd>
-<dt><span class="strong">Returns:</span></dt><dd>Gauge was registered</dd></dl>
+<dd><code><a href="../../../../org/apache/samza/metrics/MetricsRegistry.html#newGauge(java.lang.String,%20org.apache.samza.metrics.Gauge)">newGauge</a></code> in interface <code><a href="../../../../org/apache/samza/metrics/MetricsRegistry.html" title="interface in org.apache.samza.metrics">MetricsRegistry</a></code></dd>
+</dl>
</li>
</ul>
</li>
Modified: incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/util/SinglePartitionWithoutOffsetsSystemAdmin.html
URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/util/SinglePartitionWithoutOffsetsSystemAdmin.html?rev=1609230&r1=1609229&r2=1609230&view=diff
==============================================================================
--- incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/util/SinglePartitionWithoutOffsetsSystemAdmin.html (original)
+++ incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/util/SinglePartitionWithoutOffsetsSystemAdmin.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>SinglePartitionWithoutOffsetsSystemAdmin (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/util/package-frame.html
URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/util/package-frame.html?rev=1609230&r1=1609229&r2=1609230&view=diff
==============================================================================
--- incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/util/package-frame.html (original)
+++ incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/util/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.util (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/util/package-summary.html
URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/util/package-summary.html?rev=1609230&r1=1609229&r2=1609230&view=diff
==============================================================================
--- incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/util/package-summary.html (original)
+++ incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/util/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.util (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>
@@ -76,9 +76,7 @@
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/samza/util/Clock.html" title="interface in org.apache.samza.util">Clock</a></td>
-<td class="colLast">
-<div class="block">Mockable interface for tracking time.</div>
-</td>
+<td class="colLast"> </td>
</tr>
</tbody>
</table>
@@ -100,10 +98,7 @@
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/samza/util/NoOpMetricsRegistry.html" title="class in org.apache.samza.util">NoOpMetricsRegistry</a></td>
-<td class="colLast">
-<div class="block"><a href="../../../../org/apache/samza/metrics/MetricsRegistry.html" title="interface in org.apache.samza.metrics"><code>MetricsRegistry</code></a> implementation for when no actual metrics need to be
- recorded but a registry is still required.</div>
-</td>
+<td class="colLast"> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/samza/util/SinglePartitionWithoutOffsetsSystemAdmin.html" title="class in org.apache.samza.util">SinglePartitionWithoutOffsetsSystemAdmin</a></td>
Modified: incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/util/package-tree.html
URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/util/package-tree.html?rev=1609230&r1=1609229&r2=1609230&view=diff
==============================================================================
--- incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/util/package-tree.html (original)
+++ incubator/samza/site/learn/documentation/0.7.0/api/javadocs/org/apache/samza/util/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.util 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/overview-frame.html
URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.7.0/api/javadocs/overview-frame.html?rev=1609230&r1=1609229&r2=1609230&view=diff
==============================================================================
--- incubator/samza/site/learn/documentation/0.7.0/api/javadocs/overview-frame.html (original)
+++ incubator/samza/site/learn/documentation/0.7.0/api/javadocs/overview-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>Overview List (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/overview-summary.html
URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.7.0/api/javadocs/overview-summary.html?rev=1609230&r1=1609229&r2=1609230&view=diff
==============================================================================
--- incubator/samza/site/learn/documentation/0.7.0/api/javadocs/overview-summary.html (original)
+++ incubator/samza/site/learn/documentation/0.7.0/api/javadocs/overview-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:18 PDT 2014 -->
+<!-- Generated by javadoc (version 1.7.0_60) on Wed Jul 09 09:32:50 PDT 2014 -->
<title>Overview (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/overview-tree.html
URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.7.0/api/javadocs/overview-tree.html?rev=1609230&r1=1609229&r2=1609230&view=diff
==============================================================================
--- incubator/samza/site/learn/documentation/0.7.0/api/javadocs/overview-tree.html (original)
+++ incubator/samza/site/learn/documentation/0.7.0/api/javadocs/overview-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:18 PDT 2014 -->
+<!-- Generated by javadoc (version 1.7.0_60) on Wed Jul 09 09:32:50 PDT 2014 -->
<title>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>
@@ -189,6 +189,8 @@
<li type="circle">java.lang.Enum<E> (implements java.lang.Comparable<T>, java.io.Serializable)
<ul>
<li type="circle">org.apache.samza.job.<a href="org/apache/samza/job/ApplicationStatus.html" title="enum in org.apache.samza.job"><span class="strong">ApplicationStatus</span></a></li>
+<li type="circle">org.apache.samza.metrics.<a href="org/apache/samza/metrics/DataType.html" title="enum in org.apache.samza.metrics"><span class="strong">DataType</span></a></li>
+<li type="circle">org.apache.samza.metrics.<a href="org/apache/samza/metrics/MetricsType.html" title="enum in org.apache.samza.metrics"><span class="strong">MetricsType</span></a></li>
<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>
<li type="circle">org.apache.samza.task.<a href="org/apache/samza/task/TaskCoordinator.RequestScope.html" title="enum in org.apache.samza.task"><span class="strong">TaskCoordinator.RequestScope</span></a></li>
</ul>
Modified: incubator/samza/site/learn/documentation/0.7.0/api/javadocs/serialized-form.html
URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.7.0/api/javadocs/serialized-form.html?rev=1609230&r1=1609229&r2=1609230&view=diff
==============================================================================
--- incubator/samza/site/learn/documentation/0.7.0/api/javadocs/serialized-form.html (original)
+++ incubator/samza/site/learn/documentation/0.7.0/api/javadocs/serialized-form.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:18 PDT 2014 -->
+<!-- Generated by javadoc (version 1.7.0_60) on Wed Jul 09 09:32:50 PDT 2014 -->
<title>Serialized Form (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/overview.html
URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.7.0/api/overview.html?rev=1609230&r1=1609229&r2=1609230&view=diff
==============================================================================
--- incubator/samza/site/learn/documentation/0.7.0/api/overview.html (original)
+++ incubator/samza/site/learn/documentation/0.7.0/api/overview.html Wed Jul 9 16:34:23 2014
@@ -23,7 +23,6 @@
<link href="/css/bootstrap.min.css" rel="stylesheet"/>
<link href="/css/font-awesome.min.css" rel="stylesheet"/>
<link href="/css/main.css" rel="stylesheet"/>
- <link href="/css/syntax.css" rel="stylesheet"/>
<link rel="icon" type="image/png" href="/img/samza-icon.png">
</head>
<body>
@@ -124,57 +123,54 @@
-->
<p>When writing a stream processor for Samza, you must implement the <a href="javadocs/org/apache/samza/task/StreamTask.html">StreamTask</a> interface:</p>
+<div class="highlight"><pre><code class="language-text" data-lang="text">package com.example.samza;
-<div class="highlight"><pre><code class="java"><span class="kn">package</span> <span class="n">com</span><span class="o">.</span><span class="na">example</span><span class="o">.</span><span class="na">samza</span><span class="o">;</span>
-
-<span class="kd">public</span> <span class="kd">class</span> <span class="nc">MyTaskClass</span> <span class="kd">implements</span> <span class="n">StreamTask</span> <span class="o">{</span>
-
- <span class="kd">public</span> <span class="kt">void</span> <span class="nf">process</span><span class="o">(</span><span class="n">IncomingMessageEnvelope</span> <span class="n">envelope</span><span class="o">,</span>
- <span class="n">MessageCollector</span> <span class="n">collector</span><span class="o">,</span>
- <span class="n">TaskCoordinator</span> <span class="n">coordinator</span><span class="o">)</span> <span class="o">{</span>
- <span class="c1">// process message</span>
- <span class="o">}</span>
-<span class="o">}</span></code></pre></div>
+public class MyTaskClass implements StreamTask {
+ public void process(IncomingMessageEnvelope envelope,
+ MessageCollector collector,
+ TaskCoordinator coordinator) {
+ // process message
+ }
+}
+</code></pre></div>
<p>When you run your job, Samza will create several instances of your class (potentially on multiple machines). These task instances process the messages in the input streams.</p>
<p>In your job’s configuration you can tell Samza which streams you want to consume. An incomplete example could look like this (see the <a href="../jobs/configuration.html">configuration documentation</a> for more detail):</p>
+<div class="highlight"><pre><code class="language-text" data-lang="text"># This is the class above, which Samza will instantiate when the job is run
+task.class=com.example.samza.MyTaskClass
-<div class="highlight"><pre><code class="jproperties"><span class="c"># This is the class above, which Samza will instantiate when the job is run</span>
-<span class="na">task.class</span><span class="o">=</span><span class="s">com.example.samza.MyTaskClass</span>
-
-<span class="c"># Define a system called "kafka" (you can give it any name, and you can define</span>
-<span class="c"># multiple systems if you want to process messages from different sources)</span>
-<span class="na">systems.kafka.samza.factory</span><span class="o">=</span><span class="s">org.apache.samza.system.kafka.KafkaSystemFactory</span>
-
-<span class="c"># The job consumes a topic called "PageViewEvent" from the "kafka" system</span>
-<span class="na">task.inputs</span><span class="o">=</span><span class="s">kafka.PageViewEvent</span>
-
-<span class="c"># Define a serializer/deserializer called "json" which parses JSON messages</span>
-<span class="na">serializers.registry.json.class</span><span class="o">=</span><span class="s">org.apache.samza.serializers.JsonSerdeFactory</span>
-
-<span class="c"># Use the "json" serializer for messages in the "PageViewEvent" topic</span>
-<span class="na">systems.kafka.streams.PageViewEvent.samza.msg.serde</span><span class="o">=</span><span class="s">json</span></code></pre></div>
-
+# Define a system called "kafka" (you can give it any name, and you can define
+# multiple systems if you want to process messages from different sources)
+systems.kafka.samza.factory=org.apache.samza.system.kafka.KafkaSystemFactory
+
+# The job consumes a topic called "PageViewEvent" from the "kafka" system
+task.inputs=kafka.PageViewEvent
+
+# Define a serializer/deserializer called "json" which parses JSON messages
+serializers.registry.json.class=org.apache.samza.serializers.JsonSerdeFactory
+
+# Use the "json" serializer for messages in the "PageViewEvent" topic
+systems.kafka.streams.PageViewEvent.samza.msg.serde=json
+</code></pre></div>
<p>For each message that Samza receives from the task’s input streams, the <em>process</em> method is called. The <a href="javadocs/org/apache/samza/system/IncomingMessageEnvelope.html">envelope</a> contains three things of importance: the message, the key, and the stream that the message came from.</p>
-
-<div class="highlight"><pre><code class="java"><span class="cm">/** Every message that is delivered to a StreamTask is wrapped</span>
-<span class="cm"> * in an IncomingMessageEnvelope, which contains metadata about</span>
-<span class="cm"> * the origin of the message. */</span>
-<span class="kd">public</span> <span class="kd">class</span> <span class="nc">IncomingMessageEnvelope</span> <span class="o">{</span>
- <span class="cm">/** A deserialized message. */</span>
- <span class="n">Object</span> <span class="nf">getMessage</span><span class="o">()</span> <span class="o">{</span> <span class="o">...</span> <span class="o">}</span>
-
- <span class="cm">/** A deserialized key. */</span>
- <span class="n">Object</span> <span class="nf">getKey</span><span class="o">()</span> <span class="o">{</span> <span class="o">...</span> <span class="o">}</span>
-
- <span class="cm">/** The stream and partition that this message came from. */</span>
- <span class="n">SystemStreamPartition</span> <span class="nf">getSystemStreamPartition</span><span class="o">()</span> <span class="o">{</span> <span class="o">...</span> <span class="o">}</span>
-<span class="o">}</span></code></pre></div>
-
+<div class="highlight"><pre><code class="language-text" data-lang="text">/** Every message that is delivered to a StreamTask is wrapped
+ * in an IncomingMessageEnvelope, which contains metadata about
+ * the origin of the message. */
+public class IncomingMessageEnvelope {
+ /** A deserialized message. */
+ Object getMessage() { ... }
+
+ /** A deserialized key. */
+ Object getKey() { ... }
+
+ /** The stream and partition that this message came from. */
+ SystemStreamPartition getSystemStreamPartition() { ... }
+}
+</code></pre></div>
<p>The key and value are declared as Object, and need to be cast to the correct type. If you don’t configure a <a href="../container/serialization.html">serializer/deserializer</a>, they are typically Java byte arrays. A deserializer can convert these bytes into any other type, for example the JSON deserializer mentioned above parses the byte array into java.util.Map, java.util.List and String objects.</p>
-<p>The <code>getSystemStreamPartition()</code> method returns a <a href="javadocs/org/apache/samza/system/SystemStreamPartition.html">SystemStreamPartition</a> object, which tells you where the message came from. It consists of three parts:</p>
+<p>The getSystemStreamPartition() method returns a <a href="javadocs/org/apache/samza/system/SystemStreamPartition.html">SystemStreamPartition</a> object, which tells you where the message came from. It consists of three parts:</p>
<ol>
<li>The <em>system</em>: the name of the system from which the message came, as defined in your job configuration. You can have multiple systems for input and/or output, each with a different name.</li>
@@ -183,56 +179,53 @@
</ol>
<p>The API looks like this:</p>
+<div class="highlight"><pre><code class="language-text" data-lang="text">/** A triple of system name, stream name and partition. */
+public class SystemStreamPartition extends SystemStream {
-<div class="highlight"><pre><code class="java"><span class="cm">/** A triple of system name, stream name and partition. */</span>
-<span class="kd">public</span> <span class="kd">class</span> <span class="nc">SystemStreamPartition</span> <span class="kd">extends</span> <span class="n">SystemStream</span> <span class="o">{</span>
-
- <span class="cm">/** The name of the system which provides this stream. It is</span>
-<span class="cm"> defined in the Samza job's configuration. */</span>
- <span class="kd">public</span> <span class="n">String</span> <span class="nf">getSystem</span><span class="o">()</span> <span class="o">{</span> <span class="o">...</span> <span class="o">}</span>
-
- <span class="cm">/** The name of the stream/topic/queue within the system. */</span>
- <span class="kd">public</span> <span class="n">String</span> <span class="nf">getStream</span><span class="o">()</span> <span class="o">{</span> <span class="o">...</span> <span class="o">}</span>
-
- <span class="cm">/** The partition within the stream. */</span>
- <span class="kd">public</span> <span class="n">Partition</span> <span class="nf">getPartition</span><span class="o">()</span> <span class="o">{</span> <span class="o">...</span> <span class="o">}</span>
-<span class="o">}</span></code></pre></div>
-
+ /** The name of the system which provides this stream. It is
+ defined in the Samza job's configuration. */
+ public String getSystem() { ... }
+
+ /** The name of the stream/topic/queue within the system. */
+ public String getStream() { ... }
+
+ /** The partition within the stream. */
+ public Partition getPartition() { ... }
+}
+</code></pre></div>
<p>In the example job configuration above, the system name is “kafka”, the stream name is “PageViewEvent”. (The name “kafka” isn’t special — you can give your system any name you want.) If you have several input streams feeding into your StreamTask, you can use the SystemStreamPartition to determine what kind of message you’ve received.</p>
<p>What about sending messages? If you take a look at the process() method in StreamTask, you’ll see that you get a <a href="javadocs/org/apache/samza/task/MessageCollector.html">MessageCollector</a>.</p>
-
-<div class="highlight"><pre><code class="java"><span class="cm">/** When a task wishes to send a message, it uses this interface. */</span>
-<span class="kd">public</span> <span class="kd">interface</span> <span class="nc">MessageCollector</span> <span class="o">{</span>
- <span class="kt">void</span> <span class="nf">send</span><span class="o">(</span><span class="n">OutgoingMessageEnvelope</span> <span class="n">envelope</span><span class="o">);</span>
-<span class="o">}</span></code></pre></div>
-
+<div class="highlight"><pre><code class="language-text" data-lang="text">/** When a task wishes to send a message, it uses this interface. */
+public interface MessageCollector {
+ void send(OutgoingMessageEnvelope envelope);
+}
+</code></pre></div>
<p>To send a message, you create an <a href="javadocs/org/apache/samza/system/OutgoingMessageEnvelope.html">OutgoingMessageEnvelope</a> object and pass it to the message collector. At a minimum, the envelope specifies the message you want to send, and the system and stream name to send it to. Optionally you can specify the partitioning key and other parameters. See the <a href="javadocs/org/apache/samza/system/OutgoingMessageEnvelope.html">javadoc</a> for details.</p>
-<p><strong>NOTE:</strong> Please only use the MessageCollector object within the <code>process()</code> method. If you hold on to a MessageCollector instance and use it again later, your messages may not be sent correctly.</p>
+<p><strong>NOTE:</strong> Please only use the MessageCollector object within the process() method. If you hold on to a MessageCollector instance and use it again later, your messages may not be sent correctly.</p>
<p>For example, here’s a simple task that splits each input message into words, and emits each word as a separate message:</p>
+<div class="highlight"><pre><code class="language-text" data-lang="text">public class SplitStringIntoWords implements StreamTask {
-<div class="highlight"><pre><code class="java"><span class="kd">public</span> <span class="kd">class</span> <span class="nc">SplitStringIntoWords</span> <span class="kd">implements</span> <span class="n">StreamTask</span> <span class="o">{</span>
-
- <span class="c1">// Send outgoing messages to a stream called "words"</span>
- <span class="c1">// in the "kafka" system.</span>
- <span class="kd">private</span> <span class="kd">final</span> <span class="n">SystemStream</span> <span class="n">OUTPUT_STREAM</span> <span class="o">=</span>
- <span class="k">new</span> <span class="nf">SystemStream</span><span class="o">(</span><span class="s">"kafka"</span><span class="o">,</span> <span class="s">"words"</span><span class="o">);</span>
-
- <span class="kd">public</span> <span class="kt">void</span> <span class="nf">process</span><span class="o">(</span><span class="n">IncomingMessageEnvelope</span> <span class="n">envelope</span><span class="o">,</span>
- <span class="n">MessageCollector</span> <span class="n">collector</span><span class="o">,</span>
- <span class="n">TaskCoordinator</span> <span class="n">coordinator</span><span class="o">)</span> <span class="o">{</span>
- <span class="n">String</span> <span class="n">message</span> <span class="o">=</span> <span class="o">(</span><span class="n">String</span><span class="o">)</span> <span class="n">envelope</span><span class="o">.</span><span class="na">getMessage</span><span class="o">();</span>
-
- <span class="k">for</span> <span class="o">(</span><span class="n">String</span> <span class="n">word</span> <span class="o">:</span> <span class="n">message</span><span class="o">.</span><span class="na">split</span><span class="o">(</span><span class="s">" "</span><span class="o">))</span> <span class="o">{</span>
- <span class="c1">// Use the word as the key, and 1 as the value.</span>
- <span class="c1">// A second task can add the 1's to get the word count.</span>
- <span class="n">collector</span><span class="o">.</span><span class="na">send</span><span class="o">(</span><span class="k">new</span> <span class="n">OutgoingMessageEnvelope</span><span class="o">(</span><span class="n">OUTPUT_STREAM</span><span class="o">,</span> <span class="n">word</span><span class="o">,</span> <span class="mi">1</span><span class="o">));</span>
- <span class="o">}</span>
- <span class="o">}</span>
-<span class="o">}</span></code></pre></div>
-
+ // Send outgoing messages to a stream called "words"
+ // in the "kafka" system.
+ private final SystemStream OUTPUT_STREAM =
+ new SystemStream("kafka", "words");
+
+ public void process(IncomingMessageEnvelope envelope,
+ MessageCollector collector,
+ TaskCoordinator coordinator) {
+ String message = (String) envelope.getMessage();
+
+ for (String word : message.split(" ")) {
+ // Use the word as the key, and 1 as the value.
+ // A second task can add the 1's to get the word count.
+ collector.send(new OutgoingMessageEnvelope(OUTPUT_STREAM, word, 1));
+ }
+ }
+}
+</code></pre></div>
<h2 id="samzacontainer-»"><a href="../container/samza-container.html">SamzaContainer »</a></h2>
Modified: incubator/samza/site/learn/documentation/0.7.0/comparisons/introduction.html
URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.7.0/comparisons/introduction.html?rev=1609230&r1=1609229&r2=1609230&view=diff
==============================================================================
--- incubator/samza/site/learn/documentation/0.7.0/comparisons/introduction.html (original)
+++ incubator/samza/site/learn/documentation/0.7.0/comparisons/introduction.html Wed Jul 9 16:34:23 2014
@@ -23,7 +23,6 @@
<link href="/css/bootstrap.min.css" rel="stylesheet"/>
<link href="/css/font-awesome.min.css" rel="stylesheet"/>
<link href="/css/main.css" rel="stylesheet"/>
- <link href="/css/syntax.css" rel="stylesheet"/>
<link rel="icon" type="image/png" href="/img/samza-icon.png">
</head>
<body>
Modified: incubator/samza/site/learn/documentation/0.7.0/comparisons/mupd8.html
URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.7.0/comparisons/mupd8.html?rev=1609230&r1=1609229&r2=1609230&view=diff
==============================================================================
--- incubator/samza/site/learn/documentation/0.7.0/comparisons/mupd8.html (original)
+++ incubator/samza/site/learn/documentation/0.7.0/comparisons/mupd8.html Wed Jul 9 16:34:23 2014
@@ -23,7 +23,6 @@
<link href="/css/bootstrap.min.css" rel="stylesheet"/>
<link href="/css/font-awesome.min.css" rel="stylesheet"/>
<link href="/css/main.css" rel="stylesheet"/>
- <link href="/css/syntax.css" rel="stylesheet"/>
<link rel="icon" type="image/png" href="/img/samza-icon.png">
</head>
<body>
Modified: incubator/samza/site/learn/documentation/0.7.0/comparisons/storm.html
URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/0.7.0/comparisons/storm.html?rev=1609230&r1=1609229&r2=1609230&view=diff
==============================================================================
--- incubator/samza/site/learn/documentation/0.7.0/comparisons/storm.html (original)
+++ incubator/samza/site/learn/documentation/0.7.0/comparisons/storm.html Wed Jul 9 16:34:23 2014
@@ -23,7 +23,6 @@
<link href="/css/bootstrap.min.css" rel="stylesheet"/>
<link href="/css/font-awesome.min.css" rel="stylesheet"/>
<link href="/css/main.css" rel="stylesheet"/>
- <link href="/css/syntax.css" rel="stylesheet"/>
<link rel="icon" type="image/png" href="/img/samza-icon.png">
</head>
<body>