Google Git
Sign in
eclipse / www.eclipse.org / jetty / a3b2b46b70ed9bbe40e975355658f1bbe73bbc32 / . / javadoc / jetty-9 / org / eclipse / jetty / proxy / ProxyServlet.ProxyResponseListener.html
blob: 1e3438fac81c3d0f4683970451a435338344fe6f [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (11.0.11) on Mon Jun 14 16:37:38 EDT 2021 -->
<title>ProxyServlet.ProxyResponseListener (Jetty :: Project 9.4.42.v20210604 API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2021-06-14">
<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="ProxyServlet.ProxyResponseListener (Jetty :: Project 9.4.42.v20210604 API)";
}
}
catch(err) {
}
//-->
var data = {"i0":10,"i1":10,"i2":10,"i3":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
var pathtoroot = "../../../../";
var useModuleDirectories = false;
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a id="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/ProxyServlet.ProxyResponseListener.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><a href="#constructor.summary">Constr</a>&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><a href="#constructor.detail">Constr</a>&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.proxy</a></div>
<h2 title="Class ProxyServlet.ProxyResponseListener" class="title">Class ProxyServlet.ProxyResponseListener</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li><a href="../client/api/Response.Listener.Adapter.html" title="class in org.eclipse.jetty.client.api">org.eclipse.jetty.client.api.Response.Listener.Adapter</a></li>
<li>
<ul class="inheritance">
<li>org.eclipse.jetty.proxy.ProxyServlet.ProxyResponseListener</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><code>java.util.EventListener</code>, <code><a href="../client/api/Response.AsyncContentListener.html" title="interface in org.eclipse.jetty.client.api">Response.AsyncContentListener</a></code>, <code><a href="../client/api/Response.BeginListener.html" title="interface in org.eclipse.jetty.client.api">Response.BeginListener</a></code>, <code><a href="../client/api/Response.CompleteListener.html" title="interface in org.eclipse.jetty.client.api">Response.CompleteListener</a></code>, <code><a href="../client/api/Response.ContentListener.html" title="interface in org.eclipse.jetty.client.api">Response.ContentListener</a></code>, <code><a href="../client/api/Response.DemandedContentListener.html" title="interface in org.eclipse.jetty.client.api">Response.DemandedContentListener</a></code>, <code><a href="../client/api/Response.FailureListener.html" title="interface in org.eclipse.jetty.client.api">Response.FailureListener</a></code>, <code><a href="../client/api/Response.HeaderListener.html" title="interface in org.eclipse.jetty.client.api">Response.HeaderListener</a></code>, <code><a href="../client/api/Response.HeadersListener.html" title="interface in org.eclipse.jetty.client.api">Response.HeadersListener</a></code>, <code><a href="../client/api/Response.Listener.html" title="interface in org.eclipse.jetty.client.api">Response.Listener</a></code>, <code><a href="../client/api/Response.ResponseListener.html" title="interface in org.eclipse.jetty.client.api">Response.ResponseListener</a></code>, <code><a href="../client/api/Response.SuccessListener.html" title="interface in org.eclipse.jetty.client.api">Response.SuccessListener</a></code></dd>
</dl>
<dl>
<dt>Enclosing class:</dt>
<dd><a href="ProxyServlet.html" title="class in org.eclipse.jetty.proxy">ProxyServlet</a></dd>
</dl>
<hr>
<pre>protected class <span class="typeNameLabel">ProxyServlet.ProxyResponseListener</span>
extends <a href="../client/api/Response.Listener.Adapter.html" title="class in org.eclipse.jetty.client.api">Response.Listener.Adapter</a></pre>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="nested.class.summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<ul class="blockList">
<li class="blockList"><a id="nested.classes.inherited.from.class.org.eclipse.jetty.client.api.Response.Listener">
<!-- -->
</a>
<h3>Nested classes/interfaces inherited from interface&nbsp;org.eclipse.jetty.client.api.<a href="../client/api/Response.Listener.html" title="interface in org.eclipse.jetty.client.api">Response.Listener</a></h3>
<code><a href="../client/api/Response.Listener.Adapter.html" title="class in org.eclipse.jetty.client.api">Response.Listener.Adapter</a></code></li>
</ul>
</li>
</ul>
</section>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier</th>
<th class="colSecond" scope="col">Constructor</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected </code></td>
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse)">ProxyResponseListener</a></span>&#8203;(javax.servlet.http.HttpServletRequest&nbsp;request,
javax.servlet.http.HttpServletResponse&nbsp;response)</code></th>
<td class="colLast">&nbsp;</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="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete 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>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#onBegin(org.eclipse.jetty.client.api.Response)">onBegin</a></span>&#8203;(<a href="../client/api/Response.html" title="interface in org.eclipse.jetty.client.api">Response</a>&nbsp;proxyResponse)</code></th>
<td class="colLast">
<div class="block">Callback method invoked when the response line containing HTTP version,
HTTP status code and reason has been received and parsed.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#onComplete(org.eclipse.jetty.client.api.Result)">onComplete</a></span>&#8203;(<a href="../client/api/Result.html" title="class in org.eclipse.jetty.client.api">Result</a>&nbsp;result)</code></th>
<td class="colLast">
<div class="block">Callback method invoked when the request <em><b>and</b></em> the response have been processed,
either successfully or not.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#onContent(org.eclipse.jetty.client.api.Response,java.nio.ByteBuffer,org.eclipse.jetty.util.Callback)">onContent</a></span>&#8203;(<a href="../client/api/Response.html" title="interface in org.eclipse.jetty.client.api">Response</a>&nbsp;proxyResponse,
java.nio.ByteBuffer&nbsp;content,
<a href="../util/Callback.html" title="interface in org.eclipse.jetty.util">Callback</a>&nbsp;callback)</code></th>
<td class="colLast">
<div class="block">Callback method invoked when the response content has been received, parsed and there is demand.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#onHeaders(org.eclipse.jetty.client.api.Response)">onHeaders</a></span>&#8203;(<a href="../client/api/Response.html" title="interface in org.eclipse.jetty.client.api">Response</a>&nbsp;proxyResponse)</code></th>
<td class="colLast">
<div class="block">Callback method invoked when all the response headers have been received and parsed.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.org.eclipse.jetty.client.api.Response.AsyncContentListener">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.eclipse.jetty.client.api.<a href="../client/api/Response.AsyncContentListener.html" title="interface in org.eclipse.jetty.client.api">Response.AsyncContentListener</a></h3>
<code><a href="../client/api/Response.AsyncContentListener.html#onContent(org.eclipse.jetty.client.api.Response,java.util.function.LongConsumer,java.nio.ByteBuffer,org.eclipse.jetty.util.Callback)">onContent</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.org.eclipse.jetty.client.api.Response.DemandedContentListener">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.eclipse.jetty.client.api.<a href="../client/api/Response.DemandedContentListener.html" title="interface in org.eclipse.jetty.client.api">Response.DemandedContentListener</a></h3>
<code><a href="../client/api/Response.DemandedContentListener.html#onBeforeContent(org.eclipse.jetty.client.api.Response,java.util.function.LongConsumer)">onBeforeContent</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.org.eclipse.jetty.client.api.Response.Listener">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.eclipse.jetty.client.api.<a href="../client/api/Response.Listener.html" title="interface in org.eclipse.jetty.client.api">Response.Listener</a></h3>
<code><a href="../client/api/Response.Listener.html#onContent(org.eclipse.jetty.client.api.Response,java.nio.ByteBuffer)">onContent</a>, <a href="../client/api/Response.Listener.html#onFailure(org.eclipse.jetty.client.api.Response,java.lang.Throwable)">onFailure</a>, <a href="../client/api/Response.Listener.html#onHeader(org.eclipse.jetty.client.api.Response,org.eclipse.jetty.http.HttpField)">onHeader</a>, <a href="../client/api/Response.Listener.html#onSuccess(org.eclipse.jetty.client.api.Response)">onSuccess</a></code></li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a id="&lt;init&gt;(javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>ProxyResponseListener</h4>
<pre>protected&nbsp;ProxyResponseListener&#8203;(javax.servlet.http.HttpServletRequest&nbsp;request,
javax.servlet.http.HttpServletResponse&nbsp;response)</pre>
</li>
</ul>
</li>
</ul>
</section>
<!-- ============ METHOD DETAIL ========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="onBegin(org.eclipse.jetty.client.api.Response)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>onBegin</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;onBegin&#8203;(<a href="../client/api/Response.html" title="interface in org.eclipse.jetty.client.api">Response</a>&nbsp;proxyResponse)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../client/api/Response.BeginListener.html#onBegin(org.eclipse.jetty.client.api.Response)">Response.BeginListener</a></code></span></div>
<div class="block">Callback method invoked when the response line containing HTTP version,
HTTP status code and reason has been received and parsed.
<p>
This method is the best approximation to detect when the first bytes of the response arrived to the client.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>proxyResponse</code> - the response containing the response line data</dd>
</dl>
</li>
</ul>
<a id="onHeaders(org.eclipse.jetty.client.api.Response)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>onHeaders</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;onHeaders&#8203;(<a href="../client/api/Response.html" title="interface in org.eclipse.jetty.client.api">Response</a>&nbsp;proxyResponse)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../client/api/Response.HeadersListener.html#onHeaders(org.eclipse.jetty.client.api.Response)">Response.HeadersListener</a></code></span></div>
<div class="block">Callback method invoked when all the response headers have been received and parsed.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>proxyResponse</code> - the response containing the response line data and the headers</dd>
</dl>
</li>
</ul>
<a id="onContent(org.eclipse.jetty.client.api.Response,java.nio.ByteBuffer,org.eclipse.jetty.util.Callback)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>onContent</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;onContent&#8203;(<a href="../client/api/Response.html" title="interface in org.eclipse.jetty.client.api">Response</a>&nbsp;proxyResponse,
java.nio.ByteBuffer&nbsp;content,
<a href="../util/Callback.html" title="interface in org.eclipse.jetty.util">Callback</a>&nbsp;callback)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../client/api/Response.AsyncContentListener.html#onContent(org.eclipse.jetty.client.api.Response,java.nio.ByteBuffer,org.eclipse.jetty.util.Callback)">Response.AsyncContentListener</a></code></span></div>
<div class="block">Callback method invoked when the response content has been received, parsed and there is demand.
The <code>callback</code> object should be succeeded to signal that the
<code>content</code> buffer has been consumed and to demand more content.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>proxyResponse</code> - the response containing the response line data and the headers</dd>
<dd><code>content</code> - the content bytes received</dd>
<dd><code>callback</code> - the callback to call when the content is consumed and to demand more content</dd>
</dl>
</li>
</ul>
<a id="onComplete(org.eclipse.jetty.client.api.Result)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>onComplete</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;onComplete&#8203;(<a href="../client/api/Result.html" title="class in org.eclipse.jetty.client.api">Result</a>&nbsp;result)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../client/api/Response.CompleteListener.html#onComplete(org.eclipse.jetty.client.api.Result)">Response.CompleteListener</a></code></span></div>
<div class="block">Callback method invoked when the request <em><b>and</b></em> the response have been processed,
either successfully or not.
<p>
The <code>result</code> parameter contains the request, the response, and eventual failures.
<p>
Requests may complete <em>after</em> response, for example in case of big uploads that are
discarded or read asynchronously by the server.
This method is always invoked <em>after</em> <a href="../client/api/Response.SuccessListener.html#onSuccess(org.eclipse.jetty.client.api.Response)"><code>Response.SuccessListener.onSuccess(Response)</code></a> or
<a href="../client/api/Response.FailureListener.html#onFailure(org.eclipse.jetty.client.api.Response,java.lang.Throwable)"><code>Response.FailureListener.onFailure(Response, Throwable)</code></a>, and only when request indicates that
it is completed.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>result</code> - the result of the request / response exchange</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/ProxyServlet.ProxyResponseListener.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><a href="#constructor.summary">Constr</a>&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><a href="#constructor.detail">Constr</a>&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>