| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) on Thu Sep 15 14:12:07 CDT 2022 --> |
| <title>ConnectionFactory.Upgrading (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.server, interface: ConnectionFactory, interface: Upgrading"> |
| <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/ConnectionFactory.Upgrading.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.server</a></div> |
| <h1 title="Interface ConnectionFactory.Upgrading" class="title">Interface ConnectionFactory.Upgrading</h1> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>All Superinterfaces:</dt> |
| <dd><code><a href="ConnectionFactory.html" title="interface in org.eclipse.jetty.server">ConnectionFactory</a></code></dd> |
| </dl> |
| <dl class="notes"> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><code><a href="../http2/server/HTTP2CServerConnectionFactory.html" title="class in org.eclipse.jetty.http2.server">HTTP2CServerConnectionFactory</a></code></dd> |
| </dl> |
| <dl class="notes"> |
| <dt>Enclosing interface:</dt> |
| <dd><a href="ConnectionFactory.html" title="interface in org.eclipse.jetty.server">ConnectionFactory</a></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public static interface </span><span class="element-name type-name-label">ConnectionFactory.Upgrading</span><span class="extends-implements"> |
| extends <a href="ConnectionFactory.html" title="interface in org.eclipse.jetty.server">ConnectionFactory</a></span></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.server.ConnectionFactory">Nested classes/interfaces inherited from interface org.eclipse.jetty.server.<a href="ConnectionFactory.html" title="interface in org.eclipse.jetty.server">ConnectionFactory</a></h2> |
| <code><a href="ConnectionFactory.Configuring.html" title="interface in org.eclipse.jetty.server">ConnectionFactory.Configuring</a>, <a href="ConnectionFactory.Detecting.html" title="interface in org.eclipse.jetty.server">ConnectionFactory.Detecting</a>, <a href="ConnectionFactory.Upgrading.html" title="interface in org.eclipse.jetty.server">ConnectionFactory.Upgrading</a></code></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><a href="../io/Connection.html" title="interface in org.eclipse.jetty.io">Connection</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#upgradeConnection(org.eclipse.jetty.server.Connector,org.eclipse.jetty.io.EndPoint,org.eclipse.jetty.http.MetaData.Request,org.eclipse.jetty.http.HttpFields.Mutable)" class="member-name-link">upgradeConnection</a><wbr>(<a href="Connector.html" title="interface in org.eclipse.jetty.server">Connector</a> connector, |
| <a href="../io/EndPoint.html" title="interface in org.eclipse.jetty.io">EndPoint</a> endPoint, |
| <a href="../http/MetaData.Request.html" title="class in org.eclipse.jetty.http">MetaData.Request</a> upgradeRequest, |
| <a href="../http/HttpFields.Mutable.html" title="class in org.eclipse.jetty.http">HttpFields.Mutable</a> responseFields)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Create a connection for an upgrade request.</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-org.eclipse.jetty.server.ConnectionFactory">Methods inherited from interface org.eclipse.jetty.server.<a href="ConnectionFactory.html" title="interface in org.eclipse.jetty.server">ConnectionFactory</a></h3> |
| <code><a href="ConnectionFactory.html#getProtocol()">getProtocol</a>, <a href="ConnectionFactory.html#getProtocols()">getProtocols</a>, <a href="ConnectionFactory.html#newConnection(org.eclipse.jetty.server.Connector,org.eclipse.jetty.io.EndPoint)">newConnection</a></code></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="upgradeConnection(org.eclipse.jetty.server.Connector,org.eclipse.jetty.io.EndPoint,org.eclipse.jetty.http.MetaData.Request,org.eclipse.jetty.http.HttpFields.Mutable)"> |
| <h3>upgradeConnection</h3> |
| <div class="member-signature"><span class="return-type"><a href="../io/Connection.html" title="interface in org.eclipse.jetty.io">Connection</a></span> <span class="element-name">upgradeConnection</span><wbr><span class="parameters">(<a href="Connector.html" title="interface in org.eclipse.jetty.server">Connector</a> connector, |
| <a href="../io/EndPoint.html" title="interface in org.eclipse.jetty.io">EndPoint</a> endPoint, |
| <a href="../http/MetaData.Request.html" title="class in org.eclipse.jetty.http">MetaData.Request</a> upgradeRequest, |
| <a href="../http/HttpFields.Mutable.html" title="class in org.eclipse.jetty.http">HttpFields.Mutable</a> responseFields)</span> |
| throws <span class="exceptions"><a href="../http/BadMessageException.html" title="class in org.eclipse.jetty.http">BadMessageException</a></span></div> |
| <div class="block">Create a connection for an upgrade request. |
| <p>This is a variation of <a href="ConnectionFactory.html#newConnection(org.eclipse.jetty.server.Connector,org.eclipse.jetty.io.EndPoint)"><code>ConnectionFactory.newConnection(Connector, EndPoint)</code></a> that can create (and/or customise) |
| a connection for an upgrade request. Implementations may call <a href="ConnectionFactory.html#newConnection(org.eclipse.jetty.server.Connector,org.eclipse.jetty.io.EndPoint)"><code>ConnectionFactory.newConnection(Connector, EndPoint)</code></a> or |
| may construct the connection instance themselves.</p></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>connector</code> - The connector to upgrade for.</dd> |
| <dd><code>endPoint</code> - The endpoint of the connection.</dd> |
| <dd><code>upgradeRequest</code> - The meta data of the upgrade request.</dd> |
| <dd><code>responseFields</code> - The fields to be sent with the 101 response</dd> |
| <dt>Returns:</dt> |
| <dd>Null to indicate that request processing should continue normally without upgrading. A new connection instance to |
| indicate that the upgrade should proceed.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="../http/BadMessageException.html" title="class in org.eclipse.jetty.http">BadMessageException</a></code> - Thrown to indicate the upgrade attempt was illegal and that a bad message response should be sent.</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> |