blob: e100cf118e29d561c168b8881cb2d886c2ba235e [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (11.0.13) on Tue Feb 08 12:41:33 CST 2022 -->
<title>ClientConnector.Configurator (Eclipse Jetty API Doc - v11.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="ClientConnector.Configurator (Eclipse Jetty API Doc - v11.0.8)";
}
}
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 = 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/ClientConnector.Configurator.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.io</a></div>
<h2 title="Class ClientConnector.Configurator" class="title">Class ClientConnector.Configurator</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.eclipse.jetty.io.ClientConnector.Configurator</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><code><a href="../quic/client/QuicClientConnectorConfigurator.html" title="class in org.eclipse.jetty.quic.client">QuicClientConnectorConfigurator</a></code></dd>
</dl>
<dl>
<dt>Enclosing class:</dt>
<dd><a href="ClientConnector.html" title="class in org.eclipse.jetty.io">ClientConnector</a></dd>
</dl>
<hr>
<pre>public static class <span class="typeNameLabel">ClientConnector.Configurator</span>
extends java.lang.Object</pre>
<div class="block"><p>Configures a <a href="ClientConnector.html" title="class in org.eclipse.jetty.io"><code>ClientConnector</code></a>.</p></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">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="ClientConnector.Configurator.ChannelWithAddress.html" title="class in org.eclipse.jetty.io">ClientConnector.Configurator.ChannelWithAddress</a></span></code></th>
<td class="colLast">
<div class="block">A pair/record holding a <code>SelectableChannel</code> and a <code>SocketAddress</code> to connect to.</div>
</td>
</tr>
</table>
</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">Constructor</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E()">Configurator</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="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>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isIntrinsicallySecure(org.eclipse.jetty.io.ClientConnector,java.net.SocketAddress)">isIntrinsicallySecure</a></span>&#8203;(<a href="ClientConnector.html" title="class in org.eclipse.jetty.io">ClientConnector</a>&nbsp;clientConnector,
java.net.SocketAddress&nbsp;address)</code></th>
<td class="colLast">
<div class="block">Returns whether the connection to a given <code>SocketAddress</code> is intrinsically secure.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="ClientConnector.Configurator.ChannelWithAddress.html" title="class in org.eclipse.jetty.io">ClientConnector.Configurator.ChannelWithAddress</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#newChannelWithAddress(org.eclipse.jetty.io.ClientConnector,java.net.SocketAddress,java.util.Map)">newChannelWithAddress</a></span>&#8203;(<a href="ClientConnector.html" title="class in org.eclipse.jetty.io">ClientConnector</a>&nbsp;clientConnector,
java.net.SocketAddress&nbsp;address,
java.util.Map&lt;java.lang.String,&#8203;java.lang.Object&gt;&nbsp;context)</code></th>
<td class="colLast">
<div class="block">Creates a new <code>SocketChannel</code> to connect to a <code>SocketAddress</code>
derived from the input socket address.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="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.io.ClientConnector,java.net.SocketAddress,org.eclipse.jetty.io.EndPoint,java.util.Map)">newConnection</a></span>&#8203;(<a href="ClientConnector.html" title="class in org.eclipse.jetty.io">ClientConnector</a>&nbsp;clientConnector,
java.net.SocketAddress&nbsp;address,
<a href="EndPoint.html" title="interface in org.eclipse.jetty.io">EndPoint</a>&nbsp;endPoint,
java.util.Map&lt;java.lang.String,&#8203;java.lang.Object&gt;&nbsp;context)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="EndPoint.html" title="interface in org.eclipse.jetty.io">EndPoint</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#newEndPoint(org.eclipse.jetty.io.ClientConnector,java.net.SocketAddress,java.nio.channels.SelectableChannel,org.eclipse.jetty.io.ManagedSelector,java.nio.channels.SelectionKey)">newEndPoint</a></span>&#8203;(<a href="ClientConnector.html" title="class in org.eclipse.jetty.io">ClientConnector</a>&nbsp;clientConnector,
java.net.SocketAddress&nbsp;address,
java.nio.channels.SelectableChannel&nbsp;selectable,
<a href="ManagedSelector.html" title="class in org.eclipse.jetty.io">ManagedSelector</a>&nbsp;selector,
java.nio.channels.SelectionKey&nbsp;selectionKey)</code></th>
<td class="colLast">&nbsp;</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>
</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;()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>Configurator</h4>
<pre>public&nbsp;Configurator()</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="isIntrinsicallySecure(org.eclipse.jetty.io.ClientConnector,java.net.SocketAddress)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isIntrinsicallySecure</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;isIntrinsicallySecure&#8203;(<a href="ClientConnector.html" title="class in org.eclipse.jetty.io">ClientConnector</a>&nbsp;clientConnector,
java.net.SocketAddress&nbsp;address)</pre>
<div class="block"><p>Returns whether the connection to a given <code>SocketAddress</code> is intrinsically secure.</p>
<p>A protocol such as HTTP/1.1 can be transported by TCP; however, TCP is not secure because
it does not offer any encryption.</p>
<p>Encryption is provided by using TLS to wrap the HTTP/1.1 bytes, and then transporting the
TLS bytes over TCP.</p>
<p>On the other hand, protocols such as QUIC are intrinsically secure, and therefore it is
not necessary to wrap the HTTP/1.1 bytes with TLS: the HTTP/1.1 bytes are transported over
QUIC in an intrinsically secure way.</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>clientConnector</code> - the ClientConnector</dd>
<dd><code>address</code> - the SocketAddress to connect to</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>whether the connection to the given SocketAddress is intrinsically secure</dd>
</dl>
</li>
</ul>
<a id="newChannelWithAddress(org.eclipse.jetty.io.ClientConnector,java.net.SocketAddress,java.util.Map)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>newChannelWithAddress</h4>
<pre class="methodSignature">public&nbsp;<a href="ClientConnector.Configurator.ChannelWithAddress.html" title="class in org.eclipse.jetty.io">ClientConnector.Configurator.ChannelWithAddress</a>&nbsp;newChannelWithAddress&#8203;(<a href="ClientConnector.html" title="class in org.eclipse.jetty.io">ClientConnector</a>&nbsp;clientConnector,
java.net.SocketAddress&nbsp;address,
java.util.Map&lt;java.lang.String,&#8203;java.lang.Object&gt;&nbsp;context)
throws java.io.IOException</pre>
<div class="block"><p>Creates a new <code>SocketChannel</code> to connect to a <code>SocketAddress</code>
derived from the input socket address.</p>
<p>The input socket address represents the destination socket address to
connect to, as it is typically specified by a URI authority, for example
<code>localhost:8080</code> if the URI is <code>http://localhost:8080/path</code>.</p>
<p>However, the returned socket address may be different as the implementation
may use a Unix-Domain socket address to physically connect to the virtual
destination socket address given as input.</p>
<p>The return type is a pair/record holding the socket channel and the
socket address, with the socket channel not yet connected.
The implementation of this methods must not call
<code>SocketChannel.connect(SocketAddress)</code>, as this is done later,
after configuring the socket, by the <a href="ClientConnector.html" title="class in org.eclipse.jetty.io"><code>ClientConnector</code></a> implementation.</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>address</code> - the destination socket address, typically specified in a URI</dd>
<dd><code>context</code> - the context to create the new socket channel</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a new <code>SocketChannel</code> with an associated <code>SocketAddress</code> to connect to</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.io.IOException</code> - if the socket channel or the socket address cannot be created</dd>
</dl>
</li>
</ul>
<a id="newEndPoint(org.eclipse.jetty.io.ClientConnector,java.net.SocketAddress,java.nio.channels.SelectableChannel,org.eclipse.jetty.io.ManagedSelector,java.nio.channels.SelectionKey)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>newEndPoint</h4>
<pre class="methodSignature">public&nbsp;<a href="EndPoint.html" title="interface in org.eclipse.jetty.io">EndPoint</a>&nbsp;newEndPoint&#8203;(<a href="ClientConnector.html" title="class in org.eclipse.jetty.io">ClientConnector</a>&nbsp;clientConnector,
java.net.SocketAddress&nbsp;address,
java.nio.channels.SelectableChannel&nbsp;selectable,
<a href="ManagedSelector.html" title="class in org.eclipse.jetty.io">ManagedSelector</a>&nbsp;selector,
java.nio.channels.SelectionKey&nbsp;selectionKey)</pre>
</li>
</ul>
<a id="newConnection(org.eclipse.jetty.io.ClientConnector,java.net.SocketAddress,org.eclipse.jetty.io.EndPoint,java.util.Map)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>newConnection</h4>
<pre class="methodSignature">public&nbsp;<a href="Connection.html" title="interface in org.eclipse.jetty.io">Connection</a>&nbsp;newConnection&#8203;(<a href="ClientConnector.html" title="class in org.eclipse.jetty.io">ClientConnector</a>&nbsp;clientConnector,
java.net.SocketAddress&nbsp;address,
<a href="EndPoint.html" title="interface in org.eclipse.jetty.io">EndPoint</a>&nbsp;endPoint,
java.util.Map&lt;java.lang.String,&#8203;java.lang.Object&gt;&nbsp;context)
throws java.io.IOException</pre>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.io.IOException</code></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/ClientConnector.Configurator.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;2022 <a href="https://webtide.com">Webtide</a>. All rights reserved.</small></p>
</footer>
</body>
</html>