Added: incubator/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/system/OutgoingMessageEnvelope.html URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/system/OutgoingMessageEnvelope.html?rev=1618097&view=auto ============================================================================== --- incubator/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/system/OutgoingMessageEnvelope.html (added) +++ incubator/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/system/OutgoingMessageEnvelope.html Fri Aug 15 05:28:03 2014 @@ -0,0 +1,447 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc (version 1.7.0_65) on Thu Aug 07 23:02:19 PDT 2014 --> +<title>OutgoingMessageEnvelope (samza-api 0.8.0-SNAPSHOT API)</title> +<meta name="date" content="2014-08-07"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +</head> +<body> +<script type="text/javascript"><!-- + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="OutgoingMessageEnvelope (samza-api 0.8.0-SNAPSHOT API)"; + } +//--> +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar_top"> +<!-- --> +</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../index-all.html">Index</a></li> +<li><a href="../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../org/apache/samza/system/IncomingMessageEnvelope.html" title="class in org.apache.samza.system"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/apache/samza/system/SystemAdmin.html" title="interface in org.apache.samza.system"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/samza/system/OutgoingMessageEnvelope.html" target="_top">Frames</a></li> +<li><a href="OutgoingMessageEnvelope.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li><a href="#constructor_summary">Constr</a> | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor_detail">Constr</a> | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">org.apache.samza.system</div> +<h2 title="Class OutgoingMessageEnvelope" class="title">Class OutgoingMessageEnvelope</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>org.apache.samza.system.OutgoingMessageEnvelope</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<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> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> +<caption><span>Constructors</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../../org/apache/samza/system/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,%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,%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> +<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,%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, + java.lang.Object key, + java.lang.Object message)</code> +<div class="block">Constructs a new OutgoingMessageEnvelope from specified components.</div> +</td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span>Methods</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/samza/system/OutgoingMessageEnvelope.html#equals(java.lang.Object)">equals</a></strong>(java.lang.Object obj)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/samza/system/OutgoingMessageEnvelope.html#getKey()">getKey</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/samza/system/OutgoingMessageEnvelope.html#getKeySerializerName()">getKeySerializerName</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/samza/system/OutgoingMessageEnvelope.html#getMessage()">getMessage</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/samza/system/OutgoingMessageEnvelope.html#getMessageSerializerName()">getMessageSerializerName</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/samza/system/OutgoingMessageEnvelope.html#getPartitionKey()">getPartitionKey</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/samza/system/SystemStream.html" title="class in org.apache.samza.system">SystemStream</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/samza/system/OutgoingMessageEnvelope.html#getSystemStream()">getSystemStream</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/samza/system/OutgoingMessageEnvelope.html#hashCode()">hashCode</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/samza/system/OutgoingMessageEnvelope.html#toString()">toString</a></strong>()</code> </td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.Object</h3> +<code>clone, finalize, getClass, notify, notifyAll, wait, wait, wait</code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="OutgoingMessageEnvelope(org.apache.samza.system.SystemStream, java.lang.String, java.lang.String, java.lang.Object, java.lang.Object, java.lang.Object)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>OutgoingMessageEnvelope</h4> +<pre>public OutgoingMessageEnvelope(<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, + java.lang.Object key, + java.lang.Object message)</pre> +<div class="block">Constructs a new OutgoingMessageEnvelope from specified components.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>systemStream</code> - Object representing the appropriate stream of which this envelope will be sent on.</dd><dd><code>keySerializerName</code> - String representing the serializer used for serializing this envelope's key.</dd><dd><code>messageSerializerName</code> - String representing the serializer used for serializing this envelope's message.</dd><dd><code>partitionKey</code> - A key representing which partition of the systemStream to send this envelope on.</dd><dd><code>key</code> - A deserialized key to be used for the message.</dd><dd><code>message</code> - A deserialized message to be sent in this envelope.</dd></dl> +</li> +</ul> +<a name="OutgoingMessageEnvelope(org.apache.samza.system.SystemStream, java.lang.Object, java.lang.Object, java.lang.Object)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>OutgoingMessageEnvelope</h4> +<pre>public OutgoingMessageEnvelope(<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)</pre> +<div class="block">Constructs a new OutgoingMessageEnvelope from specified components.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>systemStream</code> - Object representing the appropriate stream of which this envelope will be sent on.</dd><dd><code>partitionKey</code> - A key representing which partition of the systemStream to send this envelope on.</dd><dd><code>key</code> - A deserialized key to be used for the message.</dd><dd><code>message</code> - A deserialized message to be sent in this envelope.</dd></dl> +</li> +</ul> +<a name="OutgoingMessageEnvelope(org.apache.samza.system.SystemStream, java.lang.Object, java.lang.Object)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>OutgoingMessageEnvelope</h4> +<pre>public OutgoingMessageEnvelope(<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)</pre> +<div class="block">Constructs a new OutgoingMessageEnvelope from specified components.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>systemStream</code> - Object representing the appropriate stream of which this envelope will be sent on.</dd><dd><code>key</code> - A deserialized key to be used for the message.</dd><dd><code>message</code> - A deserialized message to be sent in this envelope.</dd></dl> +</li> +</ul> +<a name="OutgoingMessageEnvelope(org.apache.samza.system.SystemStream, java.lang.Object)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>OutgoingMessageEnvelope</h4> +<pre>public OutgoingMessageEnvelope(<a href="../../../../org/apache/samza/system/SystemStream.html" title="class in org.apache.samza.system">SystemStream</a> systemStream, + java.lang.Object message)</pre> +<div class="block">Constructs a new OutgoingMessageEnvelope from specified components.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>systemStream</code> - Object representing the appropriate stream of which this envelope will be sent on.</dd><dd><code>message</code> - A deserialized message to be sent in this envelope.</dd></dl> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="getSystemStream()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getSystemStream</h4> +<pre>public <a href="../../../../org/apache/samza/system/SystemStream.html" title="class in org.apache.samza.system">SystemStream</a> getSystemStream()</pre> +</li> +</ul> +<a name="getKeySerializerName()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getKeySerializerName</h4> +<pre>public java.lang.String getKeySerializerName()</pre> +</li> +</ul> +<a name="getMessageSerializerName()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getMessageSerializerName</h4> +<pre>public java.lang.String getMessageSerializerName()</pre> +</li> +</ul> +<a name="getPartitionKey()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getPartitionKey</h4> +<pre>public java.lang.Object getPartitionKey()</pre> +</li> +</ul> +<a name="getKey()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getKey</h4> +<pre>public java.lang.Object getKey()</pre> +</li> +</ul> +<a name="getMessage()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getMessage</h4> +<pre>public java.lang.Object getMessage()</pre> +</li> +</ul> +<a name="hashCode()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>hashCode</h4> +<pre>public int hashCode()</pre> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code>hashCode</code> in class <code>java.lang.Object</code></dd> +</dl> +</li> +</ul> +<a name="equals(java.lang.Object)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>equals</h4> +<pre>public boolean equals(java.lang.Object obj)</pre> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code>equals</code> in class <code>java.lang.Object</code></dd> +</dl> +</li> +</ul> +<a name="toString()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>toString</h4> +<pre>public java.lang.String toString()</pre> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code>toString</code> in class <code>java.lang.Object</code></dd> +</dl> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar_bottom"> +<!-- --> +</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../index-all.html">Index</a></li> +<li><a href="../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../org/apache/samza/system/IncomingMessageEnvelope.html" title="class in org.apache.samza.system"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/apache/samza/system/SystemAdmin.html" title="interface in org.apache.samza.system"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/samza/system/OutgoingMessageEnvelope.html" target="_top">Frames</a></li> +<li><a href="OutgoingMessageEnvelope.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li><a href="#constructor_summary">Constr</a> | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor_detail">Constr</a> | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html>
Added: incubator/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/system/SystemAdmin.html URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/system/SystemAdmin.html?rev=1618097&view=auto ============================================================================== --- incubator/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/system/SystemAdmin.html (added) +++ incubator/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/system/SystemAdmin.html Fri Aug 15 05:28:03 2014 @@ -0,0 +1,239 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc (version 1.7.0_65) on Thu Aug 07 23:02:19 PDT 2014 --> +<title>SystemAdmin (samza-api 0.8.0-SNAPSHOT API)</title> +<meta name="date" content="2014-08-07"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +</head> +<body> +<script type="text/javascript"><!-- + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="SystemAdmin (samza-api 0.8.0-SNAPSHOT API)"; + } +//--> +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar_top"> +<!-- --> +</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../index-all.html">Index</a></li> +<li><a href="../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../org/apache/samza/system/OutgoingMessageEnvelope.html" title="class in org.apache.samza.system"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/apache/samza/system/SystemConsumer.html" title="interface in org.apache.samza.system"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/samza/system/SystemAdmin.html" target="_top">Frames</a></li> +<li><a href="SystemAdmin.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">org.apache.samza.system</div> +<h2 title="Interface SystemAdmin" class="title">Interface SystemAdmin</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Known Implementing Classes:</dt> +<dd><a href="../../../../org/apache/samza/util/SinglePartitionWithoutOffsetsSystemAdmin.html" title="class in org.apache.samza.util">SinglePartitionWithoutOffsetsSystemAdmin</a></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="strong">SystemAdmin</span></pre> +<div class="block">Helper interface attached to an 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> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span>Methods</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.util.Map<<a href="../../../../org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system">SystemStreamPartition</a>,java.lang.String></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/samza/system/SystemAdmin.html#getOffsetsAfter(java.util.Map)">getOffsetsAfter</a></strong>(java.util.Map<<a href="../../../../org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system">SystemStreamPartition</a>,java.lang.String> offsets)</code> +<div class="block">Fetches the offsets for the messages immediately after the supplied offsets + for a group of SystemStreamPartitions.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.util.Map<java.lang.String,<a href="../../../../org/apache/samza/system/SystemStreamMetadata.html" title="class in org.apache.samza.system">SystemStreamMetadata</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/samza/system/SystemAdmin.html#getSystemStreamMetadata(java.util.Set)">getSystemStreamMetadata</a></strong>(java.util.Set<java.lang.String> streamNames)</code> +<div class="block">Fetch metadata from a system for a set of streams.</div> +</td> +</tr> +</table> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="getOffsetsAfter(java.util.Map)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getOffsetsAfter</h4> +<pre>java.util.Map<<a href="../../../../org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system">SystemStreamPartition</a>,java.lang.String> getOffsetsAfter(java.util.Map<<a href="../../../../org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system">SystemStreamPartition</a>,java.lang.String> offsets)</pre> +<div class="block">Fetches the offsets for the messages immediately after the supplied offsets + for a group of SystemStreamPartitions.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>offsets</code> - Map from SystemStreamPartition to current offsets.</dd> +<dt><span class="strong">Returns:</span></dt><dd>Map from SystemStreamPartition to offsets immediately after the + current offsets.</dd></dl> +</li> +</ul> +<a name="getSystemStreamMetadata(java.util.Set)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getSystemStreamMetadata</h4> +<pre>java.util.Map<java.lang.String,<a href="../../../../org/apache/samza/system/SystemStreamMetadata.html" title="class in org.apache.samza.system">SystemStreamMetadata</a>> getSystemStreamMetadata(java.util.Set<java.lang.String> streamNames)</pre> +<div class="block">Fetch metadata from a system for a set of streams.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>streamNames</code> - The streams to to fetch metadata for.</dd> +<dt><span class="strong">Returns:</span></dt><dd>A map from stream name to SystemStreamMetadata for each stream + requested in the parameter set.</dd></dl> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar_bottom"> +<!-- --> +</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../index-all.html">Index</a></li> +<li><a href="../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../org/apache/samza/system/OutgoingMessageEnvelope.html" title="class in org.apache.samza.system"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/apache/samza/system/SystemConsumer.html" title="interface in org.apache.samza.system"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/samza/system/SystemAdmin.html" target="_top">Frames</a></li> +<li><a href="SystemAdmin.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html> Added: incubator/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/system/SystemConsumer.html URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/system/SystemConsumer.html?rev=1618097&view=auto ============================================================================== --- incubator/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/system/SystemConsumer.html (added) +++ incubator/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/system/SystemConsumer.html Fri Aug 15 05:28:03 2014 @@ -0,0 +1,428 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc (version 1.7.0_65) on Thu Aug 07 23:02:19 PDT 2014 --> +<title>SystemConsumer (samza-api 0.8.0-SNAPSHOT API)</title> +<meta name="date" content="2014-08-07"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +</head> +<body> +<script type="text/javascript"><!-- + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="SystemConsumer (samza-api 0.8.0-SNAPSHOT API)"; + } +//--> +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar_top"> +<!-- --> +</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../index-all.html">Index</a></li> +<li><a href="../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../org/apache/samza/system/SystemAdmin.html" title="interface in org.apache.samza.system"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/apache/samza/system/SystemFactory.html" title="interface in org.apache.samza.system"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/samza/system/SystemConsumer.html" target="_top">Frames</a></li> +<li><a href="SystemConsumer.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li><a href="#field_summary">Field</a> | </li> +<li>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#field_detail">Field</a> | </li> +<li>Constr | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">org.apache.samza.system</div> +<h2 title="Interface SystemConsumer" class="title">Interface SystemConsumer</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Known Implementing Classes:</dt> +<dd><a href="../../../../org/apache/samza/util/BlockingEnvelopeMap.html" title="class in org.apache.samza.util">BlockingEnvelopeMap</a></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="strong">SystemConsumer</span></pre> +<div class="block"><p> + SystemConsumer is the interface that must be implemented by any system that + wishes to integrate with Samza. Examples of systems that one might want to + integrate would be systems like Kafka, Hadoop, Kestrel, SQS, etc. + </p> + + <p> + SamzaContainer uses SystemConsumer to read messages from the underlying + system, and funnels the messages to the appropriate StreamTask instances. The + basic flow is for the SamzaContainer to poll for all SystemStreamPartitions, + feed all IncomingMessageEnvelopes to the appropriate StreamTask, and then + repeat. If no IncomingMessageEnvelopes are returned, the SamzaContainer polls + again, but with a timeout of 10ms. + </p> + + <p> + The SamzaContainer treats SystemConsumer in the following way: + </p> + + <ul> + <li>Start will be called before stop.</li> + <li>Register will be called one or more times before start.</li> + <li>Register won't be called twice for the same SystemStreamPartition.</li> + <li>If timeout < 0, poll will block unless all SystemStreamPartition are at + "head" (the underlying system has been checked, and returned an empty set). + If at head, an empty list is returned.</li> + <li>If timeout >= 0, poll will return any messages that are currently + available for any of the SystemStreamPartitions specified. If no new messages + are available, it will wait up to timeout milliseconds for messages from any + SystemStreamPartition to become available. It will return an empty list if + the timeout is hit, and no new messages are available.</li> + <li>Nothing will be called after stop has been invoked.</li> + <li>Poll will only be called for registered SystemStreamPartition.</li> + <li>The SystemConsumer can't assume that a given SystemStreamPartition's + messages will ever be read. It shouldn't run out of memory or deadlock all + new message arrivals if one SystemStreamPartition is never read from.</li> + <li>Any exception thrown by the SystemConsumer means that the SamzaContainer + should halt.</li> + </ul> + + <p> + There are generally three implementation styles to this interface: + </p> + + <ol> + <li>Thread-based</li> + <li>Selector-based</li> + <li>Synchronous</li> + </ol> + + <p> + Thread-based implementations typically use a series of threads to read from + an underlying system asynchronously, and put the resulting messages into a + queue, which is then read from whenever the poll method is invoked. The poll + method's parameters map very closely to Java's BlockingQueue interface. + BlockingEnvelopeMap is a helper class that makes it easy to implement + thread-based implementations of SystemConsumer. + </p> + + <p> + Selector-based implementations typically setup NIO-based non-blocking socket + that can be selected for new data when poll is called. + </p> + + <p> + Synchronous implementations simply fetch directly from the underlying system + whenever poll is invoked. Synchronous implementations must take great care to + adhere to the timeout rules defined in the poll method. + </p></div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- =========== FIELD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field_summary"> +<!-- --> +</a> +<h3>Field Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> +<caption><span>Fields</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Field and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static int</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/samza/system/SystemConsumer.html#BLOCK_ON_OUTSTANDING_MESSAGES">BLOCK_ON_OUTSTANDING_MESSAGES</a></strong></code> +<div class="block">A constant that can be used in the poll method's timeout parameter to + denote that the poll invocation should block until at least one message is + available for one of the SystemStreamPartitions supplied, or until all + SystemStreamPartitions supplied are at head (have no new messages available + since the last poll invocation was made for each SystemStreamPartition).</div> +</td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span>Methods</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.util.Map<<a href="../../../../org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system">SystemStreamPartition</a>,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.Set,%20long)">poll</a></strong>(java.util.Set<<a href="../../../../org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system">SystemStreamPartition</a>> systemStreamPartitions, + long timeout)</code> +<div class="block">Poll the SystemConsumer to get any available messages from the underlying + system.</div> +</td> +</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,%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="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/samza/system/SystemConsumer.html#start()">start</a></strong>()</code> +<div class="block">Tells the SystemConsumer to connect to the underlying system, and prepare + to begin serving messages when poll is invoked.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/samza/system/SystemConsumer.html#stop()">stop</a></strong>()</code> +<div class="block">Tells the SystemConsumer to close all connections, release all resource, + and shut down everything.</div> +</td> +</tr> +</table> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ FIELD DETAIL =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field_detail"> +<!-- --> +</a> +<h3>Field Detail</h3> +<a name="BLOCK_ON_OUTSTANDING_MESSAGES"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>BLOCK_ON_OUTSTANDING_MESSAGES</h4> +<pre>static final int BLOCK_ON_OUTSTANDING_MESSAGES</pre> +<div class="block">A constant that can be used in the poll method's timeout parameter to + denote that the poll invocation should block until at least one message is + available for one of the SystemStreamPartitions supplied, or until all + SystemStreamPartitions supplied are at head (have no new messages available + since the last poll invocation was made for each SystemStreamPartition).</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.samza.system.SystemConsumer.BLOCK_ON_OUTSTANDING_MESSAGES">Constant Field Values</a></dd></dl> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="start()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>start</h4> +<pre>void start()</pre> +<div class="block">Tells the SystemConsumer to connect to the underlying system, and prepare + to begin serving messages when poll is invoked.</div> +</li> +</ul> +<a name="stop()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>stop</h4> +<pre>void stop()</pre> +<div class="block">Tells the SystemConsumer to close all connections, release all resource, + and shut down everything. The SystemConsumer will not be used again after + stop is called.</div> +</li> +</ul> +<a name="register(org.apache.samza.system.SystemStreamPartition, java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>register</h4> +<pre>void register(<a href="../../../../org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system">SystemStreamPartition</a> systemStreamPartition, + java.lang.String offset)</pre> +<div class="block">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><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 + specified, the first message for the system/stream/partition to be + consumed and returned would be a message whose offset is "7".</dd></dl> +</li> +</ul> +<a name="poll(java.util.Set, long)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>poll</h4> +<pre>java.util.Map<<a href="../../../../org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system">SystemStreamPartition</a>,java.util.List<<a href="../../../../org/apache/samza/system/IncomingMessageEnvelope.html" title="class in org.apache.samza.system">IncomingMessageEnvelope</a>>> poll(java.util.Set<<a href="../../../../org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system">SystemStreamPartition</a>> systemStreamPartitions, + long timeout) + throws java.lang.InterruptedException</pre> +<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 + 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. + </p></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>systemStreamPartitions</code> - A set of SystemStreamPartition to poll for new messages. If + SystemConsumer has messages available for other registered + SystemStreamPartitions, but they are not in the + systemStreamPartitions set in a given poll invocation, they can't + be returned. It is illegal to pass in SystemStreamPartitions that + have not been registered with the SystemConsumer first.</dd><dd><code>timeout</code> - If timeout < 0, poll will block unless all SystemStreamPartition + are at "head" (the underlying system has been checked, and + returned an empty set). If at head, an empty map is returned. If + timeout >= 0, poll will return any messages that are currently + available for any of the SystemStreamPartitions specified. If no + new messages are available, it will wait up to timeout + milliseconds for messages from any SystemStreamPartition to become + available. It will return an empty map if the timeout is hit, and + no new messages are available.</dd> +<dt><span class="strong">Returns:</span></dt><dd>A map from SystemStreamPartitions to any available + IncomingMessageEnvelopes for the SystemStreamPartitions. If no + messages are available for a SystemStreamPartition that was + supplied in the polling set, the map will not contain a key for the + SystemStreamPartition. Will return an empty map, not null, if no + new messages are available for any SystemStreamPartitions in the + input set.</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.InterruptedException</code> - Thrown when a blocking poll has been interrupted by another + thread.</dd></dl> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar_bottom"> +<!-- --> +</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../index-all.html">Index</a></li> +<li><a href="../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../org/apache/samza/system/SystemAdmin.html" title="interface in org.apache.samza.system"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/apache/samza/system/SystemFactory.html" title="interface in org.apache.samza.system"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/samza/system/SystemConsumer.html" target="_top">Frames</a></li> +<li><a href="SystemConsumer.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li><a href="#field_summary">Field</a> | </li> +<li>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#field_detail">Field</a> | </li> +<li>Constr | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html> Added: incubator/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/system/SystemFactory.html URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/system/SystemFactory.html?rev=1618097&view=auto ============================================================================== --- incubator/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/system/SystemFactory.html (added) +++ incubator/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/system/SystemFactory.html Fri Aug 15 05:28:03 2014 @@ -0,0 +1,242 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc (version 1.7.0_65) on Thu Aug 07 23:02:19 PDT 2014 --> +<title>SystemFactory (samza-api 0.8.0-SNAPSHOT API)</title> +<meta name="date" content="2014-08-07"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +</head> +<body> +<script type="text/javascript"><!-- + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="SystemFactory (samza-api 0.8.0-SNAPSHOT API)"; + } +//--> +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar_top"> +<!-- --> +</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../index-all.html">Index</a></li> +<li><a href="../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../org/apache/samza/system/SystemConsumer.html" title="interface in org.apache.samza.system"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/apache/samza/system/SystemProducer.html" title="interface in org.apache.samza.system"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/samza/system/SystemFactory.html" target="_top">Frames</a></li> +<li><a href="SystemFactory.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">org.apache.samza.system</div> +<h2 title="Interface SystemFactory" class="title">Interface SystemFactory</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<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> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span>Methods</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/samza/system/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,%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,%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,%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> +</table> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="getConsumer(java.lang.String, org.apache.samza.config.Config, org.apache.samza.metrics.MetricsRegistry)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getConsumer</h4> +<pre><a href="../../../../org/apache/samza/system/SystemConsumer.html" title="interface in org.apache.samza.system">SystemConsumer</a> getConsumer(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)</pre> +</li> +</ul> +<a name="getProducer(java.lang.String, org.apache.samza.config.Config, org.apache.samza.metrics.MetricsRegistry)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getProducer</h4> +<pre><a href="../../../../org/apache/samza/system/SystemProducer.html" title="interface in org.apache.samza.system">SystemProducer</a> getProducer(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)</pre> +</li> +</ul> +<a name="getAdmin(java.lang.String, org.apache.samza.config.Config)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getAdmin</h4> +<pre><a href="../../../../org/apache/samza/system/SystemAdmin.html" title="interface in org.apache.samza.system">SystemAdmin</a> getAdmin(java.lang.String systemName, + <a href="../../../../org/apache/samza/config/Config.html" title="class in org.apache.samza.config">Config</a> config)</pre> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar_bottom"> +<!-- --> +</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../index-all.html">Index</a></li> +<li><a href="../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../org/apache/samza/system/SystemConsumer.html" title="interface in org.apache.samza.system"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/apache/samza/system/SystemProducer.html" title="interface in org.apache.samza.system"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/samza/system/SystemFactory.html" target="_top">Frames</a></li> +<li><a href="SystemFactory.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html> Added: incubator/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/system/SystemProducer.html URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/system/SystemProducer.html?rev=1618097&view=auto ============================================================================== --- incubator/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/system/SystemProducer.html (added) +++ incubator/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/system/SystemProducer.html Fri Aug 15 05:28:03 2014 @@ -0,0 +1,282 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc (version 1.7.0_65) on Thu Aug 07 23:02:19 PDT 2014 --> +<title>SystemProducer (samza-api 0.8.0-SNAPSHOT API)</title> +<meta name="date" content="2014-08-07"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +</head> +<body> +<script type="text/javascript"><!-- + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="SystemProducer (samza-api 0.8.0-SNAPSHOT API)"; + } +//--> +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar_top"> +<!-- --> +</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../index-all.html">Index</a></li> +<li><a href="../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../org/apache/samza/system/SystemFactory.html" title="interface in org.apache.samza.system"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/apache/samza/system/SystemStream.html" title="class in org.apache.samza.system"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/samza/system/SystemProducer.html" target="_top">Frames</a></li> +<li><a href="SystemProducer.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">org.apache.samza.system</div> +<h2 title="Interface SystemProducer" class="title">Interface SystemProducer</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<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> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span>Methods</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/samza/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> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/samza/system/SystemProducer.html#register(java.lang.String)">register</a></strong>(java.lang.String source)</code> +<div class="block">Registers this producer to send messages from a specified Samza source, such as a StreamTask.</div> +</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#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> +</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> +</tr> +</table> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="start()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>start</h4> +<pre>void start()</pre> +<div class="block">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()"> +<!-- --> +</a> +<ul class="blockList"> +<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)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>register</h4> +<pre>void register(java.lang.String source)</pre> +<div class="block">Registers this producer to send messages from a specified Samza source, such as a StreamTask.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>source</code> - String representing the source of the message.</dd></dl> +</li> +</ul> +<a name="send(java.lang.String, org.apache.samza.system.OutgoingMessageEnvelope)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>send</h4> +<pre>void send(java.lang.String source, + <a href="../../../../org/apache/samza/system/OutgoingMessageEnvelope.html" title="class in org.apache.samza.system">OutgoingMessageEnvelope</a> envelope)</pre> +<div class="block">Sends a specified message envelope from a specified Samza source.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>source</code> - String representing the source of the message.</dd><dd><code>envelope</code> - Aggregate object representing the serialized message to send from the source.</dd></dl> +</li> +</ul> +<a name="flush(java.lang.String)"> +<!-- --> +</a> +<ul class="blockListLast"> +<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> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar_bottom"> +<!-- --> +</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../index-all.html">Index</a></li> +<li><a href="../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../org/apache/samza/system/SystemFactory.html" title="interface in org.apache.samza.system"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/apache/samza/system/SystemStream.html" title="class in org.apache.samza.system"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/samza/system/SystemProducer.html" target="_top">Frames</a></li> +<li><a href="SystemProducer.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html> Added: incubator/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/system/SystemStream.html URL: http://svn.apache.org/viewvc/incubator/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/system/SystemStream.html?rev=1618097&view=auto ============================================================================== --- incubator/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/system/SystemStream.html (added) +++ incubator/samza/site/learn/documentation/latest/api/javadocs/org/apache/samza/system/SystemStream.html Fri Aug 15 05:28:03 2014 @@ -0,0 +1,398 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc (version 1.7.0_65) on Thu Aug 07 23:02:19 PDT 2014 --> +<title>SystemStream (samza-api 0.8.0-SNAPSHOT API)</title> +<meta name="date" content="2014-08-07"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +</head> +<body> +<script type="text/javascript"><!-- + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="SystemStream (samza-api 0.8.0-SNAPSHOT API)"; + } +//--> +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar_top"> +<!-- --> +</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../index-all.html">Index</a></li> +<li><a href="../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../org/apache/samza/system/SystemProducer.html" title="interface in org.apache.samza.system"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/apache/samza/system/SystemStreamMetadata.html" title="class in org.apache.samza.system"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/samza/system/SystemStream.html" target="_top">Frames</a></li> +<li><a href="SystemStream.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li><a href="#field_summary">Field</a> | </li> +<li><a href="#constructor_summary">Constr</a> | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#field_detail">Field</a> | </li> +<li><a href="#constructor_detail">Constr</a> | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">org.apache.samza.system</div> +<h2 title="Class SystemStream" class="title">Class SystemStream</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>org.apache.samza.system.SystemStream</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>Direct Known Subclasses:</dt> +<dd><a href="../../../../org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system">SystemStreamPartition</a></dd> +</dl> +<hr> +<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> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- =========== FIELD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field_summary"> +<!-- --> +</a> +<h3>Field Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> +<caption><span>Fields</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Field and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/samza/system/SystemStream.html#stream">stream</a></strong></code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/samza/system/SystemStream.html#system">system</a></strong></code> </td> +</tr> +</table> +</li> +</ul> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> +<caption><span>Constructors</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../../org/apache/samza/system/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> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../../org/apache/samza/system/SystemStream.html#SystemStream(org.apache.samza.system.SystemStream)">SystemStream</a></strong>(<a href="../../../../org/apache/samza/system/SystemStream.html" title="class in org.apache.samza.system">SystemStream</a> other)</code> +<div class="block">Constructs a Samza stream object based upon an existing Samza stream.</div> +</td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span>Methods</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/samza/system/SystemStream.html#equals(java.lang.Object)">equals</a></strong>(java.lang.Object obj)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/samza/system/SystemStream.html#getStream()">getStream</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/samza/system/SystemStream.html#getSystem()">getSystem</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/samza/system/SystemStream.html#hashCode()">hashCode</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/samza/system/SystemStream.html#toString()">toString</a></strong>()</code> </td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.Object</h3> +<code>clone, finalize, getClass, notify, notifyAll, wait, wait, wait</code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ FIELD DETAIL =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field_detail"> +<!-- --> +</a> +<h3>Field Detail</h3> +<a name="system"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>system</h4> +<pre>protected final java.lang.String system</pre> +</li> +</ul> +<a name="stream"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>stream</h4> +<pre>protected final java.lang.String stream</pre> +</li> +</ul> +</li> +</ul> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="SystemStream(java.lang.String, java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>SystemStream</h4> +<pre>public SystemStream(java.lang.String system, + java.lang.String stream)</pre> +<div class="block">Constructs a Samza stream object from specified components.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>system</code> - The name of the system of which this stream is associated with.</dd><dd><code>stream</code> - The name of the stream as specified in the stream configuration file.</dd></dl> +</li> +</ul> +<a name="SystemStream(org.apache.samza.system.SystemStream)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>SystemStream</h4> +<pre>public SystemStream(<a href="../../../../org/apache/samza/system/SystemStream.html" title="class in org.apache.samza.system">SystemStream</a> other)</pre> +<div class="block">Constructs a Samza stream object based upon an existing Samza stream.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>other</code> - Reference to an already existing Samza stream.</dd></dl> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="getSystem()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getSystem</h4> +<pre>public java.lang.String getSystem()</pre> +</li> +</ul> +<a name="getStream()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getStream</h4> +<pre>public java.lang.String getStream()</pre> +</li> +</ul> +<a name="hashCode()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>hashCode</h4> +<pre>public int hashCode()</pre> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code>hashCode</code> in class <code>java.lang.Object</code></dd> +</dl> +</li> +</ul> +<a name="equals(java.lang.Object)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>equals</h4> +<pre>public boolean equals(java.lang.Object obj)</pre> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code>equals</code> in class <code>java.lang.Object</code></dd> +</dl> +</li> +</ul> +<a name="toString()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>toString</h4> +<pre>public java.lang.String toString()</pre> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code>toString</code> in class <code>java.lang.Object</code></dd> +</dl> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar_bottom"> +<!-- --> +</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../index-all.html">Index</a></li> +<li><a href="../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../org/apache/samza/system/SystemProducer.html" title="interface in org.apache.samza.system"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/apache/samza/system/SystemStreamMetadata.html" title="class in org.apache.samza.system"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/samza/system/SystemStream.html" target="_top">Frames</a></li> +<li><a href="SystemStream.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li><a href="#field_summary">Field</a> | </li> +<li><a href="#constructor_summary">Constr</a> | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#field_detail">Field</a> | </li> +<li><a href="#constructor_detail">Constr</a> | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html>
