Google Git
Sign in
eclipse / www.eclipse.org / jetty / 244b31480d88c4c2e783a862c86c320807c66eb3 / . / javadoc / 9.3.24.v20180605 / org / eclipse / jetty / websocket / server / WebSocketUpgradeFilter.html
blob: 0089841b15217142249696d48e7f1b49efab08a8 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_92) on Thu Jun 07 14:26:32 EDT 2018 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>WebSocketUpgradeFilter (Jetty :: Project 9.3.24.v20180605 API)</title>
<meta name="date" content="2018-06-07">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="WebSocketUpgradeFilter (Jetty :: Project 9.3.24.v20180605 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":42,"i2":10,"i3":41,"i4":9,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":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";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.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">
<li><a href="../../../../../org/eclipse/jetty/websocket/server/WebSocketServerFactory.html" title="class in org.eclipse.jetty.websocket.server"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/eclipse/jetty/websocket/server/WebSocketUpgradeHandlerWrapper.html" title="class in org.eclipse.jetty.websocket.server"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/eclipse/jetty/websocket/server/WebSocketUpgradeFilter.html" target="_top">Frames</a></li>
<li><a href="WebSocketUpgradeFilter.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></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>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&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 name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.eclipse.jetty.websocket.server</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>javax.servlet.Filter, <a href="../../../../../org/eclipse/jetty/util/component/Dumpable.html" title="interface in org.eclipse.jetty.util.component">Dumpable</a>, <a href="../../../../../org/eclipse/jetty/websocket/server/MappedWebSocketCreator.html" title="interface in org.eclipse.jetty.websocket.server">MappedWebSocketCreator</a></dd>
</dl>
<hr>
<br>
<pre><a href="../../../../../org/eclipse/jetty/util/annotation/ManagedObject.html" title="annotation in org.eclipse.jetty.util.annotation">@ManagedObject</a>(<a href="../../../../../org/eclipse/jetty/util/annotation/ManagedObject.html#value--">value</a>="WebSocket Upgrade Filter")
public class <span class="typeNameLabel">WebSocketUpgradeFilter</span>
extends java.lang.Object
implements javax.servlet.Filter, <a href="../../../../../org/eclipse/jetty/websocket/server/MappedWebSocketCreator.html" title="interface in org.eclipse.jetty.websocket.server">MappedWebSocketCreator</a>, <a href="../../../../../org/eclipse/jetty/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="../../../../../org/eclipse/jetty/websocket/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">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/jetty/websocket/server/WebSocketUpgradeFilter.html#CONFIG_ATTRIBUTE_KEY">CONFIG_ATTRIBUTE_KEY</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/jetty/websocket/server/WebSocketUpgradeFilter.html#CONTEXT_ATTRIBUTE_KEY">CONTEXT_ATTRIBUTE_KEY</a></span></code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/jetty/websocket/server/WebSocketUpgradeFilter.html#WebSocketUpgradeFilter--">WebSocketUpgradeFilter</a></span>()</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/jetty/websocket/server/WebSocketUpgradeFilter.html#WebSocketUpgradeFilter-org.eclipse.jetty.websocket.server.NativeWebSocketConfiguration-">WebSocketUpgradeFilter</a></span>(<a href="../../../../../org/eclipse/jetty/websocket/server/NativeWebSocketConfiguration.html" title="class in org.eclipse.jetty.websocket.server">NativeWebSocketConfiguration</a>&nbsp;configuration)</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/jetty/websocket/server/WebSocketUpgradeFilter.html#WebSocketUpgradeFilter-org.eclipse.jetty.websocket.server.WebSocketServerFactory-">WebSocketUpgradeFilter</a></span>(<a href="../../../../../org/eclipse/jetty/websocket/server/WebSocketServerFactory.html" title="class in org.eclipse.jetty.websocket.server">WebSocketServerFactory</a>&nbsp;factory)</code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<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="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/jetty/websocket/server/WebSocketUpgradeFilter.html#addMapping-org.eclipse.jetty.http.pathmap.PathSpec-org.eclipse.jetty.websocket.servlet.WebSocketCreator-">addMapping</a></span>(<a href="../../../../../org/eclipse/jetty/http/pathmap/PathSpec.html" title="class in org.eclipse.jetty.http.pathmap">PathSpec</a>&nbsp;spec,
<a href="../../../../../org/eclipse/jetty/websocket/servlet/WebSocketCreator.html" title="interface in org.eclipse.jetty.websocket.servlet">WebSocketCreator</a>&nbsp;creator)</code>
<div class="block">Add a mapping.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/jetty/websocket/server/WebSocketUpgradeFilter.html#addMapping-org.eclipse.jetty.websocket.server.pathmap.PathSpec-org.eclipse.jetty.websocket.servlet.WebSocketCreator-">addMapping</a></span>(<a href="../../../../../org/eclipse/jetty/websocket/server/pathmap/PathSpec.html" title="class in org.eclipse.jetty.websocket.server.pathmap">PathSpec</a>&nbsp;spec,
<a href="../../../../../org/eclipse/jetty/websocket/servlet/WebSocketCreator.html" title="interface in org.eclipse.jetty.websocket.servlet">WebSocketCreator</a>&nbsp;creator)</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
<div class="block"><span class="deprecationComment">use new <a href="../../../../../org/eclipse/jetty/websocket/server/WebSocketUpgradeFilter.html#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</span></div>
</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/jetty/websocket/server/WebSocketUpgradeFilter.html#addMapping-java.lang.String-org.eclipse.jetty.websocket.servlet.WebSocketCreator-">addMapping</a></span>(java.lang.String&nbsp;spec,
<a href="../../../../../org/eclipse/jetty/websocket/servlet/WebSocketCreator.html" title="interface in org.eclipse.jetty.websocket.servlet">WebSocketCreator</a>&nbsp;creator)</code>
<div class="block">Add a mapping, of a pathspec to a WebSocketCreator.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>static <a href="../../../../../org/eclipse/jetty/websocket/server/WebSocketUpgradeFilter.html" title="class in org.eclipse.jetty.websocket.server">WebSocketUpgradeFilter</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/jetty/websocket/server/WebSocketUpgradeFilter.html#configureContext-javax.servlet.ServletContext-">configureContext</a></span>(javax.servlet.ServletContext&nbsp;context)</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
<div class="block"><span class="deprecationComment">use <a href="../../../../../org/eclipse/jetty/websocket/server/WebSocketUpgradeFilter.html#configureContext-org.eclipse.jetty.servlet.ServletContextHandler-"><code>configureContext(ServletContextHandler)</code></a> instead</span></div>
</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>static <a href="../../../../../org/eclipse/jetty/websocket/server/WebSocketUpgradeFilter.html" title="class in org.eclipse.jetty.websocket.server">WebSocketUpgradeFilter</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/jetty/websocket/server/WebSocketUpgradeFilter.html#configureContext-org.eclipse.jetty.servlet.ServletContextHandler-">configureContext</a></span>(<a href="../../../../../org/eclipse/jetty/servlet/ServletContextHandler.html" title="class in org.eclipse.jetty.servlet">ServletContextHandler</a>&nbsp;context)</code>&nbsp;</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/jetty/websocket/server/WebSocketUpgradeFilter.html#destroy--">destroy</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/jetty/websocket/server/WebSocketUpgradeFilter.html#doFilter-javax.servlet.ServletRequest-javax.servlet.ServletResponse-javax.servlet.FilterChain-">doFilter</a></span>(javax.servlet.ServletRequest&nbsp;request,
javax.servlet.ServletResponse&nbsp;response,
javax.servlet.FilterChain&nbsp;chain)</code>&nbsp;</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/jetty/websocket/server/WebSocketUpgradeFilter.html#dump--">dump</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/jetty/websocket/server/WebSocketUpgradeFilter.html#dump-java.lang.Appendable-java.lang.String-">dump</a></span>(java.lang.Appendable&nbsp;out,
java.lang.String&nbsp;indent)</code>&nbsp;</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/eclipse/jetty/websocket/server/NativeWebSocketConfiguration.html" title="class in org.eclipse.jetty.websocket.server">NativeWebSocketConfiguration</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/jetty/websocket/server/WebSocketUpgradeFilter.html#getConfiguration--">getConfiguration</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/eclipse/jetty/websocket/servlet/WebSocketServletFactory.html" title="interface in org.eclipse.jetty.websocket.servlet">WebSocketServletFactory</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/jetty/websocket/server/WebSocketUpgradeFilter.html#getFactory--">getFactory</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/eclipse/jetty/websocket/servlet/WebSocketCreator.html" title="interface in org.eclipse.jetty.websocket.servlet">WebSocketCreator</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/jetty/websocket/server/WebSocketUpgradeFilter.html#getMapping-java.lang.String-">getMapping</a></span>(java.lang.String&nbsp;target)</code>
<div class="block">/**
Returns the creator for the given path spec.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/jetty/websocket/server/WebSocketUpgradeFilter.html#init-javax.servlet.FilterConfig-">init</a></span>(javax.servlet.FilterConfig&nbsp;config)</code>&nbsp;</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/jetty/websocket/server/WebSocketUpgradeFilter.html#removeMapping-java.lang.String-">removeMapping</a></span>(java.lang.String&nbsp;spec)</code>
<div class="block">Removes the mapping based on the given path spec.</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/jetty/websocket/server/WebSocketUpgradeFilter.html#setToAttribute-javax.servlet.ServletContext-java.lang.String-">setToAttribute</a></span>(javax.servlet.ServletContext&nbsp;context,
java.lang.String&nbsp;key)</code>&nbsp;</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/jetty/websocket/server/WebSocketUpgradeFilter.html#toString--">toString</a></span>()</code>&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="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>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="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 name="CONFIG_ATTRIBUTE_KEY">
<!-- -->
</a>
<ul class="blockListLast">
<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>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="WebSocketUpgradeFilter--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>WebSocketUpgradeFilter</h4>
<pre>public&nbsp;WebSocketUpgradeFilter()</pre>
</li>
</ul>
<a name="WebSocketUpgradeFilter-org.eclipse.jetty.websocket.server.WebSocketServerFactory-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>WebSocketUpgradeFilter</h4>
<pre>public&nbsp;WebSocketUpgradeFilter(<a href="../../../../../org/eclipse/jetty/websocket/server/WebSocketServerFactory.html" title="class in org.eclipse.jetty.websocket.server">WebSocketServerFactory</a>&nbsp;factory)</pre>
</li>
</ul>
<a name="WebSocketUpgradeFilter-org.eclipse.jetty.websocket.server.NativeWebSocketConfiguration-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>WebSocketUpgradeFilter</h4>
<pre>public&nbsp;WebSocketUpgradeFilter(<a href="../../../../../org/eclipse/jetty/websocket/server/NativeWebSocketConfiguration.html" title="class in org.eclipse.jetty.websocket.server">NativeWebSocketConfiguration</a>&nbsp;configuration)</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="configureContext-org.eclipse.jetty.servlet.ServletContextHandler-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>configureContext</h4>
<pre>public static&nbsp;<a href="../../../../../org/eclipse/jetty/websocket/server/WebSocketUpgradeFilter.html" title="class in org.eclipse.jetty.websocket.server">WebSocketUpgradeFilter</a>&nbsp;configureContext(<a href="../../../../../org/eclipse/jetty/servlet/ServletContextHandler.html" title="class in org.eclipse.jetty.servlet">ServletContextHandler</a>&nbsp;context)
throws javax.servlet.ServletException</pre>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>javax.servlet.ServletException</code></dd>
</dl>
</li>
</ul>
<a name="configureContext-javax.servlet.ServletContext-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>configureContext</h4>
<pre>@Deprecated
public static&nbsp;<a href="../../../../../org/eclipse/jetty/websocket/server/WebSocketUpgradeFilter.html" title="class in org.eclipse.jetty.websocket.server">WebSocketUpgradeFilter</a>&nbsp;configureContext(javax.servlet.ServletContext&nbsp;context)
throws javax.servlet.ServletException</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<span class="deprecationComment">use <a href="../../../../../org/eclipse/jetty/websocket/server/WebSocketUpgradeFilter.html#configureContext-org.eclipse.jetty.servlet.ServletContextHandler-"><code>configureContext(ServletContextHandler)</code></a> instead</span></div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>javax.servlet.ServletException</code></dd>
</dl>
</li>
</ul>
<a name="addMapping-org.eclipse.jetty.http.pathmap.PathSpec-org.eclipse.jetty.websocket.servlet.WebSocketCreator-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addMapping</h4>
<pre>public&nbsp;void&nbsp;addMapping(<a href="../../../../../org/eclipse/jetty/http/pathmap/PathSpec.html" title="class in org.eclipse.jetty.http.pathmap">PathSpec</a>&nbsp;spec,
<a href="../../../../../org/eclipse/jetty/websocket/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="../../../../../org/eclipse/jetty/websocket/server/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="../../../../../org/eclipse/jetty/websocket/server/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="../../../../../org/eclipse/jetty/websocket/server/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 name="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>@Deprecated
public&nbsp;void&nbsp;addMapping(<a href="../../../../../org/eclipse/jetty/websocket/server/pathmap/PathSpec.html" title="class in org.eclipse.jetty.websocket.server.pathmap">PathSpec</a>&nbsp;spec,
<a href="../../../../../org/eclipse/jetty/websocket/servlet/WebSocketCreator.html" title="interface in org.eclipse.jetty.websocket.servlet">WebSocketCreator</a>&nbsp;creator)</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<span class="deprecationComment">use new <a href="../../../../../org/eclipse/jetty/websocket/server/WebSocketUpgradeFilter.html#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</span></div>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/eclipse/jetty/websocket/server/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="../../../../../org/eclipse/jetty/websocket/server/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="../../../../../org/eclipse/jetty/websocket/server/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 name="addMapping-java.lang.String-org.eclipse.jetty.websocket.servlet.WebSocketCreator-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addMapping</h4>
<pre>public&nbsp;void&nbsp;addMapping(java.lang.String&nbsp;spec,
<a href="../../../../../org/eclipse/jetty/websocket/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="../../../../../org/eclipse/jetty/websocket/server/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="../../../../../org/eclipse/jetty/websocket/server/MappedWebSocketCreator.html#addMapping-java.lang.String-org.eclipse.jetty.websocket.servlet.WebSocketCreator-">addMapping</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/eclipse/jetty/websocket/server/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 name="removeMapping-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeMapping</h4>
<pre>public&nbsp;boolean&nbsp;removeMapping(java.lang.String&nbsp;spec)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/eclipse/jetty/websocket/server/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="../../../../../org/eclipse/jetty/websocket/server/MappedWebSocketCreator.html#removeMapping-java.lang.String-">removeMapping</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/eclipse/jetty/websocket/server/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="../../../../../org/eclipse/jetty/websocket/server/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 name="destroy--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>destroy</h4>
<pre>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 name="doFilter-javax.servlet.ServletRequest-javax.servlet.ServletResponse-javax.servlet.FilterChain-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>doFilter</h4>
<pre>public&nbsp;void&nbsp;doFilter(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 name="dump--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>dump</h4>
<pre>public&nbsp;java.lang.String&nbsp;dump()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/eclipse/jetty/util/component/Dumpable.html#dump--">dump</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/eclipse/jetty/util/component/Dumpable.html" title="interface in org.eclipse.jetty.util.component">Dumpable</a></code></dd>
</dl>
</li>
</ul>
<a name="dump-java.lang.Appendable-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>dump</h4>
<pre>public&nbsp;void&nbsp;dump(java.lang.Appendable&nbsp;out,
java.lang.String&nbsp;indent)
throws java.io.IOException</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/eclipse/jetty/util/component/Dumpable.html#dump-java.lang.Appendable-java.lang.String-">dump</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/eclipse/jetty/util/component/Dumpable.html" title="interface in org.eclipse.jetty.util.component">Dumpable</a></code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.io.IOException</code></dd>
</dl>
</li>
</ul>
<a name="getFactory--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFactory</h4>
<pre>public&nbsp;<a href="../../../../../org/eclipse/jetty/websocket/servlet/WebSocketServletFactory.html" title="interface in org.eclipse.jetty.websocket.servlet">WebSocketServletFactory</a>&nbsp;getFactory()</pre>
</li>
</ul>
<a name="getConfiguration--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getConfiguration</h4>
<pre><a href="../../../../../org/eclipse/jetty/util/annotation/ManagedAttribute.html" title="annotation in org.eclipse.jetty.util.annotation">@ManagedAttribute</a>(<a href="../../../../../org/eclipse/jetty/util/annotation/ManagedAttribute.html#value--">value</a>="configuration",
<a href="../../../../../org/eclipse/jetty/util/annotation/ManagedAttribute.html#readonly--">readonly</a>=true)
public&nbsp;<a href="../../../../../org/eclipse/jetty/websocket/server/NativeWebSocketConfiguration.html" title="class in org.eclipse.jetty.websocket.server">NativeWebSocketConfiguration</a>&nbsp;getConfiguration()</pre>
</li>
</ul>
<a name="getMapping-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMapping</h4>
<pre>public&nbsp;<a href="../../../../../org/eclipse/jetty/websocket/servlet/WebSocketCreator.html" title="interface in org.eclipse.jetty.websocket.servlet">WebSocketCreator</a>&nbsp;getMapping(java.lang.String&nbsp;target)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/eclipse/jetty/websocket/server/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="../../../../../org/eclipse/jetty/websocket/server/MappedWebSocketCreator.html#getMapping-java.lang.String-">getMapping</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/eclipse/jetty/websocket/server/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> - @param spec the spec to test for (using the same spec syntax as seen in <a href="../../../../../org/eclipse/jetty/websocket/server/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 name="init-javax.servlet.FilterConfig-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>init</h4>
<pre>public&nbsp;void&nbsp;init(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 name="setToAttribute-javax.servlet.ServletContext-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setToAttribute</h4>
<pre>public&nbsp;void&nbsp;setToAttribute(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 name="toString--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>toString</h4>
<pre>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>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.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">
<li><a href="../../../../../org/eclipse/jetty/websocket/server/WebSocketServerFactory.html" title="class in org.eclipse.jetty.websocket.server"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/eclipse/jetty/websocket/server/WebSocketUpgradeHandlerWrapper.html" title="class in org.eclipse.jetty.websocket.server"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/eclipse/jetty/websocket/server/WebSocketUpgradeFilter.html" target="_top">Frames</a></li>
<li><a href="WebSocketUpgradeFilter.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.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>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&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 name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 1995&#x2013;2018 <a href="http://webtide.com">Webtide</a>. All rights reserved.</small></p>
</body>
</html>