http://git-wip-us.apache.org/repos/asf/incubator-samza/blob/b2ecfef4/docs/learn/documentation/versioned/api/javadocs/org/apache/samza/task/InitableTask.html ---------------------------------------------------------------------- diff --git a/docs/learn/documentation/versioned/api/javadocs/org/apache/samza/task/InitableTask.html b/docs/learn/documentation/versioned/api/javadocs/org/apache/samza/task/InitableTask.html deleted file mode 100644 index 4db8d07..0000000 --- a/docs/learn/documentation/versioned/api/javadocs/org/apache/samza/task/InitableTask.html +++ /dev/null @@ -1,215 +0,0 @@ -<!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 Tue Aug 05 21:46:34 PDT 2014 --> -<title>InitableTask (samza-api 0.8.0-SNAPSHOT API)</title> -<meta name="date" content="2014-08-05"> -<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> -</head> -<body> -<script type="text/javascript"><!-- - if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="InitableTask (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/task/ClosableTask.html" title="interface in org.apache.samza.task"><span class="strong">Prev Class</span></a></li> -<li><a href="../../../../org/apache/samza/task/MessageCollector.html" title="interface in org.apache.samza.task"><span class="strong">Next Class</span></a></li> -</ul> -<ul class="navList"> -<li><a href="../../../../index.html?org/apache/samza/task/InitableTask.html" target="_top">Frames</a></li> -<li><a href="InitableTask.html" target="_top">No Frames</a></li> -</ul> -<ul class="navList" id="allclasses_navbar_top"> -<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> -</ul> -<div> -<script type="text/javascript"><!-- - allClassesLink = document.getElementById("allclasses_navbar_top"); - if(window==top) { - allClassesLink.style.display = "block"; - } - else { - allClassesLink.style.display = "none"; - } - //--> -</script> -</div> -<div> -<ul class="subNavList"> -<li>Summary: </li> -<li>Nested | </li> -<li>Field | </li> -<li>Constr | </li> -<li><a href="#method_summary">Method</a></li> -</ul> -<ul class="subNavList"> -<li>Detail: </li> -<li>Field | </li> -<li>Constr | </li> -<li><a href="#method_detail">Method</a></li> -</ul> -</div> -<a name="skip-navbar_top"> -<!-- --> -</a></div> -<!-- ========= END OF TOP NAVBAR ========= --> -<!-- ======== START OF CLASS DATA ======== --> -<div class="header"> -<div class="subTitle">org.apache.samza.task</div> -<h2 title="Interface InitableTask" class="title">Interface InitableTask</h2> -</div> -<div class="contentContainer"> -<div class="description"> -<ul class="blockList"> -<li class="blockList"> -<hr> -<br> -<pre>public interface <span class="strong">InitableTask</span></pre> -<div class="block">Used as an interface for user processing StreamTasks that need to have specific functionality performed as their StreamTasks - are instantiated by TaskRunner.</div> -</li> -</ul> -</div> -<div class="summary"> -<ul class="blockList"> -<li class="blockList"> -<!-- ========== METHOD SUMMARY =========== --> -<ul class="blockList"> -<li class="blockList"><a name="method_summary"> -<!-- --> -</a> -<h3>Method Summary</h3> -<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> -<caption><span>Methods</span><span class="tabEnd"> </span></caption> -<tr> -<th class="colFirst" scope="col">Modifier and Type</th> -<th class="colLast" scope="col">Method and Description</th> -</tr> -<tr class="altColor"> -<td class="colFirst"><code>void</code></td> -<td class="colLast"><code><strong><a href="../../../../org/apache/samza/task/InitableTask.html#init(org.apache.samza.config.Config,%20org.apache.samza.task.TaskContext)">init</a></strong>(<a href="../../../../org/apache/samza/config/Config.html" title="class in org.apache.samza.config">Config</a> config, - <a href="../../../../org/apache/samza/task/TaskContext.html" title="interface in org.apache.samza.task">TaskContext</a> context)</code> -<div class="block">Called by TaskRunner each time an implementing task is created.</div> -</td> -</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="init(org.apache.samza.config.Config, org.apache.samza.task.TaskContext)"> -<!-- --> -</a> -<ul class="blockListLast"> -<li class="blockList"> -<h4>init</h4> -<pre>void init(<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) - throws java.lang.Exception</pre> -<div class="block">Called by TaskRunner each time an implementing task is created.</div> -<dl><dt><span class="strong">Parameters:</span></dt><dd><code>config</code> - Allows accessing of fields in the configuration files that this StreamTask is specified in.</dd><dd><code>context</code> - Allows accessing of contextual data of this StreamTask.</dd> -<dt><span class="strong">Throws:</span></dt> -<dd><code>java.lang.Exception</code> - Any exception types encountered during the execution of the processing task.</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/task/ClosableTask.html" title="interface in org.apache.samza.task"><span class="strong">Prev Class</span></a></li> -<li><a href="../../../../org/apache/samza/task/MessageCollector.html" title="interface in org.apache.samza.task"><span class="strong">Next Class</span></a></li> -</ul> -<ul class="navList"> -<li><a href="../../../../index.html?org/apache/samza/task/InitableTask.html" target="_top">Frames</a></li> -<li><a href="InitableTask.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>
http://git-wip-us.apache.org/repos/asf/incubator-samza/blob/b2ecfef4/docs/learn/documentation/versioned/api/javadocs/org/apache/samza/task/MessageCollector.html ---------------------------------------------------------------------- diff --git a/docs/learn/documentation/versioned/api/javadocs/org/apache/samza/task/MessageCollector.html b/docs/learn/documentation/versioned/api/javadocs/org/apache/samza/task/MessageCollector.html deleted file mode 100644 index 280633a..0000000 --- a/docs/learn/documentation/versioned/api/javadocs/org/apache/samza/task/MessageCollector.html +++ /dev/null @@ -1,213 +0,0 @@ -<!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 Tue Aug 05 21:46:34 PDT 2014 --> -<title>MessageCollector (samza-api 0.8.0-SNAPSHOT API)</title> -<meta name="date" content="2014-08-05"> -<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> -</head> -<body> -<script type="text/javascript"><!-- - if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="MessageCollector (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/task/InitableTask.html" title="interface in org.apache.samza.task"><span class="strong">Prev Class</span></a></li> -<li><a href="../../../../org/apache/samza/task/StreamTask.html" title="interface in org.apache.samza.task"><span class="strong">Next Class</span></a></li> -</ul> -<ul class="navList"> -<li><a href="../../../../index.html?org/apache/samza/task/MessageCollector.html" target="_top">Frames</a></li> -<li><a href="MessageCollector.html" target="_top">No Frames</a></li> -</ul> -<ul class="navList" id="allclasses_navbar_top"> -<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> -</ul> -<div> -<script type="text/javascript"><!-- - allClassesLink = document.getElementById("allclasses_navbar_top"); - if(window==top) { - allClassesLink.style.display = "block"; - } - else { - allClassesLink.style.display = "none"; - } - //--> -</script> -</div> -<div> -<ul class="subNavList"> -<li>Summary: </li> -<li>Nested | </li> -<li>Field | </li> -<li>Constr | </li> -<li><a href="#method_summary">Method</a></li> -</ul> -<ul class="subNavList"> -<li>Detail: </li> -<li>Field | </li> -<li>Constr | </li> -<li><a href="#method_detail">Method</a></li> -</ul> -</div> -<a name="skip-navbar_top"> -<!-- --> -</a></div> -<!-- ========= END OF TOP NAVBAR ========= --> -<!-- ======== START OF CLASS DATA ======== --> -<div class="header"> -<div class="subTitle">org.apache.samza.task</div> -<h2 title="Interface MessageCollector" class="title">Interface MessageCollector</h2> -</div> -<div class="contentContainer"> -<div class="description"> -<ul class="blockList"> -<li class="blockList"> -<hr> -<br> -<pre>public interface <span class="strong">MessageCollector</span></pre> -<div class="block">Used as an interface for the means of sending message envelopes to an output stream. - - <p>A MessageCollector is provided on every call to <a href="../../../../org/apache/samza/task/StreamTask.html#process(org.apache.samza.system.IncomingMessageEnvelope,%20org.apache.samza.task.MessageCollector,%20org.apache.samza.task.TaskCoordinator)"><code>StreamTask.process(org.apache.samza.system.IncomingMessageEnvelope, org.apache.samza.task.MessageCollector, org.apache.samza.task.TaskCoordinator)</code></a> and - <a href="../../../../org/apache/samza/task/WindowableTask.html#window(org.apache.samza.task.MessageCollector,%20org.apache.samza.task.TaskCoordinator)"><code>WindowableTask.window(org.apache.samza.task.MessageCollector, org.apache.samza.task.TaskCoordinator)</code></a>. You must use those MessageCollector objects only within - those method calls, and not hold on to a reference for use at any other time.</div> -</li> -</ul> -</div> -<div class="summary"> -<ul class="blockList"> -<li class="blockList"> -<!-- ========== METHOD SUMMARY =========== --> -<ul class="blockList"> -<li class="blockList"><a name="method_summary"> -<!-- --> -</a> -<h3>Method Summary</h3> -<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> -<caption><span>Methods</span><span class="tabEnd"> </span></caption> -<tr> -<th class="colFirst" scope="col">Modifier and Type</th> -<th class="colLast" scope="col">Method and Description</th> -</tr> -<tr class="altColor"> -<td class="colFirst"><code>void</code></td> -<td class="colLast"><code><strong><a href="../../../../org/apache/samza/task/MessageCollector.html#send(org.apache.samza.system.OutgoingMessageEnvelope)">send</a></strong>(<a href="../../../../org/apache/samza/system/OutgoingMessageEnvelope.html" title="class in org.apache.samza.system">OutgoingMessageEnvelope</a> envelope)</code> -<div class="block">Sends message envelope out onto specified stream.</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="send(org.apache.samza.system.OutgoingMessageEnvelope)"> -<!-- --> -</a> -<ul class="blockListLast"> -<li class="blockList"> -<h4>send</h4> -<pre>void send(<a href="../../../../org/apache/samza/system/OutgoingMessageEnvelope.html" title="class in org.apache.samza.system">OutgoingMessageEnvelope</a> envelope)</pre> -<div class="block">Sends message envelope out onto specified stream.</div> -<dl><dt><span class="strong">Parameters:</span></dt><dd><code>envelope</code> - Self contained envelope containing message, key and specified stream to be sent to.</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/task/InitableTask.html" title="interface in org.apache.samza.task"><span class="strong">Prev Class</span></a></li> -<li><a href="../../../../org/apache/samza/task/StreamTask.html" title="interface in org.apache.samza.task"><span class="strong">Next Class</span></a></li> -</ul> -<ul class="navList"> -<li><a href="../../../../index.html?org/apache/samza/task/MessageCollector.html" target="_top">Frames</a></li> -<li><a href="MessageCollector.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> http://git-wip-us.apache.org/repos/asf/incubator-samza/blob/b2ecfef4/docs/learn/documentation/versioned/api/javadocs/org/apache/samza/task/StreamTask.html ---------------------------------------------------------------------- diff --git a/docs/learn/documentation/versioned/api/javadocs/org/apache/samza/task/StreamTask.html b/docs/learn/documentation/versioned/api/javadocs/org/apache/samza/task/StreamTask.html deleted file mode 100644 index 9e270fa..0000000 --- a/docs/learn/documentation/versioned/api/javadocs/org/apache/samza/task/StreamTask.html +++ /dev/null @@ -1,229 +0,0 @@ -<!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 Tue Aug 05 21:46:34 PDT 2014 --> -<title>StreamTask (samza-api 0.8.0-SNAPSHOT API)</title> -<meta name="date" content="2014-08-05"> -<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> -</head> -<body> -<script type="text/javascript"><!-- - if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="StreamTask (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/task/MessageCollector.html" title="interface in org.apache.samza.task"><span class="strong">Prev Class</span></a></li> -<li><a href="../../../../org/apache/samza/task/TaskContext.html" title="interface in org.apache.samza.task"><span class="strong">Next Class</span></a></li> -</ul> -<ul class="navList"> -<li><a href="../../../../index.html?org/apache/samza/task/StreamTask.html" target="_top">Frames</a></li> -<li><a href="StreamTask.html" target="_top">No Frames</a></li> -</ul> -<ul class="navList" id="allclasses_navbar_top"> -<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> -</ul> -<div> -<script type="text/javascript"><!-- - allClassesLink = document.getElementById("allclasses_navbar_top"); - if(window==top) { - allClassesLink.style.display = "block"; - } - else { - allClassesLink.style.display = "none"; - } - //--> -</script> -</div> -<div> -<ul class="subNavList"> -<li>Summary: </li> -<li>Nested | </li> -<li>Field | </li> -<li>Constr | </li> -<li><a href="#method_summary">Method</a></li> -</ul> -<ul class="subNavList"> -<li>Detail: </li> -<li>Field | </li> -<li>Constr | </li> -<li><a href="#method_detail">Method</a></li> -</ul> -</div> -<a name="skip-navbar_top"> -<!-- --> -</a></div> -<!-- ========= END OF TOP NAVBAR ========= --> -<!-- ======== START OF CLASS DATA ======== --> -<div class="header"> -<div class="subTitle">org.apache.samza.task</div> -<h2 title="Interface StreamTask" class="title">Interface StreamTask</h2> -</div> -<div class="contentContainer"> -<div class="description"> -<ul class="blockList"> -<li class="blockList"> -<hr> -<br> -<pre>public interface <span class="strong">StreamTask</span></pre> -<div class="block">A StreamTask is the basic class on which Samza jobs are implemented. Developers writing Samza jobs begin by - implementing this class, which processes messages from the job's input streams and writes messages out to - streams via the provided <a href="../../../../org/apache/samza/task/MessageCollector.html" title="interface in org.apache.samza.task"><code>MessageCollector</code></a>. A StreamTask may be augmented by - implementing other interfaces, such as <a href="../../../../org/apache/samza/task/InitableTask.html" title="interface in org.apache.samza.task"><code>InitableTask</code></a>, <a href="../../../../org/apache/samza/task/WindowableTask.html" title="interface in org.apache.samza.task"><code>WindowableTask</code></a>, - or <a href="../../../../org/apache/samza/task/ClosableTask.html" title="interface in org.apache.samza.task"><code>ClosableTask</code></a>. - <p> - The methods of StreamTasks and associated other tasks are guaranteed to be called in a single-threaded fashion; - no extra synchronization is necessary on the part of the class implementer. References to instances of - <a href="../../../../org/apache/samza/system/IncomingMessageEnvelope.html" title="class in org.apache.samza.system"><code>IncomingMessageEnvelope</code></a>s,<a href="../../../../org/apache/samza/task/MessageCollector.html" title="interface in org.apache.samza.task"><code>MessageCollector</code></a>s, and - <a href="../../../../org/apache/samza/task/TaskCoordinator.html" title="interface in org.apache.samza.task"><code>TaskCoordinator</code></a> should not be held onto between calls; there is no guarantee that - these will not be invalidated or otherwise used by the framework.</div> -</li> -</ul> -</div> -<div class="summary"> -<ul class="blockList"> -<li class="blockList"> -<!-- ========== METHOD SUMMARY =========== --> -<ul class="blockList"> -<li class="blockList"><a name="method_summary"> -<!-- --> -</a> -<h3>Method Summary</h3> -<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> -<caption><span>Methods</span><span class="tabEnd"> </span></caption> -<tr> -<th class="colFirst" scope="col">Modifier and Type</th> -<th class="colLast" scope="col">Method and Description</th> -</tr> -<tr class="altColor"> -<td class="colFirst"><code>void</code></td> -<td class="colLast"><code><strong><a href="../../../../org/apache/samza/task/StreamTask.html#process(org.apache.samza.system.IncomingMessageEnvelope,%20org.apache.samza.task.MessageCollector,%20org.apache.samza.task.TaskCoordinator)">process</a></strong>(<a href="../../../../org/apache/samza/system/IncomingMessageEnvelope.html" title="class in org.apache.samza.system">IncomingMessageEnvelope</a> envelope, - <a href="../../../../org/apache/samza/task/MessageCollector.html" title="interface in org.apache.samza.task">MessageCollector</a> collector, - <a href="../../../../org/apache/samza/task/TaskCoordinator.html" title="interface in org.apache.samza.task">TaskCoordinator</a> coordinator)</code> -<div class="block">Called once for each message that this StreamTask receives.</div> -</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="process(org.apache.samza.system.IncomingMessageEnvelope, org.apache.samza.task.MessageCollector, org.apache.samza.task.TaskCoordinator)"> -<!-- --> -</a> -<ul class="blockListLast"> -<li class="blockList"> -<h4>process</h4> -<pre>void process(<a href="../../../../org/apache/samza/system/IncomingMessageEnvelope.html" title="class in org.apache.samza.system">IncomingMessageEnvelope</a> envelope, - <a href="../../../../org/apache/samza/task/MessageCollector.html" title="interface in org.apache.samza.task">MessageCollector</a> collector, - <a href="../../../../org/apache/samza/task/TaskCoordinator.html" title="interface in org.apache.samza.task">TaskCoordinator</a> coordinator) - throws java.lang.Exception</pre> -<div class="block">Called once for each message that this StreamTask receives.</div> -<dl><dt><span class="strong">Parameters:</span></dt><dd><code>envelope</code> - Contains the received deserialized message and key, and also information regarding the stream and - partition of which the message was received from.</dd><dd><code>collector</code> - Contains the means of sending message envelopes to the output stream. The collector must only - be used during the current call to the process method; you should not reuse the collector between invocations - of this method.</dd><dd><code>coordinator</code> - Manages execution of tasks.</dd> -<dt><span class="strong">Throws:</span></dt> -<dd><code>java.lang.Exception</code> - Any exception types encountered during the execution of the processing task.</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/task/MessageCollector.html" title="interface in org.apache.samza.task"><span class="strong">Prev Class</span></a></li> -<li><a href="../../../../org/apache/samza/task/TaskContext.html" title="interface in org.apache.samza.task"><span class="strong">Next Class</span></a></li> -</ul> -<ul class="navList"> -<li><a href="../../../../index.html?org/apache/samza/task/StreamTask.html" target="_top">Frames</a></li> -<li><a href="StreamTask.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> http://git-wip-us.apache.org/repos/asf/incubator-samza/blob/b2ecfef4/docs/learn/documentation/versioned/api/javadocs/org/apache/samza/task/TaskContext.html ---------------------------------------------------------------------- diff --git a/docs/learn/documentation/versioned/api/javadocs/org/apache/samza/task/TaskContext.html b/docs/learn/documentation/versioned/api/javadocs/org/apache/samza/task/TaskContext.html deleted file mode 100644 index 454c3f0..0000000 --- a/docs/learn/documentation/versioned/api/javadocs/org/apache/samza/task/TaskContext.html +++ /dev/null @@ -1,245 +0,0 @@ -<!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 Tue Aug 05 21:46:34 PDT 2014 --> -<title>TaskContext (samza-api 0.8.0-SNAPSHOT API)</title> -<meta name="date" content="2014-08-05"> -<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> -</head> -<body> -<script type="text/javascript"><!-- - if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="TaskContext (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/task/StreamTask.html" title="interface in org.apache.samza.task"><span class="strong">Prev Class</span></a></li> -<li><a href="../../../../org/apache/samza/task/TaskCoordinator.html" title="interface in org.apache.samza.task"><span class="strong">Next Class</span></a></li> -</ul> -<ul class="navList"> -<li><a href="../../../../index.html?org/apache/samza/task/TaskContext.html" target="_top">Frames</a></li> -<li><a href="TaskContext.html" target="_top">No Frames</a></li> -</ul> -<ul class="navList" id="allclasses_navbar_top"> -<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> -</ul> -<div> -<script type="text/javascript"><!-- - allClassesLink = document.getElementById("allclasses_navbar_top"); - if(window==top) { - allClassesLink.style.display = "block"; - } - else { - allClassesLink.style.display = "none"; - } - //--> -</script> -</div> -<div> -<ul class="subNavList"> -<li>Summary: </li> -<li>Nested | </li> -<li>Field | </li> -<li>Constr | </li> -<li><a href="#method_summary">Method</a></li> -</ul> -<ul class="subNavList"> -<li>Detail: </li> -<li>Field | </li> -<li>Constr | </li> -<li><a href="#method_detail">Method</a></li> -</ul> -</div> -<a name="skip-navbar_top"> -<!-- --> -</a></div> -<!-- ========= END OF TOP NAVBAR ========= --> -<!-- ======== START OF CLASS DATA ======== --> -<div class="header"> -<div class="subTitle">org.apache.samza.task</div> -<h2 title="Interface TaskContext" class="title">Interface TaskContext</h2> -</div> -<div class="contentContainer"> -<div class="description"> -<ul class="blockList"> -<li class="blockList"> -<hr> -<br> -<pre>public interface <span class="strong">TaskContext</span></pre> -<div class="block">A TaskContext provides resources about the <a href="../../../../org/apache/samza/task/StreamTask.html" title="interface in org.apache.samza.task"><code>StreamTask</code></a>, particularly during - initialization in an <a href="../../../../org/apache/samza/task/InitableTask.html" title="interface in org.apache.samza.task"><code>InitableTask</code></a> and during calls to <a href="../../../../org/apache/samza/task/TaskLifecycleListener.html" title="interface in org.apache.samza.task"><code>TaskLifecycleListener</code></a>s.</div> -</li> -</ul> -</div> -<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/metrics/MetricsRegistry.html" title="interface in org.apache.samza.metrics">MetricsRegistry</a></code></td> -<td class="colLast"><code><strong><a href="../../../../org/apache/samza/task/TaskContext.html#getMetricsRegistry()">getMetricsRegistry</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/task/TaskContext.html#getStore(java.lang.String)">getStore</a></strong>(java.lang.String name)</code> </td> -</tr> -<tr class="altColor"> -<td class="colFirst"><code>java.util.Set<<a href="../../../../org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system">SystemStreamPartition</a>></code></td> -<td class="colLast"><code><strong><a href="../../../../org/apache/samza/task/TaskContext.html#getSystemStreamPartitions()">getSystemStreamPartitions</a></strong>()</code> </td> -</tr> -<tr class="rowColor"> -<td class="colFirst"><code><a href="../../../../org/apache/samza/container/TaskName.html" title="class in org.apache.samza.container">TaskName</a></code></td> -<td class="colLast"><code><strong><a href="../../../../org/apache/samza/task/TaskContext.html#getTaskName()">getTaskName</a></strong>()</code> </td> -</tr> -</table> -</li> -</ul> -</li> -</ul> -</div> -<div class="details"> -<ul class="blockList"> -<li class="blockList"> -<!-- ============ METHOD DETAIL ========== --> -<ul class="blockList"> -<li class="blockList"><a name="method_detail"> -<!-- --> -</a> -<h3>Method Detail</h3> -<a name="getMetricsRegistry()"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>getMetricsRegistry</h4> -<pre><a href="../../../../org/apache/samza/metrics/MetricsRegistry.html" title="interface in org.apache.samza.metrics">MetricsRegistry</a> getMetricsRegistry()</pre> -</li> -</ul> -<a name="getSystemStreamPartitions()"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>getSystemStreamPartitions</h4> -<pre>java.util.Set<<a href="../../../../org/apache/samza/system/SystemStreamPartition.html" title="class in org.apache.samza.system">SystemStreamPartition</a>> getSystemStreamPartitions()</pre> -</li> -</ul> -<a name="getStore(java.lang.String)"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>getStore</h4> -<pre>java.lang.Object getStore(java.lang.String name)</pre> -</li> -</ul> -<a name="getTaskName()"> -<!-- --> -</a> -<ul class="blockListLast"> -<li class="blockList"> -<h4>getTaskName</h4> -<pre><a href="../../../../org/apache/samza/container/TaskName.html" title="class in org.apache.samza.container">TaskName</a> getTaskName()</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/task/StreamTask.html" title="interface in org.apache.samza.task"><span class="strong">Prev Class</span></a></li> -<li><a href="../../../../org/apache/samza/task/TaskCoordinator.html" title="interface in org.apache.samza.task"><span class="strong">Next Class</span></a></li> -</ul> -<ul class="navList"> -<li><a href="../../../../index.html?org/apache/samza/task/TaskContext.html" target="_top">Frames</a></li> -<li><a href="TaskContext.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> http://git-wip-us.apache.org/repos/asf/incubator-samza/blob/b2ecfef4/docs/learn/documentation/versioned/api/javadocs/org/apache/samza/task/TaskCoordinator.RequestScope.html ---------------------------------------------------------------------- diff --git a/docs/learn/documentation/versioned/api/javadocs/org/apache/samza/task/TaskCoordinator.RequestScope.html b/docs/learn/documentation/versioned/api/javadocs/org/apache/samza/task/TaskCoordinator.RequestScope.html deleted file mode 100644 index e617316..0000000 --- a/docs/learn/documentation/versioned/api/javadocs/org/apache/samza/task/TaskCoordinator.RequestScope.html +++ /dev/null @@ -1,332 +0,0 @@ -<!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 Tue Aug 05 21:46:34 PDT 2014 --> -<title>TaskCoordinator.RequestScope (samza-api 0.8.0-SNAPSHOT API)</title> -<meta name="date" content="2014-08-05"> -<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> -</head> -<body> -<script type="text/javascript"><!-- - if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="TaskCoordinator.RequestScope (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/task/TaskCoordinator.html" title="interface in org.apache.samza.task"><span class="strong">Prev Class</span></a></li> -<li><a href="../../../../org/apache/samza/task/TaskLifecycleListener.html" title="interface in org.apache.samza.task"><span class="strong">Next Class</span></a></li> -</ul> -<ul class="navList"> -<li><a href="../../../../index.html?org/apache/samza/task/TaskCoordinator.RequestScope.html" target="_top">Frames</a></li> -<li><a href="TaskCoordinator.RequestScope.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="#enum_constant_summary">Enum Constants</a> | </li> -<li>Field | </li> -<li><a href="#method_summary">Method</a></li> -</ul> -<ul class="subNavList"> -<li>Detail: </li> -<li><a href="#enum_constant_detail">Enum Constants</a> | </li> -<li>Field | </li> -<li><a href="#method_detail">Method</a></li> -</ul> -</div> -<a name="skip-navbar_top"> -<!-- --> -</a></div> -<!-- ========= END OF TOP NAVBAR ========= --> -<!-- ======== START OF CLASS DATA ======== --> -<div class="header"> -<div class="subTitle">org.apache.samza.task</div> -<h2 title="Enum TaskCoordinator.RequestScope" class="title">Enum TaskCoordinator.RequestScope</h2> -</div> -<div class="contentContainer"> -<ul class="inheritance"> -<li>java.lang.Object</li> -<li> -<ul class="inheritance"> -<li>java.lang.Enum<<a href="../../../../org/apache/samza/task/TaskCoordinator.RequestScope.html" title="enum in org.apache.samza.task">TaskCoordinator.RequestScope</a>></li> -<li> -<ul class="inheritance"> -<li>org.apache.samza.task.TaskCoordinator.RequestScope</li> -</ul> -</li> -</ul> -</li> -</ul> -<div class="description"> -<ul class="blockList"> -<li class="blockList"> -<dl> -<dt>All Implemented Interfaces:</dt> -<dd>java.io.Serializable, java.lang.Comparable<<a href="../../../../org/apache/samza/task/TaskCoordinator.RequestScope.html" title="enum in org.apache.samza.task">TaskCoordinator.RequestScope</a>></dd> -</dl> -<dl> -<dt>Enclosing interface:</dt> -<dd><a href="../../../../org/apache/samza/task/TaskCoordinator.html" title="interface in org.apache.samza.task">TaskCoordinator</a></dd> -</dl> -<hr> -<br> -<pre>public static enum <span class="strong">TaskCoordinator.RequestScope</span> -extends java.lang.Enum<<a href="../../../../org/apache/samza/task/TaskCoordinator.RequestScope.html" title="enum in org.apache.samza.task">TaskCoordinator.RequestScope</a>></pre> -<div class="block">A task can make requests to the Samza framework while processing messages, such as - <a href="../../../../org/apache/samza/task/TaskCoordinator.html#commit(org.apache.samza.task.TaskCoordinator.RequestScope)"><code>TaskCoordinator.commit(RequestScope)</code></a> and - <a href="../../../../org/apache/samza/task/TaskCoordinator.html#shutdown(org.apache.samza.task.TaskCoordinator.RequestScope)"><code>TaskCoordinator.shutdown(RequestScope)</code></a>. This enum is used to indicate - whether those requests apply only to the current task, or to all tasks in the - current container.</div> -</li> -</ul> -</div> -<div class="summary"> -<ul class="blockList"> -<li class="blockList"> -<!-- =========== ENUM CONSTANT SUMMARY =========== --> -<ul class="blockList"> -<li class="blockList"><a name="enum_constant_summary"> -<!-- --> -</a> -<h3>Enum Constant Summary</h3> -<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Constant Summary table, listing enum constants, and an explanation"> -<caption><span>Enum Constants</span><span class="tabEnd"> </span></caption> -<tr> -<th class="colOne" scope="col">Enum Constant and Description</th> -</tr> -<tr class="altColor"> -<td class="colOne"><code><strong><a href="../../../../org/apache/samza/task/TaskCoordinator.RequestScope.html#ALL_TASKS_IN_CONTAINER">ALL_TASKS_IN_CONTAINER</a></strong></code> -<div class="block">Indicates that a request applies to all tasks in the current container.</div> -</td> -</tr> -<tr class="rowColor"> -<td class="colOne"><code><strong><a href="../../../../org/apache/samza/task/TaskCoordinator.RequestScope.html#CURRENT_TASK">CURRENT_TASK</a></strong></code> -<div class="block">Indicates that a request applies only to the task making the call.</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>static <a href="../../../../org/apache/samza/task/TaskCoordinator.RequestScope.html" title="enum in org.apache.samza.task">TaskCoordinator.RequestScope</a></code></td> -<td class="colLast"><code><strong><a href="../../../../org/apache/samza/task/TaskCoordinator.RequestScope.html#valueOf(java.lang.String)">valueOf</a></strong>(java.lang.String name)</code> -<div class="block">Returns the enum constant of this type with the specified name.</div> -</td> -</tr> -<tr class="rowColor"> -<td class="colFirst"><code>static <a href="../../../../org/apache/samza/task/TaskCoordinator.RequestScope.html" title="enum in org.apache.samza.task">TaskCoordinator.RequestScope</a>[]</code></td> -<td class="colLast"><code><strong><a href="../../../../org/apache/samza/task/TaskCoordinator.RequestScope.html#values()">values</a></strong>()</code> -<div class="block">Returns an array containing the constants of this enum type, in -the order they are declared.</div> -</td> -</tr> -</table> -<ul class="blockList"> -<li class="blockList"><a name="methods_inherited_from_class_java.lang.Enum"> -<!-- --> -</a> -<h3>Methods inherited from class java.lang.Enum</h3> -<code>clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf</code></li> -</ul> -<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>getClass, notify, notifyAll, wait, wait, wait</code></li> -</ul> -</li> -</ul> -</li> -</ul> -</div> -<div class="details"> -<ul class="blockList"> -<li class="blockList"> -<!-- ============ ENUM CONSTANT DETAIL =========== --> -<ul class="blockList"> -<li class="blockList"><a name="enum_constant_detail"> -<!-- --> -</a> -<h3>Enum Constant Detail</h3> -<a name="CURRENT_TASK"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>CURRENT_TASK</h4> -<pre>public static final <a href="../../../../org/apache/samza/task/TaskCoordinator.RequestScope.html" title="enum in org.apache.samza.task">TaskCoordinator.RequestScope</a> CURRENT_TASK</pre> -<div class="block">Indicates that a request applies only to the task making the call.</div> -</li> -</ul> -<a name="ALL_TASKS_IN_CONTAINER"> -<!-- --> -</a> -<ul class="blockListLast"> -<li class="blockList"> -<h4>ALL_TASKS_IN_CONTAINER</h4> -<pre>public static final <a href="../../../../org/apache/samza/task/TaskCoordinator.RequestScope.html" title="enum in org.apache.samza.task">TaskCoordinator.RequestScope</a> ALL_TASKS_IN_CONTAINER</pre> -<div class="block">Indicates that a request applies to all tasks in the current container.</div> -</li> -</ul> -</li> -</ul> -<!-- ============ METHOD DETAIL ========== --> -<ul class="blockList"> -<li class="blockList"><a name="method_detail"> -<!-- --> -</a> -<h3>Method Detail</h3> -<a name="values()"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>values</h4> -<pre>public static <a href="../../../../org/apache/samza/task/TaskCoordinator.RequestScope.html" title="enum in org.apache.samza.task">TaskCoordinator.RequestScope</a>[] values()</pre> -<div class="block">Returns an array containing the constants of this enum type, in -the order they are declared. This method may be used to iterate -over the constants as follows: -<pre> -for (TaskCoordinator.RequestScope c : TaskCoordinator.RequestScope.values()) - System.out.println(c); -</pre></div> -<dl><dt><span class="strong">Returns:</span></dt><dd>an array containing the constants of this enum type, in the order they are declared</dd></dl> -</li> -</ul> -<a name="valueOf(java.lang.String)"> -<!-- --> -</a> -<ul class="blockListLast"> -<li class="blockList"> -<h4>valueOf</h4> -<pre>public static <a href="../../../../org/apache/samza/task/TaskCoordinator.RequestScope.html" title="enum in org.apache.samza.task">TaskCoordinator.RequestScope</a> valueOf(java.lang.String name)</pre> -<div class="block">Returns the enum constant of this type with the specified name. -The string must match <i>exactly</i> an identifier used to declare an -enum constant in this type. (Extraneous whitespace characters are -not permitted.)</div> -<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - the name of the enum constant to be returned.</dd> -<dt><span class="strong">Returns:</span></dt><dd>the enum constant with the specified name</dd> -<dt><span class="strong">Throws:</span></dt> -<dd><code>java.lang.IllegalArgumentException</code> - if this enum type has no constant with the specified name</dd> -<dd><code>java.lang.NullPointerException</code> - if the argument is null</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/task/TaskCoordinator.html" title="interface in org.apache.samza.task"><span class="strong">Prev Class</span></a></li> -<li><a href="../../../../org/apache/samza/task/TaskLifecycleListener.html" title="interface in org.apache.samza.task"><span class="strong">Next Class</span></a></li> -</ul> -<ul class="navList"> -<li><a href="../../../../index.html?org/apache/samza/task/TaskCoordinator.RequestScope.html" target="_top">Frames</a></li> -<li><a href="TaskCoordinator.RequestScope.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="#enum_constant_summary">Enum Constants</a> | </li> -<li>Field | </li> -<li><a href="#method_summary">Method</a></li> -</ul> -<ul class="subNavList"> -<li>Detail: </li> -<li><a href="#enum_constant_detail">Enum Constants</a> | </li> -<li>Field | </li> -<li><a href="#method_detail">Method</a></li> -</ul> -</div> -<a name="skip-navbar_bottom"> -<!-- --> -</a></div> -<!-- ======== END OF BOTTOM NAVBAR ======= --> -</body> -</html> http://git-wip-us.apache.org/repos/asf/incubator-samza/blob/b2ecfef4/docs/learn/documentation/versioned/api/javadocs/org/apache/samza/task/TaskCoordinator.html ---------------------------------------------------------------------- diff --git a/docs/learn/documentation/versioned/api/javadocs/org/apache/samza/task/TaskCoordinator.html b/docs/learn/documentation/versioned/api/javadocs/org/apache/samza/task/TaskCoordinator.html deleted file mode 100644 index 77ee4cf..0000000 --- a/docs/learn/documentation/versioned/api/javadocs/org/apache/samza/task/TaskCoordinator.html +++ /dev/null @@ -1,279 +0,0 @@ -<!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 Tue Aug 05 21:46:34 PDT 2014 --> -<title>TaskCoordinator (samza-api 0.8.0-SNAPSHOT API)</title> -<meta name="date" content="2014-08-05"> -<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> -</head> -<body> -<script type="text/javascript"><!-- - if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="TaskCoordinator (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/task/TaskContext.html" title="interface in org.apache.samza.task"><span class="strong">Prev Class</span></a></li> -<li><a href="../../../../org/apache/samza/task/TaskCoordinator.RequestScope.html" title="enum in org.apache.samza.task"><span class="strong">Next Class</span></a></li> -</ul> -<ul class="navList"> -<li><a href="../../../../index.html?org/apache/samza/task/TaskCoordinator.html" target="_top">Frames</a></li> -<li><a href="TaskCoordinator.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><a href="#nested_class_summary">Nested</a> | </li> -<li>Field | </li> -<li>Constr | </li> -<li><a href="#method_summary">Method</a></li> -</ul> -<ul class="subNavList"> -<li>Detail: </li> -<li>Field | </li> -<li>Constr | </li> -<li><a href="#method_detail">Method</a></li> -</ul> -</div> -<a name="skip-navbar_top"> -<!-- --> -</a></div> -<!-- ========= END OF TOP NAVBAR ========= --> -<!-- ======== START OF CLASS DATA ======== --> -<div class="header"> -<div class="subTitle">org.apache.samza.task</div> -<h2 title="Interface TaskCoordinator" class="title">Interface TaskCoordinator</h2> -</div> -<div class="contentContainer"> -<div class="description"> -<ul class="blockList"> -<li class="blockList"> -<hr> -<br> -<pre>public interface <span class="strong">TaskCoordinator</span></pre> -<div class="block">TaskCoordinators are provided to the process methods of <a href="../../../../org/apache/samza/task/StreamTask.html" title="interface in org.apache.samza.task"><code>StreamTask</code></a> implementations - to allow the user code to request actions from the Samza framework, including committing the current checkpoints - to configured <a href="../../../../org/apache/samza/checkpoint/CheckpointManager.html" title="interface in org.apache.samza.checkpoint"><code>CheckpointManager</code></a>s or shutting down the task or all tasks within - a container. - <p> - This interface may evolve over time. - </p></div> -</li> -</ul> -</div> -<div class="summary"> -<ul class="blockList"> -<li class="blockList"> -<!-- ======== NESTED CLASS SUMMARY ======== --> -<ul class="blockList"> -<li class="blockList"><a name="nested_class_summary"> -<!-- --> -</a> -<h3>Nested Class Summary</h3> -<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> -<caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> -<tr> -<th class="colFirst" scope="col">Modifier and Type</th> -<th class="colLast" scope="col">Interface and Description</th> -</tr> -<tr class="altColor"> -<td class="colFirst"><code>static class </code></td> -<td class="colLast"><code><strong><a href="../../../../org/apache/samza/task/TaskCoordinator.RequestScope.html" title="enum in org.apache.samza.task">TaskCoordinator.RequestScope</a></strong></code> -<div class="block">A task can make requests to the Samza framework while processing messages, such as - <a href="../../../../org/apache/samza/task/TaskCoordinator.html#commit(org.apache.samza.task.TaskCoordinator.RequestScope)"><code>commit(RequestScope)</code></a> and - <a href="../../../../org/apache/samza/task/TaskCoordinator.html#shutdown(org.apache.samza.task.TaskCoordinator.RequestScope)"><code>shutdown(RequestScope)</code></a>.</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>void</code></td> -<td class="colLast"><code><strong><a href="../../../../org/apache/samza/task/TaskCoordinator.html#commit(org.apache.samza.task.TaskCoordinator.RequestScope)">commit</a></strong>(<a href="../../../../org/apache/samza/task/TaskCoordinator.RequestScope.html" title="enum in org.apache.samza.task">TaskCoordinator.RequestScope</a> scope)</code> -<div class="block">Requests that Samza should write out a checkpoint, from which a task can restart - after failure.</div> -</td> -</tr> -<tr class="rowColor"> -<td class="colFirst"><code>void</code></td> -<td class="colLast"><code><strong><a href="../../../../org/apache/samza/task/TaskCoordinator.html#shutdown(org.apache.samza.task.TaskCoordinator.RequestScope)">shutdown</a></strong>(<a href="../../../../org/apache/samza/task/TaskCoordinator.RequestScope.html" title="enum in org.apache.samza.task">TaskCoordinator.RequestScope</a> scope)</code> -<div class="block">Requests that the container should be shut down.</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="commit(org.apache.samza.task.TaskCoordinator.RequestScope)"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>commit</h4> -<pre>void commit(<a href="../../../../org/apache/samza/task/TaskCoordinator.RequestScope.html" title="enum in org.apache.samza.task">TaskCoordinator.RequestScope</a> scope)</pre> -<div class="block">Requests that Samza should write out a checkpoint, from which a task can restart - after failure. - - <p>If <code>CURRENT_TASK</code> is given, a checkpoint is only written for the - current task. If <code>ALL_TASKS_IN_CONTAINER</code> is given, a checkpoint is - written for all tasks in the current container. - - <p>Note that if you also have also configured your job to commit in regular - intervals (using the <code>task.commit.ms</code> property), those time-based - commits are not affected by calling this method. Any commits you request explicitly - are in addition to timer-based commits. You can set <code>task.commit.ms=-1</code> - if you don't want commits to happen automatically.</div> -<dl><dt><span class="strong">Parameters:</span></dt><dd><code>scope</code> - Which tasks are being asked to commit.</dd></dl> -</li> -</ul> -<a name="shutdown(org.apache.samza.task.TaskCoordinator.RequestScope)"> -<!-- --> -</a> -<ul class="blockListLast"> -<li class="blockList"> -<h4>shutdown</h4> -<pre>void shutdown(<a href="../../../../org/apache/samza/task/TaskCoordinator.RequestScope.html" title="enum in org.apache.samza.task">TaskCoordinator.RequestScope</a> scope)</pre> -<div class="block">Requests that the container should be shut down. - - <p>If <code>CURRENT_TASK</code> is given, that indicates a willingness of the current - task to shut down. All tasks in the container (including the one that requested - shutdown) will continue processing messages. Only when every task in the container - has called <code>shutdown(CURRENT_TASK)</code>, the container is shut down. Once a - task has called <code>shutdown(CURRENT_TASK)</code>, it cannot change its mind - (i.e. it cannot revoke its willingness to shut down). - - <p>If <code>ALL_TASKS_IN_CONTAINER</code> is given, the container will shut down - immediately after it has finished processing the current message. Any buffers of - pending writes are flushed, but no further messages will be processed in this - container.</div> -<dl><dt><span class="strong">Parameters:</span></dt><dd><code>scope</code> - The approach we should use for shutting down the container.</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/task/TaskContext.html" title="interface in org.apache.samza.task"><span class="strong">Prev Class</span></a></li> -<li><a href="../../../../org/apache/samza/task/TaskCoordinator.RequestScope.html" title="enum in org.apache.samza.task"><span class="strong">Next Class</span></a></li> -</ul> -<ul class="navList"> -<li><a href="../../../../index.html?org/apache/samza/task/TaskCoordinator.html" target="_top">Frames</a></li> -<li><a href="TaskCoordinator.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><a href="#nested_class_summary">Nested</a> | </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> http://git-wip-us.apache.org/repos/asf/incubator-samza/blob/b2ecfef4/docs/learn/documentation/versioned/api/javadocs/org/apache/samza/task/TaskLifecycleListener.html ---------------------------------------------------------------------- diff --git a/docs/learn/documentation/versioned/api/javadocs/org/apache/samza/task/TaskLifecycleListener.html b/docs/learn/documentation/versioned/api/javadocs/org/apache/samza/task/TaskLifecycleListener.html deleted file mode 100644 index dc95c4d..0000000 --- a/docs/learn/documentation/versioned/api/javadocs/org/apache/samza/task/TaskLifecycleListener.html +++ /dev/null @@ -1,311 +0,0 @@ -<!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 Tue Aug 05 21:46:34 PDT 2014 --> -<title>TaskLifecycleListener (samza-api 0.8.0-SNAPSHOT API)</title> -<meta name="date" content="2014-08-05"> -<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> -</head> -<body> -<script type="text/javascript"><!-- - if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="TaskLifecycleListener (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/task/TaskCoordinator.RequestScope.html" title="enum in org.apache.samza.task"><span class="strong">Prev Class</span></a></li> -<li><a href="../../../../org/apache/samza/task/TaskLifecycleListenerFactory.html" title="interface in org.apache.samza.task"><span class="strong">Next Class</span></a></li> -</ul> -<ul class="navList"> -<li><a href="../../../../index.html?org/apache/samza/task/TaskLifecycleListener.html" target="_top">Frames</a></li> -<li><a href="TaskLifecycleListener.html" target="_top">No Frames</a></li> -</ul> -<ul class="navList" id="allclasses_navbar_top"> -<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> -</ul> -<div> -<script type="text/javascript"><!-- - allClassesLink = document.getElementById("allclasses_navbar_top"); - if(window==top) { - allClassesLink.style.display = "block"; - } - else { - allClassesLink.style.display = "none"; - } - //--> -</script> -</div> -<div> -<ul class="subNavList"> -<li>Summary: </li> -<li>Nested | </li> -<li>Field | </li> -<li>Constr | </li> -<li><a href="#method_summary">Method</a></li> -</ul> -<ul class="subNavList"> -<li>Detail: </li> -<li>Field | </li> -<li>Constr | </li> -<li><a href="#method_detail">Method</a></li> -</ul> -</div> -<a name="skip-navbar_top"> -<!-- --> -</a></div> -<!-- ========= END OF TOP NAVBAR ========= --> -<!-- ======== START OF CLASS DATA ======== --> -<div class="header"> -<div class="subTitle">org.apache.samza.task</div> -<h2 title="Interface TaskLifecycleListener" class="title">Interface TaskLifecycleListener</h2> -</div> -<div class="contentContainer"> -<div class="description"> -<ul class="blockList"> -<li class="blockList"> -<hr> -<br> -<pre>public interface <span class="strong">TaskLifecycleListener</span></pre> -<div class="block">Used to get before/after notifications before initializing/closing all tasks - in a given container (JVM/process).</div> -</li> -</ul> -</div> -<div class="summary"> -<ul class="blockList"> -<li class="blockList"> -<!-- ========== METHOD SUMMARY =========== --> -<ul class="blockList"> -<li class="blockList"><a name="method_summary"> -<!-- --> -</a> -<h3>Method Summary</h3> -<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> -<caption><span>Methods</span><span class="tabEnd"> </span></caption> -<tr> -<th class="colFirst" scope="col">Modifier and Type</th> -<th class="colLast" scope="col">Method and Description</th> -</tr> -<tr class="altColor"> -<td class="colFirst"><code>void</code></td> -<td class="colLast"><code><strong><a href="../../../../org/apache/samza/task/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,%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,%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> -</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#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,%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,%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> -</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="beforeInit(org.apache.samza.config.Config, org.apache.samza.task.TaskContext)"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>beforeInit</h4> -<pre>void beforeInit(<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)</pre> -<div class="block">Called before all tasks in TaskRunner are initialized.</div> -<dl><dt><span class="strong">Parameters:</span></dt><dd><code>config</code> - Config for the Samza job.</dd><dd><code>context</code> - TaskContext for the StreamTask that's being initialized.</dd></dl> -</li> -</ul> -<a name="afterInit(org.apache.samza.config.Config, org.apache.samza.task.TaskContext)"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>afterInit</h4> -<pre>void afterInit(<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)</pre> -<div class="block">Called after all tasks in TaskRunner are initialized.</div> -<dl><dt><span class="strong">Parameters:</span></dt><dd><code>config</code> - Config for the Samza job.</dd><dd><code>context</code> - TaskContext for the StreamTask that's being initialized.</dd></dl> -</li> -</ul> -<a name="beforeProcess(org.apache.samza.system.IncomingMessageEnvelope, org.apache.samza.config.Config, org.apache.samza.task.TaskContext)"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>beforeProcess</h4> -<pre>void beforeProcess(<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)</pre> -<div class="block">Called before a message is processed by a task.</div> -<dl><dt><span class="strong">Parameters:</span></dt><dd><code>envelope</code> - The envelope to be processed by the StreamTask.</dd><dd><code>config</code> - Config for the Samza job.</dd><dd><code>context</code> - TaskContext for the StreamTask that's about to process a message.</dd></dl> -</li> -</ul> -<a name="afterProcess(org.apache.samza.system.IncomingMessageEnvelope, org.apache.samza.config.Config, org.apache.samza.task.TaskContext)"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>afterProcess</h4> -<pre>void afterProcess(<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)</pre> -<div class="block">Called after a message is processed by a task.</div> -<dl><dt><span class="strong">Parameters:</span></dt><dd><code>envelope</code> - The envelope that was processed by the StreamTask.</dd><dd><code>config</code> - Config for the Samza job.</dd><dd><code>context</code> - TaskContext for the StreamTask that just processed a message.</dd></dl> -</li> -</ul> -<a name="beforeClose(org.apache.samza.config.Config, org.apache.samza.task.TaskContext)"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>beforeClose</h4> -<pre>void beforeClose(<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)</pre> -<div class="block">Called before all tasks in TaskRunner are closed.</div> -<dl><dt><span class="strong">Parameters:</span></dt><dd><code>config</code> - Config for the Samza job.</dd><dd><code>context</code> - TaskContext for the StreamTask that's about to be shutdown.</dd></dl> -</li> -</ul> -<a name="afterClose(org.apache.samza.config.Config, org.apache.samza.task.TaskContext)"> -<!-- --> -</a> -<ul class="blockListLast"> -<li class="blockList"> -<h4>afterClose</h4> -<pre>void afterClose(<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)</pre> -<div class="block">Called after all tasks in TaskRunner are closed.</div> -<dl><dt><span class="strong">Parameters:</span></dt><dd><code>config</code> - Config for the Samza job.</dd><dd><code>context</code> - TaskContext for the StreamTask that was just shutdown.</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/task/TaskCoordinator.RequestScope.html" title="enum in org.apache.samza.task"><span class="strong">Prev Class</span></a></li> -<li><a href="../../../../org/apache/samza/task/TaskLifecycleListenerFactory.html" title="interface in org.apache.samza.task"><span class="strong">Next Class</span></a></li> -</ul> -<ul class="navList"> -<li><a href="../../../../index.html?org/apache/samza/task/TaskLifecycleListener.html" target="_top">Frames</a></li> -<li><a href="TaskLifecycleListener.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>
