| <!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_71) on Tue May 17 00:28:45 UTC 2016 --> |
| <title>HttpStreams (Quarks v0.4.0)</title> |
| <meta name="date" content="2016-05-17"> |
| <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="HttpStreams (Quarks v0.4.0)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":9,"i1":9}; |
| var tabs = {65535:["t0","All Methods"],1:["t1","Static 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/HttpStreams.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="../../../quarks/connectors/http/HttpResponders.html" title="class in quarks.connectors.http"><span class="typeNameLink">Prev Class</span></a></li> |
| <li>Next Class</li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../index.html?quarks/connectors/http/HttpStreams.html" target="_top">Frames</a></li> |
| <li><a href="HttpStreams.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">quarks.connectors.http</div> |
| <h2 title="Class HttpStreams" class="title">Class HttpStreams</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li>quarks.connectors.http.HttpStreams</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <pre>public class <span class="typeNameLabel">HttpStreams</span> |
| extends java.lang.Object</pre> |
| <div class="block">HTTP streams.</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="../../../quarks/connectors/http/HttpStreams.html#HttpStreams--">HttpStreams</a></span>()</code> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static 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>static <a href="../../../quarks/topology/TStream.html" title="interface in quarks.topology">TStream</a><com.google.gson.JsonObject></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../quarks/connectors/http/HttpStreams.html#getJson-quarks.topology.TStream-quarks.function.Supplier-quarks.function.Function-">getJson</a></span>(<a href="../../../quarks/topology/TStream.html" title="interface in quarks.topology">TStream</a><com.google.gson.JsonObject> stream, |
| <a href="../../../quarks/function/Supplier.html" title="interface in quarks.function">Supplier</a><org.apache.http.impl.client.CloseableHttpClient> clientCreator, |
| <a href="../../../quarks/function/Function.html" title="interface in quarks.function">Function</a><com.google.gson.JsonObject,java.lang.String> uri)</code> </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>static <T,R> <a href="../../../quarks/topology/TStream.html" title="interface in quarks.topology">TStream</a><R></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../quarks/connectors/http/HttpStreams.html#requests-quarks.topology.TStream-quarks.function.Supplier-quarks.function.Function-quarks.function.Function-quarks.function.BiFunction-">requests</a></span>(<a href="../../../quarks/topology/TStream.html" title="interface in quarks.topology">TStream</a><T> stream, |
| <a href="../../../quarks/function/Supplier.html" title="interface in quarks.function">Supplier</a><org.apache.http.impl.client.CloseableHttpClient> clientCreator, |
| <a href="../../../quarks/function/Function.html" title="interface in quarks.function">Function</a><T,java.lang.String> method, |
| <a href="../../../quarks/function/Function.html" title="interface in quarks.function">Function</a><T,java.lang.String> uri, |
| <a href="../../../quarks/function/BiFunction.html" title="interface in quarks.function">BiFunction</a><T,org.apache.http.client.methods.CloseableHttpResponse,R> response)</code> |
| <div class="block">Make an HTTP request for each tuple on a stream.</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="HttpStreams--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>HttpStreams</h4> |
| <pre>public HttpStreams()</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="getJson-quarks.topology.TStream-quarks.function.Supplier-quarks.function.Function-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getJson</h4> |
| <pre>public static <a href="../../../quarks/topology/TStream.html" title="interface in quarks.topology">TStream</a><com.google.gson.JsonObject> getJson(<a href="../../../quarks/topology/TStream.html" title="interface in quarks.topology">TStream</a><com.google.gson.JsonObject> stream, |
| <a href="../../../quarks/function/Supplier.html" title="interface in quarks.function">Supplier</a><org.apache.http.impl.client.CloseableHttpClient> clientCreator, |
| <a href="../../../quarks/function/Function.html" title="interface in quarks.function">Function</a><com.google.gson.JsonObject,java.lang.String> uri)</pre> |
| </li> |
| </ul> |
| <a name="requests-quarks.topology.TStream-quarks.function.Supplier-quarks.function.Function-quarks.function.Function-quarks.function.BiFunction-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>requests</h4> |
| <pre>public static <T,R> <a href="../../../quarks/topology/TStream.html" title="interface in quarks.topology">TStream</a><R> requests(<a href="../../../quarks/topology/TStream.html" title="interface in quarks.topology">TStream</a><T> stream, |
| <a href="../../../quarks/function/Supplier.html" title="interface in quarks.function">Supplier</a><org.apache.http.impl.client.CloseableHttpClient> clientCreator, |
| <a href="../../../quarks/function/Function.html" title="interface in quarks.function">Function</a><T,java.lang.String> method, |
| <a href="../../../quarks/function/Function.html" title="interface in quarks.function">Function</a><T,java.lang.String> uri, |
| <a href="../../../quarks/function/BiFunction.html" title="interface in quarks.function">BiFunction</a><T,org.apache.http.client.methods.CloseableHttpResponse,R> response)</pre> |
| <div class="block">Make an HTTP request for each tuple on a stream. |
| <UL> |
| <LI><code>clientCreator</code> is invoked once to create a new HTTP client |
| to make the requests. |
| </LI> |
| <LI> |
| <code>method</code> is invoked for each tuple to define the method |
| to be used for the HTTP request driven by the tuple. A fixed method |
| can be declared using a function such as: |
| <UL style="list-style-type:none"><LI><code>t -> HttpGet.METHOD_NAME</code></LI></UL> |
| </LI> |
| <LI> |
| <code>uri</code> is invoked for each tuple to define the URI |
| to be used for the HTTP request driven by the tuple. A fixed method |
| can be declared using a function such as: |
| <UL style="list-style-type:none"><LI><code>t -> "http://www.example.com"</code></LI></UL> |
| </LI> |
| <LI> |
| <code>response</code> is invoked after each request that did not throw an exception. |
| It is passed the input tuple and the HTTP response. The function must completely |
| consume the entity stream for the response. The return value is present on |
| the stream returned by this method if it is non-null. A null return results |
| in no tuple on the returned stream. |
| |
| </LI> |
| </UL></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>stream</code> - Stream to invoke HTTP requests.</dd> |
| <dd><code>clientCreator</code> - Function to create a HTTP client.</dd> |
| <dd><code>method</code> - Function to define the HTTP method.</dd> |
| <dd><code>uri</code> - Function to define the URI.</dd> |
| <dd><code>response</code> - Function to process the response.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Stream containing HTTP responses processed by the <code>response</code> function.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../quarks/connectors/http/HttpClients.html" title="class in quarks.connectors.http"><code>HttpClients</code></a>, |
| <a href="../../../quarks/connectors/http/HttpResponders.html" title="class in quarks.connectors.http"><code>HttpResponders</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="class-use/HttpStreams.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 class="aboutLanguage"><a href="http://quarks.incubator.apache.org">Apache Quarks (incubating)</a></div> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../quarks/connectors/http/HttpResponders.html" title="class in quarks.connectors.http"><span class="typeNameLink">Prev Class</span></a></li> |
| <li>Next Class</li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../index.html?quarks/connectors/http/HttpStreams.html" target="_top">Frames</a></li> |
| <li><a href="HttpStreams.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 ======= --> |
| <p class="legalCopy"><small>Copyright © 2016 The Apache Software Foundation. All Rights Reserved - d6cdfc6-20160517-0028</small></p> |
| </body> |
| </html> |
