Google Git
Sign in
eclipse / www.eclipse.org / jetty / 244b31480d88c4c2e783a862c86c320807c66eb3 / . / javadoc / 11.0.0.beta3 / org / eclipse / jetty / websocket / server / JettyWebSocketServletFactory.html
blob: 6fa7e3c0470b9ca3f142dc6b92b1385a96580489 [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (11.0.8) on Thu Oct 22 13:40:13 CDT 2020 -->
<title>JettyWebSocketServletFactory (Jetty :: Javadoc Build 11.0.0.beta3 API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2020-10-22">
<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.3.1.js"></script>
<script type="text/javascript" src="../../../../../jquery/jquery-migrate-3.0.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="JettyWebSocketServletFactory (Jetty :: Javadoc Build 11.0.0.beta3 API)";
}
}
catch(err) {
}
//-->
var data = {"i0":6,"i1":6,"i2":18,"i3":6,"i4":6,"i5":6,"i6":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],16:["t5","Default Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
var pathtoroot = "../../../../../";
var useModuleDirectories = true;
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a id="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/JettyWebSocketServletFactory.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>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>
<!-- ======== START OF CLASS DATA ======== -->
<main role="main">
<div class="header">
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">org.eclipse.jetty.websocket.server</a></div>
<h2 title="Interface JettyWebSocketServletFactory" class="title">Interface JettyWebSocketServletFactory</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Superinterfaces:</dt>
<dd><code><a href="../api/WebSocketPolicy.html" title="interface in org.eclipse.jetty.websocket.api">WebSocketPolicy</a></code></dd>
</dl>
<hr>
<pre>public interface <span class="typeNameLabel">JettyWebSocketServletFactory</span>
extends <a href="../api/WebSocketPolicy.html" title="interface in org.eclipse.jetty.websocket.api">WebSocketPolicy</a></pre>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t5" class="tableTab"><span><a href="javascript:show(16);">Default 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.server.JettyWebSocketCreator)">addMapping</a></span>&#8203;(java.lang.String&nbsp;pathSpec,
<a href="JettyWebSocketCreator.html" title="interface in org.eclipse.jetty.websocket.server">JettyWebSocketCreator</a>&nbsp;creator)</code></th>
<td class="colLast">
<div class="block">Add a WebSocket mapping to a provided <a href="JettyWebSocketCreator.html" title="interface in org.eclipse.jetty.websocket.server"><code>JettyWebSocketCreator</code></a>.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>java.util.Set&lt;java.lang.String&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getAvailableExtensionNames()">getAvailableExtensionNames</a></span>()</code></th>
<td class="colLast">
<div class="block">Get the names of all available WebSocket Extensions.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>default <a href="../api/WebSocketBehavior.html" title="enum in org.eclipse.jetty.websocket.api">WebSocketBehavior</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getBehavior()">getBehavior</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="JettyWebSocketCreator.html" title="interface in org.eclipse.jetty.websocket.server">JettyWebSocketCreator</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;pathSpec)</code></th>
<td class="colLast">
<div class="block">Returns the creator for the given path spec.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#register(java.lang.Class)">register</a></span>&#8203;(java.lang.Class&lt;?&gt;&nbsp;endpointClass)</code></th>
<td class="colLast">
<div class="block">Add a WebSocket mapping at PathSpec "/" for a creator which creates the endpointClass</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<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;pathSpec)</code></th>
<td class="colLast">
<div class="block">Removes the mapping based on the given path spec.</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="#setCreator(org.eclipse.jetty.websocket.server.JettyWebSocketCreator)">setCreator</a></span>&#8203;(<a href="JettyWebSocketCreator.html" title="interface in org.eclipse.jetty.websocket.server">JettyWebSocketCreator</a>&nbsp;creator)</code></th>
<td class="colLast">
<div class="block">Add a WebSocket mapping at PathSpec "/" for a creator</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.org.eclipse.jetty.websocket.api.WebSocketPolicy">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.eclipse.jetty.websocket.api.<a href="../api/WebSocketPolicy.html" title="interface in org.eclipse.jetty.websocket.api">WebSocketPolicy</a></h3>
<code><a href="../api/WebSocketPolicy.html#getIdleTimeout()">getIdleTimeout</a>, <a href="../api/WebSocketPolicy.html#getInputBufferSize()">getInputBufferSize</a>, <a href="../api/WebSocketPolicy.html#getMaxBinaryMessageSize()">getMaxBinaryMessageSize</a>, <a href="../api/WebSocketPolicy.html#getMaxFrameSize()">getMaxFrameSize</a>, <a href="../api/WebSocketPolicy.html#getMaxTextMessageSize()">getMaxTextMessageSize</a>, <a href="../api/WebSocketPolicy.html#getOutputBufferSize()">getOutputBufferSize</a>, <a href="../api/WebSocketPolicy.html#isAutoFragment()">isAutoFragment</a>, <a href="../api/WebSocketPolicy.html#setAutoFragment(boolean)">setAutoFragment</a>, <a href="../api/WebSocketPolicy.html#setIdleTimeout(java.time.Duration)">setIdleTimeout</a>, <a href="../api/WebSocketPolicy.html#setInputBufferSize(int)">setInputBufferSize</a>, <a href="../api/WebSocketPolicy.html#setMaxBinaryMessageSize(long)">setMaxBinaryMessageSize</a>, <a href="../api/WebSocketPolicy.html#setMaxFrameSize(long)">setMaxFrameSize</a>, <a href="../api/WebSocketPolicy.html#setMaxTextMessageSize(long)">setMaxTextMessageSize</a>, <a href="../api/WebSocketPolicy.html#setOutputBufferSize(int)">setOutputBufferSize</a></code></li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="addMapping(java.lang.String,org.eclipse.jetty.websocket.server.JettyWebSocketCreator)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addMapping</h4>
<pre class="methodSignature">void&nbsp;addMapping&#8203;(java.lang.String&nbsp;pathSpec,
<a href="JettyWebSocketCreator.html" title="interface in org.eclipse.jetty.websocket.server">JettyWebSocketCreator</a>&nbsp;creator)</pre>
<div class="block">Add a WebSocket mapping to a provided <a href="JettyWebSocketCreator.html" title="interface in org.eclipse.jetty.websocket.server"><code>JettyWebSocketCreator</code></a>.
<p>
If mapping is added before this configuration is started, then it is persisted through
stop/start of this configuration's lifecycle. Otherwise it will be removed when
this configuration is stopped.
</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>pathSpec</code> - the pathspec to respond on</dd>
<dd><code>creator</code> - the WebSocketCreator to use</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>10.0</dd>
</dl>
</li>
</ul>
<a id="register(java.lang.Class)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>register</h4>
<pre class="methodSignature">void&nbsp;register&#8203;(java.lang.Class&lt;?&gt;&nbsp;endpointClass)</pre>
<div class="block">Add a WebSocket mapping at PathSpec "/" for a creator which creates the endpointClass</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>endpointClass</code> - the WebSocket class to use</dd>
</dl>
</li>
</ul>
<a id="setCreator(org.eclipse.jetty.websocket.server.JettyWebSocketCreator)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setCreator</h4>
<pre class="methodSignature">void&nbsp;setCreator&#8203;(<a href="JettyWebSocketCreator.html" title="interface in org.eclipse.jetty.websocket.server">JettyWebSocketCreator</a>&nbsp;creator)</pre>
<div class="block">Add a WebSocket mapping at PathSpec "/" for a creator</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>creator</code> - the WebSocketCreator to use</dd>
</dl>
</li>
</ul>
<a id="getMapping(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMapping</h4>
<pre class="methodSignature"><a href="JettyWebSocketCreator.html" title="interface in org.eclipse.jetty.websocket.server">JettyWebSocketCreator</a>&nbsp;getMapping&#8203;(java.lang.String&nbsp;pathSpec)</pre>
<div class="block">Returns the creator for the given path spec.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>pathSpec</code> - the pathspec to respond on</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the websocket creator if path spec exists, or null</dd>
</dl>
</li>
</ul>
<a id="removeMapping(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeMapping</h4>
<pre class="methodSignature">boolean&nbsp;removeMapping&#8203;(java.lang.String&nbsp;pathSpec)</pre>
<div class="block">Removes the mapping based on the given path spec.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>pathSpec</code> - the pathspec to respond on</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if underlying mapping were altered, false otherwise</dd>
</dl>
</li>
</ul>
<a id="getAvailableExtensionNames()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAvailableExtensionNames</h4>
<pre class="methodSignature">java.util.Set&lt;java.lang.String&gt;&nbsp;getAvailableExtensionNames()</pre>
<div class="block">Get the names of all available WebSocket Extensions.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a set the available extension names.</dd>
</dl>
</li>
</ul>
<a id="getBehavior()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getBehavior</h4>
<pre class="methodSignature">default&nbsp;<a href="../api/WebSocketBehavior.html" title="enum in org.eclipse.jetty.websocket.api">WebSocketBehavior</a>&nbsp;getBehavior()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../api/WebSocketPolicy.html#getBehavior()">getBehavior</a></code>&nbsp;in interface&nbsp;<code><a href="../api/WebSocketPolicy.html" title="interface in org.eclipse.jetty.websocket.api">WebSocketPolicy</a></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/JettyWebSocketServletFactory.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>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
<p class="legalCopy"><small>Copyright &#169; 1995&#x2013;2020 <a href="https://webtide.com">Webtide</a>. All rights reserved.</small></p>
</footer>
</body>
</html>