blob: c2487e5a4874df834a7e43c6cb8b60c2ebe68b0c [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>ConnectionFactory (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="ConnectionFactory (Eclipse Jetty API Doc - v10.0.8)";
}
}
catch(err) {
}
//-->
var data = {"i0":6,"i1":6,"i2":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
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><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/ConnectionFactory.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>Constr&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>Constr&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.server</a></div>
<h2 title="Interface ConnectionFactory" class="title">Interface ConnectionFactory</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Known Subinterfaces:</dt>
<dd><code><a href="ConnectionFactory.Configuring.html" title="interface in org.eclipse.jetty.server">ConnectionFactory.Configuring</a></code>, <code><a href="ConnectionFactory.Detecting.html" title="interface in org.eclipse.jetty.server">ConnectionFactory.Detecting</a></code>, <code><a href="ConnectionFactory.Upgrading.html" title="interface in org.eclipse.jetty.server">ConnectionFactory.Upgrading</a></code></dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><code><a href="AbstractConnectionFactory.html" title="class in org.eclipse.jetty.server">AbstractConnectionFactory</a></code>, <code><a href="../http2/server/AbstractHTTP2ServerConnectionFactory.html" title="class in org.eclipse.jetty.http2.server">AbstractHTTP2ServerConnectionFactory</a></code>, <code><a href="../http3/server/AbstractHTTP3ServerConnectionFactory.html" title="class in org.eclipse.jetty.http3.server">AbstractHTTP3ServerConnectionFactory</a></code>, <code><a href="../alpn/server/ALPNServerConnectionFactory.html" title="class in org.eclipse.jetty.alpn.server">ALPNServerConnectionFactory</a></code>, <code><a href="DetectorConnectionFactory.html" title="class in org.eclipse.jetty.server">DetectorConnectionFactory</a></code>, <code><a href="../http2/server/HTTP2CServerConnectionFactory.html" title="class in org.eclipse.jetty.http2.server">HTTP2CServerConnectionFactory</a></code>, <code><a href="../http2/server/HTTP2ServerConnectionFactory.html" title="class in org.eclipse.jetty.http2.server">HTTP2ServerConnectionFactory</a></code>, <code><a href="../http3/server/HTTP3ServerConnectionFactory.html" title="class in org.eclipse.jetty.http3.server">HTTP3ServerConnectionFactory</a></code>, <code><a href="HttpConnectionFactory.html" title="class in org.eclipse.jetty.server">HttpConnectionFactory</a></code>, <code><a href="NegotiatingServerConnectionFactory.html" title="class in org.eclipse.jetty.server">NegotiatingServerConnectionFactory</a></code>, <code><a href="OptionalSslConnectionFactory.html" title="class in org.eclipse.jetty.server">OptionalSslConnectionFactory</a></code>, <code><a href="ProxyConnectionFactory.html" title="class in org.eclipse.jetty.server">ProxyConnectionFactory</a></code>, <code><a href="../http2/server/RawHTTP2ServerConnectionFactory.html" title="class in org.eclipse.jetty.http2.server">RawHTTP2ServerConnectionFactory</a></code>, <code><a href="../http3/server/RawHTTP3ServerConnectionFactory.html" title="class in org.eclipse.jetty.http3.server">RawHTTP3ServerConnectionFactory</a></code>, <code><a href="../fcgi/server/ServerFCGIConnectionFactory.html" title="class in org.eclipse.jetty.fcgi.server">ServerFCGIConnectionFactory</a></code>, <code><a href="SslConnectionFactory.html" title="class in org.eclipse.jetty.server">SslConnectionFactory</a></code></dd>
</dl>
<hr>
<pre>public interface <span class="typeNameLabel">ConnectionFactory</span></pre>
<div class="block">A Factory to create <a href="../io/Connection.html" title="interface in org.eclipse.jetty.io"><code>Connection</code></a> instances for <a href="Connector.html" title="interface in org.eclipse.jetty.server"><code>Connector</code></a>s.
<p>
A Connection factory is responsible for instantiating and configuring a <a href="../io/Connection.html" title="interface in org.eclipse.jetty.io"><code>Connection</code></a> instance
to handle an <a href="../io/EndPoint.html" title="interface in org.eclipse.jetty.io"><code>EndPoint</code></a> accepted by a <a href="Connector.html" title="interface in org.eclipse.jetty.server"><code>Connector</code></a>.
<p>
A ConnectionFactory has a protocol name that represents the protocol of the Connections
created. Example of protocol names include:
<dl>
<dt>http</dt><dd>Creates an HTTP connection that can handle multiple versions of HTTP from 0.9 to 1.1</dd>
<dt>h2</dt><dd>Creates an HTTP/2 connection that handles the HTTP/2 protocol</dd>
<dt>SSL-XYZ</dt><dd>Create an SSL connection chained to a connection obtained from a connection factory
with a protocol "XYZ".</dd>
<dt>SSL-http</dt><dd>Create an SSL connection chained to an HTTP connection (aka https)</dd>
<dt>SSL-ALPN</dt><dd>Create an SSL connection chained to a ALPN connection, that uses a negotiation with
the client to determine the next protocol.</dd>
</dl></div>
</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>
<table class="memberSummary">
<caption><span>Nested Classes</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Interface</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static interface&nbsp;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="ConnectionFactory.Configuring.html" title="interface in org.eclipse.jetty.server">ConnectionFactory.Configuring</a></span></code></th>
<td class="colLast">
<div class="block">A ConnectionFactory that can configure the connector.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static interface&nbsp;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="ConnectionFactory.Detecting.html" title="interface in org.eclipse.jetty.server">ConnectionFactory.Detecting</a></span></code></th>
<td class="colLast">
<div class="block">Connections created by this factory MUST implement <a href="../io/Connection.UpgradeTo.html" title="interface in org.eclipse.jetty.io"><code>Connection.UpgradeTo</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static interface&nbsp;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="ConnectionFactory.Upgrading.html" title="interface in org.eclipse.jetty.server">ConnectionFactory.Upgrading</a></span></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="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract 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>java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getProtocol()">getProtocol</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>java.util.List&lt;java.lang.String&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getProtocols()">getProtocols</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="../io/Connection.html" title="interface in org.eclipse.jetty.io">Connection</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#newConnection(org.eclipse.jetty.server.Connector,org.eclipse.jetty.io.EndPoint)">newConnection</a></span>&#8203;(<a href="Connector.html" title="interface in org.eclipse.jetty.server">Connector</a>&nbsp;connector,
<a href="../io/EndPoint.html" title="interface in org.eclipse.jetty.io">EndPoint</a>&nbsp;endPoint)</code></th>
<td class="colLast">
<div class="block">Creates a new <a href="../io/Connection.html" title="interface in org.eclipse.jetty.io"><code>Connection</code></a> with the given parameters</div>
</td>
</tr>
</table>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="getProtocol()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getProtocol</h4>
<pre class="methodSignature">java.lang.String&nbsp;getProtocol()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>A string representing the primary protocol name.</dd>
</dl>
</li>
</ul>
<a id="getProtocols()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getProtocols</h4>
<pre class="methodSignature">java.util.List&lt;java.lang.String&gt;&nbsp;getProtocols()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>A list of alternative protocol names/versions including the primary protocol.</dd>
</dl>
</li>
</ul>
<a id="newConnection(org.eclipse.jetty.server.Connector,org.eclipse.jetty.io.EndPoint)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>newConnection</h4>
<pre class="methodSignature"><a href="../io/Connection.html" title="interface in org.eclipse.jetty.io">Connection</a>&nbsp;newConnection&#8203;(<a href="Connector.html" title="interface in org.eclipse.jetty.server">Connector</a>&nbsp;connector,
<a href="../io/EndPoint.html" title="interface in org.eclipse.jetty.io">EndPoint</a>&nbsp;endPoint)</pre>
<div class="block"><p>Creates a new <a href="../io/Connection.html" title="interface in org.eclipse.jetty.io"><code>Connection</code></a> with the given parameters</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>connector</code> - The <a href="Connector.html" title="interface in org.eclipse.jetty.server"><code>Connector</code></a> creating this connection</dd>
<dd><code>endPoint</code> - the <a href="../io/EndPoint.html" title="interface in org.eclipse.jetty.io"><code>EndPoint</code></a> associated with the connection</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a new <a href="../io/Connection.html" title="interface in org.eclipse.jetty.io"><code>Connection</code></a></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/ConnectionFactory.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>Constr&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>Constr&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;2022 <a href="https://webtide.com">Webtide</a>. All rights reserved.</small></p>
</footer>
</body>
</html>