blob: b19b3bb21bb18f185d650764483fb1de45016be8 [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (11.0.11) on Mon Oct 11 11:08:51 CDT 2021 -->
<title>Request (Eclipse Jetty API Doc - v10.0.7)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2021-10-11">
<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="Request (Eclipse Jetty API Doc - v10.0.7)";
}
}
catch(err) {
}
//-->
var data = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":38,"i6":38,"i7":6,"i8":6,"i9":6,"i10":6,"i11":6,"i12":6,"i13":6,"i14":6,"i15":38,"i16":6,"i17":6,"i18":6,"i19":6,"i20":6,"i21":6,"i22":6,"i23":6,"i24":6,"i25":6,"i26":6,"i27":6,"i28":6,"i29":6,"i30":6,"i31":38,"i32":38,"i33":6,"i34":18,"i35":6,"i36":6,"i37":6,"i38":6,"i39":6,"i40":6,"i41":6,"i42":6,"i43":6,"i44":6,"i45":6,"i46":6,"i47":6,"i48":6,"i49":6,"i50":6,"i51":6,"i52":6,"i53":6,"i54":6,"i55":6,"i56":6,"i57":6,"i58":18,"i59":6,"i60":6,"i61":6,"i62":6,"i63":6,"i64":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],16:["t5","Default Methods"],32:["t6","Deprecated Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
var pathtoroot = "../../../../../";
var useModuleDirectories = true;
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/Request.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&nbsp;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:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</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">&nbsp;</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>&nbsp;<a href="package-summary.html">org.eclipse.jetty.client.api</a></div>
<h2 title="Interface Request" class="title">Interface Request</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><code><a href="../../websocket/core/client/CoreClientUpgradeRequest.html" title="class in org.eclipse.jetty.websocket.core.client">CoreClientUpgradeRequest</a></code>, <code><a href="../HttpProxy.TunnelRequest.html" title="class in org.eclipse.jetty.client">HttpProxy.TunnelRequest</a></code>, <code><a href="../HttpRequest.html" title="class in org.eclipse.jetty.client">HttpRequest</a></code>, <code><a href="../../websocket/javax/client/internal/JavaxClientUpgradeRequest.html" title="class in org.eclipse.jetty.websocket.javax.client.internal">JavaxClientUpgradeRequest</a></code>, <code><a href="../../websocket/client/impl/JettyClientUpgradeRequest.html" title="class in org.eclipse.jetty.websocket.client.impl">JettyClientUpgradeRequest</a></code></dd>
</dl>
<hr>
<pre>public interface <span class="typeNameLabel">Request</span></pre>
<div class="block"><p><a href="Request.html" title="interface in org.eclipse.jetty.client.api"><code>Request</code></a> represents an HTTP request, and offers a fluent interface to customize
various attributes such as the path, the headers, the content, etc.</p>
<p>You can create <a href="Request.html" title="interface in org.eclipse.jetty.client.api"><code>Request</code></a> objects via <a href="../HttpClient.html#newRequest(java.lang.String)"><code>HttpClient.newRequest(String)</code></a> and
you can send them using either <a href="#send()"><code>send()</code></a> for a blocking semantic, or
<a href="#send(org.eclipse.jetty.client.api.Response.CompleteListener)"><code>send(Response.CompleteListener)</code></a> for an asynchronous semantic.</p></div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="Response.html" title="interface in org.eclipse.jetty.client.api"><code>Response</code></a></dd>
</dl>
</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>
<table class="memberSummary">
<caption><span>Nested Classes</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Interface</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static interface&nbsp;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="Request.BeginListener.html" title="interface in org.eclipse.jetty.client.api">Request.BeginListener</a></span></code></th>
<td class="colLast">
<div class="block">Listener for the request begin event.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static interface&nbsp;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="Request.CommitListener.html" title="interface in org.eclipse.jetty.client.api">Request.CommitListener</a></span></code></th>
<td class="colLast">
<div class="block">Listener for the request committed event.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static interface&nbsp;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="Request.Content.html" title="interface in org.eclipse.jetty.client.api">Request.Content</a></span></code></th>
<td class="colLast">
<div class="block">A reactive model to produce request content, similar to <code>Flow.Publisher</code>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static interface&nbsp;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="Request.ContentListener.html" title="interface in org.eclipse.jetty.client.api">Request.ContentListener</a></span></code></th>
<td class="colLast">
<div class="block">Listener for the request content event.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static interface&nbsp;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="Request.FailureListener.html" title="interface in org.eclipse.jetty.client.api">Request.FailureListener</a></span></code></th>
<td class="colLast">
<div class="block">Listener for the request failed event.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static interface&nbsp;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="Request.HeadersListener.html" title="interface in org.eclipse.jetty.client.api">Request.HeadersListener</a></span></code></th>
<td class="colLast">
<div class="block">Listener for the request headers event.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static interface&nbsp;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="Request.Listener.html" title="interface in org.eclipse.jetty.client.api">Request.Listener</a></span></code></th>
<td class="colLast">
<div class="block">Listener for all request events.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static interface&nbsp;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="Request.QueuedListener.html" title="interface in org.eclipse.jetty.client.api">Request.QueuedListener</a></span></code></th>
<td class="colLast">
<div class="block">Listener for the request queued event.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static interface&nbsp;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="Request.RequestListener.html" title="interface in org.eclipse.jetty.client.api">Request.RequestListener</a></span></code></th>
<td class="colLast">
<div class="block">Common, empty, super-interface for request listeners.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static interface&nbsp;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="Request.SuccessListener.html" title="interface in org.eclipse.jetty.client.api">Request.SuccessListener</a></span></code></th>
<td class="colLast">
<div class="block">Listener for the request succeeded event.</div>
</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">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t5" class="tableTab"><span><a href="javascript:show(16);">Default Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated Methods</a></span><span class="tabEnd">&nbsp;</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>&#8203;(java.lang.Throwable&nbsp;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="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>&#8203;(java.lang.String...&nbsp;accepts)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="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>&#8203;(java.lang.String&nbsp;agent)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="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>&#8203;(java.lang.String&nbsp;name,
java.lang.Object&nbsp;value)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="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="#body(org.eclipse.jetty.client.api.Request.Content)">body</a></span>&#8203;(<a href="Request.Content.html" title="interface in org.eclipse.jetty.client.api">Request.Content</a>&nbsp;content)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="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>&#8203;(<a href="ContentProvider.html" title="interface in org.eclipse.jetty.client.api">ContentProvider</a>&nbsp;content)</code></th>
<td class="colLast">
<div class="block"><span class="deprecatedLabel">Deprecated.</span>
<div class="deprecationComment">use <a href="#body(org.eclipse.jetty.client.api.Request.Content)"><code>body(Content)</code></a> instead</div>
</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="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>&#8203;(<a href="ContentProvider.html" title="interface in org.eclipse.jetty.client.api">ContentProvider</a>&nbsp;content,
java.lang.String&nbsp;contentType)</code></th>
<td class="colLast">
<div class="block"><span class="deprecatedLabel">Deprecated.</span>
<div class="deprecationComment">use <a href="#body(org.eclipse.jetty.client.api.Request.Content)"><code>body(Content)</code></a> instead</div>
</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code><a href="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>&#8203;(java.net.HttpCookie&nbsp;cookie)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code><a href="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>&#8203;(java.nio.file.Path&nbsp;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="i9" class="rowColor">
<td class="colFirst"><code><a href="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>&#8203;(java.nio.file.Path&nbsp;file,
java.lang.String&nbsp;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="i10" class="altColor">
<td class="colFirst"><code><a href="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>&#8203;(boolean&nbsp;follow)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i11" class="rowColor">
<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">&nbsp;</td>
</tr>
<tr id="i12" class="altColor">
<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">&nbsp;</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>java.util.Map&lt;java.lang.String,&#8203;java.lang.Object&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getAttributes()">getAttributes</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code><a href="Request.Content.html" title="interface in org.eclipse.jetty.client.api">Request.Content</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getBody()">getBody</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code><a href="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">
<div class="block"><span class="deprecatedLabel">Deprecated.</span>
<div class="deprecationComment">use <a href="#getBody()"><code>getBody()</code></a> instead</div>
</div>
</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code>java.util.List&lt;java.net.HttpCookie&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getCookies()">getCookies</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code><a href="../../http/HttpFields.html" title="interface 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">&nbsp;</td>
</tr>
<tr id="i18" class="altColor">
<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">&nbsp;</td>
</tr>
<tr id="i19" class="rowColor">
<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">&nbsp;</td>
</tr>
<tr id="i20" class="altColor">
<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">&nbsp;</td>
</tr>
<tr id="i21" class="rowColor">
<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">&nbsp;</td>
</tr>
<tr id="i22" class="altColor">
<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">&nbsp;</td>
</tr>
<tr id="i23" class="rowColor">
<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">&nbsp;</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">&nbsp;</td>
</tr>
<tr id="i25" class="rowColor">
<td class="colFirst"><code>&lt;T extends <a href="Request.RequestListener.html" title="interface in org.eclipse.jetty.client.api">Request.RequestListener</a>&gt;<br>java.util.List&lt;T&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getRequestListeners(java.lang.Class)">getRequestListeners</a></span>&#8203;(java.lang.Class&lt;T&gt;&nbsp;listenerClass)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i26" class="altColor">
<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">&nbsp;</td>
</tr>
<tr id="i27" class="rowColor">
<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">&nbsp;</td>
</tr>
<tr id="i28" class="altColor">
<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">&nbsp;</td>
</tr>
<tr id="i29" 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">&nbsp;</td>
</tr>
<tr id="i30" 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">&nbsp;</td>
</tr>
<tr id="i31" class="rowColor">
<td class="colFirst"><code><a href="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>&#8203;(java.lang.String&nbsp;name,
java.lang.String&nbsp;value)</code></th>
<td class="colLast">
<div class="block"><span class="deprecatedLabel">Deprecated.</span>
<div class="deprecationComment">use <a href="#headers(java.util.function.Consumer)"><code>headers(Consumer)</code></a> instead</div>
</div>
</td>
</tr>
<tr id="i32" class="altColor">
<td class="colFirst"><code><a href="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>&#8203;(<a href="../../http/HttpHeader.html" title="enum in org.eclipse.jetty.http">HttpHeader</a>&nbsp;header,
java.lang.String&nbsp;value)</code></th>
<td class="colLast">
<div class="block"><span class="deprecatedLabel">Deprecated.</span>
<div class="deprecationComment">use <a href="#headers(java.util.function.Consumer)"><code>headers(Consumer)</code></a> instead</div>
</div>
</td>
</tr>
<tr id="i33" class="rowColor">
<td class="colFirst"><code><a href="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="#headers(java.util.function.Consumer)">headers</a></span>&#8203;(java.util.function.Consumer&lt;<a href="../../http/HttpFields.Mutable.html" title="class in org.eclipse.jetty.http">HttpFields.Mutable</a>&gt;&nbsp;consumer)</code></th>
<td class="colLast">
<div class="block">Modifies the headers of this request.</div>
</td>
</tr>
<tr id="i34" class="altColor">
<td class="colFirst"><code>default <a href="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>&#8203;(java.lang.String&nbsp;host)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i35" class="rowColor">
<td class="colFirst"><code><a href="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>&#8203;(long&nbsp;timeout,
java.util.concurrent.TimeUnit&nbsp;unit)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i36" class="altColor">
<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">&nbsp;</td>
</tr>
<tr id="i37" class="rowColor">
<td class="colFirst"><code><a href="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>&#8203;(<a href="Request.Listener.html" title="interface in org.eclipse.jetty.client.api">Request.Listener</a>&nbsp;listener)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i38" class="altColor">
<td class="colFirst"><code><a href="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>&#8203;(java.lang.String&nbsp;method)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i39" class="rowColor">
<td class="colFirst"><code><a href="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>&#8203;(<a href="../../http/HttpMethod.html" title="enum in org.eclipse.jetty.http">HttpMethod</a>&nbsp;method)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i40" class="altColor">
<td class="colFirst"><code><a href="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>&#8203;(<a href="Response.CompleteListener.html" title="interface in org.eclipse.jetty.client.api">Response.CompleteListener</a>&nbsp;listener)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i41" class="rowColor">
<td class="colFirst"><code><a href="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>&#8203;(<a href="Request.BeginListener.html" title="interface in org.eclipse.jetty.client.api">Request.BeginListener</a>&nbsp;listener)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i42" class="altColor">
<td class="colFirst"><code><a href="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>&#8203;(<a href="Request.CommitListener.html" title="interface in org.eclipse.jetty.client.api">Request.CommitListener</a>&nbsp;listener)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i43" class="rowColor">
<td class="colFirst"><code><a href="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>&#8203;(<a href="Request.ContentListener.html" title="interface in org.eclipse.jetty.client.api">Request.ContentListener</a>&nbsp;listener)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i44" class="altColor">
<td class="colFirst"><code><a href="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>&#8203;(<a href="Request.FailureListener.html" title="interface in org.eclipse.jetty.client.api">Request.FailureListener</a>&nbsp;listener)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i45" class="rowColor">
<td class="colFirst"><code><a href="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>&#8203;(<a href="Request.HeadersListener.html" title="interface in org.eclipse.jetty.client.api">Request.HeadersListener</a>&nbsp;listener)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i46" class="altColor">
<td class="colFirst"><code><a href="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>&#8203;(<a href="Request.QueuedListener.html" title="interface in org.eclipse.jetty.client.api">Request.QueuedListener</a>&nbsp;listener)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i47" class="rowColor">
<td class="colFirst"><code><a href="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>&#8203;(<a href="Request.SuccessListener.html" title="interface in org.eclipse.jetty.client.api">Request.SuccessListener</a>&nbsp;listener)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i48" class="altColor">
<td class="colFirst"><code><a href="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>&#8203;(<a href="Response.BeginListener.html" title="interface in org.eclipse.jetty.client.api">Response.BeginListener</a>&nbsp;listener)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i49" class="rowColor">
<td class="colFirst"><code><a href="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>&#8203;(<a href="Response.ContentListener.html" title="interface in org.eclipse.jetty.client.api">Response.ContentListener</a>&nbsp;listener)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i50" class="altColor">
<td class="colFirst"><code><a href="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>&#8203;(<a href="Response.AsyncContentListener.html" title="interface in org.eclipse.jetty.client.api">Response.AsyncContentListener</a>&nbsp;listener)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i51" class="rowColor">
<td class="colFirst"><code><a href="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>&#8203;(<a href="Response.DemandedContentListener.html" title="interface in org.eclipse.jetty.client.api">Response.DemandedContentListener</a>&nbsp;listener)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i52" class="altColor">
<td class="colFirst"><code><a href="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>&#8203;(<a href="Response.FailureListener.html" title="interface in org.eclipse.jetty.client.api">Response.FailureListener</a>&nbsp;listener)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i53" class="rowColor">
<td class="colFirst"><code><a href="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>&#8203;(<a href="Response.HeaderListener.html" title="interface in org.eclipse.jetty.client.api">Response.HeaderListener</a>&nbsp;listener)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i54" class="altColor">
<td class="colFirst"><code><a href="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>&#8203;(<a href="Response.HeadersListener.html" title="interface in org.eclipse.jetty.client.api">Response.HeadersListener</a>&nbsp;listener)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i55" class="rowColor">
<td class="colFirst"><code><a href="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>&#8203;(<a href="Response.SuccessListener.html" title="interface in org.eclipse.jetty.client.api">Response.SuccessListener</a>&nbsp;listener)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i56" class="altColor">
<td class="colFirst"><code><a href="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>&#8203;(java.lang.String&nbsp;name,
java.lang.String&nbsp;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="i57" class="rowColor">
<td class="colFirst"><code><a href="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>&#8203;(java.lang.String&nbsp;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="i58" class="altColor">
<td class="colFirst"><code>default <a href="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>&#8203;(int&nbsp;port)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i59" class="rowColor">
<td class="colFirst"><code><a href="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>&#8203;(java.lang.String&nbsp;scheme)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i60" class="altColor">
<td class="colFirst"><code><a href="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="i61" 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>&#8203;(<a href="Response.CompleteListener.html" title="interface in org.eclipse.jetty.client.api">Response.CompleteListener</a>&nbsp;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="i62" class="altColor">
<td class="colFirst"><code><a href="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>&#8203;(java.lang.Object&nbsp;tag)</code></th>
<td class="colLast">
<div class="block">Tags this request with the given metadata tag.</div>
</td>
</tr>
<tr id="i63" class="rowColor">
<td class="colFirst"><code><a href="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>&#8203;(long&nbsp;timeout,
java.util.concurrent.TimeUnit&nbsp;unit)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i64" class="altColor">
<td class="colFirst"><code><a href="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>&#8203;(<a href="../../http/HttpVersion.html" title="enum in org.eclipse.jetty.http">HttpVersion</a>&nbsp;version)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="getScheme()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getScheme</h4>
<pre class="methodSignature">java.lang.String&nbsp;getScheme()</pre>
<dl>
<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"><a href="Request.html" title="interface in org.eclipse.jetty.client.api">Request</a>&nbsp;scheme&#8203;(java.lang.String&nbsp;scheme)</pre>
<dl>
<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">java.lang.String&nbsp;getHost()</pre>
<dl>
<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">default&nbsp;<a href="Request.html" title="interface in org.eclipse.jetty.client.api">Request</a>&nbsp;host&#8203;(java.lang.String&nbsp;host)</pre>
<dl>
<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">int&nbsp;getPort()</pre>
<dl>
<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">default&nbsp;<a href="Request.html" title="interface in org.eclipse.jetty.client.api">Request</a>&nbsp;port&#8203;(int&nbsp;port)</pre>
<dl>
<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">java.lang.String&nbsp;getMethod()</pre>
<dl>
<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"><a href="Request.html" title="interface in org.eclipse.jetty.client.api">Request</a>&nbsp;method&#8203;(<a href="../../http/HttpMethod.html" title="enum in org.eclipse.jetty.http">HttpMethod</a>&nbsp;method)</pre>
<dl>
<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"><a href="Request.html" title="interface in org.eclipse.jetty.client.api">Request</a>&nbsp;method&#8203;(java.lang.String&nbsp;method)</pre>
<dl>
<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">java.lang.String&nbsp;getPath()</pre>
<dl>
<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="#getQuery()"><code>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"><a href="Request.html" title="interface in org.eclipse.jetty.client.api">Request</a>&nbsp;path&#8203;(java.lang.String&nbsp;path)</pre>
<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 &euro; then the
query string for this parameter must be "currency=%E2%82%AC".
For transparent encoding of parameter values, use <a href="#param(java.lang.String,java.lang.String)"><code>param(String, String)</code></a>.</div>
<dl>
<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">java.lang.String&nbsp;getQuery()</pre>
<dl>
<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="#getPath()"><code>getPath()</code></a>,
<a href="#getParams()"><code>getParams()</code></a></dd>
</dl>
</li>
</ul>
<a id="getURI()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getURI</h4>
<pre class="methodSignature">java.net.URI&nbsp;getURI()</pre>
<dl>
<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"><a href="../../http/HttpVersion.html" title="enum in org.eclipse.jetty.http">HttpVersion</a>&nbsp;getVersion()</pre>
<dl>
<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"><a href="Request.html" title="interface in org.eclipse.jetty.client.api">Request</a>&nbsp;version&#8203;(<a href="../../http/HttpVersion.html" title="enum in org.eclipse.jetty.http">HttpVersion</a>&nbsp;version)</pre>
<dl>
<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="getParams()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getParams</h4>
<pre class="methodSignature"><a href="../../util/Fields.html" title="class in org.eclipse.jetty.util">Fields</a>&nbsp;getParams()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the URI query parameters of this request</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"><a href="Request.html" title="interface in org.eclipse.jetty.client.api">Request</a>&nbsp;param&#8203;(java.lang.String&nbsp;name,
java.lang.String&nbsp;value)</pre>
<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="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="getHeaders()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getHeaders</h4>
<pre class="methodSignature"><a href="../../http/HttpFields.html" title="interface in org.eclipse.jetty.http">HttpFields</a>&nbsp;getHeaders()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the headers of this request</dd>
</dl>
</li>
</ul>
<a id="headers(java.util.function.Consumer)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>headers</h4>
<pre class="methodSignature"><a href="Request.html" title="interface in org.eclipse.jetty.client.api">Request</a>&nbsp;headers&#8203;(java.util.function.Consumer&lt;<a href="../../http/HttpFields.Mutable.html" title="class in org.eclipse.jetty.http">HttpFields.Mutable</a>&gt;&nbsp;consumer)</pre>
<div class="block">Modifies the headers of this request.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>consumer</code> - the code that modifies the headers of this request</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">@Deprecated
<a href="Request.html" title="interface in org.eclipse.jetty.client.api">Request</a>&nbsp;header&#8203;(java.lang.String&nbsp;name,
java.lang.String&nbsp;value)</pre>
<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span>
<div class="deprecationComment">use <a href="#headers(java.util.function.Consumer)"><code>headers(Consumer)</code></a> instead</div>
</div>
<dl>
<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="#header(org.eclipse.jetty.http.HttpHeader,java.lang.String)"><code>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">@Deprecated
<a href="Request.html" title="interface in org.eclipse.jetty.client.api">Request</a>&nbsp;header&#8203;(<a href="../../http/HttpHeader.html" title="enum in org.eclipse.jetty.http">HttpHeader</a>&nbsp;header,
java.lang.String&nbsp;value)</pre>
<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span>
<div class="deprecationComment">use <a href="#headers(java.util.function.Consumer)"><code>headers(Consumer)</code></a> instead</div>
</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="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">java.util.List&lt;java.net.HttpCookie&gt;&nbsp;getCookies()</pre>
<dl>
<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"><a href="Request.html" title="interface in org.eclipse.jetty.client.api">Request</a>&nbsp;cookie&#8203;(java.net.HttpCookie&nbsp;cookie)</pre>
<dl>
<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"><a href="Request.html" title="interface in org.eclipse.jetty.client.api">Request</a>&nbsp;tag&#8203;(java.lang.Object&nbsp;tag)</pre>
<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="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">java.lang.Object&nbsp;getTag()</pre>
<dl>
<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"><a href="Request.html" title="interface in org.eclipse.jetty.client.api">Request</a>&nbsp;attribute&#8203;(java.lang.String&nbsp;name,
java.lang.Object&nbsp;value)</pre>
<dl>
<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">java.util.Map&lt;java.lang.String,&#8203;java.lang.Object&gt;&nbsp;getAttributes()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the attributes of this request</dd>
</dl>
</li>
</ul>
<a id="getContent()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getContent</h4>
<pre class="methodSignature">@Deprecated
<a href="ContentProvider.html" title="interface in org.eclipse.jetty.client.api">ContentProvider</a>&nbsp;getContent()</pre>
<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span>
<div class="deprecationComment">use <a href="#getBody()"><code>getBody()</code></a> instead</div>
</div>
<dl>
<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">@Deprecated
<a href="Request.html" title="interface in org.eclipse.jetty.client.api">Request</a>&nbsp;content&#8203;(<a href="ContentProvider.html" title="interface in org.eclipse.jetty.client.api">ContentProvider</a>&nbsp;content)</pre>
<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span>
<div class="deprecationComment">use <a href="#body(org.eclipse.jetty.client.api.Request.Content)"><code>body(Content)</code></a> instead</div>
</div>
<dl>
<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">@Deprecated
<a href="Request.html" title="interface in org.eclipse.jetty.client.api">Request</a>&nbsp;content&#8203;(<a href="ContentProvider.html" title="interface in org.eclipse.jetty.client.api">ContentProvider</a>&nbsp;content,
java.lang.String&nbsp;contentType)</pre>
<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span>
<div class="deprecationComment">use <a href="#body(org.eclipse.jetty.client.api.Request.Content)"><code>body(Content)</code></a> instead</div>
</div>
<dl>
<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="getBody()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getBody</h4>
<pre class="methodSignature"><a href="Request.Content.html" title="interface in org.eclipse.jetty.client.api">Request.Content</a>&nbsp;getBody()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the request content of this request</dd>
</dl>
</li>
</ul>
<a id="body(org.eclipse.jetty.client.api.Request.Content)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>body</h4>
<pre class="methodSignature"><a href="Request.html" title="interface in org.eclipse.jetty.client.api">Request</a>&nbsp;body&#8203;(<a href="Request.Content.html" title="interface in org.eclipse.jetty.client.api">Request.Content</a>&nbsp;content)</pre>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>content</code> - the request content of this request</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"><a href="Request.html" title="interface in org.eclipse.jetty.client.api">Request</a>&nbsp;file&#8203;(java.nio.file.Path&nbsp;file)
throws java.io.IOException</pre>
<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="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"><a href="Request.html" title="interface in org.eclipse.jetty.client.api">Request</a>&nbsp;file&#8203;(java.nio.file.Path&nbsp;file,
java.lang.String&nbsp;contentType)
throws java.io.IOException</pre>
<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="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="getAgent()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAgent</h4>
<pre class="methodSignature">java.lang.String&nbsp;getAgent()</pre>
<dl>
<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"><a href="Request.html" title="interface in org.eclipse.jetty.client.api">Request</a>&nbsp;agent&#8203;(java.lang.String&nbsp;agent)</pre>
<dl>
<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"><a href="Request.html" title="interface in org.eclipse.jetty.client.api">Request</a>&nbsp;accept&#8203;(java.lang.String...&nbsp;accepts)</pre>
<dl>
<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="getIdleTimeout()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getIdleTimeout</h4>
<pre class="methodSignature">long&nbsp;getIdleTimeout()</pre>
<dl>
<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"><a href="Request.html" title="interface in org.eclipse.jetty.client.api">Request</a>&nbsp;idleTimeout&#8203;(long&nbsp;timeout,
java.util.concurrent.TimeUnit&nbsp;unit)</pre>
<dl>
<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">long&nbsp;getTimeout()</pre>
<dl>
<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"><a href="Request.html" title="interface in org.eclipse.jetty.client.api">Request</a>&nbsp;timeout&#8203;(long&nbsp;timeout,
java.util.concurrent.TimeUnit&nbsp;unit)</pre>
<dl>
<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="isFollowRedirects()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isFollowRedirects</h4>
<pre class="methodSignature">boolean&nbsp;isFollowRedirects()</pre>
<dl>
<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"><a href="Request.html" title="interface in org.eclipse.jetty.client.api">Request</a>&nbsp;followRedirects&#8203;(boolean&nbsp;follow)</pre>
<dl>
<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="getRequestListeners(java.lang.Class)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRequestListeners</h4>
<pre class="methodSignature">&lt;T extends <a href="Request.RequestListener.html" title="interface in org.eclipse.jetty.client.api">Request.RequestListener</a>&gt;&nbsp;java.util.List&lt;T&gt;&nbsp;getRequestListeners&#8203;(java.lang.Class&lt;T&gt;&nbsp;listenerClass)</pre>
<dl>
<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>listenerClass</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"><a href="Request.html" title="interface in org.eclipse.jetty.client.api">Request</a>&nbsp;listener&#8203;(<a href="Request.Listener.html" title="interface in org.eclipse.jetty.client.api">Request.Listener</a>&nbsp;listener)</pre>
<dl>
<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"><a href="Request.html" title="interface in org.eclipse.jetty.client.api">Request</a>&nbsp;onRequestQueued&#8203;(<a href="Request.QueuedListener.html" title="interface in org.eclipse.jetty.client.api">Request.QueuedListener</a>&nbsp;listener)</pre>
<dl>
<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"><a href="Request.html" title="interface in org.eclipse.jetty.client.api">Request</a>&nbsp;onRequestBegin&#8203;(<a href="Request.BeginListener.html" title="interface in org.eclipse.jetty.client.api">Request.BeginListener</a>&nbsp;listener)</pre>
<dl>
<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"><a href="Request.html" title="interface in org.eclipse.jetty.client.api">Request</a>&nbsp;onRequestHeaders&#8203;(<a href="Request.HeadersListener.html" title="interface in org.eclipse.jetty.client.api">Request.HeadersListener</a>&nbsp;listener)</pre>
<dl>
<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"><a href="Request.html" title="interface in org.eclipse.jetty.client.api">Request</a>&nbsp;onRequestCommit&#8203;(<a href="Request.CommitListener.html" title="interface in org.eclipse.jetty.client.api">Request.CommitListener</a>&nbsp;listener)</pre>
<dl>
<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"><a href="Request.html" title="interface in org.eclipse.jetty.client.api">Request</a>&nbsp;onRequestContent&#8203;(<a href="Request.ContentListener.html" title="interface in org.eclipse.jetty.client.api">Request.ContentListener</a>&nbsp;listener)</pre>
<dl>
<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"><a href="Request.html" title="interface in org.eclipse.jetty.client.api">Request</a>&nbsp;onRequestSuccess&#8203;(<a href="Request.SuccessListener.html" title="interface in org.eclipse.jetty.client.api">Request.SuccessListener</a>&nbsp;listener)</pre>
<dl>
<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"><a href="Request.html" title="interface in org.eclipse.jetty.client.api">Request</a>&nbsp;onRequestFailure&#8203;(<a href="Request.FailureListener.html" title="interface in org.eclipse.jetty.client.api">Request.FailureListener</a>&nbsp;listener)</pre>
<dl>
<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"><a href="Request.html" title="interface in org.eclipse.jetty.client.api">Request</a>&nbsp;onResponseBegin&#8203;(<a href="Response.BeginListener.html" title="interface in org.eclipse.jetty.client.api">Response.BeginListener</a>&nbsp;listener)</pre>
<dl>
<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"><a href="Request.html" title="interface in org.eclipse.jetty.client.api">Request</a>&nbsp;onResponseHeader&#8203;(<a href="Response.HeaderListener.html" title="interface in org.eclipse.jetty.client.api">Response.HeaderListener</a>&nbsp;listener)</pre>
<dl>
<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"><a href="Request.html" title="interface in org.eclipse.jetty.client.api">Request</a>&nbsp;onResponseHeaders&#8203;(<a href="Response.HeadersListener.html" title="interface in org.eclipse.jetty.client.api">Response.HeadersListener</a>&nbsp;listener)</pre>
<dl>
<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"><a href="Request.html" title="interface in org.eclipse.jetty.client.api">Request</a>&nbsp;onResponseContent&#8203;(<a href="Response.ContentListener.html" title="interface in org.eclipse.jetty.client.api">Response.ContentListener</a>&nbsp;listener)</pre>
<dl>
<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"><a href="Request.html" title="interface in org.eclipse.jetty.client.api">Request</a>&nbsp;onResponseContentAsync&#8203;(<a href="Response.AsyncContentListener.html" title="interface in org.eclipse.jetty.client.api">Response.AsyncContentListener</a>&nbsp;listener)</pre>
<dl>
<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"><a href="Request.html" title="interface in org.eclipse.jetty.client.api">Request</a>&nbsp;onResponseContentDemanded&#8203;(<a href="Response.DemandedContentListener.html" title="interface in org.eclipse.jetty.client.api">Response.DemandedContentListener</a>&nbsp;listener)</pre>
<dl>
<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"><a href="Request.html" title="interface in org.eclipse.jetty.client.api">Request</a>&nbsp;onResponseSuccess&#8203;(<a href="Response.SuccessListener.html" title="interface in org.eclipse.jetty.client.api">Response.SuccessListener</a>&nbsp;listener)</pre>
<dl>
<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"><a href="Request.html" title="interface in org.eclipse.jetty.client.api">Request</a>&nbsp;onResponseFailure&#8203;(<a href="Response.FailureListener.html" title="interface in org.eclipse.jetty.client.api">Response.FailureListener</a>&nbsp;listener)</pre>
<dl>
<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"><a href="Request.html" title="interface in org.eclipse.jetty.client.api">Request</a>&nbsp;onComplete&#8203;(<a href="Response.CompleteListener.html" title="interface in org.eclipse.jetty.client.api">Response.CompleteListener</a>&nbsp;listener)</pre>
<dl>
<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="send()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>send</h4>
<pre class="methodSignature"><a href="ContentResponse.html" title="interface in org.eclipse.jetty.client.api">ContentResponse</a>&nbsp;send()
throws java.lang.InterruptedException,
java.util.concurrent.TimeoutException,
java.util.concurrent.ExecutionException</pre>
<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="#send(org.eclipse.jetty.client.api.Response.CompleteListener)"><code>send(Response.CompleteListener)</code></a> instead, passing your own <a href="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="Response.CompleteListener.html" title="interface in org.eclipse.jetty.client.api"><code>complete event</code></a> is fired.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a <a href="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="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">void&nbsp;send&#8203;(<a href="Response.CompleteListener.html" title="interface in org.eclipse.jetty.client.api">Response.CompleteListener</a>&nbsp;listener)</pre>
<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="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="paramLabel">Parameters:</span></dt>
<dd><code>listener</code> - the listener that receives response events</dd>
</dl>
</li>
</ul>
<a id="abort(java.lang.Throwable)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>abort</h4>
<pre class="methodSignature">boolean&nbsp;abort&#8203;(java.lang.Throwable&nbsp;cause)</pre>
<div class="block">Attempts to abort the send of this request.</div>
<dl>
<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="blockListLast">
<li class="blockList">
<h4>getAbortCause</h4>
<pre class="methodSignature">java.lang.Throwable&nbsp;getAbortCause()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the abort cause passed to <a href="#abort(java.lang.Throwable)"><code>abort(Throwable)</code></a>,
or null if this request has not been aborted</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/Request.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&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</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 &#169; 1995&#x2013;2021 <a href="https://webtide.com">Webtide</a>. All rights reserved.</small></p>
</footer>
</body>
</html>