| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) on Thu Sep 15 14:13:16 CDT 2022 --> |
| <title>HttpUpgrader (Eclipse Jetty API Doc - v11.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, interface: HttpUpgrader"> |
| <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/HttpUpgrader.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>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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="Interface HttpUpgrader" class="title">Interface HttpUpgrader</h1> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><code><a href="../websocket/core/client/internal/HttpUpgraderOverHTTP.html" title="class in org.eclipse.jetty.websocket.core.client.internal">HttpUpgraderOverHTTP</a></code>, <code><a href="../websocket/core/client/internal/HttpUpgraderOverHTTP2.html" title="class in org.eclipse.jetty.websocket.core.client.internal">HttpUpgraderOverHTTP2</a></code>, <code><a href="http/ProtocolHttpUpgrader.html" title="class in org.eclipse.jetty.client.http">ProtocolHttpUpgrader</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">HttpUpgrader</span></div> |
| <div class="block"><p>HttpUpgrader prepares a HTTP request to upgrade from one protocol to another, |
| and implements the upgrade mechanism.</p> |
| <p>The upgrade mechanism can be the |
| <a href="https://tools.ietf.org/html/rfc7230#section-6.7">HTTP/1.1 upgrade mechanism</a> |
| or the |
| <a href="https://tools.ietf.org/html/rfc8441#section-4">HTTP/2 extended CONNECT mechanism</a>.</p> |
| <p>Given the differences among mechanism implementations, a request needs to be |
| prepared before being sent to comply with the mechanism requirements (for example, |
| add required headers, etc.).</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="caption"><span>Nested Classes</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">Interface</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><code>static interface </code></div> |
| <div class="col-second even-row-color"><code><a href="HttpUpgrader.Factory.html" class="type-name-link" title="interface in org.eclipse.jetty.client">HttpUpgrader.Factory</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">A factory for <a href="HttpUpgrader.html" title="interface in org.eclipse.jetty.client"><code>HttpUpgrader</code></a>s.</div> |
| </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-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract 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-tab3"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#prepare(org.eclipse.jetty.client.HttpRequest)" class="member-name-link">prepare</a><wbr>(<a href="HttpRequest.html" title="class in org.eclipse.jetty.client">HttpRequest</a> request)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Prepares the request for the upgrade, for example by setting the HTTP method |
| or by setting HTTP headers required for the upgrade.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#upgrade(org.eclipse.jetty.client.HttpResponse,org.eclipse.jetty.io.EndPoint,org.eclipse.jetty.util.Callback)" class="member-name-link">upgrade</a><wbr>(<a href="HttpResponse.html" title="class in org.eclipse.jetty.client">HttpResponse</a> response, |
| <a href="../io/EndPoint.html" title="interface in org.eclipse.jetty.io">EndPoint</a> endPoint, |
| <a href="../util/Callback.html" title="interface in org.eclipse.jetty.util">Callback</a> callback)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Upgrades the given <code>endPoint</code> to a different protocol.</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li> |
| <section class="method-details" id="method-detail"> |
| <h2>Method Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="prepare(org.eclipse.jetty.client.HttpRequest)"> |
| <h3>prepare</h3> |
| <div class="member-signature"><span class="return-type">void</span> <span class="element-name">prepare</span><wbr><span class="parameters">(<a href="HttpRequest.html" title="class in org.eclipse.jetty.client">HttpRequest</a> request)</span></div> |
| <div class="block"><p>Prepares the request for the upgrade, for example by setting the HTTP method |
| or by setting HTTP headers required for the upgrade.</p></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>request</code> - the request to prepare</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="upgrade(org.eclipse.jetty.client.HttpResponse,org.eclipse.jetty.io.EndPoint,org.eclipse.jetty.util.Callback)"> |
| <h3>upgrade</h3> |
| <div class="member-signature"><span class="return-type">void</span> <span class="element-name">upgrade</span><wbr><span class="parameters">(<a href="HttpResponse.html" title="class in org.eclipse.jetty.client">HttpResponse</a> response, |
| <a href="../io/EndPoint.html" title="interface in org.eclipse.jetty.io">EndPoint</a> endPoint, |
| <a href="../util/Callback.html" title="interface in org.eclipse.jetty.util">Callback</a> callback)</span></div> |
| <div class="block"><p>Upgrades the given <code>endPoint</code> to a different protocol.</p> |
| <p>The success or failure of the upgrade should be communicated via the given <code>callback</code>.</p> |
| <p>An exception thrown by this method is equivalent to failing the callback.</p></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>response</code> - the response with the information about the upgrade</dd> |
| <dd><code>endPoint</code> - the EndPoint to upgrade</dd> |
| <dd><code>callback</code> - a callback to notify of the success or failure of the upgrade</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> |
