Added: samza/site/learn/documentation/latest/rest/javadocs/org/apache/samza/monitor/ScheduledExecutorSchedulingProvider.html URL: http://svn.apache.org/viewvc/samza/site/learn/documentation/latest/rest/javadocs/org/apache/samza/monitor/ScheduledExecutorSchedulingProvider.html?rev=1757411&view=auto ============================================================================== --- samza/site/learn/documentation/latest/rest/javadocs/org/apache/samza/monitor/ScheduledExecutorSchedulingProvider.html (added) +++ samza/site/learn/documentation/latest/rest/javadocs/org/apache/samza/monitor/ScheduledExecutorSchedulingProvider.html Tue Aug 23 17:38:58 2016 @@ -0,0 +1,297 @@ +<!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>ScheduledExecutorSchedulingProvider (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="ScheduledExecutorSchedulingProvider (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/monitor/SamzaMonitorService.html" title="class in org.apache.samza.monitor"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/samza/monitor/SchedulingProvider.html" title="interface in org.apache.samza.monitor"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/samza/monitor/ScheduledExecutorSchedulingProvider.html" target="_top">Frames</a></li> +<li><a href="ScheduledExecutorSchedulingProvider.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.monitor</div> +<h2 title="Class ScheduledExecutorSchedulingProvider" class="title">Class ScheduledExecutorSchedulingProvider</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>org.apache.samza.monitor.ScheduledExecutorSchedulingProvider</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd><a href="../../../../org/apache/samza/monitor/SchedulingProvider.html" title="interface in org.apache.samza.monitor">SchedulingProvider</a></dd> +</dl> +<hr> +<br> +<pre>public class <span class="typeNameLabel">ScheduledExecutorSchedulingProvider</span> +extends java.lang.Object +implements <a href="../../../../org/apache/samza/monitor/SchedulingProvider.html" title="interface in org.apache.samza.monitor">SchedulingProvider</a></pre> +</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/monitor/ScheduledExecutorSchedulingProvider.html#ScheduledExecutorSchedulingProvider-java.util.concurrent.ScheduledExecutorService-">ScheduledExecutorSchedulingProvider</a></span>(java.util.concurrent.ScheduledExecutorService scheduler)</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>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/samza/monitor/ScheduledExecutorSchedulingProvider.html#schedule-java.lang.Runnable-int-">schedule</a></span>(java.lang.Runnable runnable, + int interval)</code> </td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/samza/monitor/ScheduledExecutorSchedulingProvider.html#stop--">stop</a></span>()</code> </td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.Object</h3> +<code>clone, 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="ScheduledExecutorSchedulingProvider-java.util.concurrent.ScheduledExecutorService-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>ScheduledExecutorSchedulingProvider</h4> +<pre>public ScheduledExecutorSchedulingProvider(java.util.concurrent.ScheduledExecutorService scheduler)</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="schedule-java.lang.Runnable-int-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>schedule</h4> +<pre>public void schedule(java.lang.Runnable runnable, + int interval)</pre> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../org/apache/samza/monitor/SchedulingProvider.html#schedule-java.lang.Runnable-int-">schedule</a></code> in interface <code><a href="../../../../org/apache/samza/monitor/SchedulingProvider.html" title="interface in org.apache.samza.monitor">SchedulingProvider</a></code></dd> +</dl> +</li> +</ul> +<a name="stop--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>stop</h4> +<pre>public void stop()</pre> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../org/apache/samza/monitor/SchedulingProvider.html#stop--">stop</a></code> in interface <code><a href="../../../../org/apache/samza/monitor/SchedulingProvider.html" title="interface in org.apache.samza.monitor">SchedulingProvider</a></code></dd> +</dl> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar.bottom"> +<!-- --> +</a> +<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/monitor/SamzaMonitorService.html" title="class in org.apache.samza.monitor"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/samza/monitor/SchedulingProvider.html" title="interface in org.apache.samza.monitor"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/samza/monitor/ScheduledExecutorSchedulingProvider.html" target="_top">Frames</a></li> +<li><a href="ScheduledExecutorSchedulingProvider.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/monitor/SchedulingProvider.html URL: http://svn.apache.org/viewvc/samza/site/learn/documentation/latest/rest/javadocs/org/apache/samza/monitor/SchedulingProvider.html?rev=1757411&view=auto ============================================================================== --- samza/site/learn/documentation/latest/rest/javadocs/org/apache/samza/monitor/SchedulingProvider.html (added) +++ samza/site/learn/documentation/latest/rest/javadocs/org/apache/samza/monitor/SchedulingProvider.html Tue Aug 23 17:38:58 2016 @@ -0,0 +1,239 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc (1.8.0_102) on Tue Aug 23 00:00:09 PDT 2016 --> +<title>SchedulingProvider (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="SchedulingProvider (samza-rest 0.10.1-SNAPSHOT API)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":6,"i1":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/monitor/ScheduledExecutorSchedulingProvider.html" title="class in org.apache.samza.monitor"><span class="typeNameLink">Prev Class</span></a></li> +<li>Next Class</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/samza/monitor/SchedulingProvider.html" target="_top">Frames</a></li> +<li><a href="SchedulingProvider.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.monitor</div> +<h2 title="Interface SchedulingProvider" class="title">Interface SchedulingProvider</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/monitor/ScheduledExecutorSchedulingProvider.html" title="class in org.apache.samza.monitor">ScheduledExecutorSchedulingProvider</a></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="typeNameLabel">SchedulingProvider</span></pre> +<div class="block">Provides scheduling functionality to the SamzaMonitorService.</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/monitor/SchedulingProvider.html#schedule-java.lang.Runnable-int-">schedule</a></span>(java.lang.Runnable runnable, + int intervalMs)</code> </td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/samza/monitor/SchedulingProvider.html#stop--">stop</a></span>()</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="schedule-java.lang.Runnable-int-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>schedule</h4> +<pre>void schedule(java.lang.Runnable runnable, + int intervalMs)</pre> +</li> +</ul> +<a name="stop--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>stop</h4> +<pre>void stop()</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> +<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/monitor/ScheduledExecutorSchedulingProvider.html" title="class in org.apache.samza.monitor"><span class="typeNameLink">Prev Class</span></a></li> +<li>Next Class</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/samza/monitor/SchedulingProvider.html" target="_top">Frames</a></li> +<li><a href="SchedulingProvider.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/monitor/package-frame.html URL: http://svn.apache.org/viewvc/samza/site/learn/documentation/latest/rest/javadocs/org/apache/samza/monitor/package-frame.html?rev=1757411&view=auto ============================================================================== --- samza/site/learn/documentation/latest/rest/javadocs/org/apache/samza/monitor/package-frame.html (added) +++ samza/site/learn/documentation/latest/rest/javadocs/org/apache/samza/monitor/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:09 PDT 2016 --> +<title>org.apache.samza.monitor (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/monitor/package-summary.html" target="classFrame">org.apache.samza.monitor</a></h1> +<div class="indexContainer"> +<h2 title="Interfaces">Interfaces</h2> +<ul title="Interfaces"> +<li><a href="Monitor.html" title="interface in org.apache.samza.monitor" target="classFrame"><span class="interfaceName">Monitor</span></a></li> +<li><a href="SchedulingProvider.html" title="interface in org.apache.samza.monitor" target="classFrame"><span class="interfaceName">SchedulingProvider</span></a></li> +</ul> +<h2 title="Classes">Classes</h2> +<ul title="Classes"> +<li><a href="SamzaMonitorService.html" title="class in org.apache.samza.monitor" target="classFrame">SamzaMonitorService</a></li> +<li><a href="ScheduledExecutorSchedulingProvider.html" title="class in org.apache.samza.monitor" target="classFrame">ScheduledExecutorSchedulingProvider</a></li> +</ul> +</div> +</body> +</html> Added: samza/site/learn/documentation/latest/rest/javadocs/org/apache/samza/monitor/package-summary.html URL: http://svn.apache.org/viewvc/samza/site/learn/documentation/latest/rest/javadocs/org/apache/samza/monitor/package-summary.html?rev=1757411&view=auto ============================================================================== --- samza/site/learn/documentation/latest/rest/javadocs/org/apache/samza/monitor/package-summary.html (added) +++ samza/site/learn/documentation/latest/rest/javadocs/org/apache/samza/monitor/package-summary.html Tue Aug 23 17:38:58 2016 @@ -0,0 +1,169 @@ +<!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>org.apache.samza.monitor (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.monitor (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>Prev Package</li> +<li><a href="../../../../org/apache/samza/rest/package-summary.html">Next Package</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/samza/monitor/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.monitor</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/monitor/Monitor.html" title="interface in org.apache.samza.monitor">Monitor</a></td> +<td class="colLast"> +<div class="block">A Monitor is a class implementing some functionality that should be done every N milliseconds on a YARN RM or NM.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../org/apache/samza/monitor/SchedulingProvider.html" title="interface in org.apache.samza.monitor">SchedulingProvider</a></td> +<td class="colLast"> +<div class="block">Provides scheduling functionality to the SamzaMonitorService.</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/monitor/SamzaMonitorService.html" title="class in org.apache.samza.monitor">SamzaMonitorService</a></td> +<td class="colLast"> +<div class="block">The class responsible for handling long-running/scheduled monitors in Samza REST.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../org/apache/samza/monitor/ScheduledExecutorSchedulingProvider.html" title="class in org.apache.samza.monitor">ScheduledExecutorSchedulingProvider</a></td> +<td class="colLast"> </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>Prev Package</li> +<li><a href="../../../../org/apache/samza/rest/package-summary.html">Next Package</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/samza/monitor/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/monitor/package-tree.html URL: http://svn.apache.org/viewvc/samza/site/learn/documentation/latest/rest/javadocs/org/apache/samza/monitor/package-tree.html?rev=1757411&view=auto ============================================================================== --- samza/site/learn/documentation/latest/rest/javadocs/org/apache/samza/monitor/package-tree.html (added) +++ samza/site/learn/documentation/latest/rest/javadocs/org/apache/samza/monitor/package-tree.html Tue Aug 23 17:38:58 2016 @@ -0,0 +1,141 @@ +<!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>org.apache.samza.monitor 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.monitor 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>Prev</li> +<li><a href="../../../../org/apache/samza/rest/package-tree.html">Next</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/samza/monitor/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.monitor</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.monitor.<a href="../../../../org/apache/samza/monitor/SamzaMonitorService.html" title="class in org.apache.samza.monitor"><span class="typeNameLink">SamzaMonitorService</span></a></li> +<li type="circle">org.apache.samza.monitor.<a href="../../../../org/apache/samza/monitor/ScheduledExecutorSchedulingProvider.html" title="class in org.apache.samza.monitor"><span class="typeNameLink">ScheduledExecutorSchedulingProvider</span></a> (implements org.apache.samza.monitor.<a href="../../../../org/apache/samza/monitor/SchedulingProvider.html" title="interface in org.apache.samza.monitor">SchedulingProvider</a>)</li> +</ul> +</li> +</ul> +<h2 title="Interface Hierarchy">Interface Hierarchy</h2> +<ul> +<li type="circle">org.apache.samza.monitor.<a href="../../../../org/apache/samza/monitor/Monitor.html" title="interface in org.apache.samza.monitor"><span class="typeNameLink">Monitor</span></a></li> +<li type="circle">org.apache.samza.monitor.<a href="../../../../org/apache/samza/monitor/SchedulingProvider.html" title="interface in org.apache.samza.monitor"><span class="typeNameLink">SchedulingProvider</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>Prev</li> +<li><a href="../../../../org/apache/samza/rest/package-tree.html">Next</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/samza/monitor/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/SamzaRestApplication.html URL: http://svn.apache.org/viewvc/samza/site/learn/documentation/latest/rest/javadocs/org/apache/samza/rest/SamzaRestApplication.html?rev=1757411&view=auto ============================================================================== --- samza/site/learn/documentation/latest/rest/javadocs/org/apache/samza/rest/SamzaRestApplication.html (added) +++ samza/site/learn/documentation/latest/rest/javadocs/org/apache/samza/rest/SamzaRestApplication.html Tue Aug 23 17:38:58 2016 @@ -0,0 +1,257 @@ +<!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>SamzaRestApplication (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="SamzaRestApplication (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="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/SamzaRestConfig.html" title="class in org.apache.samza.rest"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/samza/rest/SamzaRestApplication.html" target="_top">Frames</a></li> +<li><a href="SamzaRestApplication.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="#methods.inherited.from.class.org.glassfish.jersey.server.ResourceConfig">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor.detail">Constr</a> | </li> +<li>Method</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</div> +<h2 title="Class SamzaRestApplication" class="title">Class SamzaRestApplication</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>javax.ws.rs.core.Application</li> +<li> +<ul class="inheritance"> +<li>org.glassfish.jersey.server.ResourceConfig</li> +<li> +<ul class="inheritance"> +<li>org.apache.samza.rest.SamzaRestApplication</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd>javax.ws.rs.core.Configurable<org.glassfish.jersey.server.ResourceConfig>, javax.ws.rs.core.Configuration, org.glassfish.jersey.ExtendedConfig, org.glassfish.jersey.server.ServerConfig</dd> +</dl> +<hr> +<br> +<pre>public class <span class="typeNameLabel">SamzaRestApplication</span> +extends org.glassfish.jersey.server.ResourceConfig</pre> +<div class="block">Samza REST implementation of the JAX-RS <code>Application</code> model.</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/SamzaRestApplication.html#SamzaRestApplication-org.apache.samza.rest.SamzaRestConfig-">SamzaRestApplication</a></span>(<a href="../../../../org/apache/samza/rest/SamzaRestConfig.html" title="class in org.apache.samza.rest">SamzaRestConfig</a> config)</code> </td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.org.glassfish.jersey.server.ResourceConfig"> +<!-- --> +</a> +<h3>Methods inherited from class org.glassfish.jersey.server.ResourceConfig</h3> +<code>addProperties, files, files, forApplication, forApplicationClass, forApplicationClass, getApplication, getApplicationName, getClasses, getClassLoader, getConfiguration, getContracts, getInstances, getProperties, getProperty, getPropertyNames, getResources, getRuntimeType, getSingletons, isEnabled, isEnabled, isProperty, isRegistered, isRegistered, packages, packages, property, register, register, register, register, register, register, register, register, registerClasses, registerClasses, registerFinder, registerInstances, registerInstances, registerResources, registerResources, setApplicationName, setClassLoader, setProperties</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, 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="SamzaRestApplication-org.apache.samza.rest.SamzaRestConfig-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>SamzaRestApplication</h4> +<pre>public SamzaRestApplication(<a href="../../../../org/apache/samza/rest/SamzaRestConfig.html" title="class in org.apache.samza.rest">SamzaRestConfig</a> config)</pre> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar.bottom"> +<!-- --> +</a> +<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/SamzaRestConfig.html" title="class in org.apache.samza.rest"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/samza/rest/SamzaRestApplication.html" target="_top">Frames</a></li> +<li><a href="SamzaRestApplication.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="#methods.inherited.from.class.org.glassfish.jersey.server.ResourceConfig">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor.detail">Constr</a> | </li> +<li>Method</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/SamzaRestConfig.html URL: http://svn.apache.org/viewvc/samza/site/learn/documentation/latest/rest/javadocs/org/apache/samza/rest/SamzaRestConfig.html?rev=1757411&view=auto ============================================================================== --- samza/site/learn/documentation/latest/rest/javadocs/org/apache/samza/rest/SamzaRestConfig.html (added) +++ samza/site/learn/documentation/latest/rest/javadocs/org/apache/samza/rest/SamzaRestConfig.html Tue Aug 23 17:38:58 2016 @@ -0,0 +1,541 @@ +<!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>SamzaRestConfig (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="SamzaRestConfig (samza-rest 0.10.1-SNAPSHOT API)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":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/SamzaRestApplication.html" title="class in org.apache.samza.rest"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/samza/rest/SamzaRestService.html" title="class in org.apache.samza.rest"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/samza/rest/SamzaRestConfig.html" target="_top">Frames</a></li> +<li><a href="SamzaRestConfig.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</div> +<h2 title="Class SamzaRestConfig" class="title">Class SamzaRestConfig</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.SamzaRestConfig</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">SamzaRestConfig</span> +extends org.apache.samza.config.MapConfig</pre> +<div class="block">The set of configurations required by the core components of the <a href="../../../../org/apache/samza/rest/SamzaRestService.html" title="class in org.apache.samza.rest"><code>SamzaRestService</code></a>. + Other configurations (e.g. from <code>JobConfig</code>) may also be used by some of the + implementation classes.</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/SamzaRestConfig.html#CONFIG_MONITOR_CLASSES">CONFIG_MONITOR_CLASSES</a></span></code> +<div class="block">Specifies a comma-delimited list of class names corresponding to Monitor implementations.</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/SamzaRestConfig.html#CONFIG_MONITOR_INTERVAL_MS">CONFIG_MONITOR_INTERVAL_MS</a></span></code> +<div class="block">Specifies the interval at which each registered Monitor's monitor method will be called.</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/SamzaRestConfig.html#CONFIG_REST_RESOURCE_CLASSES">CONFIG_REST_RESOURCE_CLASSES</a></span></code> +<div class="block">Specifies a comma-delimited list of class names of resources to register with the server.</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/SamzaRestConfig.html#CONFIG_REST_RESOURCE_FACTORIES">CONFIG_REST_RESOURCE_FACTORIES</a></span></code> +<div class="block">Specifies a comma-delimited list of class names that implement ResourceFactory.</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/SamzaRestConfig.html#CONFIG_SAMZA_REST_SERVICE_PORT">CONFIG_SAMZA_REST_SERVICE_PORT</a></span></code> +<div class="block">The port number to use for the HTTP server or 0 to dynamically choose a port.</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/SamzaRestConfig.html#SamzaRestConfig-org.apache.samza.config.Config-">SamzaRestConfig</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.util.List<java.lang.String></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/samza/rest/SamzaRestConfig.html#getConfigMonitorClassList--">getConfigMonitorClassList</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/SamzaRestConfig.html#getConfigMonitorIntervalMs--">getConfigMonitorIntervalMs</a></span>()</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/SamzaRestConfig.html#getPort--">getPort</a></span>()</code> </td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code>java.util.List<java.lang.String></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/samza/rest/SamzaRestConfig.html#getResourceClassNames--">getResourceClassNames</a></span>()</code> </td> +</tr> +<tr id="i4" class="altColor"> +<td class="colFirst"><code>java.util.List<java.lang.String></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/samza/rest/SamzaRestConfig.html#getResourceFactoryClassNames--">getResourceFactoryClassNames</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_REST_RESOURCE_FACTORIES"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>CONFIG_REST_RESOURCE_FACTORIES</h4> +<pre>public static final java.lang.String CONFIG_REST_RESOURCE_FACTORIES</pre> +<div class="block">Specifies a comma-delimited list of class names that implement ResourceFactory. + These factories will be used to create specific instances of resources, passing the server config.</div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../constant-values.html#org.apache.samza.rest.SamzaRestConfig.CONFIG_REST_RESOURCE_FACTORIES">Constant Field Values</a></dd> +</dl> +</li> +</ul> +<a name="CONFIG_REST_RESOURCE_CLASSES"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>CONFIG_REST_RESOURCE_CLASSES</h4> +<pre>public static final java.lang.String CONFIG_REST_RESOURCE_CLASSES</pre> +<div class="block">Specifies a comma-delimited list of class names of resources to register with the server.</div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../constant-values.html#org.apache.samza.rest.SamzaRestConfig.CONFIG_REST_RESOURCE_CLASSES">Constant Field Values</a></dd> +</dl> +</li> +</ul> +<a name="CONFIG_MONITOR_CLASSES"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>CONFIG_MONITOR_CLASSES</h4> +<pre>public static final java.lang.String CONFIG_MONITOR_CLASSES</pre> +<div class="block">Specifies a comma-delimited list of class names corresponding to Monitor implementations. + These will be instantiated and scheduled to run periodically at runtime. + Note that you must include the ENTIRE package name (org.apache.samza...).</div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../constant-values.html#org.apache.samza.rest.SamzaRestConfig.CONFIG_MONITOR_CLASSES">Constant Field Values</a></dd> +</dl> +</li> +</ul> +<a name="CONFIG_MONITOR_INTERVAL_MS"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>CONFIG_MONITOR_INTERVAL_MS</h4> +<pre>public static final java.lang.String CONFIG_MONITOR_INTERVAL_MS</pre> +<div class="block">Specifies the interval at which each registered Monitor's monitor method will be called.</div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../constant-values.html#org.apache.samza.rest.SamzaRestConfig.CONFIG_MONITOR_INTERVAL_MS">Constant Field Values</a></dd> +</dl> +</li> +</ul> +<a name="CONFIG_SAMZA_REST_SERVICE_PORT"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>CONFIG_SAMZA_REST_SERVICE_PORT</h4> +<pre>public static final java.lang.String CONFIG_SAMZA_REST_SERVICE_PORT</pre> +<div class="block">The port number to use for the HTTP server or 0 to dynamically choose a port.</div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../constant-values.html#org.apache.samza.rest.SamzaRestConfig.CONFIG_SAMZA_REST_SERVICE_PORT">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="SamzaRestConfig-org.apache.samza.config.Config-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>SamzaRestConfig</h4> +<pre>public SamzaRestConfig(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="getPort--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getPort</h4> +<pre>public int getPort()</pre> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the port number to use for the HTTP server or 0 to dynamically choose a port.</dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../org/apache/samza/rest/SamzaRestConfig.html#CONFIG_SAMZA_REST_SERVICE_PORT"><code>CONFIG_SAMZA_REST_SERVICE_PORT</code></a></dd> +</dl> +</li> +</ul> +<a name="getResourceFactoryClassNames--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getResourceFactoryClassNames</h4> +<pre>public java.util.List<java.lang.String> getResourceFactoryClassNames()</pre> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>a list of class names as Strings corresponding to factories + that Samza REST should use to instantiate and register resources + or an empty list if none were configured.</dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../org/apache/samza/rest/SamzaRestConfig.html#CONFIG_REST_RESOURCE_FACTORIES"><code>CONFIG_REST_RESOURCE_FACTORIES</code></a></dd> +</dl> +</li> +</ul> +<a name="getResourceClassNames--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getResourceClassNames</h4> +<pre>public java.util.List<java.lang.String> getResourceClassNames()</pre> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>a list of class names as Strings corresponding to resource classes + that Samza REST should register or an empty list if none were configured.</dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../org/apache/samza/rest/SamzaRestConfig.html#CONFIG_REST_RESOURCE_CLASSES"><code>CONFIG_REST_RESOURCE_CLASSES</code></a></dd> +</dl> +</li> +</ul> +<a name="getConfigMonitorClassList--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getConfigMonitorClassList</h4> +<pre>public java.util.List<java.lang.String> getConfigMonitorClassList()</pre> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>a list of class names as Strings corresponding to Monitors that + Samza REST should schedule or an empty list if none were configured.</dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../org/apache/samza/rest/SamzaRestConfig.html#CONFIG_MONITOR_CLASSES"><code>CONFIG_MONITOR_CLASSES</code></a></dd> +</dl> +</li> +</ul> +<a name="getConfigMonitorIntervalMs--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getConfigMonitorIntervalMs</h4> +<pre>public int getConfigMonitorIntervalMs()</pre> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>an integer number of milliseconds, the period at which to schedule monitor runs.</dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../org/apache/samza/rest/SamzaRestConfig.html#CONFIG_MONITOR_INTERVAL_MS"><code>CONFIG_MONITOR_INTERVAL_MS</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/SamzaRestApplication.html" title="class in org.apache.samza.rest"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/samza/rest/SamzaRestService.html" title="class in org.apache.samza.rest"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/samza/rest/SamzaRestConfig.html" target="_top">Frames</a></li> +<li><a href="SamzaRestConfig.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/SamzaRestService.html URL: http://svn.apache.org/viewvc/samza/site/learn/documentation/latest/rest/javadocs/org/apache/samza/rest/SamzaRestService.html?rev=1757411&view=auto ============================================================================== --- samza/site/learn/documentation/latest/rest/javadocs/org/apache/samza/rest/SamzaRestService.html (added) +++ samza/site/learn/documentation/latest/rest/javadocs/org/apache/samza/rest/SamzaRestService.html Tue Aug 23 17:38:58 2016 @@ -0,0 +1,353 @@ +<!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>SamzaRestService (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="SamzaRestService (samza-rest 0.10.1-SNAPSHOT API)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":10,"i1":9,"i2":10,"i3":10}; +var tabs = {65535:["t0","All Methods"],1:["t1","Static 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/SamzaRestConfig.html" title="class in org.apache.samza.rest"><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/SamzaRestService.html" target="_top">Frames</a></li> +<li><a href="SamzaRestService.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</div> +<h2 title="Class SamzaRestService" class="title">Class SamzaRestService</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>org.apache.samza.rest.SamzaRestService</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="typeNameLabel">SamzaRestService</span> +extends java.lang.Object</pre> +<div class="block">The main Java class for the Samza REST API. It runs an embedded Jetty server so it can be deployed as a Jar file. + + This class can be started from the command line by providing the --config-path parameter to a Samza REST config file + which will be used to configure the default resources exposed by the API. + + It can also be managed programmatically using the + <a href="../../../../org/apache/samza/rest/SamzaRestService.html#addServlet-javax.servlet.Servlet-java.lang.String-"><code>addServlet(javax.servlet.Servlet, String)</code></a>, + <a href="../../../../org/apache/samza/rest/SamzaRestService.html#start--"><code>start()</code></a> and <a href="../../../../org/apache/samza/rest/SamzaRestService.html#stop--"><code>stop()</code></a> methods.</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/SamzaRestService.html#SamzaRestService-org.apache.samza.rest.SamzaRestConfig-">SamzaRestService</a></span>(<a href="../../../../org/apache/samza/rest/SamzaRestConfig.html" title="class in org.apache.samza.rest">SamzaRestConfig</a> 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="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></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>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/samza/rest/SamzaRestService.html#addServlet-javax.servlet.Servlet-java.lang.String-">addServlet</a></span>(javax.servlet.Servlet servlet, + java.lang.String path)</code> +<div class="block">Adds the specified <code>Servlet</code> to the server at the specified path.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/samza/rest/SamzaRestService.html#main-java.lang.String:A-">main</a></span>(java.lang.String[] args)</code> +<div class="block">Command line interface to run the server.</div> +</td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/samza/rest/SamzaRestService.html#start--">start</a></span>()</code> +<div class="block">Starts the server asynchronously.</div> +</td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/samza/rest/SamzaRestService.html#stop--">stop</a></span>()</code> +<div class="block">Stops the server.</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="SamzaRestService-org.apache.samza.rest.SamzaRestConfig-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>SamzaRestService</h4> +<pre>public SamzaRestService(<a href="../../../../org/apache/samza/rest/SamzaRestConfig.html" title="class in org.apache.samza.rest">SamzaRestConfig</a> 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="main-java.lang.String:A-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>main</h4> +<pre>public static void main(java.lang.String[] args) + throws java.lang.Exception</pre> +<div class="block">Command line interface to run the server.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>args</code> - arguments supported by <code>CommandLine</code>. + In particular, --config-path and --config-factory are used to read the Samza REST config file.</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>java.lang.Exception</code> - if the server could not be successfully started.</dd> +</dl> +</li> +</ul> +<a name="addServlet-javax.servlet.Servlet-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addServlet</h4> +<pre>public void addServlet(javax.servlet.Servlet servlet, + java.lang.String path)</pre> +<div class="block">Adds the specified <code>Servlet</code> to the server at the specified path.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>servlet</code> - the <code>Servlet</code> to be added.</dd> +<dd><code>path</code> - the path for the servlet.</dd> +</dl> +</li> +</ul> +<a name="start--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>start</h4> +<pre>public void start() + throws java.lang.Exception</pre> +<div class="block">Starts the server asynchronously. To stop the server, see <a href="../../../../org/apache/samza/rest/SamzaRestService.html#stop--"><code>stop()</code></a>.</div> +<dl> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>java.lang.Exception</code> - if the server could not be successfully started.</dd> +</dl> +</li> +</ul> +<a name="stop--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>stop</h4> +<pre>public void stop() + throws java.lang.Exception</pre> +<div class="block">Stops the server.</div> +<dl> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>java.lang.Exception</code> - if the server could not be successfully stopped.</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/SamzaRestConfig.html" title="class in org.apache.samza.rest"><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/SamzaRestService.html" target="_top">Frames</a></li> +<li><a href="SamzaRestService.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>
