blob: a87da846a3286d09f1356433b1871ddcb44c0e86 [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (11.0.13) on Tue Feb 08 12:40:05 CST 2022 -->
<title>org.eclipse.jetty.client.api (Eclipse Jetty API Doc - v10.0.8)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2022-02-08">
<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="org.eclipse.jetty.client.api (Eclipse Jetty API Doc - v10.0.8)";
}
}
catch(err) {
}
//-->
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 class="navBarCell1Rev">Package</li>
<li>Class</li>
<li><a href="package-use.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>
<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>
<main role="main">
<div class="header">
<h1 title="Package" class="title">Package&nbsp;org.eclipse.jetty.client.api</h1>
</div>
<div class="contentContainer">
<section role="region"><a id="package.description">
<!-- -->
</a>
<div class="block">Jetty Client : API Classes</div>
</section>
<ul class="blockList">
<li class="blockList">
<table class="typeSummary">
<caption><span>Interface Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Interface</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="Authentication.html" title="interface in org.eclipse.jetty.client.api">Authentication</a></th>
<td class="colLast">
<div class="block"><a href="Authentication.html" title="interface in org.eclipse.jetty.client.api"><code>Authentication</code></a> represents a mechanism to authenticate requests for protected resources.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="Authentication.Result.html" title="interface in org.eclipse.jetty.client.api">Authentication.Result</a></th>
<td class="colLast">
<div class="block"><a href="Authentication.Result.html" title="interface in org.eclipse.jetty.client.api"><code>Authentication.Result</code></a> holds the information needed to authenticate a <a href="Request.html" title="interface in org.eclipse.jetty.client.api"><code>Request</code></a> via <a href="Authentication.Result.html#apply(org.eclipse.jetty.client.api.Request)"><code>Authentication.Result.apply(org.eclipse.jetty.client.api.Request)</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="AuthenticationStore.html" title="interface in org.eclipse.jetty.client.api">AuthenticationStore</a></th>
<td class="colLast">
<div class="block">A store for <a href="Authentication.html" title="interface in org.eclipse.jetty.client.api"><code>Authentication</code></a>s and <a href="Authentication.Result.html" title="interface in org.eclipse.jetty.client.api"><code>Authentication.Result</code></a>s.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="Connection.html" title="interface in org.eclipse.jetty.client.api">Connection</a></th>
<td class="colLast">
<div class="block"><a href="Connection.html" title="interface in org.eclipse.jetty.client.api"><code>Connection</code></a> represent a connection to a <a href="Destination.html" title="interface in org.eclipse.jetty.client.api"><code>Destination</code></a> and allow applications to send
requests via <a href="Connection.html#send(org.eclipse.jetty.client.api.Request,org.eclipse.jetty.client.api.Response.CompleteListener)"><code>Connection.send(Request, Response.CompleteListener)</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="ContentProvider.html" title="interface in org.eclipse.jetty.client.api">ContentProvider</a></th>
<td class="colLast">Deprecated.
<div class="deprecationComment">use <a href="Request.Content.html" title="interface in org.eclipse.jetty.client.api"><code>Request.Content</code></a> instead, or <a href="ContentProvider.html#toRequestContent(org.eclipse.jetty.client.api.ContentProvider)"><code>ContentProvider.toRequestContent(ContentProvider)</code></a>
to convert ContentProvider to <a href="Request.Content.html" title="interface in org.eclipse.jetty.client.api"><code>Request.Content</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="ContentProvider.Typed.html" title="interface in org.eclipse.jetty.client.api">ContentProvider.Typed</a></th>
<td class="colLast">Deprecated.
<div class="deprecationComment">use <a href="Request.Content.html" title="interface in org.eclipse.jetty.client.api"><code>Request.Content</code></a> instead</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="ContentResponse.html" title="interface in org.eclipse.jetty.client.api">ContentResponse</a></th>
<td class="colLast">
<div class="block">A specialized <a href="Response.html" title="interface in org.eclipse.jetty.client.api"><code>Response</code></a> that can hold a limited content in memory.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="Destination.html" title="interface in org.eclipse.jetty.client.api">Destination</a></th>
<td class="colLast">
<div class="block"><a href="Destination.html" title="interface in org.eclipse.jetty.client.api"><code>Destination</code></a> represents the triple made of the <a href="Destination.html#getScheme()"><code>Destination.getScheme()</code></a>, the <a href="Destination.html#getHost()"><code>Destination.getHost()</code></a>
and the <a href="Destination.html#getPort()"><code>Destination.getPort()</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="Request.html" title="interface in org.eclipse.jetty.client.api">Request</a></th>
<td class="colLast">
<div class="block"><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.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="Request.BeginListener.html" title="interface in org.eclipse.jetty.client.api">Request.BeginListener</a></th>
<td class="colLast">
<div class="block">Listener for the request begin event.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="Request.CommitListener.html" title="interface in org.eclipse.jetty.client.api">Request.CommitListener</a></th>
<td class="colLast">
<div class="block">Listener for the request committed event.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="Request.Content.html" title="interface in org.eclipse.jetty.client.api">Request.Content</a></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="altColor">
<th class="colFirst" scope="row"><a href="Request.Content.Consumer.html" title="interface in org.eclipse.jetty.client.api">Request.Content.Consumer</a></th>
<td class="colLast">
<div class="block">A reactive model to consume request content, similar to <code>Flow.Subscriber</code>.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="Request.Content.Subscription.html" title="interface in org.eclipse.jetty.client.api">Request.Content.Subscription</a></th>
<td class="colLast">
<div class="block">The link between a content producer and a content consumer.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="Request.ContentListener.html" title="interface in org.eclipse.jetty.client.api">Request.ContentListener</a></th>
<td class="colLast">
<div class="block">Listener for the request content event.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="Request.FailureListener.html" title="interface in org.eclipse.jetty.client.api">Request.FailureListener</a></th>
<td class="colLast">
<div class="block">Listener for the request failed event.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="Request.HeadersListener.html" title="interface in org.eclipse.jetty.client.api">Request.HeadersListener</a></th>
<td class="colLast">
<div class="block">Listener for the request headers event.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="Request.Listener.html" title="interface in org.eclipse.jetty.client.api">Request.Listener</a></th>
<td class="colLast">
<div class="block">Listener for all request events.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="Request.QueuedListener.html" title="interface in org.eclipse.jetty.client.api">Request.QueuedListener</a></th>
<td class="colLast">
<div class="block">Listener for the request queued event.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="Request.RequestListener.html" title="interface in org.eclipse.jetty.client.api">Request.RequestListener</a></th>
<td class="colLast">
<div class="block">Common, empty, super-interface for request listeners.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="Request.SuccessListener.html" title="interface in org.eclipse.jetty.client.api">Request.SuccessListener</a></th>
<td class="colLast">
<div class="block">Listener for the request succeeded event.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="Response.html" title="interface in org.eclipse.jetty.client.api">Response</a></th>
<td class="colLast">
<div class="block"><a href="Response.html" title="interface in org.eclipse.jetty.client.api"><code>Response</code></a> represents an HTTP response and offers methods to retrieve status code, HTTP version
and headers.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="Response.AsyncContentListener.html" title="interface in org.eclipse.jetty.client.api">Response.AsyncContentListener</a></th>
<td class="colLast">
<div class="block">Asynchronous listener for the response content events.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="Response.BeginListener.html" title="interface in org.eclipse.jetty.client.api">Response.BeginListener</a></th>
<td class="colLast">
<div class="block">Listener for the response begin event.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="Response.CompleteListener.html" title="interface in org.eclipse.jetty.client.api">Response.CompleteListener</a></th>
<td class="colLast">
<div class="block">Listener for the request and response completed event.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="Response.ContentListener.html" title="interface in org.eclipse.jetty.client.api">Response.ContentListener</a></th>
<td class="colLast">
<div class="block">Synchronous listener for the response content events.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="Response.DemandedContentListener.html" title="interface in org.eclipse.jetty.client.api">Response.DemandedContentListener</a></th>
<td class="colLast">
<div class="block">Asynchronous listener for the response content events.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="Response.FailureListener.html" title="interface in org.eclipse.jetty.client.api">Response.FailureListener</a></th>
<td class="colLast">
<div class="block">Listener for the response failure event.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="Response.HeaderListener.html" title="interface in org.eclipse.jetty.client.api">Response.HeaderListener</a></th>
<td class="colLast">
<div class="block">Listener for a response header event.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="Response.HeadersListener.html" title="interface in org.eclipse.jetty.client.api">Response.HeadersListener</a></th>
<td class="colLast">
<div class="block">Listener for the response headers event.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="Response.Listener.html" title="interface in org.eclipse.jetty.client.api">Response.Listener</a></th>
<td class="colLast">
<div class="block">Listener for all response events.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="Response.ResponseListener.html" title="interface in org.eclipse.jetty.client.api">Response.ResponseListener</a></th>
<td class="colLast">
<div class="block">Common, empty, super-interface for response listeners</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="Response.SuccessListener.html" title="interface in org.eclipse.jetty.client.api">Response.SuccessListener</a></th>
<td class="colLast">
<div class="block">Listener for the response succeeded event.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary">
<caption><span>Class Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="Authentication.HeaderInfo.html" title="class in org.eclipse.jetty.client.api">Authentication.HeaderInfo</a></th>
<td class="colLast">
<div class="block">Structure holding information about the <code>WWW-Authenticate</code> (or <code>Proxy-Authenticate</code>) header.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="Request.Listener.Adapter.html" title="class in org.eclipse.jetty.client.api">Request.Listener.Adapter</a></th>
<td class="colLast">
<div class="block">An empty implementation of <a href="Request.Listener.html" title="interface in org.eclipse.jetty.client.api"><code>Request.Listener</code></a></div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="Response.Listener.Adapter.html" title="class in org.eclipse.jetty.client.api">Response.Listener.Adapter</a></th>
<td class="colLast">
<div class="block">An empty implementation of <a href="Response.Listener.html" title="interface in org.eclipse.jetty.client.api"><code>Response.Listener</code></a></div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="Result.html" title="class in org.eclipse.jetty.client.api">Result</a></th>
<td class="colLast">
<div class="block">The result of a request / response exchange, containing the <a href="Request.html" title="interface in org.eclipse.jetty.client.api"><code>Request</code></a>, the <a href="Response.html" title="interface in org.eclipse.jetty.client.api"><code>Response</code></a>
and eventual failures of either.</div>
</td>
</tr>
</tbody>
</table>
</li>
</ul>
</div>
</main>
<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 class="navBarCell1Rev">Package</li>
<li>Class</li>
<li><a href="package-use.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>
<a id="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
<p class="legalCopy"><small>Copyright &#169; 1995&#x2013;2022 <a href="https://webtide.com">Webtide</a>. All rights reserved.</small></p>
</footer>
</body>
</html>