| <!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 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>RestCallHandler (Apache Juneau 9.0.0)</title> |
| <link rel="stylesheet" type="text/css" href="../../../../../javadoc.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="RestCallHandler (Apache Juneau 9.0.0)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../org/apache/juneau/rest/client/RestCallException.html" title="class in org.apache.juneau.rest.client"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/juneau/rest/client/RestCallInterceptor.html" title="interface in org.apache.juneau.rest.client"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/juneau/rest/client/RestCallHandler.html" target="_top">Frames</a></li> |
| <li><a href="RestCallHandler.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.juneau.rest.client</div> |
| <h2 title="Interface RestCallHandler" class="title">Interface RestCallHandler</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/juneau/rest/client/BasicRestCallHandler.html" title="class in org.apache.juneau.rest.client">BasicRestCallHandler</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <a href="../../../../../src-html/org/apache/juneau/rest/client/RestCallHandler.html#line.64">RestCallHandler</a></pre> |
| <div class="block">Interface that allows you to override the handling of HTTP requests. |
| |
| <p> |
| Providing this implementation is the equivalent to overriding the <a href="../../../../../org/apache/juneau/rest/client/RestClient.html#execute-org.apache.http.HttpHost-org.apache.http.HttpRequest-org.apache.http.protocol.HttpContext-"><code>RestClient.execute(HttpHost,HttpRequest,HttpContext)</code></a>. |
| <br>This can also be accomplished by providing your own <a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#connectionManager-org.apache.http.conn.HttpClientConnectionManager-"><code>connection manager</code></a> |
| or subclassing <a href="../../../../../org/apache/juneau/rest/client/RestClient.html" title="class in org.apache.juneau.rest.client"><code>RestClient</code></a>, but this provides a simpler way of handling the requests yourself. |
| |
| <p> |
| The constructor on the implementation class can optionally take in any of the following parameters: |
| <ul> |
| <li><a href="../../../../../org/apache/juneau/rest/client/RestClient.html" title="class in org.apache.juneau.rest.client"><code>RestClient</code></a> - The client using this handler. |
| </ul> |
| |
| <p> |
| The <a href="../../../../../org/apache/juneau/rest/client/BasicRestCallHandler.html" title="class in org.apache.juneau.rest.client"><code>BasicRestCallHandler</code></a> shows an example of a simple pass-through handler. Note that you must handle |
| the case where <code>HttpHost</code> is null. |
| |
| <p class='bjava'> |
| <jk>public class</jk> BasicRestCallHandler <jk>implements</jk> RestCallHandler { |
| |
| <jk>private final</jk> RestClient <jf>client</jf>; |
| |
| <jk>public</jk> BasicRestCallHandler(RestClient <jv>client</jv>) { |
| <jk>this</jk>.<jf>client</jf> = <jv>client</jv>; |
| } |
| |
| <ja>@Override</ja> |
| <jk>public</jk> HttpResponse run(HttpHost <jv>target</jv>, HttpRequest <jv>request</jv>, HttpContext <jv>context</jv>) <jk>throws</jk> IOException { |
| <jk>if</jk> (<jv>target</jv> == <jk>null</jk>) |
| <jk>return</jk> <jf>client</jf>.execute((HttpUriRequest)<jv>request</jv>, <jv>context</jv>); |
| <jk>return</jk> <jf>client</jf>.execute(<jv>target</jv>, <jv>request</jv>, <jv>context</jv>); |
| } |
| } |
| </p> |
| |
| <ul class='seealso'> |
| <li class='jm'><a href="../../../../../org/apache/juneau/rest/client/RestClient.Builder.html#callHandler--"><code>RestClient.Builder.callHandler()</code></a> |
| <li class='link'><a class='doclink' href='../../../../../overview-summary.html#juneau-rest-client'>Overview > juneau-rest-client</a> |
| <li class='extlink'><a class='doclink' target='_blank' href='https://github.com/apache/juneau/blob/master/juneau-rest/juneau-rest-client/src/main/java/org/apache/juneau/rest/client/RestCallHandler.java'>Source</a> |
| </ul></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>org.apache.http.HttpResponse</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/rest/client/RestCallHandler.html#run-org.apache.http.HttpHost-org.apache.http.HttpRequest-org.apache.http.protocol.HttpContext-">run</a></span>(org.apache.http.HttpHost target, |
| org.apache.http.HttpRequest request, |
| org.apache.http.protocol.HttpContext context)</code> |
| <div class="block">Execute the specified request.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="run-org.apache.http.HttpHost-org.apache.http.HttpRequest-org.apache.http.protocol.HttpContext-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>run</h4> |
| <pre>org.apache.http.HttpResponse <a href="../../../../../src-html/org/apache/juneau/rest/client/RestCallHandler.html#line.89">run</a>(org.apache.http.HttpHost target, |
| org.apache.http.HttpRequest request, |
| org.apache.http.protocol.HttpContext context) |
| throws org.apache.http.client.ClientProtocolException, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> |
| <div class="block">Execute the specified request. |
| |
| <p> |
| Subclasses can override this method to provide specialized handling.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>target</code> - The target host for the request. |
| <br>Implementations may accept <jk>null</jk> if they can still determine a route, for example to a default |
| target or by inspecting the request.</dd> |
| <dd><code>request</code> - The request to execute. Must be an instance of <code>HttpUriRequest</code> if the target is <jk>null</jk>.</dd> |
| <dd><code>context</code> - The context to use for the execution, or <jk>null</jk> to use the default context.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The response to the request. |
| <br>This is always a final response, never an intermediate response with an 1xx status code. |
| <br>Whether redirects or authentication challenges will be returned or handled automatically depends on the |
| implementation and configuration of this client.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - In case of a problem or the connection was aborted.</dd> |
| <dd><code>org.apache.http.client.ClientProtocolException</code> - In case of an http protocol error.</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/juneau/rest/client/RestCallException.html" title="class in org.apache.juneau.rest.client"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/juneau/rest/client/RestCallInterceptor.html" title="interface in org.apache.juneau.rest.client"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/juneau/rest/client/RestCallHandler.html" target="_top">Frames</a></li> |
| <li><a href="RestCallHandler.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 ======= --> |
| <p class="legalCopy"><small>Copyright © 2016–2022 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |
