Google Git
Sign in
eclipse / www.eclipse.org / jetty / caa63cef1178e162a958a0ce982848d67ac0e16a / . / javadoc / jetty-9 / org / eclipse / jetty / websocket / server / WebSocketUpgradeFilter.html
blob: b13e7293dc209ae8a5738b6898d2b8622f964af7 [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (11.0.10) on Fri Feb 26 09:50:23 CST 2021 -->
<title>WebSocketUpgradeFilter (Jetty :: Project 9.4.38.v20210224 API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2021-02-26">
<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="WebSocketUpgradeFilter (Jetty :: Project 9.4.38.v20210224 API)";
}
}
catch(err) {
}
//-->
var data = {"i0":10,"i1":10,"i2":42,"i3":9,"i4":41,"i5":41,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"],32:["t6","Deprecated Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
var pathtoroot = "../../../../../";
var useModuleDirectories = false;
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/WebSocketUpgradeFilter.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><a href="#field.summary">Field</a>&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><a href="#field.detail">Field</a>&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.websocket.server</a></div>
<h2 title="Class WebSocketUpgradeFilter" class="title">Class WebSocketUpgradeFilter</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.eclipse.jetty.websocket.server.WebSocketUpgradeFilter</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><code>javax.servlet.Filter</code>, <code><a href="../../util/component/Dumpable.html" title="interface in org.eclipse.jetty.util.component">Dumpable</a></code>, <code><a href="MappedWebSocketCreator.html" title="interface in org.eclipse.jetty.websocket.server">MappedWebSocketCreator</a></code></dd>
</dl>
<hr>
<pre><a href="../../util/annotation/ManagedObject.html" title="annotation in org.eclipse.jetty.util.annotation">@ManagedObject</a>("WebSocket Upgrade Filter")
public class <span class="typeNameLabel">WebSocketUpgradeFilter</span>
extends java.lang.Object
implements javax.servlet.Filter, <a href="MappedWebSocketCreator.html" title="interface in org.eclipse.jetty.websocket.server">MappedWebSocketCreator</a>, <a href="../../util/component/Dumpable.html" title="interface in org.eclipse.jetty.util.component">Dumpable</a></pre>
<div class="block">Inline Servlet Filter to capture WebSocket upgrade requests and perform path mappings to <a href="../servlet/WebSocketCreator.html" title="interface in org.eclipse.jetty.websocket.servlet"><code>WebSocketCreator</code></a> objects.</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>
<ul class="blockList">
<li class="blockList"><a id="nested.classes.inherited.from.class.org.eclipse.jetty.util.component.Dumpable">
<!-- -->
</a>
<h3>Nested classes/interfaces inherited from interface&nbsp;org.eclipse.jetty.util.component.<a href="../../util/component/Dumpable.html" title="interface in org.eclipse.jetty.util.component">Dumpable</a></h3>
<code><a href="../../util/component/Dumpable.DumpableContainer.html" title="interface in org.eclipse.jetty.util.component">Dumpable.DumpableContainer</a></code></li>
</ul>
</li>
</ul>
</section>
<!-- =========== FIELD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Field</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#ATTR_KEY">ATTR_KEY</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#CONFIG_ATTRIBUTE_KEY">CONFIG_ATTRIBUTE_KEY</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#CONTEXT_ATTRIBUTE_KEY">CONTEXT_ATTRIBUTE_KEY</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="fields.inherited.from.class.org.eclipse.jetty.util.component.Dumpable">
<!-- -->
</a>
<h3>Fields inherited from interface&nbsp;org.eclipse.jetty.util.component.<a href="../../util/component/Dumpable.html" title="interface in org.eclipse.jetty.util.component">Dumpable</a></h3>
<code><a href="../../util/component/Dumpable.html#KEY">KEY</a></code></li>
</ul>
</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()">WebSocketUpgradeFilter</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(org.eclipse.jetty.websocket.server.NativeWebSocketConfiguration)">WebSocketUpgradeFilter</a></span>&#8203;(<a href="NativeWebSocketConfiguration.html" title="class in org.eclipse.jetty.websocket.server">NativeWebSocketConfiguration</a>&nbsp;configuration)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(org.eclipse.jetty.websocket.server.WebSocketServerFactory)">WebSocketUpgradeFilter</a></span>&#8203;(<a href="WebSocketServerFactory.html" title="class in org.eclipse.jetty.websocket.server">WebSocketServerFactory</a>&nbsp;factory)</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="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></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><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated 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>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#addMapping(java.lang.String,org.eclipse.jetty.websocket.servlet.WebSocketCreator)">addMapping</a></span>&#8203;(java.lang.String&nbsp;spec,
<a href="../servlet/WebSocketCreator.html" title="interface in org.eclipse.jetty.websocket.servlet">WebSocketCreator</a>&nbsp;creator)</code></th>
<td class="colLast">
<div class="block">Add a mapping, of a pathspec to a WebSocketCreator.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#addMapping(org.eclipse.jetty.http.pathmap.PathSpec,org.eclipse.jetty.websocket.servlet.WebSocketCreator)">addMapping</a></span>&#8203;(<a href="../../http/pathmap/PathSpec.html" title="interface in org.eclipse.jetty.http.pathmap">PathSpec</a>&nbsp;spec,
<a href="../servlet/WebSocketCreator.html" title="interface in org.eclipse.jetty.websocket.servlet">WebSocketCreator</a>&nbsp;creator)</code></th>
<td class="colLast">
<div class="block">Add a mapping.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#addMapping(org.eclipse.jetty.websocket.server.pathmap.PathSpec,org.eclipse.jetty.websocket.servlet.WebSocketCreator)">addMapping</a></span>&#8203;(<a href="pathmap/PathSpec.html" title="class in org.eclipse.jetty.websocket.server.pathmap">PathSpec</a>&nbsp;spec,
<a href="../servlet/WebSocketCreator.html" title="interface in org.eclipse.jetty.websocket.servlet">WebSocketCreator</a>&nbsp;creator)</code></th>
<td class="colLast">
<div class="block"><span class="deprecatedLabel">Deprecated.</span>
<div class="deprecationComment">use new <a href="#addMapping(org.eclipse.jetty.http.pathmap.PathSpec,org.eclipse.jetty.websocket.servlet.WebSocketCreator)"><code>addMapping(org.eclipse.jetty.http.pathmap.PathSpec, WebSocketCreator)</code></a> instead</div>
</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>static <a href="WebSocketUpgradeFilter.html" title="class in org.eclipse.jetty.websocket.server">WebSocketUpgradeFilter</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#configure(org.eclipse.jetty.servlet.ServletContextHandler)">configure</a></span>&#8203;(<a href="../../servlet/ServletContextHandler.html" title="class in org.eclipse.jetty.servlet">ServletContextHandler</a>&nbsp;context)</code></th>
<td class="colLast">
<div class="block">Configure the default WebSocketUpgradeFilter.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>static <a href="WebSocketUpgradeFilter.html" title="class in org.eclipse.jetty.websocket.server">WebSocketUpgradeFilter</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#configureContext(javax.servlet.ServletContext)">configureContext</a></span>&#8203;(javax.servlet.ServletContext&nbsp;context)</code></th>
<td class="colLast">
<div class="block"><span class="deprecatedLabel">Deprecated.</span>
<div class="deprecationComment">use <a href="#configureContext(org.eclipse.jetty.servlet.ServletContextHandler)"><code>configureContext(ServletContextHandler)</code></a> instead</div>
</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>static <a href="WebSocketUpgradeFilter.html" title="class in org.eclipse.jetty.websocket.server">WebSocketUpgradeFilter</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#configureContext(org.eclipse.jetty.servlet.ServletContextHandler)">configureContext</a></span>&#8203;(<a href="../../servlet/ServletContextHandler.html" title="class in org.eclipse.jetty.servlet">ServletContextHandler</a>&nbsp;context)</code></th>
<td class="colLast">
<div class="block"><span class="deprecatedLabel">Deprecated.</span>
<div class="deprecationComment">use <a href="#configure(org.eclipse.jetty.servlet.ServletContextHandler)"><code>configure(ServletContextHandler)</code></a> instead</div>
</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#destroy()">destroy</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#doFilter(javax.servlet.ServletRequest,javax.servlet.ServletResponse,javax.servlet.FilterChain)">doFilter</a></span>&#8203;(javax.servlet.ServletRequest&nbsp;request,
javax.servlet.ServletResponse&nbsp;response,
javax.servlet.FilterChain&nbsp;chain)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#dump()">dump</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#dump(java.lang.Appendable,java.lang.String)">dump</a></span>&#8203;(java.lang.Appendable&nbsp;out,
java.lang.String&nbsp;indent)</code></th>
<td class="colLast">
<div class="block">Dump this object (and children) into an Appendable using the provided indent after any new lines.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code><a href="NativeWebSocketConfiguration.html" title="class in org.eclipse.jetty.websocket.server">NativeWebSocketConfiguration</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getConfiguration()">getConfiguration</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code><a href="../servlet/WebSocketServletFactory.html" title="interface in org.eclipse.jetty.websocket.servlet">WebSocketServletFactory</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getFactory()">getFactory</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code><a href="../servlet/WebSocketCreator.html" title="interface in org.eclipse.jetty.websocket.servlet">WebSocketCreator</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getMapping(java.lang.String)">getMapping</a></span>&#8203;(java.lang.String&nbsp;target)</code></th>
<td class="colLast">
<div class="block">/**
Returns the creator for the given path spec.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#init(javax.servlet.FilterConfig)">init</a></span>&#8203;(javax.servlet.FilterConfig&nbsp;config)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#removeMapping(java.lang.String)">removeMapping</a></span>&#8203;(java.lang.String&nbsp;spec)</code></th>
<td class="colLast">
<div class="block">Removes the mapping based on the given path spec.</div>
</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setToAttribute(javax.servlet.ServletContext,java.lang.String)">setToAttribute</a></span>&#8203;(javax.servlet.ServletContext&nbsp;context,
java.lang.String&nbsp;key)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#toString()">toString</a></span>()</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, wait, wait, wait</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.org.eclipse.jetty.util.component.Dumpable">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.eclipse.jetty.util.component.<a href="../../util/component/Dumpable.html" title="interface in org.eclipse.jetty.util.component">Dumpable</a></h3>
<code><a href="../../util/component/Dumpable.html#dumpSelf()">dumpSelf</a></code></li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a id="CONTEXT_ATTRIBUTE_KEY">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>CONTEXT_ATTRIBUTE_KEY</h4>
<pre>public static final&nbsp;java.lang.String CONTEXT_ATTRIBUTE_KEY</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.eclipse.jetty.websocket.server.WebSocketUpgradeFilter.CONTEXT_ATTRIBUTE_KEY">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a id="CONFIG_ATTRIBUTE_KEY">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>CONFIG_ATTRIBUTE_KEY</h4>
<pre>public static final&nbsp;java.lang.String CONFIG_ATTRIBUTE_KEY</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.eclipse.jetty.websocket.server.WebSocketUpgradeFilter.CONFIG_ATTRIBUTE_KEY">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a id="ATTR_KEY">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>ATTR_KEY</h4>
<pre>public static final&nbsp;java.lang.String ATTR_KEY</pre>
</li>
</ul>
</li>
</ul>
</section>
<!-- ========= 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="blockList">
<li class="blockList">
<h4>WebSocketUpgradeFilter</h4>
<pre>public&nbsp;WebSocketUpgradeFilter()</pre>
</li>
</ul>
<a id="&lt;init&gt;(org.eclipse.jetty.websocket.server.WebSocketServerFactory)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>WebSocketUpgradeFilter</h4>
<pre>public&nbsp;WebSocketUpgradeFilter&#8203;(<a href="WebSocketServerFactory.html" title="class in org.eclipse.jetty.websocket.server">WebSocketServerFactory</a>&nbsp;factory)</pre>
</li>
</ul>
<a id="&lt;init&gt;(org.eclipse.jetty.websocket.server.NativeWebSocketConfiguration)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>WebSocketUpgradeFilter</h4>
<pre>public&nbsp;WebSocketUpgradeFilter&#8203;(<a href="NativeWebSocketConfiguration.html" title="class in org.eclipse.jetty.websocket.server">NativeWebSocketConfiguration</a>&nbsp;configuration)</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="configure(org.eclipse.jetty.servlet.ServletContextHandler)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>configure</h4>
<pre class="methodSignature">public static&nbsp;<a href="WebSocketUpgradeFilter.html" title="class in org.eclipse.jetty.websocket.server">WebSocketUpgradeFilter</a>&nbsp;configure&#8203;(<a href="../../servlet/ServletContextHandler.html" title="class in org.eclipse.jetty.servlet">ServletContextHandler</a>&nbsp;context)
throws javax.servlet.ServletException</pre>
<div class="block">Configure the default WebSocketUpgradeFilter.
<p>
This will return the default <a href="WebSocketUpgradeFilter.html" title="class in org.eclipse.jetty.websocket.server"><code>WebSocketUpgradeFilter</code></a> on the
provided <a href="../../servlet/ServletContextHandler.html" title="class in org.eclipse.jetty.servlet"><code>ServletContextHandler</code></a>, creating the filter if necessary.
</p>
<p>
The default <a href="WebSocketUpgradeFilter.html" title="class in org.eclipse.jetty.websocket.server"><code>WebSocketUpgradeFilter</code></a> is also available via
the <code>ServletContext</code> attribute named <code>org.eclipse.jetty.websocket.server.WebSocketUpgradeFilter</code>
</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>context</code> - the <a href="../../servlet/ServletContextHandler.html" title="class in org.eclipse.jetty.servlet"><code>ServletContextHandler</code></a> to use</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the configured default <a href="WebSocketUpgradeFilter.html" title="class in org.eclipse.jetty.websocket.server"><code>WebSocketUpgradeFilter</code></a> instance</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>javax.servlet.ServletException</code> - if the filer cannot be configured</dd>
</dl>
</li>
</ul>
<a id="configureContext(org.eclipse.jetty.servlet.ServletContextHandler)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>configureContext</h4>
<pre class="methodSignature">@Deprecated
public static&nbsp;<a href="WebSocketUpgradeFilter.html" title="class in org.eclipse.jetty.websocket.server">WebSocketUpgradeFilter</a>&nbsp;configureContext&#8203;(<a href="../../servlet/ServletContextHandler.html" title="class in org.eclipse.jetty.servlet">ServletContextHandler</a>&nbsp;context)
throws javax.servlet.ServletException</pre>
<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span>
<div class="deprecationComment">use <a href="#configure(org.eclipse.jetty.servlet.ServletContextHandler)"><code>configure(ServletContextHandler)</code></a> instead</div>
</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>context</code> - the <a href="../../servlet/ServletContextHandler.html" title="class in org.eclipse.jetty.servlet"><code>ServletContextHandler</code></a> to use</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a configured <a href="WebSocketUpgradeFilter.html" title="class in org.eclipse.jetty.websocket.server"><code>WebSocketUpgradeFilter</code></a> instance</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>javax.servlet.ServletException</code> - if the filer cannot be configured</dd>
</dl>
</li>
</ul>
<a id="configureContext(javax.servlet.ServletContext)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>configureContext</h4>
<pre class="methodSignature">@Deprecated
public static&nbsp;<a href="WebSocketUpgradeFilter.html" title="class in org.eclipse.jetty.websocket.server">WebSocketUpgradeFilter</a>&nbsp;configureContext&#8203;(javax.servlet.ServletContext&nbsp;context)
throws javax.servlet.ServletException</pre>
<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span>
<div class="deprecationComment">use <a href="#configureContext(org.eclipse.jetty.servlet.ServletContextHandler)"><code>configureContext(ServletContextHandler)</code></a> instead</div>
</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>context</code> - the ServletContext to use</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a configured <a href="WebSocketUpgradeFilter.html" title="class in org.eclipse.jetty.websocket.server"><code>WebSocketUpgradeFilter</code></a> instance</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>javax.servlet.ServletException</code> - if the filer cannot be configured</dd>
</dl>
</li>
</ul>
<a id="addMapping(org.eclipse.jetty.http.pathmap.PathSpec,org.eclipse.jetty.websocket.servlet.WebSocketCreator)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addMapping</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;addMapping&#8203;(<a href="../../http/pathmap/PathSpec.html" title="interface in org.eclipse.jetty.http.pathmap">PathSpec</a>&nbsp;spec,
<a href="../servlet/WebSocketCreator.html" title="interface in org.eclipse.jetty.websocket.servlet">WebSocketCreator</a>&nbsp;creator)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="MappedWebSocketCreator.html#addMapping(org.eclipse.jetty.http.pathmap.PathSpec,org.eclipse.jetty.websocket.servlet.WebSocketCreator)">MappedWebSocketCreator</a></code></span></div>
<div class="block">Add a mapping.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="MappedWebSocketCreator.html#addMapping(org.eclipse.jetty.http.pathmap.PathSpec,org.eclipse.jetty.websocket.servlet.WebSocketCreator)">addMapping</a></code>&nbsp;in interface&nbsp;<code><a href="MappedWebSocketCreator.html" title="interface in org.eclipse.jetty.websocket.server">MappedWebSocketCreator</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>spec</code> - the path spec to use</dd>
<dd><code>creator</code> - the creator for the mapping</dd>
</dl>
</li>
</ul>
<a id="addMapping(org.eclipse.jetty.websocket.server.pathmap.PathSpec,org.eclipse.jetty.websocket.servlet.WebSocketCreator)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addMapping</h4>
<pre class="methodSignature">@Deprecated
public&nbsp;void&nbsp;addMapping&#8203;(<a href="pathmap/PathSpec.html" title="class in org.eclipse.jetty.websocket.server.pathmap">PathSpec</a>&nbsp;spec,
<a href="../servlet/WebSocketCreator.html" title="interface in org.eclipse.jetty.websocket.servlet">WebSocketCreator</a>&nbsp;creator)</pre>
<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span>
<div class="deprecationComment">use new <a href="#addMapping(org.eclipse.jetty.http.pathmap.PathSpec,org.eclipse.jetty.websocket.servlet.WebSocketCreator)"><code>addMapping(org.eclipse.jetty.http.pathmap.PathSpec, WebSocketCreator)</code></a> instead</div>
</div>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="MappedWebSocketCreator.html#addMapping(org.eclipse.jetty.websocket.server.pathmap.PathSpec,org.eclipse.jetty.websocket.servlet.WebSocketCreator)">MappedWebSocketCreator</a></code></span></div>
<div class="block">Add a mapping.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="MappedWebSocketCreator.html#addMapping(org.eclipse.jetty.websocket.server.pathmap.PathSpec,org.eclipse.jetty.websocket.servlet.WebSocketCreator)">addMapping</a></code>&nbsp;in interface&nbsp;<code><a href="MappedWebSocketCreator.html" title="interface in org.eclipse.jetty.websocket.server">MappedWebSocketCreator</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>spec</code> - the path spec to use</dd>
<dd><code>creator</code> - the creator for the mapping</dd>
</dl>
</li>
</ul>
<a id="addMapping(java.lang.String,org.eclipse.jetty.websocket.servlet.WebSocketCreator)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addMapping</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;addMapping&#8203;(java.lang.String&nbsp;spec,
<a href="../servlet/WebSocketCreator.html" title="interface in org.eclipse.jetty.websocket.servlet">WebSocketCreator</a>&nbsp;creator)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="MappedWebSocketCreator.html#addMapping(java.lang.String,org.eclipse.jetty.websocket.servlet.WebSocketCreator)">MappedWebSocketCreator</a></code></span></div>
<div class="block">Add a mapping, of a pathspec to a WebSocketCreator.
<p>
Recognized Path Spec syntaxes
</p>
<dl>
<dt><code>/path/to</code> or <code>/</code> or <code>*.ext</code> or <code>servlet|{spec}</code></dt>
<dd>Servlet Syntax</dd>
<dt><code>^{spec}</code> or <code>regex|{spec}</code></dt>
<dd>Regex Syntax</dd>
<dt><code>uri-template|{spec}</code></dt>
<dd>URI Template (see JSR356 and RFC6570 level 1)</dd>
</dl></div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="MappedWebSocketCreator.html#addMapping(java.lang.String,org.eclipse.jetty.websocket.servlet.WebSocketCreator)">addMapping</a></code>&nbsp;in interface&nbsp;<code><a href="MappedWebSocketCreator.html" title="interface in org.eclipse.jetty.websocket.server">MappedWebSocketCreator</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>spec</code> - the path spec to use.</dd>
<dd><code>creator</code> - the websocket creator for this specific mapping</dd>
</dl>
</li>
</ul>
<a id="removeMapping(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeMapping</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;removeMapping&#8203;(java.lang.String&nbsp;spec)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="MappedWebSocketCreator.html#removeMapping(java.lang.String)">MappedWebSocketCreator</a></code></span></div>
<div class="block">Removes the mapping based on the given path spec.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="MappedWebSocketCreator.html#removeMapping(java.lang.String)">removeMapping</a></code>&nbsp;in interface&nbsp;<code><a href="MappedWebSocketCreator.html" title="interface in org.eclipse.jetty.websocket.server">MappedWebSocketCreator</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>spec</code> - the path spec to remove (using the same spec syntax as seen in <a href="MappedWebSocketCreator.html#addMapping(java.lang.String,org.eclipse.jetty.websocket.servlet.WebSocketCreator)"><code>MappedWebSocketCreator.addMapping(String, WebSocketCreator)</code></a>)</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if underlying mapping were altered, false otherwise</dd>
</dl>
</li>
</ul>
<a id="destroy()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>destroy</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;destroy()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>destroy</code>&nbsp;in interface&nbsp;<code>javax.servlet.Filter</code></dd>
</dl>
</li>
</ul>
<a id="doFilter(javax.servlet.ServletRequest,javax.servlet.ServletResponse,javax.servlet.FilterChain)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>doFilter</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;doFilter&#8203;(javax.servlet.ServletRequest&nbsp;request,
javax.servlet.ServletResponse&nbsp;response,
javax.servlet.FilterChain&nbsp;chain)
throws java.io.IOException,
javax.servlet.ServletException</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>doFilter</code>&nbsp;in interface&nbsp;<code>javax.servlet.Filter</code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.io.IOException</code></dd>
<dd><code>javax.servlet.ServletException</code></dd>
</dl>
</li>
</ul>
<a id="dump()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>dump</h4>
<pre class="methodSignature">public&nbsp;java.lang.String&nbsp;dump()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../util/component/Dumpable.html#dump()">dump</a></code>&nbsp;in interface&nbsp;<code><a href="../../util/component/Dumpable.html" title="interface in org.eclipse.jetty.util.component">Dumpable</a></code></dd>
</dl>
</li>
</ul>
<a id="dump(java.lang.Appendable,java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>dump</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;dump&#8203;(java.lang.Appendable&nbsp;out,
java.lang.String&nbsp;indent)
throws java.io.IOException</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../util/component/Dumpable.html#dump(java.lang.Appendable,java.lang.String)">Dumpable</a></code></span></div>
<div class="block">Dump this object (and children) into an Appendable using the provided indent after any new lines.
The indent should not be applied to the first object dumped.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../util/component/Dumpable.html#dump(java.lang.Appendable,java.lang.String)">dump</a></code>&nbsp;in interface&nbsp;<code><a href="../../util/component/Dumpable.html" title="interface in org.eclipse.jetty.util.component">Dumpable</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>out</code> - The appendable to dump to</dd>
<dd><code>indent</code> - The indent to apply after any new lines.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.io.IOException</code> - if unable to write to Appendable</dd>
</dl>
</li>
</ul>
<a id="getFactory()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFactory</h4>
<pre class="methodSignature">public&nbsp;<a href="../servlet/WebSocketServletFactory.html" title="interface in org.eclipse.jetty.websocket.servlet">WebSocketServletFactory</a>&nbsp;getFactory()</pre>
</li>
</ul>
<a id="getConfiguration()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getConfiguration</h4>
<pre class="methodSignature"><a href="../../util/annotation/ManagedAttribute.html" title="annotation in org.eclipse.jetty.util.annotation">@ManagedAttribute</a>(<a href="../../util/annotation/ManagedAttribute.html#value()">value</a>="configuration",
<a href="../../util/annotation/ManagedAttribute.html#readonly()">readonly</a>=true)
public&nbsp;<a href="NativeWebSocketConfiguration.html" title="class in org.eclipse.jetty.websocket.server">NativeWebSocketConfiguration</a>&nbsp;getConfiguration()</pre>
</li>
</ul>
<a id="getMapping(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMapping</h4>
<pre class="methodSignature">public&nbsp;<a href="../servlet/WebSocketCreator.html" title="interface in org.eclipse.jetty.websocket.servlet">WebSocketCreator</a>&nbsp;getMapping&#8203;(java.lang.String&nbsp;target)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="MappedWebSocketCreator.html#getMapping(java.lang.String)">MappedWebSocketCreator</a></code></span></div>
<div class="block">/**
Returns the creator for the given path spec.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="MappedWebSocketCreator.html#getMapping(java.lang.String)">getMapping</a></code>&nbsp;in interface&nbsp;<code><a href="MappedWebSocketCreator.html" title="interface in org.eclipse.jetty.websocket.server">MappedWebSocketCreator</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>target</code> - the spec to test for (using the same spec syntax as seen in <a href="MappedWebSocketCreator.html#addMapping(java.lang.String,org.eclipse.jetty.websocket.servlet.WebSocketCreator)"><code>MappedWebSocketCreator.addMapping(String, WebSocketCreator)</code></a>)</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the websocket creator if path spec exists, or null</dd>
</dl>
</li>
</ul>
<a id="init(javax.servlet.FilterConfig)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>init</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;init&#8203;(javax.servlet.FilterConfig&nbsp;config)
throws javax.servlet.ServletException</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>init</code>&nbsp;in interface&nbsp;<code>javax.servlet.Filter</code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>javax.servlet.ServletException</code></dd>
</dl>
</li>
</ul>
<a id="setToAttribute(javax.servlet.ServletContext,java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setToAttribute</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setToAttribute&#8203;(javax.servlet.ServletContext&nbsp;context,
java.lang.String&nbsp;key)
throws javax.servlet.ServletException</pre>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>javax.servlet.ServletException</code></dd>
</dl>
</li>
</ul>
<a id="toString()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>toString</h4>
<pre class="methodSignature">public&nbsp;java.lang.String&nbsp;toString()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>toString</code>&nbsp;in class&nbsp;<code>java.lang.Object</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/WebSocketUpgradeFilter.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><a href="#field.summary">Field</a>&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><a href="#field.detail">Field</a>&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;2021 <a href="https://webtide.com">Webtide</a>. All rights reserved.</small></p>
</footer>
</body>
</html>