blob: d8d0162a7ff6cc850b7ec342511a24c6f47134e5 [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (11.0.9.1) on Mon Dec 07 10:59:53 CST 2020 -->
<title>Uses of Interface org.eclipse.jetty.websocket.core.server.WebSocketNegotiator (Eclipse Jetty API Doc - v11.0.0)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2020-12-07">
<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="Uses of Interface org.eclipse.jetty.websocket.core.server.WebSocketNegotiator (Eclipse Jetty API Doc - v11.0.0)";
}
}
catch(err) {
}
//-->
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><a href="../WebSocketNegotiator.html" title="interface in org.eclipse.jetty.websocket.core.server">Class</a></li>
<li class="navBarCell1Rev">Use</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>
<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>
<main role="main">
<div class="header">
<h2 title="Uses of Interface org.eclipse.jetty.websocket.core.server.WebSocketNegotiator" class="title">Uses of Interface<br>org.eclipse.jetty.websocket.core.server.WebSocketNegotiator</h2>
</div>
<div class="classUseContainer">
<ul class="blockList">
<li class="blockList">
<table class="useSummary">
<caption><span>Packages that use <a href="../WebSocketNegotiator.html" title="interface in org.eclipse.jetty.websocket.core.server">WebSocketNegotiator</a></span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Package</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="#org.eclipse.jetty.websocket.core.server">org.eclipse.jetty.websocket.core.server</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="#org.eclipse.jetty.websocket.core.server.internal">org.eclipse.jetty.websocket.core.server.internal</a></th>
<td class="colLast">&nbsp;</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<ul class="blockList">
<li class="blockList">
<section role="region"><a id="org.eclipse.jetty.websocket.core.server">
<!-- -->
</a>
<h3>Uses of <a href="../WebSocketNegotiator.html" title="interface in org.eclipse.jetty.websocket.core.server">WebSocketNegotiator</a> in <a href="../package-summary.html">org.eclipse.jetty.websocket.core.server</a></h3>
<table class="useSummary">
<caption><span>Classes in <a href="../package-summary.html">org.eclipse.jetty.websocket.core.server</a> that implement <a href="../WebSocketNegotiator.html" title="interface in org.eclipse.jetty.websocket.core.server">WebSocketNegotiator</a></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>
<tbody>
<tr class="altColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../WebSocketNegotiator.AbstractNegotiator.html" title="class in org.eclipse.jetty.websocket.core.server">WebSocketNegotiator.AbstractNegotiator</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
</tbody>
</table>
<table class="useSummary">
<caption><span>Methods in <a href="../package-summary.html">org.eclipse.jetty.websocket.core.server</a> that return <a href="../WebSocketNegotiator.html" title="interface in org.eclipse.jetty.websocket.core.server">WebSocketNegotiator</a></span><span class="tabEnd">&nbsp;</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>
<tbody>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../WebSocketNegotiator.html" title="interface in org.eclipse.jetty.websocket.core.server">WebSocketNegotiator</a></code></td>
<th class="colSecond" scope="row"><span class="typeNameLabel">WebSocketNegotiator.</span><code><span class="memberNameLink"><a href="../WebSocketNegotiator.html#from(java.util.function.Function)">from</a></span>&#8203;(java.util.function.Function&lt;<a href="../WebSocketNegotiation.html" title="class in org.eclipse.jetty.websocket.core.server">WebSocketNegotiation</a>,&#8203;<a href="../../FrameHandler.html" title="interface in org.eclipse.jetty.websocket.core">FrameHandler</a>&gt;&nbsp;negotiate)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="../WebSocketNegotiator.html" title="interface in org.eclipse.jetty.websocket.core.server">WebSocketNegotiator</a></code></td>
<th class="colSecond" scope="row"><span class="typeNameLabel">WebSocketNegotiator.</span><code><span class="memberNameLink"><a href="../WebSocketNegotiator.html#from(java.util.function.Function,org.eclipse.jetty.websocket.core.Configuration.Customizer)">from</a></span>&#8203;(java.util.function.Function&lt;<a href="../WebSocketNegotiation.html" title="class in org.eclipse.jetty.websocket.core.server">WebSocketNegotiation</a>,&#8203;<a href="../../FrameHandler.html" title="interface in org.eclipse.jetty.websocket.core">FrameHandler</a>&gt;&nbsp;negotiate,
<a href="../../Configuration.Customizer.html" title="interface in org.eclipse.jetty.websocket.core">Configuration.Customizer</a>&nbsp;customizer)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../WebSocketNegotiator.html" title="interface in org.eclipse.jetty.websocket.core.server">WebSocketNegotiator</a></code></td>
<th class="colSecond" scope="row"><span class="typeNameLabel">WebSocketMappings.</span><code><span class="memberNameLink"><a href="../WebSocketMappings.html#getMatchedNegotiator(java.lang.String,java.util.function.Consumer)">getMatchedNegotiator</a></span>&#8203;(java.lang.String&nbsp;target,
java.util.function.Consumer&lt;<a href="../../../../http/pathmap/PathSpec.html" title="interface in org.eclipse.jetty.http.pathmap">PathSpec</a>&gt;&nbsp;pathSpecConsumer)</code></th>
<td class="colLast">
<div class="block">Get the matching <a href="../../../../http/pathmap/MappedResource.html" title="class in org.eclipse.jetty.http.pathmap"><code>MappedResource</code></a> for the provided target.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../WebSocketNegotiator.html" title="interface in org.eclipse.jetty.websocket.core.server">WebSocketNegotiator</a></code></td>
<th class="colSecond" scope="row"><span class="typeNameLabel">WebSocketMappings.</span><code><span class="memberNameLink"><a href="../WebSocketMappings.html#getWebSocketNegotiator(org.eclipse.jetty.http.pathmap.PathSpec)">getWebSocketNegotiator</a></span>&#8203;(<a href="../../../../http/pathmap/PathSpec.html" title="interface in org.eclipse.jetty.http.pathmap">PathSpec</a>&nbsp;pathSpec)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
</tbody>
</table>
<table class="useSummary">
<caption><span>Methods in <a href="../package-summary.html">org.eclipse.jetty.websocket.core.server</a> with parameters of type <a href="../WebSocketNegotiator.html" title="interface in org.eclipse.jetty.websocket.core.server">WebSocketNegotiator</a></span><span class="tabEnd">&nbsp;</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>
<tbody>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><span class="typeNameLabel">WebSocketMappings.</span><code><span class="memberNameLink"><a href="../WebSocketMappings.html#addMapping(org.eclipse.jetty.http.pathmap.PathSpec,org.eclipse.jetty.websocket.core.server.WebSocketNegotiator)">addMapping</a></span>&#8203;(<a href="../../../../http/pathmap/PathSpec.html" title="interface in org.eclipse.jetty.http.pathmap">PathSpec</a>&nbsp;pathSpec,
<a href="../WebSocketNegotiator.html" title="interface in org.eclipse.jetty.websocket.core.server">WebSocketNegotiator</a>&nbsp;negotiator)</code></th>
<td class="colLast">
<div class="block">Manually add a WebSocket mapping.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><span class="typeNameLabel">WebSocketUpgradeHandler.</span><code><span class="memberNameLink"><a href="../WebSocketUpgradeHandler.html#addMapping(java.lang.String,org.eclipse.jetty.websocket.core.server.WebSocketNegotiator)">addMapping</a></span>&#8203;(java.lang.String&nbsp;pathSpec,
<a href="../WebSocketNegotiator.html" title="interface in org.eclipse.jetty.websocket.core.server">WebSocketNegotiator</a>&nbsp;negotiator)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><span class="typeNameLabel">WebSocketUpgradeHandler.</span><code><span class="memberNameLink"><a href="../WebSocketUpgradeHandler.html#addMapping(org.eclipse.jetty.http.pathmap.PathSpec,org.eclipse.jetty.websocket.core.server.WebSocketNegotiator)">addMapping</a></span>&#8203;(<a href="../../../../http/pathmap/PathSpec.html" title="interface in org.eclipse.jetty.http.pathmap">PathSpec</a>&nbsp;pathSpec,
<a href="../WebSocketNegotiator.html" title="interface in org.eclipse.jetty.websocket.core.server">WebSocketNegotiator</a>&nbsp;negotiator)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
</tbody>
</table>
</section>
</li>
<li class="blockList">
<section role="region"><a id="org.eclipse.jetty.websocket.core.server.internal">
<!-- -->
</a>
<h3>Uses of <a href="../WebSocketNegotiator.html" title="interface in org.eclipse.jetty.websocket.core.server">WebSocketNegotiator</a> in <a href="../internal/package-summary.html">org.eclipse.jetty.websocket.core.server.internal</a></h3>
<table class="useSummary">
<caption><span>Classes in <a href="../internal/package-summary.html">org.eclipse.jetty.websocket.core.server.internal</a> that implement <a href="../WebSocketNegotiator.html" title="interface in org.eclipse.jetty.websocket.core.server">WebSocketNegotiator</a></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>
<tbody>
<tr class="altColor">
<td class="colFirst"><code>class&nbsp;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../internal/CreatorNegotiator.html" title="class in org.eclipse.jetty.websocket.core.server.internal">CreatorNegotiator</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
</tbody>
</table>
<table class="useSummary">
<caption><span>Methods in <a href="../internal/package-summary.html">org.eclipse.jetty.websocket.core.server.internal</a> with parameters of type <a href="../WebSocketNegotiator.html" title="interface in org.eclipse.jetty.websocket.core.server">WebSocketNegotiator</a></span><span class="tabEnd">&nbsp;</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>
<tbody>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><span class="typeNameLabel">AbstractHandshaker.</span><code><span class="memberNameLink"><a href="../internal/AbstractHandshaker.html#upgradeRequest(org.eclipse.jetty.websocket.core.server.WebSocketNegotiator,jakarta.servlet.http.HttpServletRequest,jakarta.servlet.http.HttpServletResponse,org.eclipse.jetty.websocket.core.WebSocketComponents,org.eclipse.jetty.websocket.core.Configuration.Customizer)">upgradeRequest</a></span>&#8203;(<a href="../WebSocketNegotiator.html" title="interface in org.eclipse.jetty.websocket.core.server">WebSocketNegotiator</a>&nbsp;negotiator,
jakarta.servlet.http.HttpServletRequest&nbsp;request,
jakarta.servlet.http.HttpServletResponse&nbsp;response,
<a href="../../WebSocketComponents.html" title="class in org.eclipse.jetty.websocket.core">WebSocketComponents</a>&nbsp;components,
<a href="../../Configuration.Customizer.html" title="interface in org.eclipse.jetty.websocket.core">Configuration.Customizer</a>&nbsp;defaultCustomizer)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><span class="typeNameLabel">Handshaker.</span><code><span class="memberNameLink"><a href="../internal/Handshaker.html#upgradeRequest(org.eclipse.jetty.websocket.core.server.WebSocketNegotiator,jakarta.servlet.http.HttpServletRequest,jakarta.servlet.http.HttpServletResponse,org.eclipse.jetty.websocket.core.WebSocketComponents,org.eclipse.jetty.websocket.core.Configuration.Customizer)">upgradeRequest</a></span>&#8203;(<a href="../WebSocketNegotiator.html" title="interface in org.eclipse.jetty.websocket.core.server">WebSocketNegotiator</a>&nbsp;negotiator,
jakarta.servlet.http.HttpServletRequest&nbsp;request,
jakarta.servlet.http.HttpServletResponse&nbsp;response,
<a href="../../WebSocketComponents.html" title="class in org.eclipse.jetty.websocket.core">WebSocketComponents</a>&nbsp;components,
<a href="../../Configuration.Customizer.html" title="interface in org.eclipse.jetty.websocket.core">Configuration.Customizer</a>&nbsp;defaultCustomizer)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><span class="typeNameLabel">HandshakerSelector.</span><code><span class="memberNameLink"><a href="../internal/HandshakerSelector.html#upgradeRequest(org.eclipse.jetty.websocket.core.server.WebSocketNegotiator,jakarta.servlet.http.HttpServletRequest,jakarta.servlet.http.HttpServletResponse,org.eclipse.jetty.websocket.core.WebSocketComponents,org.eclipse.jetty.websocket.core.Configuration.Customizer)">upgradeRequest</a></span>&#8203;(<a href="../WebSocketNegotiator.html" title="interface in org.eclipse.jetty.websocket.core.server">WebSocketNegotiator</a>&nbsp;negotiator,
jakarta.servlet.http.HttpServletRequest&nbsp;request,
jakarta.servlet.http.HttpServletResponse&nbsp;response,
<a href="../../WebSocketComponents.html" title="class in org.eclipse.jetty.websocket.core">WebSocketComponents</a>&nbsp;components,
<a href="../../Configuration.Customizer.html" title="interface in org.eclipse.jetty.websocket.core">Configuration.Customizer</a>&nbsp;defaultCustomizer)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
</tbody>
</table>
</section>
</li>
</ul>
</li>
</ul>
</div>
</main>
<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><a href="../WebSocketNegotiator.html" title="interface in org.eclipse.jetty.websocket.core.server">Class</a></li>
<li class="navBarCell1Rev">Use</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>
<a id="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
<p class="legalCopy"><small>Copyright &#169; 1995&#x2013;2020 <a href="https://webtide.com">Webtide</a>. All rights reserved.</small></p>
</footer>
</body>
</html>