| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (11.0.11) on Mon May 17 19:14:02 CDT 2021 --> |
| <title>HttpRequest (Jetty :: Project 9.4.41.v20210516 API)</title> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="dc.created" content="2021-05-17"> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../jquery/jquery-ui.css" title="Style"> |
| <script type="text/javascript" src="../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../jquery/jszip/dist/jszip.min.js"></script> |
| <script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script> |
| <!--[if IE]> |
| <script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script> |
| <![endif]--> |
| <script type="text/javascript" src="../../../../jquery/jquery-3.5.1.js"></script> |
| <script type="text/javascript" src="../../../../jquery/jquery-ui.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="HttpRequest (Jetty :: Project 9.4.41.v20210516 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"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":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10,"i21":10,"i22":10,"i23":10,"i24":10,"i25":10,"i26":10,"i27":10,"i28":10,"i29":10,"i30":10,"i31":10,"i32":10,"i33":10,"i34":10,"i35":10,"i36":10,"i37":10,"i38":10,"i39":10,"i40":10,"i41":10,"i42":10,"i43":10,"i44":10,"i45":10,"i46":10,"i47":10,"i48":10,"i49":10,"i50":10,"i51":10,"i52":10,"i53":10,"i54":10,"i55":10,"i56":10,"i57":10,"i58":10,"i59":10,"i60":10,"i61":10,"i62":10,"i63":10,"i64":10,"i65":10,"i66":10,"i67":10,"i68":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"; |
| var pathtoroot = "../../../../"; |
| var useModuleDirectories = false; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <header role="banner"> |
| <nav role="navigation"> |
| <div class="fixedNav"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a id="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/HttpRequest.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" id="allclasses_navbar_top"> |
| <li><a href="../../../../allclasses.html">All Classes</a></li> |
| </ul> |
| <ul class="navListSearch"> |
| <li><label for="search">SEARCH:</label> |
| <input type="text" id="search" value="search" disabled="disabled"> |
| <input type="reset" id="reset" value="reset" disabled="disabled"> |
| </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> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li><a href="#nested.class.summary">Nested</a> | </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 id="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| </div> |
| <div class="navPadding"> </div> |
| <script type="text/javascript"><!-- |
| $('.navPadding').css('padding-top', $('.fixedNav').css("height")); |
| //--> |
| </script> |
| </nav> |
| </header> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <main role="main"> |
| <div class="header"> |
| <div class="subTitle"><span class="packageLabelInType">Package</span> <a href="package-summary.html">org.eclipse.jetty.client</a></div> |
| <h2 title="Class HttpRequest" class="title">Class HttpRequest</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.eclipse.jetty.client.HttpRequest</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code><a href="api/Request.html" title="interface in org.eclipse.jetty.client.api">Request</a></code></dd> |
| </dl> |
| <dl> |
| <dt>Direct Known Subclasses:</dt> |
| <dd><code><a href="../websocket/client/WebSocketUpgradeRequest.html" title="class in org.eclipse.jetty.websocket.client">WebSocketUpgradeRequest</a></code></dd> |
| </dl> |
| <hr> |
| <pre>public class <span class="typeNameLabel">HttpRequest</span> |
| extends java.lang.Object |
| implements <a href="api/Request.html" title="interface in org.eclipse.jetty.client.api">Request</a></pre> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="nested.class.summary"> |
| <!-- --> |
| </a> |
| <h3>Nested Class Summary</h3> |
| <ul class="blockList"> |
| <li class="blockList"><a id="nested.classes.inherited.from.class.org.eclipse.jetty.client.api.Request"> |
| <!-- --> |
| </a> |
| <h3>Nested classes/interfaces inherited from interface org.eclipse.jetty.client.api.<a href="api/Request.html" title="interface in org.eclipse.jetty.client.api">Request</a></h3> |
| <code><a href="api/Request.BeginListener.html" title="interface in org.eclipse.jetty.client.api">Request.BeginListener</a>, <a href="api/Request.CommitListener.html" title="interface in org.eclipse.jetty.client.api">Request.CommitListener</a>, <a href="api/Request.ContentListener.html" title="interface in org.eclipse.jetty.client.api">Request.ContentListener</a>, <a href="api/Request.FailureListener.html" title="interface in org.eclipse.jetty.client.api">Request.FailureListener</a>, <a href="api/Request.HeadersListener.html" title="interface in org.eclipse.jetty.client.api">Request.HeadersListener</a>, <a href="api/Request.Listener.html" title="interface in org.eclipse.jetty.client.api">Request.Listener</a>, <a href="api/Request.QueuedListener.html" title="interface in org.eclipse.jetty.client.api">Request.QueuedListener</a>, <a href="api/Request.RequestListener.html" title="interface in org.eclipse.jetty.client.api">Request.RequestListener</a>, <a href="api/Request.SuccessListener.html" title="interface in org.eclipse.jetty.client.api">Request.SuccessListener</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier</th> |
| <th class="colSecond" scope="col">Constructor</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected </code></td> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(org.eclipse.jetty.client.HttpClient,org.eclipse.jetty.client.HttpConversation,java.net.URI)">HttpRequest</a></span>​(<a href="HttpClient.html" title="class in org.eclipse.jetty.client">HttpClient</a> client, |
| <a href="HttpConversation.html" title="class in org.eclipse.jetty.client">HttpConversation</a> conversation, |
| java.net.URI uri)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </section> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary"> |
| <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="colSecond" scope="col">Method</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#abort(java.lang.Throwable)">abort</a></span>​(java.lang.Throwable cause)</code></th> |
| <td class="colLast"> |
| <div class="block">Attempts to abort the send of this request.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="api/Request.html" title="interface in org.eclipse.jetty.client.api">Request</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#accept(java.lang.String...)">accept</a></span>​(java.lang.String... accepts)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="api/Request.html" title="interface in org.eclipse.jetty.client.api">Request</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#agent(java.lang.String)">agent</a></span>​(java.lang.String agent)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><a href="api/Request.html" title="interface in org.eclipse.jetty.client.api">Request</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#attribute(java.lang.String,java.lang.Object)">attribute</a></span>​(java.lang.String name, |
| java.lang.Object value)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><a href="api/Request.html" title="interface in org.eclipse.jetty.client.api">Request</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#content(org.eclipse.jetty.client.api.ContentProvider)">content</a></span>​(<a href="api/ContentProvider.html" title="interface in org.eclipse.jetty.client.api">ContentProvider</a> content)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code><a href="api/Request.html" title="interface in org.eclipse.jetty.client.api">Request</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#content(org.eclipse.jetty.client.api.ContentProvider,java.lang.String)">content</a></span>​(<a href="api/ContentProvider.html" title="interface in org.eclipse.jetty.client.api">ContentProvider</a> content, |
| java.lang.String contentType)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code><a href="api/Request.html" title="interface in org.eclipse.jetty.client.api">Request</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#cookie(java.net.HttpCookie)">cookie</a></span>​(java.net.HttpCookie cookie)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code><a href="api/Request.html" title="interface in org.eclipse.jetty.client.api">Request</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#file(java.nio.file.Path)">file</a></span>​(java.nio.file.Path file)</code></th> |
| <td class="colLast"> |
| <div class="block">Shortcut method to specify a file as a content for this request, with the default content type of |
| "application/octect-stream".</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code><a href="api/Request.html" title="interface in org.eclipse.jetty.client.api">Request</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#file(java.nio.file.Path,java.lang.String)">file</a></span>​(java.nio.file.Path file, |
| java.lang.String contentType)</code></th> |
| <td class="colLast"> |
| <div class="block">Shortcut method to specify a file as a content for this request, with the given content type.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code><a href="api/Request.html" title="interface in org.eclipse.jetty.client.api">Request</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#followRedirects(boolean)">followRedirects</a></span>​(boolean follow)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>java.lang.Throwable</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getAbortCause()">getAbortCause</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getAgent()">getAgent</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code>java.util.Map<java.lang.String,​java.lang.Object></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getAttributes()">getAttributes</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code><a href="api/ContentProvider.html" title="interface in org.eclipse.jetty.client.api">ContentProvider</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getContent()">getContent</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code><a href="HttpConversation.html" title="class in org.eclipse.jetty.client">HttpConversation</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getConversation()">getConversation</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code>java.util.List<java.net.HttpCookie></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getCookies()">getCookies</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code><a href="../http/HttpFields.html" title="class in org.eclipse.jetty.http">HttpFields</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getHeaders()">getHeaders</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i17" class="rowColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getHost()">getHost</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i18" class="altColor"> |
| <td class="colFirst"><code>long</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getIdleTimeout()">getIdleTimeout</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i19" class="rowColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getMethod()">getMethod</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i20" class="altColor"> |
| <td class="colFirst"><code><a href="../util/Fields.html" title="class in org.eclipse.jetty.util">Fields</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getParams()">getParams</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i21" class="rowColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getPath()">getPath</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i22" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getPort()">getPort</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i23" class="rowColor"> |
| <td class="colFirst"><code>java.util.function.BiFunction<<a href="api/Request.html" title="interface in org.eclipse.jetty.client.api">Request</a>,​<a href="api/Request.html" title="interface in org.eclipse.jetty.client.api">Request</a>,​<a href="api/Response.CompleteListener.html" title="interface in org.eclipse.jetty.client.api">Response.CompleteListener</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getPushListener()">getPushListener</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i24" class="altColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getQuery()">getQuery</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i25" class="rowColor"> |
| <td class="colFirst"><code><T extends <a href="api/Request.RequestListener.html" title="interface in org.eclipse.jetty.client.api">Request.RequestListener</a>><br>java.util.List<T></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getRequestListeners(java.lang.Class)">getRequestListeners</a></span>​(java.lang.Class<T> type)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i26" class="altColor"> |
| <td class="colFirst"><code>protected java.util.List<<a href="api/Response.ResponseListener.html" title="interface in org.eclipse.jetty.client.api">Response.ResponseListener</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getResponseListeners()">getResponseListeners</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i27" class="rowColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getScheme()">getScheme</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i28" class="altColor"> |
| <td class="colFirst"><code>java.lang.Object</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getTag()">getTag</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i29" class="rowColor"> |
| <td class="colFirst"><code>long</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getTimeout()">getTimeout</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i30" class="altColor"> |
| <td class="colFirst"><code>java.util.function.Supplier<<a href="../http/HttpFields.html" title="class in org.eclipse.jetty.http">HttpFields</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getTrailers()">getTrailers</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i31" class="rowColor"> |
| <td class="colFirst"><code>java.net.URI</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getURI()">getURI</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i32" class="altColor"> |
| <td class="colFirst"><code><a href="../http/HttpVersion.html" title="enum in org.eclipse.jetty.http">HttpVersion</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getVersion()">getVersion</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i33" class="rowColor"> |
| <td class="colFirst"><code><a href="api/Request.html" title="interface in org.eclipse.jetty.client.api">Request</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#header(java.lang.String,java.lang.String)">header</a></span>​(java.lang.String name, |
| java.lang.String value)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i34" class="altColor"> |
| <td class="colFirst"><code><a href="api/Request.html" title="interface in org.eclipse.jetty.client.api">Request</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#header(org.eclipse.jetty.http.HttpHeader,java.lang.String)">header</a></span>​(<a href="../http/HttpHeader.html" title="enum in org.eclipse.jetty.http">HttpHeader</a> header, |
| java.lang.String value)</code></th> |
| <td class="colLast"> |
| <div class="block">Adds the given <code>value</code> to the specified <code>header</code>.</div> |
| </td> |
| </tr> |
| <tr id="i35" class="rowColor"> |
| <td class="colFirst"><code><a href="api/Request.html" title="interface in org.eclipse.jetty.client.api">Request</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#host(java.lang.String)">host</a></span>​(java.lang.String host)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i36" class="altColor"> |
| <td class="colFirst"><code><a href="api/Request.html" title="interface in org.eclipse.jetty.client.api">Request</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#idleTimeout(long,java.util.concurrent.TimeUnit)">idleTimeout</a></span>​(long timeout, |
| java.util.concurrent.TimeUnit unit)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i37" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isFollowRedirects()">isFollowRedirects</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i38" class="altColor"> |
| <td class="colFirst"><code><a href="api/Request.html" title="interface in org.eclipse.jetty.client.api">Request</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#listener(org.eclipse.jetty.client.api.Request.Listener)">listener</a></span>​(<a href="api/Request.Listener.html" title="interface in org.eclipse.jetty.client.api">Request.Listener</a> listener)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i39" class="rowColor"> |
| <td class="colFirst"><code><a href="api/Request.html" title="interface in org.eclipse.jetty.client.api">Request</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#method(java.lang.String)">method</a></span>​(java.lang.String method)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i40" class="altColor"> |
| <td class="colFirst"><code><a href="api/Request.html" title="interface in org.eclipse.jetty.client.api">Request</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#method(org.eclipse.jetty.http.HttpMethod)">method</a></span>​(<a href="../http/HttpMethod.html" title="enum in org.eclipse.jetty.http">HttpMethod</a> method)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i41" class="rowColor"> |
| <td class="colFirst"><code><a href="api/Request.html" title="interface in org.eclipse.jetty.client.api">Request</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#onComplete(org.eclipse.jetty.client.api.Response.CompleteListener)">onComplete</a></span>​(<a href="api/Response.CompleteListener.html" title="interface in org.eclipse.jetty.client.api">Response.CompleteListener</a> listener)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i42" class="altColor"> |
| <td class="colFirst"><code><a href="api/Request.html" title="interface in org.eclipse.jetty.client.api">Request</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#onRequestBegin(org.eclipse.jetty.client.api.Request.BeginListener)">onRequestBegin</a></span>​(<a href="api/Request.BeginListener.html" title="interface in org.eclipse.jetty.client.api">Request.BeginListener</a> listener)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i43" class="rowColor"> |
| <td class="colFirst"><code><a href="api/Request.html" title="interface in org.eclipse.jetty.client.api">Request</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#onRequestCommit(org.eclipse.jetty.client.api.Request.CommitListener)">onRequestCommit</a></span>​(<a href="api/Request.CommitListener.html" title="interface in org.eclipse.jetty.client.api">Request.CommitListener</a> listener)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i44" class="altColor"> |
| <td class="colFirst"><code><a href="api/Request.html" title="interface in org.eclipse.jetty.client.api">Request</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#onRequestContent(org.eclipse.jetty.client.api.Request.ContentListener)">onRequestContent</a></span>​(<a href="api/Request.ContentListener.html" title="interface in org.eclipse.jetty.client.api">Request.ContentListener</a> listener)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i45" class="rowColor"> |
| <td class="colFirst"><code><a href="api/Request.html" title="interface in org.eclipse.jetty.client.api">Request</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#onRequestFailure(org.eclipse.jetty.client.api.Request.FailureListener)">onRequestFailure</a></span>​(<a href="api/Request.FailureListener.html" title="interface in org.eclipse.jetty.client.api">Request.FailureListener</a> listener)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i46" class="altColor"> |
| <td class="colFirst"><code><a href="api/Request.html" title="interface in org.eclipse.jetty.client.api">Request</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#onRequestHeaders(org.eclipse.jetty.client.api.Request.HeadersListener)">onRequestHeaders</a></span>​(<a href="api/Request.HeadersListener.html" title="interface in org.eclipse.jetty.client.api">Request.HeadersListener</a> listener)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i47" class="rowColor"> |
| <td class="colFirst"><code><a href="api/Request.html" title="interface in org.eclipse.jetty.client.api">Request</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#onRequestQueued(org.eclipse.jetty.client.api.Request.QueuedListener)">onRequestQueued</a></span>​(<a href="api/Request.QueuedListener.html" title="interface in org.eclipse.jetty.client.api">Request.QueuedListener</a> listener)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i48" class="altColor"> |
| <td class="colFirst"><code><a href="api/Request.html" title="interface in org.eclipse.jetty.client.api">Request</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#onRequestSuccess(org.eclipse.jetty.client.api.Request.SuccessListener)">onRequestSuccess</a></span>​(<a href="api/Request.SuccessListener.html" title="interface in org.eclipse.jetty.client.api">Request.SuccessListener</a> listener)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i49" class="rowColor"> |
| <td class="colFirst"><code><a href="api/Request.html" title="interface in org.eclipse.jetty.client.api">Request</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#onResponseBegin(org.eclipse.jetty.client.api.Response.BeginListener)">onResponseBegin</a></span>​(<a href="api/Response.BeginListener.html" title="interface in org.eclipse.jetty.client.api">Response.BeginListener</a> listener)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i50" class="altColor"> |
| <td class="colFirst"><code><a href="api/Request.html" title="interface in org.eclipse.jetty.client.api">Request</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#onResponseContent(org.eclipse.jetty.client.api.Response.ContentListener)">onResponseContent</a></span>​(<a href="api/Response.ContentListener.html" title="interface in org.eclipse.jetty.client.api">Response.ContentListener</a> listener)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i51" class="rowColor"> |
| <td class="colFirst"><code><a href="api/Request.html" title="interface in org.eclipse.jetty.client.api">Request</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#onResponseContentAsync(org.eclipse.jetty.client.api.Response.AsyncContentListener)">onResponseContentAsync</a></span>​(<a href="api/Response.AsyncContentListener.html" title="interface in org.eclipse.jetty.client.api">Response.AsyncContentListener</a> listener)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i52" class="altColor"> |
| <td class="colFirst"><code><a href="api/Request.html" title="interface in org.eclipse.jetty.client.api">Request</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#onResponseContentDemanded(org.eclipse.jetty.client.api.Response.DemandedContentListener)">onResponseContentDemanded</a></span>​(<a href="api/Response.DemandedContentListener.html" title="interface in org.eclipse.jetty.client.api">Response.DemandedContentListener</a> listener)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i53" class="rowColor"> |
| <td class="colFirst"><code><a href="api/Request.html" title="interface in org.eclipse.jetty.client.api">Request</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#onResponseFailure(org.eclipse.jetty.client.api.Response.FailureListener)">onResponseFailure</a></span>​(<a href="api/Response.FailureListener.html" title="interface in org.eclipse.jetty.client.api">Response.FailureListener</a> listener)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i54" class="altColor"> |
| <td class="colFirst"><code><a href="api/Request.html" title="interface in org.eclipse.jetty.client.api">Request</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#onResponseHeader(org.eclipse.jetty.client.api.Response.HeaderListener)">onResponseHeader</a></span>​(<a href="api/Response.HeaderListener.html" title="interface in org.eclipse.jetty.client.api">Response.HeaderListener</a> listener)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i55" class="rowColor"> |
| <td class="colFirst"><code><a href="api/Request.html" title="interface in org.eclipse.jetty.client.api">Request</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#onResponseHeaders(org.eclipse.jetty.client.api.Response.HeadersListener)">onResponseHeaders</a></span>​(<a href="api/Response.HeadersListener.html" title="interface in org.eclipse.jetty.client.api">Response.HeadersListener</a> listener)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i56" class="altColor"> |
| <td class="colFirst"><code><a href="api/Request.html" title="interface in org.eclipse.jetty.client.api">Request</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#onResponseSuccess(org.eclipse.jetty.client.api.Response.SuccessListener)">onResponseSuccess</a></span>​(<a href="api/Response.SuccessListener.html" title="interface in org.eclipse.jetty.client.api">Response.SuccessListener</a> listener)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i57" class="rowColor"> |
| <td class="colFirst"><code><a href="api/Request.html" title="interface in org.eclipse.jetty.client.api">Request</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#param(java.lang.String,java.lang.String)">param</a></span>​(java.lang.String name, |
| java.lang.String value)</code></th> |
| <td class="colLast"> |
| <div class="block">Adds a URI query parameter with the given name and value.</div> |
| </td> |
| </tr> |
| <tr id="i58" class="altColor"> |
| <td class="colFirst"><code><a href="api/Request.html" title="interface in org.eclipse.jetty.client.api">Request</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#path(java.lang.String)">path</a></span>​(java.lang.String path)</code></th> |
| <td class="colLast"> |
| <div class="block">Specifies the URI path - and possibly the query - of this request.</div> |
| </td> |
| </tr> |
| <tr id="i59" class="rowColor"> |
| <td class="colFirst"><code><a href="api/Request.html" title="interface in org.eclipse.jetty.client.api">Request</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#port(int)">port</a></span>​(int port)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i60" class="altColor"> |
| <td class="colFirst"><code><a href="api/Request.html" title="interface in org.eclipse.jetty.client.api">Request</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#pushListener(java.util.function.BiFunction)">pushListener</a></span>​(java.util.function.BiFunction<<a href="api/Request.html" title="interface in org.eclipse.jetty.client.api">Request</a>,​<a href="api/Request.html" title="interface in org.eclipse.jetty.client.api">Request</a>,​<a href="api/Response.CompleteListener.html" title="interface in org.eclipse.jetty.client.api">Response.CompleteListener</a>> listener)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets a listener for pushed resources.</div> |
| </td> |
| </tr> |
| <tr id="i61" class="rowColor"> |
| <td class="colFirst"><code><a href="api/Request.html" title="interface in org.eclipse.jetty.client.api">Request</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#scheme(java.lang.String)">scheme</a></span>​(java.lang.String scheme)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i62" class="altColor"> |
| <td class="colFirst"><code><a href="api/ContentResponse.html" title="interface in org.eclipse.jetty.client.api">ContentResponse</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#send()">send</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Sends this request and returns the response.</div> |
| </td> |
| </tr> |
| <tr id="i63" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#send(org.eclipse.jetty.client.api.Response.CompleteListener)">send</a></span>​(<a href="api/Response.CompleteListener.html" title="interface in org.eclipse.jetty.client.api">Response.CompleteListener</a> listener)</code></th> |
| <td class="colLast"> |
| <div class="block">Sends this request and asynchronously notifies the given listener for response events.</div> |
| </td> |
| </tr> |
| <tr id="i64" class="altColor"> |
| <td class="colFirst"><code><a href="api/Request.html" title="interface in org.eclipse.jetty.client.api">Request</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#tag(java.lang.Object)">tag</a></span>​(java.lang.Object tag)</code></th> |
| <td class="colLast"> |
| <div class="block">Tags this request with the given metadata tag.</div> |
| </td> |
| </tr> |
| <tr id="i65" class="rowColor"> |
| <td class="colFirst"><code><a href="api/Request.html" title="interface in org.eclipse.jetty.client.api">Request</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#timeout(long,java.util.concurrent.TimeUnit)">timeout</a></span>​(long timeout, |
| java.util.concurrent.TimeUnit unit)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i66" class="altColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#toString()">toString</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i67" class="rowColor"> |
| <td class="colFirst"><code><a href="HttpRequest.html" title="class in org.eclipse.jetty.client">HttpRequest</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#trailers(java.util.function.Supplier)">trailers</a></span>​(java.util.function.Supplier<<a href="../http/HttpFields.html" title="class in org.eclipse.jetty.http">HttpFields</a>> trailers)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i68" class="altColor"> |
| <td class="colFirst"><code><a href="api/Request.html" title="interface in org.eclipse.jetty.client.api">Request</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#version(org.eclipse.jetty.http.HttpVersion)">version</a></span>​(<a href="../http/HttpVersion.html" title="enum in org.eclipse.jetty.http">HttpVersion</a> version)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a id="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, wait, wait, wait</code></li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a id="<init>(org.eclipse.jetty.client.HttpClient,org.eclipse.jetty.client.HttpConversation,java.net.URI)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>HttpRequest</h4> |
| <pre>protected HttpRequest​(<a href="HttpClient.html" title="class in org.eclipse.jetty.client">HttpClient</a> client, |
| <a href="HttpConversation.html" title="class in org.eclipse.jetty.client">HttpConversation</a> conversation, |
| java.net.URI uri)</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| <!-- ============ METHOD DETAIL ========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a id="getConversation()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getConversation</h4> |
| <pre class="methodSignature">public <a href="HttpConversation.html" title="class in org.eclipse.jetty.client">HttpConversation</a> getConversation()</pre> |
| </li> |
| </ul> |
| <a id="getScheme()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getScheme</h4> |
| <pre class="methodSignature">public java.lang.String getScheme()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="api/Request.html#getScheme()">getScheme</a></code> in interface <code><a href="api/Request.html" title="interface in org.eclipse.jetty.client.api">Request</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the URI scheme of this request, such as "http" or "https"</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="scheme(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>scheme</h4> |
| <pre class="methodSignature">public <a href="api/Request.html" title="interface in org.eclipse.jetty.client.api">Request</a> scheme​(java.lang.String scheme)</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="api/Request.html#scheme(java.lang.String)">scheme</a></code> in interface <code><a href="api/Request.html" title="interface in org.eclipse.jetty.client.api">Request</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>scheme</code> - the URI scheme of this request, such as "http" or "https"</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this request object</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getHost()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getHost</h4> |
| <pre class="methodSignature">public java.lang.String getHost()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="api/Request.html#getHost()">getHost</a></code> in interface <code><a href="api/Request.html" title="interface in org.eclipse.jetty.client.api">Request</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the URI host of this request, such as "127.0.0.1" or "google.com"</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="host(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>host</h4> |
| <pre class="methodSignature">public <a href="api/Request.html" title="interface in org.eclipse.jetty.client.api">Request</a> host​(java.lang.String host)</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="api/Request.html#host(java.lang.String)">host</a></code> in interface <code><a href="api/Request.html" title="interface in org.eclipse.jetty.client.api">Request</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>host</code> - the URI host of this request, such as "127.0.0.1" or "google.com"</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this request object</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getPort()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPort</h4> |
| <pre class="methodSignature">public int getPort()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="api/Request.html#getPort()">getPort</a></code> in interface <code><a href="api/Request.html" title="interface in org.eclipse.jetty.client.api">Request</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the URI port of this request such as 80 or 443</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="port(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>port</h4> |
| <pre class="methodSignature">public <a href="api/Request.html" title="interface in org.eclipse.jetty.client.api">Request</a> port​(int port)</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="api/Request.html#port(int)">port</a></code> in interface <code><a href="api/Request.html" title="interface in org.eclipse.jetty.client.api">Request</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>port</code> - the URI port of this request such as 80 or 443</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this request object</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getMethod()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMethod</h4> |
| <pre class="methodSignature">public java.lang.String getMethod()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="api/Request.html#getMethod()">getMethod</a></code> in interface <code><a href="api/Request.html" title="interface in org.eclipse.jetty.client.api">Request</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the method of this request, such as GET or POST, as a String</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="method(org.eclipse.jetty.http.HttpMethod)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>method</h4> |
| <pre class="methodSignature">public <a href="api/Request.html" title="interface in org.eclipse.jetty.client.api">Request</a> method​(<a href="../http/HttpMethod.html" title="enum in org.eclipse.jetty.http">HttpMethod</a> method)</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="api/Request.html#method(org.eclipse.jetty.http.HttpMethod)">method</a></code> in interface <code><a href="api/Request.html" title="interface in org.eclipse.jetty.client.api">Request</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>method</code> - the method of this request, such as GET or POST</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this request object</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="method(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>method</h4> |
| <pre class="methodSignature">public <a href="api/Request.html" title="interface in org.eclipse.jetty.client.api">Request</a> method​(java.lang.String method)</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="api/Request.html#method(java.lang.String)">method</a></code> in interface <code><a href="api/Request.html" title="interface in org.eclipse.jetty.client.api">Request</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>method</code> - the method of this request, such as GET or POST</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this request object</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getPath()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPath</h4> |
| <pre class="methodSignature">public java.lang.String getPath()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="api/Request.html#getPath()">getPath</a></code> in interface <code><a href="api/Request.html" title="interface in org.eclipse.jetty.client.api">Request</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the URI path of this request, such as "/" or "/path" - without the query</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="api/Request.html#getQuery()"><code>Request.getQuery()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="path(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>path</h4> |
| <pre class="methodSignature">public <a href="api/Request.html" title="interface in org.eclipse.jetty.client.api">Request</a> path​(java.lang.String path)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="api/Request.html#path(java.lang.String)">Request</a></code></span></div> |
| <div class="block">Specifies the URI path - and possibly the query - of this request. |
| If the query part is specified, parameter values must be properly |
| <code>UTF-8 URL encoded</code>. |
| For example, if the value for parameter "currency" is the euro symbol € then the |
| query string for this parameter must be "currency=%E2%82%AC". |
| For transparent encoding of parameter values, use <a href="api/Request.html#param(java.lang.String,java.lang.String)"><code>Request.param(String, String)</code></a>.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="api/Request.html#path(java.lang.String)">path</a></code> in interface <code><a href="api/Request.html" title="interface in org.eclipse.jetty.client.api">Request</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>path</code> - the URI path of this request, such as "/" or "/path?param=1"</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this request object</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getQuery()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getQuery</h4> |
| <pre class="methodSignature">public java.lang.String getQuery()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="api/Request.html#getQuery()">getQuery</a></code> in interface <code><a href="api/Request.html" title="interface in org.eclipse.jetty.client.api">Request</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the URI query string of this request such as "param=1"</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="api/Request.html#getPath()"><code>Request.getPath()</code></a>, |
| <a href="api/Request.html#getParams()"><code>Request.getParams()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getURI()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getURI</h4> |
| <pre class="methodSignature">public java.net.URI getURI()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="api/Request.html#getURI()">getURI</a></code> in interface <code><a href="api/Request.html" title="interface in org.eclipse.jetty.client.api">Request</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the full URI of this request such as "http://host:port/path?param=1"</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getVersion()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getVersion</h4> |
| <pre class="methodSignature">public <a href="../http/HttpVersion.html" title="enum in org.eclipse.jetty.http">HttpVersion</a> getVersion()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="api/Request.html#getVersion()">getVersion</a></code> in interface <code><a href="api/Request.html" title="interface in org.eclipse.jetty.client.api">Request</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the HTTP version of this request, such as "HTTP/1.1"</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="version(org.eclipse.jetty.http.HttpVersion)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>version</h4> |
| <pre class="methodSignature">public <a href="api/Request.html" title="interface in org.eclipse.jetty.client.api">Request</a> version​(<a href="../http/HttpVersion.html" title="enum in org.eclipse.jetty.http">HttpVersion</a> version)</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="api/Request.html#version(org.eclipse.jetty.http.HttpVersion)">version</a></code> in interface <code><a href="api/Request.html" title="interface in org.eclipse.jetty.client.api">Request</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>version</code> - the HTTP version of this request, such as "HTTP/1.1"</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this request object</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="param(java.lang.String,java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>param</h4> |
| <pre class="methodSignature">public <a href="api/Request.html" title="interface in org.eclipse.jetty.client.api">Request</a> param​(java.lang.String name, |
| java.lang.String value)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="api/Request.html#param(java.lang.String,java.lang.String)">Request</a></code></span></div> |
| <div class="block">Adds a URI query parameter with the given name and value. |
| The value is <code>UTF-8 URL encoded</code>.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="api/Request.html#param(java.lang.String,java.lang.String)">param</a></code> in interface <code><a href="api/Request.html" title="interface in org.eclipse.jetty.client.api">Request</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - the name of the query parameter</dd> |
| <dd><code>value</code> - the value of the query parameter</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this request object</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getParams()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getParams</h4> |
| <pre class="methodSignature">public <a href="../util/Fields.html" title="class in org.eclipse.jetty.util">Fields</a> getParams()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="api/Request.html#getParams()">getParams</a></code> in interface <code><a href="api/Request.html" title="interface in org.eclipse.jetty.client.api">Request</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the URI query parameters of this request</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getAgent()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAgent</h4> |
| <pre class="methodSignature">public java.lang.String getAgent()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="api/Request.html#getAgent()">getAgent</a></code> in interface <code><a href="api/Request.html" title="interface in org.eclipse.jetty.client.api">Request</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the user agent for this request</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="agent(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>agent</h4> |
| <pre class="methodSignature">public <a href="api/Request.html" title="interface in org.eclipse.jetty.client.api">Request</a> agent​(java.lang.String agent)</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="api/Request.html#agent(java.lang.String)">agent</a></code> in interface <code><a href="api/Request.html" title="interface in org.eclipse.jetty.client.api">Request</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>agent</code> - the user agent for this request (corresponds to the <code>User-Agent</code> header)</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this request object</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="accept(java.lang.String...)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>accept</h4> |
| <pre class="methodSignature">public <a href="api/Request.html" title="interface in org.eclipse.jetty.client.api">Request</a> accept​(java.lang.String... accepts)</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="api/Request.html#accept(java.lang.String...)">accept</a></code> in interface <code><a href="api/Request.html" title="interface in org.eclipse.jetty.client.api">Request</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>accepts</code> - the media types that are acceptable in the response, such as |
| "text/plain;q=0.5" or "text/html" (corresponds to the <code>Accept</code> header)</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this request object</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="header(java.lang.String,java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>header</h4> |
| <pre class="methodSignature">public <a href="api/Request.html" title="interface in org.eclipse.jetty.client.api">Request</a> header​(java.lang.String name, |
| java.lang.String value)</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="api/Request.html#header(java.lang.String,java.lang.String)">header</a></code> in interface <code><a href="api/Request.html" title="interface in org.eclipse.jetty.client.api">Request</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - the name of the header</dd> |
| <dd><code>value</code> - the value of the header</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this request object</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="api/Request.html#header(org.eclipse.jetty.http.HttpHeader,java.lang.String)"><code>Request.header(HttpHeader, String)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="header(org.eclipse.jetty.http.HttpHeader,java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>header</h4> |
| <pre class="methodSignature">public <a href="api/Request.html" title="interface in org.eclipse.jetty.client.api">Request</a> header​(<a href="../http/HttpHeader.html" title="enum in org.eclipse.jetty.http">HttpHeader</a> header, |
| java.lang.String value)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="api/Request.html#header(org.eclipse.jetty.http.HttpHeader,java.lang.String)">Request</a></code></span></div> |
| <div class="block"><p>Adds the given <code>value</code> to the specified <code>header</code>.</p> |
| <p>Multiple calls with the same parameters will add multiple values; |
| use the value <code>null</code> to remove the header completely.</p></div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="api/Request.html#header(org.eclipse.jetty.http.HttpHeader,java.lang.String)">header</a></code> in interface <code><a href="api/Request.html" title="interface in org.eclipse.jetty.client.api">Request</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>header</code> - the header name</dd> |
| <dd><code>value</code> - the value of the header</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this request object</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getCookies()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCookies</h4> |
| <pre class="methodSignature">public java.util.List<java.net.HttpCookie> getCookies()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="api/Request.html#getCookies()">getCookies</a></code> in interface <code><a href="api/Request.html" title="interface in org.eclipse.jetty.client.api">Request</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the cookies associated with this request</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="cookie(java.net.HttpCookie)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>cookie</h4> |
| <pre class="methodSignature">public <a href="api/Request.html" title="interface in org.eclipse.jetty.client.api">Request</a> cookie​(java.net.HttpCookie cookie)</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="api/Request.html#cookie(java.net.HttpCookie)">cookie</a></code> in interface <code><a href="api/Request.html" title="interface in org.eclipse.jetty.client.api">Request</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>cookie</code> - a cookie for this request</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this request object</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="tag(java.lang.Object)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>tag</h4> |
| <pre class="methodSignature">public <a href="api/Request.html" title="interface in org.eclipse.jetty.client.api">Request</a> tag​(java.lang.Object tag)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="api/Request.html#tag(java.lang.Object)">Request</a></code></span></div> |
| <div class="block"><p>Tags this request with the given metadata tag.</p> |
| <p>Each different tag will create a different destination, |
| even if the destination origin is the same.</p> |
| <p>This is particularly useful in proxies, where requests |
| for the same origin but from different clients may be tagged |
| with client's metadata (e.g. the client remote address).</p> |
| <p>The tag metadata class must correctly implement |
| <code>Object.hashCode()</code> and <code>Object.equals(Object)</code> |
| so that it can be used, along with the origin, to identify |
| a destination.</p></div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="api/Request.html#tag(java.lang.Object)">tag</a></code> in interface <code><a href="api/Request.html" title="interface in org.eclipse.jetty.client.api">Request</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>tag</code> - the metadata to tag the request with</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this request object</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getTag()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getTag</h4> |
| <pre class="methodSignature">public java.lang.Object getTag()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="api/Request.html#getTag()">getTag</a></code> in interface <code><a href="api/Request.html" title="interface in org.eclipse.jetty.client.api">Request</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the metadata this request has been tagged with</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="attribute(java.lang.String,java.lang.Object)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>attribute</h4> |
| <pre class="methodSignature">public <a href="api/Request.html" title="interface in org.eclipse.jetty.client.api">Request</a> attribute​(java.lang.String name, |
| java.lang.Object value)</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="api/Request.html#attribute(java.lang.String,java.lang.Object)">attribute</a></code> in interface <code><a href="api/Request.html" title="interface in org.eclipse.jetty.client.api">Request</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - the name of the attribute</dd> |
| <dd><code>value</code> - the value of the attribute</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this request object</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getAttributes()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAttributes</h4> |
| <pre class="methodSignature">public java.util.Map<java.lang.String,​java.lang.Object> getAttributes()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="api/Request.html#getAttributes()">getAttributes</a></code> in interface <code><a href="api/Request.html" title="interface in org.eclipse.jetty.client.api">Request</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the attributes of this request</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getHeaders()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getHeaders</h4> |
| <pre class="methodSignature">public <a href="../http/HttpFields.html" title="class in org.eclipse.jetty.http">HttpFields</a> getHeaders()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="api/Request.html#getHeaders()">getHeaders</a></code> in interface <code><a href="api/Request.html" title="interface in org.eclipse.jetty.client.api">Request</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the headers of this request</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getRequestListeners(java.lang.Class)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getRequestListeners</h4> |
| <pre class="methodSignature">public <T extends <a href="api/Request.RequestListener.html" title="interface in org.eclipse.jetty.client.api">Request.RequestListener</a>> java.util.List<T> getRequestListeners​(java.lang.Class<T> type)</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="api/Request.html#getRequestListeners(java.lang.Class)">getRequestListeners</a></code> in interface <code><a href="api/Request.html" title="interface in org.eclipse.jetty.client.api">Request</a></code></dd> |
| <dt><span class="paramLabel">Type Parameters:</span></dt> |
| <dd><code>T</code> - the type of listener class</dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>type</code> - the class of the listener, or null for all listeners classes</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the listeners for request events of the given class</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="listener(org.eclipse.jetty.client.api.Request.Listener)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>listener</h4> |
| <pre class="methodSignature">public <a href="api/Request.html" title="interface in org.eclipse.jetty.client.api">Request</a> listener​(<a href="api/Request.Listener.html" title="interface in org.eclipse.jetty.client.api">Request.Listener</a> listener)</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="api/Request.html#listener(org.eclipse.jetty.client.api.Request.Listener)">listener</a></code> in interface <code><a href="api/Request.html" title="interface in org.eclipse.jetty.client.api">Request</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>listener</code> - a listener for request events</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this request object</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="onRequestQueued(org.eclipse.jetty.client.api.Request.QueuedListener)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>onRequestQueued</h4> |
| <pre class="methodSignature">public <a href="api/Request.html" title="interface in org.eclipse.jetty.client.api">Request</a> onRequestQueued​(<a href="api/Request.QueuedListener.html" title="interface in org.eclipse.jetty.client.api">Request.QueuedListener</a> listener)</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="api/Request.html#onRequestQueued(org.eclipse.jetty.client.api.Request.QueuedListener)">onRequestQueued</a></code> in interface <code><a href="api/Request.html" title="interface in org.eclipse.jetty.client.api">Request</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>listener</code> - a listener for request queued event</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this request object</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="onRequestBegin(org.eclipse.jetty.client.api.Request.BeginListener)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>onRequestBegin</h4> |
| <pre class="methodSignature">public <a href="api/Request.html" title="interface in org.eclipse.jetty.client.api">Request</a> onRequestBegin​(<a href="api/Request.BeginListener.html" title="interface in org.eclipse.jetty.client.api">Request.BeginListener</a> listener)</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="api/Request.html#onRequestBegin(org.eclipse.jetty.client.api.Request.BeginListener)">onRequestBegin</a></code> in interface <code><a href="api/Request.html" title="interface in org.eclipse.jetty.client.api">Request</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>listener</code> - a listener for request begin event</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this request object</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="onRequestHeaders(org.eclipse.jetty.client.api.Request.HeadersListener)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>onRequestHeaders</h4> |
| <pre class="methodSignature">public <a href="api/Request.html" title="interface in org.eclipse.jetty.client.api">Request</a> onRequestHeaders​(<a href="api/Request.HeadersListener.html" title="interface in org.eclipse.jetty.client.api">Request.HeadersListener</a> listener)</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="api/Request.html#onRequestHeaders(org.eclipse.jetty.client.api.Request.HeadersListener)">onRequestHeaders</a></code> in interface <code><a href="api/Request.html" title="interface in org.eclipse.jetty.client.api">Request</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>listener</code> - a listener for request headers event</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this request object</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="onRequestCommit(org.eclipse.jetty.client.api.Request.CommitListener)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>onRequestCommit</h4> |
| <pre class="methodSignature">public <a href="api/Request.html" title="interface in org.eclipse.jetty.client.api">Request</a> onRequestCommit​(<a href="api/Request.CommitListener.html" title="interface in org.eclipse.jetty.client.api">Request.CommitListener</a> listener)</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="api/Request.html#onRequestCommit(org.eclipse.jetty.client.api.Request.CommitListener)">onRequestCommit</a></code> in interface <code><a href="api/Request.html" title="interface in org.eclipse.jetty.client.api">Request</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>listener</code> - a listener for request commit event</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this request object</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="onRequestContent(org.eclipse.jetty.client.api.Request.ContentListener)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>onRequestContent</h4> |
| <pre class="methodSignature">public <a href="api/Request.html" title="interface in org.eclipse.jetty.client.api">Request</a> onRequestContent​(<a href="api/Request.ContentListener.html" title="interface in org.eclipse.jetty.client.api">Request.ContentListener</a> listener)</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="api/Request.html#onRequestContent(org.eclipse.jetty.client.api.Request.ContentListener)">onRequestContent</a></code> in interface <code><a href="api/Request.html" title="interface in org.eclipse.jetty.client.api">Request</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>listener</code> - a listener for request content events</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this request object</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="onRequestSuccess(org.eclipse.jetty.client.api.Request.SuccessListener)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>onRequestSuccess</h4> |
| <pre class="methodSignature">public <a href="api/Request.html" title="interface in org.eclipse.jetty.client.api">Request</a> onRequestSuccess​(<a href="api/Request.SuccessListener.html" title="interface in org.eclipse.jetty.client.api">Request.SuccessListener</a> listener)</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="api/Request.html#onRequestSuccess(org.eclipse.jetty.client.api.Request.SuccessListener)">onRequestSuccess</a></code> in interface <code><a href="api/Request.html" title="interface in org.eclipse.jetty.client.api">Request</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>listener</code> - a listener for request success event</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this request object</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="onRequestFailure(org.eclipse.jetty.client.api.Request.FailureListener)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>onRequestFailure</h4> |
| <pre class="methodSignature">public <a href="api/Request.html" title="interface in org.eclipse.jetty.client.api">Request</a> onRequestFailure​(<a href="api/Request.FailureListener.html" title="interface in org.eclipse.jetty.client.api">Request.FailureListener</a> listener)</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="api/Request.html#onRequestFailure(org.eclipse.jetty.client.api.Request.FailureListener)">onRequestFailure</a></code> in interface <code><a href="api/Request.html" title="interface in org.eclipse.jetty.client.api">Request</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>listener</code> - a listener for request failure event</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this request object</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="onResponseBegin(org.eclipse.jetty.client.api.Response.BeginListener)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>onResponseBegin</h4> |
| <pre class="methodSignature">public <a href="api/Request.html" title="interface in org.eclipse.jetty.client.api">Request</a> onResponseBegin​(<a href="api/Response.BeginListener.html" title="interface in org.eclipse.jetty.client.api">Response.BeginListener</a> listener)</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="api/Request.html#onResponseBegin(org.eclipse.jetty.client.api.Response.BeginListener)">onResponseBegin</a></code> in interface <code><a href="api/Request.html" title="interface in org.eclipse.jetty.client.api">Request</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>listener</code> - a listener for response begin event</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this request object</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="onResponseHeader(org.eclipse.jetty.client.api.Response.HeaderListener)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>onResponseHeader</h4> |
| <pre class="methodSignature">public <a href="api/Request.html" title="interface in org.eclipse.jetty.client.api">Request</a> onResponseHeader​(<a href="api/Response.HeaderListener.html" title="interface in org.eclipse.jetty.client.api">Response.HeaderListener</a> listener)</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="api/Request.html#onResponseHeader(org.eclipse.jetty.client.api.Response.HeaderListener)">onResponseHeader</a></code> in interface <code><a href="api/Request.html" title="interface in org.eclipse.jetty.client.api">Request</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>listener</code> - a listener for response header event</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this request object</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="onResponseHeaders(org.eclipse.jetty.client.api.Response.HeadersListener)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>onResponseHeaders</h4> |
| <pre class="methodSignature">public <a href="api/Request.html" title="interface in org.eclipse.jetty.client.api">Request</a> onResponseHeaders​(<a href="api/Response.HeadersListener.html" title="interface in org.eclipse.jetty.client.api">Response.HeadersListener</a> listener)</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="api/Request.html#onResponseHeaders(org.eclipse.jetty.client.api.Response.HeadersListener)">onResponseHeaders</a></code> in interface <code><a href="api/Request.html" title="interface in org.eclipse.jetty.client.api">Request</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>listener</code> - a listener for response headers event</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this request object</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="onResponseContent(org.eclipse.jetty.client.api.Response.ContentListener)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>onResponseContent</h4> |
| <pre class="methodSignature">public <a href="api/Request.html" title="interface in org.eclipse.jetty.client.api">Request</a> onResponseContent​(<a href="api/Response.ContentListener.html" title="interface in org.eclipse.jetty.client.api">Response.ContentListener</a> listener)</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="api/Request.html#onResponseContent(org.eclipse.jetty.client.api.Response.ContentListener)">onResponseContent</a></code> in interface <code><a href="api/Request.html" title="interface in org.eclipse.jetty.client.api">Request</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>listener</code> - a consuming listener for response content events</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this request object</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="onResponseContentAsync(org.eclipse.jetty.client.api.Response.AsyncContentListener)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>onResponseContentAsync</h4> |
| <pre class="methodSignature">public <a href="api/Request.html" title="interface in org.eclipse.jetty.client.api">Request</a> onResponseContentAsync​(<a href="api/Response.AsyncContentListener.html" title="interface in org.eclipse.jetty.client.api">Response.AsyncContentListener</a> listener)</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="api/Request.html#onResponseContentAsync(org.eclipse.jetty.client.api.Response.AsyncContentListener)">onResponseContentAsync</a></code> in interface <code><a href="api/Request.html" title="interface in org.eclipse.jetty.client.api">Request</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>listener</code> - an asynchronous listener for response content events</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this request object</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="onResponseContentDemanded(org.eclipse.jetty.client.api.Response.DemandedContentListener)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>onResponseContentDemanded</h4> |
| <pre class="methodSignature">public <a href="api/Request.html" title="interface in org.eclipse.jetty.client.api">Request</a> onResponseContentDemanded​(<a href="api/Response.DemandedContentListener.html" title="interface in org.eclipse.jetty.client.api">Response.DemandedContentListener</a> listener)</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="api/Request.html#onResponseContentDemanded(org.eclipse.jetty.client.api.Response.DemandedContentListener)">onResponseContentDemanded</a></code> in interface <code><a href="api/Request.html" title="interface in org.eclipse.jetty.client.api">Request</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>listener</code> - an asynchronous listener for response content events</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this request object</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="onResponseSuccess(org.eclipse.jetty.client.api.Response.SuccessListener)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>onResponseSuccess</h4> |
| <pre class="methodSignature">public <a href="api/Request.html" title="interface in org.eclipse.jetty.client.api">Request</a> onResponseSuccess​(<a href="api/Response.SuccessListener.html" title="interface in org.eclipse.jetty.client.api">Response.SuccessListener</a> listener)</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="api/Request.html#onResponseSuccess(org.eclipse.jetty.client.api.Response.SuccessListener)">onResponseSuccess</a></code> in interface <code><a href="api/Request.html" title="interface in org.eclipse.jetty.client.api">Request</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>listener</code> - a listener for response success event</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this request object</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="onResponseFailure(org.eclipse.jetty.client.api.Response.FailureListener)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>onResponseFailure</h4> |
| <pre class="methodSignature">public <a href="api/Request.html" title="interface in org.eclipse.jetty.client.api">Request</a> onResponseFailure​(<a href="api/Response.FailureListener.html" title="interface in org.eclipse.jetty.client.api">Response.FailureListener</a> listener)</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="api/Request.html#onResponseFailure(org.eclipse.jetty.client.api.Response.FailureListener)">onResponseFailure</a></code> in interface <code><a href="api/Request.html" title="interface in org.eclipse.jetty.client.api">Request</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>listener</code> - a listener for response failure event</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this request object</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="onComplete(org.eclipse.jetty.client.api.Response.CompleteListener)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>onComplete</h4> |
| <pre class="methodSignature">public <a href="api/Request.html" title="interface in org.eclipse.jetty.client.api">Request</a> onComplete​(<a href="api/Response.CompleteListener.html" title="interface in org.eclipse.jetty.client.api">Response.CompleteListener</a> listener)</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="api/Request.html#onComplete(org.eclipse.jetty.client.api.Response.CompleteListener)">onComplete</a></code> in interface <code><a href="api/Request.html" title="interface in org.eclipse.jetty.client.api">Request</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>listener</code> - a listener for complete event</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this request object</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="pushListener(java.util.function.BiFunction)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>pushListener</h4> |
| <pre class="methodSignature">public <a href="api/Request.html" title="interface in org.eclipse.jetty.client.api">Request</a> pushListener​(java.util.function.BiFunction<<a href="api/Request.html" title="interface in org.eclipse.jetty.client.api">Request</a>,​<a href="api/Request.html" title="interface in org.eclipse.jetty.client.api">Request</a>,​<a href="api/Response.CompleteListener.html" title="interface in org.eclipse.jetty.client.api">Response.CompleteListener</a>> listener)</pre> |
| <div class="block"><p>Sets a listener for pushed resources.</p> |
| <p>When resources are pushed from the server, the given <code>listener</code> |
| is invoked for every pushed resource. |
| The parameters to the <code>BiFunction</code> are this request and the |
| synthesized request for the pushed resource. |
| The <code>BiFunction</code> should return a <code>CompleteListener</code> that |
| may also implement other listener interfaces to be notified of various |
| response events, or <code>null</code> to signal that the pushed resource |
| should be canceled.</p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>listener</code> - a listener for pushed resource events</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this request object</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="trailers(java.util.function.Supplier)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>trailers</h4> |
| <pre class="methodSignature">public <a href="HttpRequest.html" title="class in org.eclipse.jetty.client">HttpRequest</a> trailers​(java.util.function.Supplier<<a href="../http/HttpFields.html" title="class in org.eclipse.jetty.http">HttpFields</a>> trailers)</pre> |
| </li> |
| </ul> |
| <a id="getContent()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getContent</h4> |
| <pre class="methodSignature">public <a href="api/ContentProvider.html" title="interface in org.eclipse.jetty.client.api">ContentProvider</a> getContent()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="api/Request.html#getContent()">getContent</a></code> in interface <code><a href="api/Request.html" title="interface in org.eclipse.jetty.client.api">Request</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the content provider of this request</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="content(org.eclipse.jetty.client.api.ContentProvider)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>content</h4> |
| <pre class="methodSignature">public <a href="api/Request.html" title="interface in org.eclipse.jetty.client.api">Request</a> content​(<a href="api/ContentProvider.html" title="interface in org.eclipse.jetty.client.api">ContentProvider</a> content)</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="api/Request.html#content(org.eclipse.jetty.client.api.ContentProvider)">content</a></code> in interface <code><a href="api/Request.html" title="interface in org.eclipse.jetty.client.api">Request</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>content</code> - the content provider of this request</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this request object</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="content(org.eclipse.jetty.client.api.ContentProvider,java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>content</h4> |
| <pre class="methodSignature">public <a href="api/Request.html" title="interface in org.eclipse.jetty.client.api">Request</a> content​(<a href="api/ContentProvider.html" title="interface in org.eclipse.jetty.client.api">ContentProvider</a> content, |
| java.lang.String contentType)</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="api/Request.html#content(org.eclipse.jetty.client.api.ContentProvider,java.lang.String)">content</a></code> in interface <code><a href="api/Request.html" title="interface in org.eclipse.jetty.client.api">Request</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>content</code> - the content provider of this request</dd> |
| <dd><code>contentType</code> - the content type</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this request object</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="file(java.nio.file.Path)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>file</h4> |
| <pre class="methodSignature">public <a href="api/Request.html" title="interface in org.eclipse.jetty.client.api">Request</a> file​(java.nio.file.Path file) |
| throws java.io.IOException</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="api/Request.html#file(java.nio.file.Path)">Request</a></code></span></div> |
| <div class="block">Shortcut method to specify a file as a content for this request, with the default content type of |
| "application/octect-stream".</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="api/Request.html#file(java.nio.file.Path)">file</a></code> in interface <code><a href="api/Request.html" title="interface in org.eclipse.jetty.client.api">Request</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>file</code> - the file to upload</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this request object</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.io.IOException</code> - if the file does not exist or cannot be read</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="file(java.nio.file.Path,java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>file</h4> |
| <pre class="methodSignature">public <a href="api/Request.html" title="interface in org.eclipse.jetty.client.api">Request</a> file​(java.nio.file.Path file, |
| java.lang.String contentType) |
| throws java.io.IOException</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="api/Request.html#file(java.nio.file.Path,java.lang.String)">Request</a></code></span></div> |
| <div class="block">Shortcut method to specify a file as a content for this request, with the given content type.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="api/Request.html#file(java.nio.file.Path,java.lang.String)">file</a></code> in interface <code><a href="api/Request.html" title="interface in org.eclipse.jetty.client.api">Request</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>file</code> - the file to upload</dd> |
| <dd><code>contentType</code> - the content type of the file</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this request object</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.io.IOException</code> - if the file does not exist or cannot be read</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="isFollowRedirects()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isFollowRedirects</h4> |
| <pre class="methodSignature">public boolean isFollowRedirects()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="api/Request.html#isFollowRedirects()">isFollowRedirects</a></code> in interface <code><a href="api/Request.html" title="interface in org.eclipse.jetty.client.api">Request</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>whether this request follows redirects</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="followRedirects(boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>followRedirects</h4> |
| <pre class="methodSignature">public <a href="api/Request.html" title="interface in org.eclipse.jetty.client.api">Request</a> followRedirects​(boolean follow)</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="api/Request.html#followRedirects(boolean)">followRedirects</a></code> in interface <code><a href="api/Request.html" title="interface in org.eclipse.jetty.client.api">Request</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>follow</code> - whether this request follows redirects</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this request object</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getIdleTimeout()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getIdleTimeout</h4> |
| <pre class="methodSignature">public long getIdleTimeout()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="api/Request.html#getIdleTimeout()">getIdleTimeout</a></code> in interface <code><a href="api/Request.html" title="interface in org.eclipse.jetty.client.api">Request</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the idle timeout for this request, in milliseconds</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="idleTimeout(long,java.util.concurrent.TimeUnit)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>idleTimeout</h4> |
| <pre class="methodSignature">public <a href="api/Request.html" title="interface in org.eclipse.jetty.client.api">Request</a> idleTimeout​(long timeout, |
| java.util.concurrent.TimeUnit unit)</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="api/Request.html#idleTimeout(long,java.util.concurrent.TimeUnit)">idleTimeout</a></code> in interface <code><a href="api/Request.html" title="interface in org.eclipse.jetty.client.api">Request</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>timeout</code> - the idle timeout for this request</dd> |
| <dd><code>unit</code> - the idle timeout unit</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this request object</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getTimeout()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getTimeout</h4> |
| <pre class="methodSignature">public long getTimeout()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="api/Request.html#getTimeout()">getTimeout</a></code> in interface <code><a href="api/Request.html" title="interface in org.eclipse.jetty.client.api">Request</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the total timeout for this request, in milliseconds; |
| zero or negative if the timeout is disabled</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="timeout(long,java.util.concurrent.TimeUnit)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>timeout</h4> |
| <pre class="methodSignature">public <a href="api/Request.html" title="interface in org.eclipse.jetty.client.api">Request</a> timeout​(long timeout, |
| java.util.concurrent.TimeUnit unit)</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="api/Request.html#timeout(long,java.util.concurrent.TimeUnit)">timeout</a></code> in interface <code><a href="api/Request.html" title="interface in org.eclipse.jetty.client.api">Request</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>timeout</code> - the total timeout for the request/response conversation; |
| use zero or a negative value to disable the timeout</dd> |
| <dd><code>unit</code> - the timeout unit</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this request object</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="send()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>send</h4> |
| <pre class="methodSignature">public <a href="api/ContentResponse.html" title="interface in org.eclipse.jetty.client.api">ContentResponse</a> send() |
| throws java.lang.InterruptedException, |
| java.util.concurrent.TimeoutException, |
| java.util.concurrent.ExecutionException</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="api/Request.html#send()">Request</a></code></span></div> |
| <div class="block">Sends this request and returns the response. |
| <p> |
| This method should be used when a simple blocking semantic is needed, and when it is known |
| that the response content can be buffered without exceeding memory constraints. |
| <p> |
| For example, this method is not appropriate to download big files from a server; consider using |
| <a href="api/Request.html#send(org.eclipse.jetty.client.api.Response.CompleteListener)"><code>Request.send(Response.CompleteListener)</code></a> instead, passing your own <a href="api/Response.Listener.html" title="interface in org.eclipse.jetty.client.api"><code>Response.Listener</code></a> or a utility |
| listener such as <a href="util/InputStreamResponseListener.html" title="class in org.eclipse.jetty.client.util"><code>InputStreamResponseListener</code></a>. |
| <p> |
| The method returns when the <a href="api/Response.CompleteListener.html" title="interface in org.eclipse.jetty.client.api"><code>complete event</code></a> is fired.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="api/Request.html#send()">send</a></code> in interface <code><a href="api/Request.html" title="interface in org.eclipse.jetty.client.api">Request</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a <a href="api/ContentResponse.html" title="interface in org.eclipse.jetty.client.api"><code>ContentResponse</code></a> for this request</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.InterruptedException</code> - if send thread is interrupted</dd> |
| <dd><code>java.util.concurrent.TimeoutException</code> - if send times out</dd> |
| <dd><code>java.util.concurrent.ExecutionException</code> - if execution fails</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="api/Response.CompleteListener.html#onComplete(org.eclipse.jetty.client.api.Result)"><code>Response.CompleteListener.onComplete(Result)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="send(org.eclipse.jetty.client.api.Response.CompleteListener)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>send</h4> |
| <pre class="methodSignature">public void send​(<a href="api/Response.CompleteListener.html" title="interface in org.eclipse.jetty.client.api">Response.CompleteListener</a> listener)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="api/Request.html#send(org.eclipse.jetty.client.api.Response.CompleteListener)">Request</a></code></span></div> |
| <div class="block"><p>Sends this request and asynchronously notifies the given listener for response events.</p> |
| <p>This method should be used when the application needs to be notified of the various response events |
| as they happen, or when the application needs to efficiently manage the response content.</p> |
| <p>The listener passed to this method may implement not only <a href="api/Response.CompleteListener.html" title="interface in org.eclipse.jetty.client.api"><code>Response.CompleteListener</code></a> |
| but also other response listener interfaces, and all the events implemented will be notified. |
| This allows application code to write a single listener class to handle all relevant events.</p></div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="api/Request.html#send(org.eclipse.jetty.client.api.Response.CompleteListener)">send</a></code> in interface <code><a href="api/Request.html" title="interface in org.eclipse.jetty.client.api">Request</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>listener</code> - the listener that receives response events</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getResponseListeners()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getResponseListeners</h4> |
| <pre class="methodSignature">protected java.util.List<<a href="api/Response.ResponseListener.html" title="interface in org.eclipse.jetty.client.api">Response.ResponseListener</a>> getResponseListeners()</pre> |
| </li> |
| </ul> |
| <a id="getPushListener()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPushListener</h4> |
| <pre class="methodSignature">public java.util.function.BiFunction<<a href="api/Request.html" title="interface in org.eclipse.jetty.client.api">Request</a>,​<a href="api/Request.html" title="interface in org.eclipse.jetty.client.api">Request</a>,​<a href="api/Response.CompleteListener.html" title="interface in org.eclipse.jetty.client.api">Response.CompleteListener</a>> getPushListener()</pre> |
| </li> |
| </ul> |
| <a id="getTrailers()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getTrailers</h4> |
| <pre class="methodSignature">public java.util.function.Supplier<<a href="../http/HttpFields.html" title="class in org.eclipse.jetty.http">HttpFields</a>> getTrailers()</pre> |
| </li> |
| </ul> |
| <a id="abort(java.lang.Throwable)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>abort</h4> |
| <pre class="methodSignature">public boolean abort​(java.lang.Throwable cause)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="api/Request.html#abort(java.lang.Throwable)">Request</a></code></span></div> |
| <div class="block">Attempts to abort the send of this request.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="api/Request.html#abort(java.lang.Throwable)">abort</a></code> in interface <code><a href="api/Request.html" title="interface in org.eclipse.jetty.client.api">Request</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>cause</code> - the abort cause, must not be null</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>whether the abort succeeded</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getAbortCause()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAbortCause</h4> |
| <pre class="methodSignature">public java.lang.Throwable getAbortCause()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="api/Request.html#getAbortCause()">getAbortCause</a></code> in interface <code><a href="api/Request.html" title="interface in org.eclipse.jetty.client.api">Request</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the abort cause passed to <a href="api/Request.html#abort(java.lang.Throwable)"><code>Request.abort(Throwable)</code></a>, |
| or null if this request has not been aborted</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="toString()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>toString</h4> |
| <pre class="methodSignature">public java.lang.String toString()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code>toString</code> in class <code>java.lang.Object</code></dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </main> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <footer role="contentinfo"> |
| <nav role="navigation"> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a id="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/HttpRequest.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" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../allclasses.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> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li><a href="#nested.class.summary">Nested</a> | </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 id="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </nav> |
| <p class="legalCopy"><small>Copyright © 1995–2021 <a href="https://webtide.com">Webtide</a>. All rights reserved.</small></p> |
| </footer> |
| </body> |
| </html> |