blob: 234b0d82a6c1de22e090fc6fdc4685aa924c0cde [file] [log] [blame]
<!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_152) on Mon Apr 02 22:52:27 UTC 2018 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>SysomosProvider (streams-provider-sysomos 0.5.2-SNAPSHOT API)</title>
<meta name="date" content="2018-04-02">
<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="SysomosProvider (streams-provider-sysomos 0.5.2-SNAPSHOT API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":9,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":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="class-use/SysomosProvider.html">Use</a></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/streams/sysomos/provider/SysomosHeartbeatStream.QueryResult.html" title="class in org.apache.streams.sysomos.provider"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/streams/sysomos/provider/SysomosProvider.Mode.html" title="enum in org.apache.streams.sysomos.provider"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/streams/sysomos/provider/SysomosProvider.html" target="_top">Frames</a></li>
<li><a href="SysomosProvider.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</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.streams.sysomos.provider</div>
<h2 title="Class SysomosProvider" class="title">Class SysomosProvider</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>org.apache.streams.sysomos.provider.SysomosProvider</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="http://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a>, <a href="https://github.com/apache/streams/streams-core/apidocs/org/apache/streams/core/StreamsOperation.html?is-external=true" title="class or interface in org.apache.streams.core">StreamsOperation</a>, <a href="https://github.com/apache/streams/streams-core/apidocs/org/apache/streams/core/StreamsProvider.html?is-external=true" title="class or interface in org.apache.streams.core">StreamsProvider</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">SysomosProvider</span>
extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>
implements <a href="https://github.com/apache/streams/streams-core/apidocs/org/apache/streams/core/StreamsProvider.html?is-external=true" title="class or interface in org.apache.streams.core">StreamsProvider</a></pre>
<div class="block">Streams Provider for the Sysomos Heartbeat API
<p/>
Configuration:
The provider takes either a Map[String,Object] containing the mode (backfill and terminate OR continuous) and a
Map[String,String] of heartbeat IDs to document target ids or a string of the format
${heartbeatId}:${documentId},...,${heartbeatId}:${documentId}
This configuration will configure the provider to backfill to the specified document and either terminate or not
depending on the mode flag. Continuous mode is assumed, and is the ony mode supported by the String configuration.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../serialized-form.html#org.apache.streams.sysomos.provider.SysomosProvider">Serialized Form</a></dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="nested.class.summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation">
<caption><span>Nested Classes</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Class and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/streams/sysomos/provider/SysomosProvider.Mode.html" title="enum in org.apache.streams.sysomos.provider">SysomosProvider.Mode</a></span></code>&nbsp;</td>
</tr>
</table>
</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">&nbsp;</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 long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/streams/sysomos/provider/SysomosProvider.html#API_BATCH_SIZE">API_BATCH_SIZE</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/streams/sysomos/provider/SysomosProvider.html#ENDING_TIME_KEY">ENDING_TIME_KEY</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/streams/sysomos/provider/SysomosProvider.html#LATENCY">LATENCY</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/streams/sysomos/provider/SysomosProvider.html#MODE_KEY">MODE_KEY</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/streams/sysomos/provider/SysomosProvider.html#PROVIDER_BATCH_SIZE">PROVIDER_BATCH_SIZE</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected <a href="http://docs.oracle.com/javase/8/docs/api/java/util/Queue.html?is-external=true" title="class or interface in java.util">Queue</a>&lt;<a href="https://github.com/apache/streams/streams-core/apidocs/org/apache/streams/core/StreamsDatum.html?is-external=true" title="class or interface in org.apache.streams.core">StreamsDatum</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/streams/sysomos/provider/SysomosProvider.html#providerQueue">providerQueue</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/streams/sysomos/provider/SysomosProvider.html#STARTING_DOCS_KEY">STARTING_DOCS_KEY</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/streams/sysomos/provider/SysomosProvider.html#STARTING_TIME_KEY">STARTING_TIME_KEY</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/streams/sysomos/provider/SysomosProvider.html#STREAMS_ID">STREAMS_ID</a></span></code>&nbsp;</td>
</tr>
</table>
</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">&nbsp;</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/streams/sysomos/provider/SysomosProvider.html#SysomosProvider-org.apache.streams.sysomos.SysomosConfiguration-">SysomosProvider</a></span>(<a href="../../../../../org/apache/streams/sysomos/SysomosConfiguration.html" title="class in org.apache.streams.sysomos">SysomosConfiguration</a>&nbsp;sysomosConfiguration)</code>
<div class="block">SysomosProvider constructor.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="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">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</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/streams/sysomos/provider/SysomosProvider.html#cleanUp--">cleanUp</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>protected <a href="../../../../../org/apache/streams/sysomos/provider/SysomosHeartbeatStream.html" title="class in org.apache.streams.sysomos.provider">SysomosHeartbeatStream</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/streams/sysomos/provider/SysomosProvider.html#createStream-java.lang.String-">createStream</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;heartbeatId)</code>&nbsp;</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/streams/sysomos/provider/SysomosProvider.html#enqueueItem-org.apache.streams.core.StreamsDatum-">enqueueItem</a></span>(<a href="https://github.com/apache/streams/streams-core/apidocs/org/apache/streams/core/StreamsDatum.html?is-external=true" title="class or interface in org.apache.streams.core">StreamsDatum</a>&nbsp;datum)</code>&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/streams/sysomos/provider/SysomosProvider.html#extractConfigFromMap-java.util.Map-">extractConfigFromMap</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&nbsp;configMap)</code>&nbsp;</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/streams/sysomos/provider/SysomosClient.html" title="class in org.apache.streams.sysomos.provider">SysomosClient</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/streams/sysomos/provider/SysomosProvider.html#getClient--">getClient</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/streams/sysomos/SysomosConfiguration.html" title="class in org.apache.streams.sysomos">SysomosConfiguration</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/streams/sysomos/provider/SysomosProvider.html#getConfig--">getConfig</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/streams/sysomos/provider/SysomosProvider.html#getCount--">getCount</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/streams/sysomos/provider/SysomosProvider.html#getId--">getId</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/streams/sysomos/provider/SysomosProvider.html#getMaxApiBatch--">getMaxApiBatch</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/streams/sysomos/provider/SysomosProvider.html#getMinLatency--">getMinLatency</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/streams/sysomos/provider/SysomosProvider.Mode.html" title="enum in org.apache.streams.sysomos.provider">SysomosProvider.Mode</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/streams/sysomos/provider/SysomosProvider.html#getMode--">getMode</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/streams/sysomos/provider/SysomosProvider.html#isRunning--">isRunning</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/streams/sysomos/provider/SysomosProvider.html#main-java.lang.String:A-">main</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]&nbsp;args)</code>
<div class="block">To use from command line:
<p/>
Supply configuration similar to src/test/resources/rss.conf
<p/>
Launch using:
<p/>
mvn exec:java -Dexec.mainClass=org.apache.streams.rss.provider.RssStreamProvider -Dexec.args="rss.conf articles.json"</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/streams/sysomos/provider/SysomosProvider.html#pauseForSpace--">pauseForSpace</a></span>()</code>
<div class="block">Wait for the queue size to be below threshold before allowing execution to continue on this thread.</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/streams/sysomos/provider/SysomosProvider.html#prepare-java.lang.Object-">prepare</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;configurationObject)</code>&nbsp;</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code><a href="https://github.com/apache/streams/streams-core/apidocs/org/apache/streams/core/StreamsResultSet.html?is-external=true" title="class or interface in org.apache.streams.core">StreamsResultSet</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/streams/sysomos/provider/SysomosProvider.html#readCurrent--">readCurrent</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code><a href="https://github.com/apache/streams/streams-core/apidocs/org/apache/streams/core/StreamsResultSet.html?is-external=true" title="class or interface in org.apache.streams.core">StreamsResultSet</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/streams/sysomos/provider/SysomosProvider.html#readNew-java.math.BigInteger-">readNew</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/math/BigInteger.html?is-external=true" title="class or interface in java.math">BigInteger</a>&nbsp;bigInteger)</code>&nbsp;</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code><a href="https://github.com/apache/streams/streams-core/apidocs/org/apache/streams/core/StreamsResultSet.html?is-external=true" title="class or interface in org.apache.streams.core">StreamsResultSet</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/streams/sysomos/provider/SysomosProvider.html#readRange-org.joda.time.DateTime-org.joda.time.DateTime-">readRange</a></span>(org.joda.time.DateTime&nbsp;dateTime,
org.joda.time.DateTime&nbsp;dateTime2)</code>&nbsp;</td>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/streams/sysomos/provider/SysomosProvider.html#setConfig-org.apache.streams.sysomos.SysomosConfiguration-">setConfig</a></span>(<a href="../../../../../org/apache/streams/sysomos/SysomosConfiguration.html" title="class in org.apache.streams.sysomos">SysomosConfiguration</a>&nbsp;config)</code>&nbsp;</td>
</tr>
<tr id="i19" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/streams/sysomos/provider/SysomosProvider.html#signalComplete-java.lang.String-">signalComplete</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;heartbeatId)</code>
<div class="block">signalComplete.</div>
</td>
</tr>
<tr id="i20" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/streams/sysomos/provider/SysomosProvider.html#startStream--">startStream</a></span>()</code>&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></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="STREAMS_ID">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>STREAMS_ID</h4>
<pre>public static final&nbsp;<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> STREAMS_ID</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.apache.streams.sysomos.provider.SysomosProvider.STREAMS_ID">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="ENDING_TIME_KEY">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ENDING_TIME_KEY</h4>
<pre>public static final&nbsp;<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> ENDING_TIME_KEY</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.apache.streams.sysomos.provider.SysomosProvider.ENDING_TIME_KEY">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="STARTING_TIME_KEY">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>STARTING_TIME_KEY</h4>
<pre>public static final&nbsp;<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> STARTING_TIME_KEY</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.apache.streams.sysomos.provider.SysomosProvider.STARTING_TIME_KEY">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="MODE_KEY">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>MODE_KEY</h4>
<pre>public static final&nbsp;<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> MODE_KEY</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.apache.streams.sysomos.provider.SysomosProvider.MODE_KEY">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="STARTING_DOCS_KEY">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>STARTING_DOCS_KEY</h4>
<pre>public static final&nbsp;<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> STARTING_DOCS_KEY</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.apache.streams.sysomos.provider.SysomosProvider.STARTING_DOCS_KEY">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="LATENCY">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>LATENCY</h4>
<pre>public static final&nbsp;int LATENCY</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.apache.streams.sysomos.provider.SysomosProvider.LATENCY">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="PROVIDER_BATCH_SIZE">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>PROVIDER_BATCH_SIZE</h4>
<pre>public static final&nbsp;long PROVIDER_BATCH_SIZE</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.apache.streams.sysomos.provider.SysomosProvider.PROVIDER_BATCH_SIZE">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="API_BATCH_SIZE">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>API_BATCH_SIZE</h4>
<pre>public static final&nbsp;long API_BATCH_SIZE</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.apache.streams.sysomos.provider.SysomosProvider.API_BATCH_SIZE">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="providerQueue">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>providerQueue</h4>
<pre>protected volatile&nbsp;<a href="http://docs.oracle.com/javase/8/docs/api/java/util/Queue.html?is-external=true" title="class or interface in java.util">Queue</a>&lt;<a href="https://github.com/apache/streams/streams-core/apidocs/org/apache/streams/core/StreamsDatum.html?is-external=true" title="class or interface in org.apache.streams.core">StreamsDatum</a>&gt; providerQueue</pre>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="SysomosProvider-org.apache.streams.sysomos.SysomosConfiguration-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>SysomosProvider</h4>
<pre>public&nbsp;SysomosProvider(<a href="../../../../../org/apache/streams/sysomos/SysomosConfiguration.html" title="class in org.apache.streams.sysomos">SysomosConfiguration</a>&nbsp;sysomosConfiguration)</pre>
<div class="block">SysomosProvider constructor.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>sysomosConfiguration</code> - SysomosConfiguration</dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="main-java.lang.String:A-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>main</h4>
<pre>public static&nbsp;void&nbsp;main(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]&nbsp;args)
throws <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
<div class="block">To use from command line:
<p/>
Supply configuration similar to src/test/resources/rss.conf
<p/>
Launch using:
<p/>
mvn exec:java -Dexec.mainClass=org.apache.streams.rss.provider.RssStreamProvider -Dexec.args="rss.conf articles.json"</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>args</code> - args</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code> - Exception</dd>
</dl>
</li>
</ul>
<a name="getConfig--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getConfig</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/streams/sysomos/SysomosConfiguration.html" title="class in org.apache.streams.sysomos">SysomosConfiguration</a>&nbsp;getConfig()</pre>
</li>
</ul>
<a name="setConfig-org.apache.streams.sysomos.SysomosConfiguration-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setConfig</h4>
<pre>public&nbsp;void&nbsp;setConfig(<a href="../../../../../org/apache/streams/sysomos/SysomosConfiguration.html" title="class in org.apache.streams.sysomos">SysomosConfiguration</a>&nbsp;config)</pre>
</li>
</ul>
<a name="getMode--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMode</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/streams/sysomos/provider/SysomosProvider.Mode.html" title="enum in org.apache.streams.sysomos.provider">SysomosProvider.Mode</a>&nbsp;getMode()</pre>
</li>
</ul>
<a name="getMinLatency--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMinLatency</h4>
<pre>public&nbsp;long&nbsp;getMinLatency()</pre>
</li>
</ul>
<a name="getMaxApiBatch--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMaxApiBatch</h4>
<pre>public&nbsp;long&nbsp;getMaxApiBatch()</pre>
</li>
</ul>
<a name="getClient--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getClient</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/streams/sysomos/provider/SysomosClient.html" title="class in org.apache.streams.sysomos.provider">SysomosClient</a>&nbsp;getClient()</pre>
</li>
</ul>
<a name="getId--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getId</h4>
<pre>public&nbsp;<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getId()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="https://github.com/apache/streams/streams-core/apidocs/org/apache/streams/core/StreamsOperation.html?is-external=true#getId--" title="class or interface in org.apache.streams.core">getId</a></code>&nbsp;in interface&nbsp;<code><a href="https://github.com/apache/streams/streams-core/apidocs/org/apache/streams/core/StreamsOperation.html?is-external=true" title="class or interface in org.apache.streams.core">StreamsOperation</a></code></dd>
</dl>
</li>
</ul>
<a name="startStream--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>startStream</h4>
<pre>public&nbsp;void&nbsp;startStream()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="https://github.com/apache/streams/streams-core/apidocs/org/apache/streams/core/StreamsProvider.html?is-external=true#startStream--" title="class or interface in org.apache.streams.core">startStream</a></code>&nbsp;in interface&nbsp;<code><a href="https://github.com/apache/streams/streams-core/apidocs/org/apache/streams/core/StreamsProvider.html?is-external=true" title="class or interface in org.apache.streams.core">StreamsProvider</a></code></dd>
</dl>
</li>
</ul>
<a name="readCurrent--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>readCurrent</h4>
<pre>public&nbsp;<a href="https://github.com/apache/streams/streams-core/apidocs/org/apache/streams/core/StreamsResultSet.html?is-external=true" title="class or interface in org.apache.streams.core">StreamsResultSet</a>&nbsp;readCurrent()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="https://github.com/apache/streams/streams-core/apidocs/org/apache/streams/core/StreamsProvider.html?is-external=true#readCurrent--" title="class or interface in org.apache.streams.core">readCurrent</a></code>&nbsp;in interface&nbsp;<code><a href="https://github.com/apache/streams/streams-core/apidocs/org/apache/streams/core/StreamsProvider.html?is-external=true" title="class or interface in org.apache.streams.core">StreamsProvider</a></code></dd>
</dl>
</li>
</ul>
<a name="readNew-java.math.BigInteger-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>readNew</h4>
<pre>public&nbsp;<a href="https://github.com/apache/streams/streams-core/apidocs/org/apache/streams/core/StreamsResultSet.html?is-external=true" title="class or interface in org.apache.streams.core">StreamsResultSet</a>&nbsp;readNew(<a href="http://docs.oracle.com/javase/8/docs/api/java/math/BigInteger.html?is-external=true" title="class or interface in java.math">BigInteger</a>&nbsp;bigInteger)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="https://github.com/apache/streams/streams-core/apidocs/org/apache/streams/core/StreamsProvider.html?is-external=true#readNew-java.math.BigInteger-" title="class or interface in org.apache.streams.core">readNew</a></code>&nbsp;in interface&nbsp;<code><a href="https://github.com/apache/streams/streams-core/apidocs/org/apache/streams/core/StreamsProvider.html?is-external=true" title="class or interface in org.apache.streams.core">StreamsProvider</a></code></dd>
</dl>
</li>
</ul>
<a name="readRange-org.joda.time.DateTime-org.joda.time.DateTime-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>readRange</h4>
<pre>public&nbsp;<a href="https://github.com/apache/streams/streams-core/apidocs/org/apache/streams/core/StreamsResultSet.html?is-external=true" title="class or interface in org.apache.streams.core">StreamsResultSet</a>&nbsp;readRange(org.joda.time.DateTime&nbsp;dateTime,
org.joda.time.DateTime&nbsp;dateTime2)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="https://github.com/apache/streams/streams-core/apidocs/org/apache/streams/core/StreamsProvider.html?is-external=true#readRange-org.joda.time.DateTime-org.joda.time.DateTime-" title="class or interface in org.apache.streams.core">readRange</a></code>&nbsp;in interface&nbsp;<code><a href="https://github.com/apache/streams/streams-core/apidocs/org/apache/streams/core/StreamsProvider.html?is-external=true" title="class or interface in org.apache.streams.core">StreamsProvider</a></code></dd>
</dl>
</li>
</ul>
<a name="isRunning--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isRunning</h4>
<pre>public&nbsp;boolean&nbsp;isRunning()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="https://github.com/apache/streams/streams-core/apidocs/org/apache/streams/core/StreamsProvider.html?is-external=true#isRunning--" title="class or interface in org.apache.streams.core">isRunning</a></code>&nbsp;in interface&nbsp;<code><a href="https://github.com/apache/streams/streams-core/apidocs/org/apache/streams/core/StreamsProvider.html?is-external=true" title="class or interface in org.apache.streams.core">StreamsProvider</a></code></dd>
</dl>
</li>
</ul>
<a name="prepare-java.lang.Object-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>prepare</h4>
<pre>public&nbsp;void&nbsp;prepare(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;configurationObject)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="https://github.com/apache/streams/streams-core/apidocs/org/apache/streams/core/StreamsOperation.html?is-external=true#prepare-java.lang.Object-" title="class or interface in org.apache.streams.core">prepare</a></code>&nbsp;in interface&nbsp;<code><a href="https://github.com/apache/streams/streams-core/apidocs/org/apache/streams/core/StreamsOperation.html?is-external=true" title="class or interface in org.apache.streams.core">StreamsOperation</a></code></dd>
</dl>
</li>
</ul>
<a name="cleanUp--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>cleanUp</h4>
<pre>public&nbsp;void&nbsp;cleanUp()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="https://github.com/apache/streams/streams-core/apidocs/org/apache/streams/core/StreamsOperation.html?is-external=true#cleanUp--" title="class or interface in org.apache.streams.core">cleanUp</a></code>&nbsp;in interface&nbsp;<code><a href="https://github.com/apache/streams/streams-core/apidocs/org/apache/streams/core/StreamsOperation.html?is-external=true" title="class or interface in org.apache.streams.core">StreamsOperation</a></code></dd>
</dl>
</li>
</ul>
<a name="signalComplete-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>signalComplete</h4>
<pre>public&nbsp;void&nbsp;signalComplete(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;heartbeatId)</pre>
<div class="block">signalComplete.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>heartbeatId</code> - heartbeatId</dd>
</dl>
</li>
</ul>
<a name="enqueueItem-org.apache.streams.core.StreamsDatum-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>enqueueItem</h4>
<pre>protected&nbsp;void&nbsp;enqueueItem(<a href="https://github.com/apache/streams/streams-core/apidocs/org/apache/streams/core/StreamsDatum.html?is-external=true" title="class or interface in org.apache.streams.core">StreamsDatum</a>&nbsp;datum)</pre>
</li>
</ul>
<a name="createStream-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createStream</h4>
<pre>protected&nbsp;<a href="../../../../../org/apache/streams/sysomos/provider/SysomosHeartbeatStream.html" title="class in org.apache.streams.sysomos.provider">SysomosHeartbeatStream</a>&nbsp;createStream(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;heartbeatId)</pre>
</li>
</ul>
<a name="pauseForSpace--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>pauseForSpace</h4>
<pre>protected&nbsp;void&nbsp;pauseForSpace()</pre>
<div class="block">Wait for the queue size to be below threshold before allowing execution to continue on this thread.</div>
</li>
</ul>
<a name="extractConfigFromMap-java.util.Map-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>extractConfigFromMap</h4>
<pre>protected&nbsp;void&nbsp;extractConfigFromMap(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&nbsp;configMap)</pre>
</li>
</ul>
<a name="getCount--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getCount</h4>
<pre>public&nbsp;int&nbsp;getCount()</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="class-use/SysomosProvider.html">Use</a></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/streams/sysomos/provider/SysomosHeartbeatStream.QueryResult.html" title="class in org.apache.streams.sysomos.provider"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/streams/sysomos/provider/SysomosProvider.Mode.html" title="enum in org.apache.streams.sysomos.provider"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/streams/sysomos/provider/SysomosProvider.html" target="_top">Frames</a></li>
<li><a href="SysomosProvider.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2018 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>