| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) on Thu Sep 15 14:12:07 CDT 2022 --> |
| <title>RedirectProtocolHandler (Eclipse Jetty API Doc - v10.0.12)</title> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="dc.created" content="2022-09-15"> |
| <meta name="description" content="declaration: package: org.eclipse.jetty.client, class: RedirectProtocolHandler"> |
| <meta name="generator" content="javadoc/ClassWriterImpl"> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> |
| <script type="text/javascript" src="../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../script-dir/jquery-3.5.1.min.js"></script> |
| <script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> |
| </head> |
| <body class="class-declaration-page"> |
| <script type="text/javascript">var evenRowColor = "even-row-color"; |
| var oddRowColor = "odd-row-color"; |
| var tableTab = "table-tab"; |
| var activeTableTab = "active-table-tab"; |
| var pathtoroot = "../../../../"; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <div class="flex-box"> |
| <header role="banner" class="flex-header"> |
| <nav role="navigation"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="top-nav" id="navbar-top"> |
| <div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> |
| <ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> |
| <li><a href="../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="nav-bar-cell1-rev">Class</li> |
| <li><a href="class-use/RedirectProtocolHandler.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#class">Help</a></li> |
| </ul> |
| </div> |
| <div class="sub-nav"> |
| <div> |
| <ul class="sub-nav-list"> |
| <li>Summary: </li> |
| <li><a href="#nested-class-summary">Nested</a> | </li> |
| <li><a href="#field-summary">Field</a> | </li> |
| <li><a href="#constructor-summary">Constr</a> | </li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li><a href="#field-detail">Field</a> | </li> |
| <li><a href="#constructor-detail">Constr</a> | </li> |
| <li><a href="#method-detail">Method</a></li> |
| </ul> |
| </div> |
| <div class="nav-list-search"><label for="search-input">SEARCH:</label> |
| <input type="text" id="search-input" value="search" disabled="disabled"> |
| <input type="reset" id="reset-button" value="reset" disabled="disabled"> |
| </div> |
| </div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <span class="skip-nav" id="skip-navbar-top"></span></nav> |
| </header> |
| <div class="flex-content"> |
| <main role="main"> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.eclipse.jetty.client</a></div> |
| <h1 title="Class RedirectProtocolHandler" class="title">Class RedirectProtocolHandler</h1> |
| </div> |
| <div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> |
| <div class="inheritance"><a href="api/Response.Listener.Adapter.html" title="class in org.eclipse.jetty.client.api">org.eclipse.jetty.client.api.Response.Listener.Adapter</a> |
| <div class="inheritance">org.eclipse.jetty.client.RedirectProtocolHandler</div> |
| </div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/EventListener.html" title="class or interface in java.util" class="external-link">EventListener</a></code>, <code><a href="api/Response.AsyncContentListener.html" title="interface in org.eclipse.jetty.client.api">Response.AsyncContentListener</a></code>, <code><a href="api/Response.BeginListener.html" title="interface in org.eclipse.jetty.client.api">Response.BeginListener</a></code>, <code><a href="api/Response.CompleteListener.html" title="interface in org.eclipse.jetty.client.api">Response.CompleteListener</a></code>, <code><a href="api/Response.ContentListener.html" title="interface in org.eclipse.jetty.client.api">Response.ContentListener</a></code>, <code><a href="api/Response.DemandedContentListener.html" title="interface in org.eclipse.jetty.client.api">Response.DemandedContentListener</a></code>, <code><a href="api/Response.FailureListener.html" title="interface in org.eclipse.jetty.client.api">Response.FailureListener</a></code>, <code><a href="api/Response.HeaderListener.html" title="interface in org.eclipse.jetty.client.api">Response.HeaderListener</a></code>, <code><a href="api/Response.HeadersListener.html" title="interface in org.eclipse.jetty.client.api">Response.HeadersListener</a></code>, <code><a href="api/Response.Listener.html" title="interface in org.eclipse.jetty.client.api">Response.Listener</a></code>, <code><a href="api/Response.ResponseListener.html" title="interface in org.eclipse.jetty.client.api">Response.ResponseListener</a></code>, <code><a href="api/Response.SuccessListener.html" title="interface in org.eclipse.jetty.client.api">Response.SuccessListener</a></code>, <code><a href="ProtocolHandler.html" title="interface in org.eclipse.jetty.client">ProtocolHandler</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">RedirectProtocolHandler</span> |
| <span class="extends-implements">extends <a href="api/Response.Listener.Adapter.html" title="class in org.eclipse.jetty.client.api">Response.Listener.Adapter</a> |
| implements <a href="ProtocolHandler.html" title="interface in org.eclipse.jetty.client">ProtocolHandler</a></span></div> |
| <div class="block"><p>A protocol handler that handles redirect status codes 301, 302, 303, 307 and 308.</p></div> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <li> |
| <section class="nested-class-summary" id="nested-class-summary"> |
| <h2>Nested Class Summary</h2> |
| <div class="inherited-list"> |
| <h2 id="nested-classes-inherited-from-class-org.eclipse.jetty.client.api.Response.Listener">Nested classes/interfaces inherited from interface org.eclipse.jetty.client.api.<a href="api/Response.Listener.html" title="interface in org.eclipse.jetty.client.api">Response.Listener</a></h2> |
| <code><a href="api/Response.Listener.Adapter.html" title="class in org.eclipse.jetty.client.api">Response.Listener.Adapter</a></code></div> |
| </section> |
| </li> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <li> |
| <section class="field-summary" id="field-summary"> |
| <h2>Field Summary</h2> |
| <div class="caption"><span>Fields</span></div> |
| <div class="summary-table three-column-summary"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Field</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><code>static final <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second even-row-color"><code><a href="#NAME" class="member-name-link">NAME</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| </div> |
| </section> |
| </li> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <li> |
| <section class="constructor-summary" id="constructor-summary"> |
| <h2>Constructor Summary</h2> |
| <div class="caption"><span>Constructors</span></div> |
| <div class="summary-table two-column-summary"> |
| <div class="table-header col-first">Constructor</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(org.eclipse.jetty.client.HttpClient)" class="member-name-link">RedirectProtocolHandler</a><wbr>(<a href="HttpClient.html" title="class in org.eclipse.jetty.client">HttpClient</a> client)</code></div> |
| <div class="col-last even-row-color"> </div> |
| </div> |
| </section> |
| </li> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <li> |
| <section class="method-summary" id="method-summary"> |
| <h2>Method Summary</h2> |
| <div id="method-summary-table"> |
| <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> |
| <div id="method-summary-table.tabpanel" role="tabpanel"> |
| <div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Method</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#accept(org.eclipse.jetty.client.api.Request,org.eclipse.jetty.client.api.Response)" class="member-name-link">accept</a><wbr>(<a href="api/Request.html" title="interface in org.eclipse.jetty.client.api">Request</a> request, |
| <a href="api/Response.html" title="interface in org.eclipse.jetty.client.api">Response</a> response)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Inspects the given <code>request</code> and <code>response</code> |
| to detect whether this protocol handler should handle them.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getName()" class="member-name-link">getName</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="api/Response.Listener.html" title="interface in org.eclipse.jetty.client.api">Response.Listener</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getResponseListener()" class="member-name-link">getResponseListener</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#onComplete(org.eclipse.jetty.client.api.Result)" class="member-name-link">onComplete</a><wbr>(<a href="api/Result.html" title="class in org.eclipse.jetty.client.api">Result</a> result)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Callback method invoked when the request <em><b>and</b></em> the response have been processed, |
| either successfully or not.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#onHeader(org.eclipse.jetty.client.api.Response,org.eclipse.jetty.http.HttpField)" class="member-name-link">onHeader</a><wbr>(<a href="api/Response.html" title="interface in org.eclipse.jetty.client.api">Response</a> response, |
| <a href="../http/HttpField.html" title="class in org.eclipse.jetty.http">HttpField</a> field)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Callback method invoked when a response header has been received and parsed, |
| returning whether the header should be processed or not.</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> |
| <code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-org.eclipse.jetty.client.api.Response.AsyncContentListener">Methods inherited from interface org.eclipse.jetty.client.api.<a href="api/Response.AsyncContentListener.html" title="interface in org.eclipse.jetty.client.api">Response.AsyncContentListener</a></h3> |
| <code><a href="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></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-org.eclipse.jetty.client.api.Response.ContentListener">Methods inherited from interface org.eclipse.jetty.client.api.<a href="api/Response.ContentListener.html" title="interface in org.eclipse.jetty.client.api">Response.ContentListener</a></h3> |
| <code><a href="api/Response.ContentListener.html#onContent(org.eclipse.jetty.client.api.Response,java.nio.ByteBuffer,org.eclipse.jetty.util.Callback)">onContent</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-org.eclipse.jetty.client.api.Response.DemandedContentListener">Methods inherited from interface org.eclipse.jetty.client.api.<a href="api/Response.DemandedContentListener.html" title="interface in org.eclipse.jetty.client.api">Response.DemandedContentListener</a></h3> |
| <code><a href="api/Response.DemandedContentListener.html#onBeforeContent(org.eclipse.jetty.client.api.Response,java.util.function.LongConsumer)">onBeforeContent</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-org.eclipse.jetty.client.api.Response.Listener">Methods inherited from interface org.eclipse.jetty.client.api.<a href="api/Response.Listener.html" title="interface in org.eclipse.jetty.client.api">Response.Listener</a></h3> |
| <code><a href="api/Response.Listener.html#onBegin(org.eclipse.jetty.client.api.Response)">onBegin</a>, <a href="api/Response.Listener.html#onContent(org.eclipse.jetty.client.api.Response,java.nio.ByteBuffer)">onContent</a>, <a href="api/Response.Listener.html#onFailure(org.eclipse.jetty.client.api.Response,java.lang.Throwable)">onFailure</a>, <a href="api/Response.Listener.html#onHeaders(org.eclipse.jetty.client.api.Response)">onHeaders</a>, <a href="api/Response.Listener.html#onSuccess(org.eclipse.jetty.client.api.Response)">onSuccess</a></code></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <li> |
| <section class="field-details" id="field-detail"> |
| <h2>Field Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="NAME"> |
| <h3>NAME</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">NAME</span></div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../constant-values.html#org.eclipse.jetty.client.RedirectProtocolHandler.NAME">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <li> |
| <section class="constructor-details" id="constructor-detail"> |
| <h2>Constructor Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="<init>(org.eclipse.jetty.client.HttpClient)"> |
| <h3>RedirectProtocolHandler</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">RedirectProtocolHandler</span><wbr><span class="parameters">(<a href="HttpClient.html" title="class in org.eclipse.jetty.client">HttpClient</a> client)</span></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li> |
| <section class="method-details" id="method-detail"> |
| <h2>Method Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="getName()"> |
| <h3>getName</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">getName</span>()</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="ProtocolHandler.html#getName()">getName</a></code> in interface <code><a href="ProtocolHandler.html" title="interface in org.eclipse.jetty.client">ProtocolHandler</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>a unique name among protocol handlers</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="accept(org.eclipse.jetty.client.api.Request,org.eclipse.jetty.client.api.Response)"> |
| <h3>accept</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">accept</span><wbr><span class="parameters">(<a href="api/Request.html" title="interface in org.eclipse.jetty.client.api">Request</a> request, |
| <a href="api/Response.html" title="interface in org.eclipse.jetty.client.api">Response</a> response)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="ProtocolHandler.html#accept(org.eclipse.jetty.client.api.Request,org.eclipse.jetty.client.api.Response)">ProtocolHandler</a></code></span></div> |
| <div class="block"><p>Inspects the given <code>request</code> and <code>response</code> |
| to detect whether this protocol handler should handle them.</p> |
| <p>For example, a redirect protocol handler can inspect the |
| response code and return true if it is a redirect response code.</p> |
| <p>This method is being called just after the response line has |
| been parsed, and before the response headers are available.</p></div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="ProtocolHandler.html#accept(org.eclipse.jetty.client.api.Request,org.eclipse.jetty.client.api.Response)">accept</a></code> in interface <code><a href="ProtocolHandler.html" title="interface in org.eclipse.jetty.client">ProtocolHandler</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>request</code> - the request to accept</dd> |
| <dd><code>response</code> - the response to accept</dd> |
| <dt>Returns:</dt> |
| <dd>true if this protocol handler can handle the given request and response</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getResponseListener()"> |
| <h3>getResponseListener</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="api/Response.Listener.html" title="interface in org.eclipse.jetty.client.api">Response.Listener</a></span> <span class="element-name">getResponseListener</span>()</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="ProtocolHandler.html#getResponseListener()">getResponseListener</a></code> in interface <code><a href="ProtocolHandler.html" title="interface in org.eclipse.jetty.client">ProtocolHandler</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>a response listener that will handle the request and response |
| on behalf of the application.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="onHeader(org.eclipse.jetty.client.api.Response,org.eclipse.jetty.http.HttpField)"> |
| <h3>onHeader</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">onHeader</span><wbr><span class="parameters">(<a href="api/Response.html" title="interface in org.eclipse.jetty.client.api">Response</a> response, |
| <a href="../http/HttpField.html" title="class in org.eclipse.jetty.http">HttpField</a> field)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="api/Response.HeaderListener.html#onHeader(org.eclipse.jetty.client.api.Response,org.eclipse.jetty.http.HttpField)">Response.HeaderListener</a></code></span></div> |
| <div class="block">Callback method invoked when a response header has been received and parsed, |
| returning whether the header should be processed or not.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="api/Response.HeaderListener.html#onHeader(org.eclipse.jetty.client.api.Response,org.eclipse.jetty.http.HttpField)">onHeader</a></code> in interface <code><a href="api/Response.HeaderListener.html" title="interface in org.eclipse.jetty.client.api">Response.HeaderListener</a></code></dd> |
| <dt>Specified by:</dt> |
| <dd><code><a href="api/Response.Listener.html#onHeader(org.eclipse.jetty.client.api.Response,org.eclipse.jetty.http.HttpField)">onHeader</a></code> in interface <code><a href="api/Response.Listener.html" title="interface in org.eclipse.jetty.client.api">Response.Listener</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>response</code> - the response containing the response line data and the headers so far</dd> |
| <dd><code>field</code> - the header received</dd> |
| <dt>Returns:</dt> |
| <dd>true to process the header, false to skip processing of the header</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="onComplete(org.eclipse.jetty.client.api.Result)"> |
| <h3>onComplete</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">onComplete</span><wbr><span class="parameters">(<a href="api/Result.html" title="class in org.eclipse.jetty.client.api">Result</a> result)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="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="api/Response.SuccessListener.html#onSuccess(org.eclipse.jetty.client.api.Response)"><code>Response.SuccessListener.onSuccess(Response)</code></a> or |
| <a href="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 class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="api/Response.CompleteListener.html#onComplete(org.eclipse.jetty.client.api.Result)">onComplete</a></code> in interface <code><a href="api/Response.CompleteListener.html" title="interface in org.eclipse.jetty.client.api">Response.CompleteListener</a></code></dd> |
| <dt>Specified by:</dt> |
| <dd><code><a href="api/Response.Listener.html#onComplete(org.eclipse.jetty.client.api.Result)">onComplete</a></code> in interface <code><a href="api/Response.Listener.html" title="interface in org.eclipse.jetty.client.api">Response.Listener</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>result</code> - the result of the request / response exchange</dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| <footer role="contentinfo"> |
| <hr> |
| <p class="legal-copy"><small>Copyright © 1995–2022 <a href="https://webtide.com">Webtide</a>. All rights reserved.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |
