Added: samza/site/learn/documentation/latest/rest/javadocs/org/apache/samza/rest/resources/JobsResourceConfig.html URL: http://svn.apache.org/viewvc/samza/site/learn/documentation/latest/rest/javadocs/org/apache/samza/rest/resources/JobsResourceConfig.html?rev=1757411&view=auto ============================================================================== --- samza/site/learn/documentation/latest/rest/javadocs/org/apache/samza/rest/resources/JobsResourceConfig.html (added) +++ samza/site/learn/documentation/latest/rest/javadocs/org/apache/samza/rest/resources/JobsResourceConfig.html Tue Aug 23 17:38:58 2016 @@ -0,0 +1,440 @@ +<!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 (1.8.0_102) on Tue Aug 23 00:00:09 PDT 2016 --> +<title>JobsResourceConfig (samza-rest 0.10.1-SNAPSHOT API)</title> +<meta name="date" content="2016-08-23"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +</head> +<body> +<script type="text/javascript"><!-- + try { + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="JobsResourceConfig (samza-rest 0.10.1-SNAPSHOT API)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":10,"i1":10}; +var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; +var altColor = "altColor"; +var rowColor = "rowColor"; +var tableTab = "tableTab"; +var activeTableTab = "activeTableTab"; +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar.top"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> +<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/rest/resources/JobsResource.html" title="class in org.apache.samza.rest.resources"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/samza/rest/resources/ResourceFactory.html" title="interface in org.apache.samza.rest.resources"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/samza/rest/resources/JobsResourceConfig.html" target="_top">Frames</a></li> +<li><a href="JobsResourceConfig.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.rest.resources</div> +<h2 title="Class JobsResourceConfig" class="title">Class JobsResourceConfig</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>org.apache.samza.config.Config</li> +<li> +<ul class="inheritance"> +<li>org.apache.samza.config.MapConfig</li> +<li> +<ul class="inheritance"> +<li>org.apache.samza.rest.resources.JobsResourceConfig</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd>java.util.Map<java.lang.String,java.lang.String></dd> +</dl> +<hr> +<br> +<pre>public class <span class="typeNameLabel">JobsResourceConfig</span> +extends org.apache.samza.config.MapConfig</pre> +<div class="block">Configurations for the <a href="../../../../../org/apache/samza/rest/resources/JobsResource.html" title="class in org.apache.samza.rest.resources"><code>JobsResource</code></a> endpoint.</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> +<ul class="blockList"> +<li class="blockList"><a name="nested.classes.inherited.from.class.java.util.Map"> +<!-- --> +</a> +<h3>Nested classes/interfaces inherited from interface java.util.Map</h3> +<code>java.util.Map.Entry<K,V></code></li> +</ul> +</li> +</ul> +<!-- =========== FIELD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field.summary"> +<!-- --> +</a> +<h3>Field Summary</h3> +<table class="memberSummary" 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 java.lang.String</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/samza/rest/resources/JobsResourceConfig.html#CONFIG_JOB_CONFIG_FACTORY">CONFIG_JOB_CONFIG_FACTORY</a></span></code> +<div class="block">Specifies the canonical name of the <code>ConfigFactory</code> to read the job configs.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/samza/rest/resources/JobsResourceConfig.html#CONFIG_JOB_INSTALLATIONS_PATH">CONFIG_JOB_INSTALLATIONS_PATH</a></span></code> +<div class="block">The path where all the Samza jobs are installed (unzipped).</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/samza/rest/resources/JobsResourceConfig.html#CONFIG_JOB_PROXY_FACTORY">CONFIG_JOB_PROXY_FACTORY</a></span></code> +<div class="block">Specifies the canonical name of the <a href="../../../../../org/apache/samza/rest/proxy/job/JobProxyFactory.html" title="interface in org.apache.samza.rest.proxy.job"><code>JobProxyFactory</code></a> class to produce + <a href="../../../../../org/apache/samza/rest/proxy/job/JobProxy.html" title="interface in org.apache.samza.rest.proxy.job"><code>JobProxy</code></a> instances.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="fields.inherited.from.class.org.apache.samza.config.Config"> +<!-- --> +</a> +<h3>Fields inherited from class org.apache.samza.config.Config</h3> +<code>SENSITIVE_MASK, SENSITIVE_PREFIX</code></li> +</ul> +</li> +</ul> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="memberSummary" 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><span class="memberNameLink"><a href="../../../../../org/apache/samza/rest/resources/JobsResourceConfig.html#JobsResourceConfig-org.apache.samza.config.Config-">JobsResourceConfig</a></span>(org.apache.samza.config.Config config)</code> </td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr id="i0" class="altColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/samza/rest/resources/JobsResourceConfig.html#getInstallationsPath--">getInstallationsPath</a></span>()</code> </td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/samza/rest/resources/JobsResourceConfig.html#getJobProxyFactory--">getJobProxyFactory</a></span>()</code> </td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.org.apache.samza.config.MapConfig"> +<!-- --> +</a> +<h3>Methods inherited from class org.apache.samza.config.MapConfig</h3> +<code>containsKey, containsValue, entrySet, equals, get, hashCode, isEmpty, keySet, sanitize, size, toString, values</code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.org.apache.samza.config.Config"> +<!-- --> +</a> +<h3>Methods inherited from class org.apache.samza.config.Config</h3> +<code>clear, get, getBoolean, getBoolean, getClass, getDate, getDate, getDate, getDate, getDate, getDate, getDouble, getDouble, getInt, getInt, getList, getList, getLong, getLong, getNewInstance, getShort, getShort, put, putAll, regexSubset, remove, subset, subset</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>clone, finalize, getClass, notify, notifyAll, wait, wait, wait</code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.java.util.Map"> +<!-- --> +</a> +<h3>Methods inherited from interface java.util.Map</h3> +<code>compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll</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="CONFIG_JOB_PROXY_FACTORY"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>CONFIG_JOB_PROXY_FACTORY</h4> +<pre>public static final java.lang.String CONFIG_JOB_PROXY_FACTORY</pre> +<div class="block">Specifies the canonical name of the <a href="../../../../../org/apache/samza/rest/proxy/job/JobProxyFactory.html" title="interface in org.apache.samza.rest.proxy.job"><code>JobProxyFactory</code></a> class to produce + <a href="../../../../../org/apache/samza/rest/proxy/job/JobProxy.html" title="interface in org.apache.samza.rest.proxy.job"><code>JobProxy</code></a> instances. + + To use your own proxy, implement the factory and specify the class for this config.</div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../../constant-values.html#org.apache.samza.rest.resources.JobsResourceConfig.CONFIG_JOB_PROXY_FACTORY">Constant Field Values</a></dd> +</dl> +</li> +</ul> +<a name="CONFIG_JOB_INSTALLATIONS_PATH"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>CONFIG_JOB_INSTALLATIONS_PATH</h4> +<pre>public static final java.lang.String CONFIG_JOB_INSTALLATIONS_PATH</pre> +<div class="block">The path where all the Samza jobs are installed (unzipped). Each subdirectory of this path + is expected to be a Samza job installation and corresponds to one <a href="../../../../../org/apache/samza/rest/proxy/installation/InstallationRecord.html" title="class in org.apache.samza.rest.proxy.installation"><code>InstallationRecord</code></a>.</div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../../constant-values.html#org.apache.samza.rest.resources.JobsResourceConfig.CONFIG_JOB_INSTALLATIONS_PATH">Constant Field Values</a></dd> +</dl> +</li> +</ul> +<a name="CONFIG_JOB_CONFIG_FACTORY"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>CONFIG_JOB_CONFIG_FACTORY</h4> +<pre>public static final java.lang.String CONFIG_JOB_CONFIG_FACTORY</pre> +<div class="block">Specifies the canonical name of the <code>ConfigFactory</code> to read the job configs.</div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../../constant-values.html#org.apache.samza.rest.resources.JobsResourceConfig.CONFIG_JOB_CONFIG_FACTORY">Constant Field Values</a></dd> +</dl> +</li> +</ul> +</li> +</ul> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="JobsResourceConfig-org.apache.samza.config.Config-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>JobsResourceConfig</h4> +<pre>public JobsResourceConfig(org.apache.samza.config.Config config)</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="getJobProxyFactory--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getJobProxyFactory</h4> +<pre>public java.lang.String getJobProxyFactory()</pre> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the canonical name of the <a href="../../../../../org/apache/samza/rest/proxy/job/JobProxyFactory.html" title="interface in org.apache.samza.rest.proxy.job"><code>JobProxyFactory</code></a> class to produce <a href="../../../../../org/apache/samza/rest/proxy/job/JobProxy.html" title="interface in org.apache.samza.rest.proxy.job"><code>JobProxy</code></a> instances.</dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../../org/apache/samza/rest/resources/JobsResourceConfig.html#CONFIG_JOB_CONFIG_FACTORY"><code>CONFIG_JOB_CONFIG_FACTORY</code></a></dd> +</dl> +</li> +</ul> +<a name="getInstallationsPath--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getInstallationsPath</h4> +<pre>public java.lang.String getInstallationsPath()</pre> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the path where all the Samza jobs are installed (unzipped).</dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../../org/apache/samza/rest/resources/JobsResourceConfig.html#CONFIG_JOB_INSTALLATIONS_PATH"><code>CONFIG_JOB_INSTALLATIONS_PATH</code></a></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> +<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> +<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/rest/resources/JobsResource.html" title="class in org.apache.samza.rest.resources"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/samza/rest/resources/ResourceFactory.html" title="interface in org.apache.samza.rest.resources"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/samza/rest/resources/JobsResourceConfig.html" target="_top">Frames</a></li> +<li><a href="JobsResourceConfig.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>
Added: samza/site/learn/documentation/latest/rest/javadocs/org/apache/samza/rest/resources/ResourceFactory.html URL: http://svn.apache.org/viewvc/samza/site/learn/documentation/latest/rest/javadocs/org/apache/samza/rest/resources/ResourceFactory.html?rev=1757411&view=auto ============================================================================== --- samza/site/learn/documentation/latest/rest/javadocs/org/apache/samza/rest/resources/ResourceFactory.html (added) +++ samza/site/learn/documentation/latest/rest/javadocs/org/apache/samza/rest/resources/ResourceFactory.html Tue Aug 23 17:38:58 2016 @@ -0,0 +1,235 @@ +<!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 (1.8.0_102) on Tue Aug 23 00:00:09 PDT 2016 --> +<title>ResourceFactory (samza-rest 0.10.1-SNAPSHOT API)</title> +<meta name="date" content="2016-08-23"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +</head> +<body> +<script type="text/javascript"><!-- + try { + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="ResourceFactory (samza-rest 0.10.1-SNAPSHOT API)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":6}; +var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]}; +var altColor = "altColor"; +var rowColor = "rowColor"; +var tableTab = "tableTab"; +var activeTableTab = "activeTableTab"; +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar.top"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> +<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/rest/resources/JobsResourceConfig.html" title="class in org.apache.samza.rest.resources"><span class="typeNameLink">Prev Class</span></a></li> +<li>Next Class</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/samza/rest/resources/ResourceFactory.html" target="_top">Frames</a></li> +<li><a href="ResourceFactory.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.rest.resources</div> +<h2 title="Interface ResourceFactory" class="title">Interface ResourceFactory</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/rest/resources/DefaultResourceFactory.html" title="class in org.apache.samza.rest.resources">DefaultResourceFactory</a></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="typeNameLabel">ResourceFactory</span></pre> +<div class="block">Instantiates a resource using the provided config. + + This is used to instantiate and register a specific instance of the object rather than registering the class.</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="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr id="i0" class="altColor"> +<td class="colFirst"><code>java.util.List<? extends java.lang.Object></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/samza/rest/resources/ResourceFactory.html#getResourceInstances-org.apache.samza.config.Config-">getResourceInstances</a></span>(org.apache.samza.config.Config config)</code> +<div class="block">Constructs and returns resource instances to register with the server.</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="getResourceInstances-org.apache.samza.config.Config-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getResourceInstances</h4> +<pre>java.util.List<? extends java.lang.Object> getResourceInstances(org.apache.samza.config.Config config)</pre> +<div class="block">Constructs and returns resource instances to register with the server.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>config</code> - the server config used to initialize the objects.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>a collection of instances to register with the server.</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> +<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> +<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/rest/resources/JobsResourceConfig.html" title="class in org.apache.samza.rest.resources"><span class="typeNameLink">Prev Class</span></a></li> +<li>Next Class</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/samza/rest/resources/ResourceFactory.html" target="_top">Frames</a></li> +<li><a href="ResourceFactory.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: samza/site/learn/documentation/latest/rest/javadocs/org/apache/samza/rest/resources/package-frame.html URL: http://svn.apache.org/viewvc/samza/site/learn/documentation/latest/rest/javadocs/org/apache/samza/rest/resources/package-frame.html?rev=1757411&view=auto ============================================================================== --- samza/site/learn/documentation/latest/rest/javadocs/org/apache/samza/rest/resources/package-frame.html (added) +++ samza/site/learn/documentation/latest/rest/javadocs/org/apache/samza/rest/resources/package-frame.html Tue Aug 23 17:38:58 2016 @@ -0,0 +1,26 @@ +<!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 (1.8.0_102) on Tue Aug 23 00:00:10 PDT 2016 --> +<title>org.apache.samza.rest.resources (samza-rest 0.10.1-SNAPSHOT API)</title> +<meta name="date" content="2016-08-23"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +</head> +<body> +<h1 class="bar"><a href="../../../../../org/apache/samza/rest/resources/package-summary.html" target="classFrame">org.apache.samza.rest.resources</a></h1> +<div class="indexContainer"> +<h2 title="Interfaces">Interfaces</h2> +<ul title="Interfaces"> +<li><a href="ResourceFactory.html" title="interface in org.apache.samza.rest.resources" target="classFrame"><span class="interfaceName">ResourceFactory</span></a></li> +</ul> +<h2 title="Classes">Classes</h2> +<ul title="Classes"> +<li><a href="DefaultResourceFactory.html" title="class in org.apache.samza.rest.resources" target="classFrame">DefaultResourceFactory</a></li> +<li><a href="JobsResource.html" title="class in org.apache.samza.rest.resources" target="classFrame">JobsResource</a></li> +<li><a href="JobsResourceConfig.html" title="class in org.apache.samza.rest.resources" target="classFrame">JobsResourceConfig</a></li> +</ul> +</div> +</body> +</html> Added: samza/site/learn/documentation/latest/rest/javadocs/org/apache/samza/rest/resources/package-summary.html URL: http://svn.apache.org/viewvc/samza/site/learn/documentation/latest/rest/javadocs/org/apache/samza/rest/resources/package-summary.html?rev=1757411&view=auto ============================================================================== --- samza/site/learn/documentation/latest/rest/javadocs/org/apache/samza/rest/resources/package-summary.html (added) +++ samza/site/learn/documentation/latest/rest/javadocs/org/apache/samza/rest/resources/package-summary.html Tue Aug 23 17:38:58 2016 @@ -0,0 +1,171 @@ +<!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 (1.8.0_102) on Tue Aug 23 00:00:10 PDT 2016 --> +<title>org.apache.samza.rest.resources (samza-rest 0.10.1-SNAPSHOT API)</title> +<meta name="date" content="2016-08-23"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +</head> +<body> +<script type="text/javascript"><!-- + try { + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="org.apache.samza.rest.resources (samza-rest 0.10.1-SNAPSHOT API)"; + } + } + catch(err) { + } +//--> +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar.top"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.top.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../overview-summary.html">Overview</a></li> +<li class="navBarCell1Rev">Package</li> +<li>Class</li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../index-all.html">Index</a></li> +<li><a href="../../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../../org/apache/samza/rest/proxy/job/package-summary.html">Prev Package</a></li> +<li><a href="../../../../../org/apache/samza/rest/script/package-summary.html">Next Package</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/samza/rest/resources/package-summary.html" target="_top">Frames</a></li> +<li><a href="package-summary.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<a name="skip.navbar.top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<div class="header"> +<h1 title="Package" class="title">Package org.apache.samza.rest.resources</h1> +</div> +<div class="contentContainer"> +<ul class="blockList"> +<li class="blockList"> +<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Interface Summary table, listing interfaces, and an explanation"> +<caption><span>Interface Summary</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Interface</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../../org/apache/samza/rest/resources/ResourceFactory.html" title="interface in org.apache.samza.rest.resources">ResourceFactory</a></td> +<td class="colLast"> +<div class="block">Instantiates a resource using the provided config.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Class Summary table, listing classes, and an explanation"> +<caption><span>Class Summary</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Class</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../../org/apache/samza/rest/resources/DefaultResourceFactory.html" title="class in org.apache.samza.rest.resources">DefaultResourceFactory</a></td> +<td class="colLast"> +<div class="block">Instantiates all the resources that are shipped with the REST service.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../../org/apache/samza/rest/resources/JobsResource.html" title="class in org.apache.samza.rest.resources">JobsResource</a></td> +<td class="colLast"> +<div class="block">The REST resource for jobs.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../../org/apache/samza/rest/resources/JobsResourceConfig.html" title="class in org.apache.samza.rest.resources">JobsResourceConfig</a></td> +<td class="colLast"> +<div class="block">Configurations for the <a href="../../../../../org/apache/samza/rest/resources/JobsResource.html" title="class in org.apache.samza.rest.resources"><code>JobsResource</code></a> endpoint.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +</div> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar.bottom"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.bottom.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../overview-summary.html">Overview</a></li> +<li class="navBarCell1Rev">Package</li> +<li>Class</li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../index-all.html">Index</a></li> +<li><a href="../../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../../org/apache/samza/rest/proxy/job/package-summary.html">Prev Package</a></li> +<li><a href="../../../../../org/apache/samza/rest/script/package-summary.html">Next Package</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/samza/rest/resources/package-summary.html" target="_top">Frames</a></li> +<li><a href="package-summary.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html> Added: samza/site/learn/documentation/latest/rest/javadocs/org/apache/samza/rest/resources/package-tree.html URL: http://svn.apache.org/viewvc/samza/site/learn/documentation/latest/rest/javadocs/org/apache/samza/rest/resources/package-tree.html?rev=1757411&view=auto ============================================================================== --- samza/site/learn/documentation/latest/rest/javadocs/org/apache/samza/rest/resources/package-tree.html (added) +++ samza/site/learn/documentation/latest/rest/javadocs/org/apache/samza/rest/resources/package-tree.html Tue Aug 23 17:38:58 2016 @@ -0,0 +1,149 @@ +<!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 (1.8.0_102) on Tue Aug 23 00:00:10 PDT 2016 --> +<title>org.apache.samza.rest.resources Class Hierarchy (samza-rest 0.10.1-SNAPSHOT API)</title> +<meta name="date" content="2016-08-23"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +</head> +<body> +<script type="text/javascript"><!-- + try { + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="org.apache.samza.rest.resources Class Hierarchy (samza-rest 0.10.1-SNAPSHOT API)"; + } + } + catch(err) { + } +//--> +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar.top"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.top.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li>Class</li> +<li class="navBarCell1Rev">Tree</li> +<li><a href="../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../index-all.html">Index</a></li> +<li><a href="../../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../../org/apache/samza/rest/proxy/job/package-tree.html">Prev</a></li> +<li><a href="../../../../../org/apache/samza/rest/script/package-tree.html">Next</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/samza/rest/resources/package-tree.html" target="_top">Frames</a></li> +<li><a href="package-tree.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<a name="skip.navbar.top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<div class="header"> +<h1 class="title">Hierarchy For Package org.apache.samza.rest.resources</h1> +<span class="packageHierarchyLabel">Package Hierarchies:</span> +<ul class="horizontal"> +<li><a href="../../../../../overview-tree.html">All Packages</a></li> +</ul> +</div> +<div class="contentContainer"> +<h2 title="Class Hierarchy">Class Hierarchy</h2> +<ul> +<li type="circle">java.lang.Object +<ul> +<li type="circle">org.apache.samza.config.Config (implements java.util.Map<K,V>) +<ul> +<li type="circle">org.apache.samza.config.MapConfig +<ul> +<li type="circle">org.apache.samza.rest.resources.<a href="../../../../../org/apache/samza/rest/resources/JobsResourceConfig.html" title="class in org.apache.samza.rest.resources"><span class="typeNameLink">JobsResourceConfig</span></a></li> +</ul> +</li> +</ul> +</li> +<li type="circle">org.apache.samza.rest.resources.<a href="../../../../../org/apache/samza/rest/resources/DefaultResourceFactory.html" title="class in org.apache.samza.rest.resources"><span class="typeNameLink">DefaultResourceFactory</span></a> (implements org.apache.samza.rest.resources.<a href="../../../../../org/apache/samza/rest/resources/ResourceFactory.html" title="interface in org.apache.samza.rest.resources">ResourceFactory</a>)</li> +<li type="circle">org.apache.samza.rest.resources.<a href="../../../../../org/apache/samza/rest/resources/JobsResource.html" title="class in org.apache.samza.rest.resources"><span class="typeNameLink">JobsResource</span></a></li> +</ul> +</li> +</ul> +<h2 title="Interface Hierarchy">Interface Hierarchy</h2> +<ul> +<li type="circle">org.apache.samza.rest.resources.<a href="../../../../../org/apache/samza/rest/resources/ResourceFactory.html" title="interface in org.apache.samza.rest.resources"><span class="typeNameLink">ResourceFactory</span></a></li> +</ul> +</div> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar.bottom"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.bottom.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li>Class</li> +<li class="navBarCell1Rev">Tree</li> +<li><a href="../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../index-all.html">Index</a></li> +<li><a href="../../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../../org/apache/samza/rest/proxy/job/package-tree.html">Prev</a></li> +<li><a href="../../../../../org/apache/samza/rest/script/package-tree.html">Next</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/samza/rest/resources/package-tree.html" target="_top">Frames</a></li> +<li><a href="package-tree.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html> Added: samza/site/learn/documentation/latest/rest/javadocs/org/apache/samza/rest/script/ScriptOutputHandler.html URL: http://svn.apache.org/viewvc/samza/site/learn/documentation/latest/rest/javadocs/org/apache/samza/rest/script/ScriptOutputHandler.html?rev=1757411&view=auto ============================================================================== --- samza/site/learn/documentation/latest/rest/javadocs/org/apache/samza/rest/script/ScriptOutputHandler.html (added) +++ samza/site/learn/documentation/latest/rest/javadocs/org/apache/samza/rest/script/ScriptOutputHandler.html Tue Aug 23 17:38:58 2016 @@ -0,0 +1,232 @@ +<!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 (1.8.0_102) on Tue Aug 23 00:00:09 PDT 2016 --> +<title>ScriptOutputHandler (samza-rest 0.10.1-SNAPSHOT API)</title> +<meta name="date" content="2016-08-23"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +</head> +<body> +<script type="text/javascript"><!-- + try { + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="ScriptOutputHandler (samza-rest 0.10.1-SNAPSHOT API)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":6}; +var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]}; +var altColor = "altColor"; +var rowColor = "rowColor"; +var tableTab = "tableTab"; +var activeTableTab = "activeTableTab"; +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar.top"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.top.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../index-all.html">Index</a></li> +<li><a href="../../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li>Prev Class</li> +<li><a href="../../../../../org/apache/samza/rest/script/ScriptPathProvider.html" title="interface in org.apache.samza.rest.script"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/samza/rest/script/ScriptOutputHandler.html" target="_top">Frames</a></li> +<li><a href="ScriptOutputHandler.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.rest.script</div> +<h2 title="Interface ScriptOutputHandler" class="title">Interface ScriptOutputHandler</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public interface <span class="typeNameLabel">ScriptOutputHandler</span></pre> +<div class="block">A script output handler processes the stream of output from the stdout and stderr channels of a script.</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="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr id="i0" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/samza/rest/script/ScriptOutputHandler.html#processScriptOutput-java.io.InputStream-">processScriptOutput</a></span>(java.io.InputStream output)</code> +<div class="block">Processes the script output represented by the InputStream.</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="processScriptOutput-java.io.InputStream-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>processScriptOutput</h4> +<pre>void processScriptOutput(java.io.InputStream output) + throws java.io.IOException</pre> +<div class="block">Processes the script output represented by the InputStream. + + Implementations must fully process the stream or the script may hang.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>output</code> - the stream of output from the script.</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>java.io.IOException</code> - if there are problems reading the output.</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> +<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.bottom.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../index-all.html">Index</a></li> +<li><a href="../../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li>Prev Class</li> +<li><a href="../../../../../org/apache/samza/rest/script/ScriptPathProvider.html" title="interface in org.apache.samza.rest.script"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/samza/rest/script/ScriptOutputHandler.html" target="_top">Frames</a></li> +<li><a href="ScriptOutputHandler.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: samza/site/learn/documentation/latest/rest/javadocs/org/apache/samza/rest/script/ScriptPathProvider.html URL: http://svn.apache.org/viewvc/samza/site/learn/documentation/latest/rest/javadocs/org/apache/samza/rest/script/ScriptPathProvider.html?rev=1757411&view=auto ============================================================================== --- samza/site/learn/documentation/latest/rest/javadocs/org/apache/samza/rest/script/ScriptPathProvider.html (added) +++ samza/site/learn/documentation/latest/rest/javadocs/org/apache/samza/rest/script/ScriptPathProvider.html Tue Aug 23 17:38:58 2016 @@ -0,0 +1,236 @@ +<!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 (1.8.0_102) on Tue Aug 23 00:00:09 PDT 2016 --> +<title>ScriptPathProvider (samza-rest 0.10.1-SNAPSHOT API)</title> +<meta name="date" content="2016-08-23"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +</head> +<body> +<script type="text/javascript"><!-- + try { + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="ScriptPathProvider (samza-rest 0.10.1-SNAPSHOT API)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":6}; +var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]}; +var altColor = "altColor"; +var rowColor = "rowColor"; +var tableTab = "tableTab"; +var activeTableTab = "activeTableTab"; +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar.top"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> +<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/rest/script/ScriptOutputHandler.html" title="interface in org.apache.samza.rest.script"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/samza/rest/script/ScriptRunner.html" title="class in org.apache.samza.rest.script"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/samza/rest/script/ScriptPathProvider.html" target="_top">Frames</a></li> +<li><a href="ScriptPathProvider.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.rest.script</div> +<h2 title="Interface ScriptPathProvider" class="title">Interface ScriptPathProvider</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/rest/proxy/job/ScriptJobProxy.html" title="class in org.apache.samza.rest.proxy.job">ScriptJobProxy</a>, <a href="../../../../../org/apache/samza/rest/proxy/job/SimpleYarnJobProxy.html" title="class in org.apache.samza.rest.proxy.job">SimpleYarnJobProxy</a></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="typeNameLabel">ScriptPathProvider</span></pre> +<div class="block">Defines the protocol for getting script paths.</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="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr id="i0" class="altColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/samza/rest/script/ScriptPathProvider.html#getScriptPath-org.apache.samza.rest.proxy.job.JobInstance-java.lang.String-">getScriptPath</a></span>(<a href="../../../../../org/apache/samza/rest/proxy/job/JobInstance.html" title="class in org.apache.samza.rest.proxy.job">JobInstance</a> jobInstance, + java.lang.String scriptName)</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="getScriptPath-org.apache.samza.rest.proxy.job.JobInstance-java.lang.String-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getScriptPath</h4> +<pre>java.lang.String getScriptPath(<a href="../../../../../org/apache/samza/rest/proxy/job/JobInstance.html" title="class in org.apache.samza.rest.proxy.job">JobInstance</a> jobInstance, + java.lang.String scriptName) + throws java.io.FileNotFoundException</pre> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>jobInstance</code> - the job instance which may be used to access the job installation for the script.</dd> +<dd><code>scriptName</code> - the name of the script file. Not the full path.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the full path to the specified script.</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>java.io.FileNotFoundException</code> - if the script does not exist.</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> +<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> +<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/rest/script/ScriptOutputHandler.html" title="interface in org.apache.samza.rest.script"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/samza/rest/script/ScriptRunner.html" title="class in org.apache.samza.rest.script"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/samza/rest/script/ScriptPathProvider.html" target="_top">Frames</a></li> +<li><a href="ScriptPathProvider.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: samza/site/learn/documentation/latest/rest/javadocs/org/apache/samza/rest/script/ScriptRunner.html URL: http://svn.apache.org/viewvc/samza/site/learn/documentation/latest/rest/javadocs/org/apache/samza/rest/script/ScriptRunner.html?rev=1757411&view=auto ============================================================================== --- samza/site/learn/documentation/latest/rest/javadocs/org/apache/samza/rest/script/ScriptRunner.html (added) +++ samza/site/learn/documentation/latest/rest/javadocs/org/apache/samza/rest/script/ScriptRunner.html Tue Aug 23 17:38:58 2016 @@ -0,0 +1,332 @@ +<!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 (1.8.0_102) on Tue Aug 23 00:00:09 PDT 2016 --> +<title>ScriptRunner (samza-rest 0.10.1-SNAPSHOT API)</title> +<meta name="date" content="2016-08-23"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +</head> +<body> +<script type="text/javascript"><!-- + try { + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="ScriptRunner (samza-rest 0.10.1-SNAPSHOT API)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":10,"i1":10,"i2":10}; +var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; +var altColor = "altColor"; +var rowColor = "rowColor"; +var tableTab = "tableTab"; +var activeTableTab = "activeTableTab"; +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar.top"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> +<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/rest/script/ScriptPathProvider.html" title="interface in org.apache.samza.rest.script"><span class="typeNameLink">Prev Class</span></a></li> +<li>Next Class</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/samza/rest/script/ScriptRunner.html" target="_top">Frames</a></li> +<li><a href="ScriptRunner.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.rest.script</div> +<h2 title="Class ScriptRunner" class="title">Class ScriptRunner</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>org.apache.samza.rest.script.ScriptRunner</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="typeNameLabel">ScriptRunner</span> +extends java.lang.Object</pre> +<div class="block">Runs a script process and returns the exit code. + + The script can be run with an output handler or with output redirected to console.</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="memberSummary" 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><span class="memberNameLink"><a href="../../../../../org/apache/samza/rest/script/ScriptRunner.html#ScriptRunner--">ScriptRunner</a></span>()</code> </td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr id="i0" class="altColor"> +<td class="colFirst"><code>protected long</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/samza/rest/script/ScriptRunner.html#getScriptTimeoutS--">getScriptTimeoutS</a></span>()</code> </td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/samza/rest/script/ScriptRunner.html#runScript-java.lang.String-org.apache.samza.rest.script.ScriptOutputHandler-java.lang.String...-">runScript</a></span>(java.lang.String scriptPath, + <a href="../../../../../org/apache/samza/rest/script/ScriptOutputHandler.html" title="interface in org.apache.samza.rest.script">ScriptOutputHandler</a> outputHandler, + java.lang.String... args)</code> </td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/samza/rest/script/ScriptRunner.html#runScript-java.lang.String-java.lang.String...-">runScript</a></span>(java.lang.String scriptPath, + java.lang.String... args)</code> +<div class="block">Runs a script with IO inherited from the current Java process.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.Object</h3> +<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li> +</ul> +</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="ScriptRunner--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>ScriptRunner</h4> +<pre>public ScriptRunner()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="getScriptTimeoutS--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getScriptTimeoutS</h4> +<pre>protected long getScriptTimeoutS()</pre> +</li> +</ul> +<a name="runScript-java.lang.String-java.lang.String...-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>runScript</h4> +<pre>public int runScript(java.lang.String scriptPath, + java.lang.String... args) + throws java.io.IOException, + java.lang.InterruptedException</pre> +<div class="block">Runs a script with IO inherited from the current Java process. Typically this redirects to console.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>scriptPath</code> - the path to the script file.</dd> +<dd><code>args</code> - the command line args to pass to the script.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the exit code returned by the script.</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>java.io.IOException</code> - if there was a problem running the process.</dd> +<dd><code>java.lang.InterruptedException</code> - if the thread is interrupted while waiting for the process to finish.</dd> +</dl> +</li> +</ul> +<a name="runScript-java.lang.String-org.apache.samza.rest.script.ScriptOutputHandler-java.lang.String...-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>runScript</h4> +<pre>public int runScript(java.lang.String scriptPath, + <a href="../../../../../org/apache/samza/rest/script/ScriptOutputHandler.html" title="interface in org.apache.samza.rest.script">ScriptOutputHandler</a> outputHandler, + java.lang.String... args) + throws java.io.IOException, + java.lang.InterruptedException</pre> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>scriptPath</code> - the path to the script file.</dd> +<dd><code>outputHandler</code> - the handler for any stdout and stderr produced by the script.</dd> +<dd><code>args</code> - the command line args to pass to the script.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the exit code returned by the script.</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>java.io.IOException</code> - if there was a problem running the process.</dd> +<dd><code>java.lang.InterruptedException</code> - if the thread is interrupted while waiting for the process to finish.</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> +<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> +<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/rest/script/ScriptPathProvider.html" title="interface in org.apache.samza.rest.script"><span class="typeNameLink">Prev Class</span></a></li> +<li>Next Class</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/samza/rest/script/ScriptRunner.html" target="_top">Frames</a></li> +<li><a href="ScriptRunner.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: samza/site/learn/documentation/latest/rest/javadocs/org/apache/samza/rest/script/package-frame.html URL: http://svn.apache.org/viewvc/samza/site/learn/documentation/latest/rest/javadocs/org/apache/samza/rest/script/package-frame.html?rev=1757411&view=auto ============================================================================== --- samza/site/learn/documentation/latest/rest/javadocs/org/apache/samza/rest/script/package-frame.html (added) +++ samza/site/learn/documentation/latest/rest/javadocs/org/apache/samza/rest/script/package-frame.html Tue Aug 23 17:38:58 2016 @@ -0,0 +1,25 @@ +<!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 (1.8.0_102) on Tue Aug 23 00:00:10 PDT 2016 --> +<title>org.apache.samza.rest.script (samza-rest 0.10.1-SNAPSHOT API)</title> +<meta name="date" content="2016-08-23"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +</head> +<body> +<h1 class="bar"><a href="../../../../../org/apache/samza/rest/script/package-summary.html" target="classFrame">org.apache.samza.rest.script</a></h1> +<div class="indexContainer"> +<h2 title="Interfaces">Interfaces</h2> +<ul title="Interfaces"> +<li><a href="ScriptOutputHandler.html" title="interface in org.apache.samza.rest.script" target="classFrame"><span class="interfaceName">ScriptOutputHandler</span></a></li> +<li><a href="ScriptPathProvider.html" title="interface in org.apache.samza.rest.script" target="classFrame"><span class="interfaceName">ScriptPathProvider</span></a></li> +</ul> +<h2 title="Classes">Classes</h2> +<ul title="Classes"> +<li><a href="ScriptRunner.html" title="class in org.apache.samza.rest.script" target="classFrame">ScriptRunner</a></li> +</ul> +</div> +</body> +</html> Added: samza/site/learn/documentation/latest/rest/javadocs/org/apache/samza/rest/script/package-summary.html URL: http://svn.apache.org/viewvc/samza/site/learn/documentation/latest/rest/javadocs/org/apache/samza/rest/script/package-summary.html?rev=1757411&view=auto ============================================================================== --- samza/site/learn/documentation/latest/rest/javadocs/org/apache/samza/rest/script/package-summary.html (added) +++ samza/site/learn/documentation/latest/rest/javadocs/org/apache/samza/rest/script/package-summary.html Tue Aug 23 17:38:58 2016 @@ -0,0 +1,165 @@ +<!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 (1.8.0_102) on Tue Aug 23 00:00:10 PDT 2016 --> +<title>org.apache.samza.rest.script (samza-rest 0.10.1-SNAPSHOT API)</title> +<meta name="date" content="2016-08-23"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +</head> +<body> +<script type="text/javascript"><!-- + try { + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="org.apache.samza.rest.script (samza-rest 0.10.1-SNAPSHOT API)"; + } + } + catch(err) { + } +//--> +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar.top"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.top.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../overview-summary.html">Overview</a></li> +<li class="navBarCell1Rev">Package</li> +<li>Class</li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../index-all.html">Index</a></li> +<li><a href="../../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../../org/apache/samza/rest/resources/package-summary.html">Prev Package</a></li> +<li>Next Package</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/samza/rest/script/package-summary.html" target="_top">Frames</a></li> +<li><a href="package-summary.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<a name="skip.navbar.top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<div class="header"> +<h1 title="Package" class="title">Package org.apache.samza.rest.script</h1> +</div> +<div class="contentContainer"> +<ul class="blockList"> +<li class="blockList"> +<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Interface Summary table, listing interfaces, and an explanation"> +<caption><span>Interface Summary</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Interface</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../../org/apache/samza/rest/script/ScriptOutputHandler.html" title="interface in org.apache.samza.rest.script">ScriptOutputHandler</a></td> +<td class="colLast"> +<div class="block">A script output handler processes the stream of output from the stdout and stderr channels of a script.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../../org/apache/samza/rest/script/ScriptPathProvider.html" title="interface in org.apache.samza.rest.script">ScriptPathProvider</a></td> +<td class="colLast"> +<div class="block">Defines the protocol for getting script paths.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Class Summary table, listing classes, and an explanation"> +<caption><span>Class Summary</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Class</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../../org/apache/samza/rest/script/ScriptRunner.html" title="class in org.apache.samza.rest.script">ScriptRunner</a></td> +<td class="colLast"> +<div class="block">Runs a script process and returns the exit code.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +</div> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar.bottom"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.bottom.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../overview-summary.html">Overview</a></li> +<li class="navBarCell1Rev">Package</li> +<li>Class</li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../index-all.html">Index</a></li> +<li><a href="../../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../../org/apache/samza/rest/resources/package-summary.html">Prev Package</a></li> +<li>Next Package</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/samza/rest/script/package-summary.html" target="_top">Frames</a></li> +<li><a href="package-summary.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html>
