Google Git
Sign in
eclipse / www.eclipse.org / jetty / 244b31480d88c4c2e783a862c86c320807c66eb3 / . / javadoc / 9.4.29.v20200521 / org / eclipse / jetty / websocket / server / WebSocketServerFactory.html
blob: 34f2de1a1e26aa7d1a1140e73e61db0231f62ee2 [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (11.0.6) on Fri May 22 12:37:48 EDT 2020 -->
<title>WebSocketServerFactory (Jetty :: Project 9.4.29.v20200521 API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2020-05-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="WebSocketServerFactory (Jetty :: Project 9.4.29.v20200521 API)";
}
}
catch(err) {
}
//-->
var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":42,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10,"i21":10,"i22":10};
var tabs = {65535:["t0","All 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/WebSocketServerFactory.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>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>
<!-- ======== START OF CLASS DATA ======== -->
<main role="main">
<div class="header">
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">org.eclipse.jetty.websocket.server</a></div>
<h2 title="Class WebSocketServerFactory" class="title">Class WebSocketServerFactory</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li><a href="../../util/component/AbstractLifeCycle.html" title="class in org.eclipse.jetty.util.component">org.eclipse.jetty.util.component.AbstractLifeCycle</a></li>
<li>
<ul class="inheritance">
<li><a href="../../util/component/ContainerLifeCycle.html" title="class in org.eclipse.jetty.util.component">org.eclipse.jetty.util.component.ContainerLifeCycle</a></li>
<li>
<ul class="inheritance">
<li>org.eclipse.jetty.websocket.server.WebSocketServerFactory</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><code><a href="../../util/component/Container.html" title="interface in org.eclipse.jetty.util.component">Container</a></code>, <code><a href="../../util/component/Destroyable.html" title="interface in org.eclipse.jetty.util.component">Destroyable</a></code>, <code><a href="../../util/component/Dumpable.html" title="interface in org.eclipse.jetty.util.component">Dumpable</a></code>, <code><a href="../../util/component/LifeCycle.html" title="interface in org.eclipse.jetty.util.component">LifeCycle</a></code>, <code><a href="../common/scopes/WebSocketContainerScope.html" title="interface in org.eclipse.jetty.websocket.common.scopes">WebSocketContainerScope</a></code>, <code><a href="../servlet/WebSocketCreator.html" title="interface in org.eclipse.jetty.websocket.servlet">WebSocketCreator</a></code>, <code><a href="../servlet/WebSocketServletFactory.html" title="interface in org.eclipse.jetty.websocket.servlet">WebSocketServletFactory</a></code></dd>
</dl>
<hr>
<pre>public class <span class="typeNameLabel">WebSocketServerFactory</span>
extends <a href="../../util/component/ContainerLifeCycle.html" title="class in org.eclipse.jetty.util.component">ContainerLifeCycle</a>
implements <a href="../servlet/WebSocketCreator.html" title="interface in org.eclipse.jetty.websocket.servlet">WebSocketCreator</a>, <a href="../common/scopes/WebSocketContainerScope.html" title="interface in org.eclipse.jetty.websocket.common.scopes">WebSocketContainerScope</a>, <a href="../servlet/WebSocketServletFactory.html" title="interface in org.eclipse.jetty.websocket.servlet">WebSocketServletFactory</a></pre>
<div class="block">Factory to create WebSocket connections</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.AbstractLifeCycle">
<!-- -->
</a>
<h3>Nested classes/interfaces inherited from class&nbsp;org.eclipse.jetty.util.component.<a href="../../util/component/AbstractLifeCycle.html" title="class in org.eclipse.jetty.util.component">AbstractLifeCycle</a></h3>
<code><a href="../../util/component/AbstractLifeCycle.AbstractLifeCycleListener.html" title="class in org.eclipse.jetty.util.component">AbstractLifeCycle.AbstractLifeCycleListener</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="nested.classes.inherited.from.class.org.eclipse.jetty.util.component.Container">
<!-- -->
</a>
<h3>Nested classes/interfaces inherited from interface&nbsp;org.eclipse.jetty.util.component.<a href="../../util/component/Container.html" title="interface in org.eclipse.jetty.util.component">Container</a></h3>
<code><a href="../../util/component/Container.InheritedListener.html" title="interface in org.eclipse.jetty.util.component">Container.InheritedListener</a>, <a href="../../util/component/Container.Listener.html" title="interface in org.eclipse.jetty.util.component">Container.Listener</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="nested.classes.inherited.from.class.org.eclipse.jetty.util.component.LifeCycle">
<!-- -->
</a>
<h3>Nested classes/interfaces inherited from interface&nbsp;org.eclipse.jetty.util.component.<a href="../../util/component/LifeCycle.html" title="interface in org.eclipse.jetty.util.component">LifeCycle</a></h3>
<code><a href="../../util/component/LifeCycle.Listener.html" title="interface in org.eclipse.jetty.util.component">LifeCycle.Listener</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="nested.classes.inherited.from.class.org.eclipse.jetty.websocket.servlet.WebSocketServletFactory">
<!-- -->
</a>
<h3>Nested classes/interfaces inherited from interface&nbsp;org.eclipse.jetty.websocket.servlet.<a href="../servlet/WebSocketServletFactory.html" title="interface in org.eclipse.jetty.websocket.servlet">WebSocketServletFactory</a></h3>
<code><a href="../servlet/WebSocketServletFactory.Loader.html" title="class in org.eclipse.jetty.websocket.servlet">WebSocketServletFactory.Loader</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>
<ul class="blockList">
<li class="blockList"><a id="fields.inherited.from.class.org.eclipse.jetty.util.component.AbstractLifeCycle">
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;org.eclipse.jetty.util.component.<a href="../../util/component/AbstractLifeCycle.html" title="class in org.eclipse.jetty.util.component">AbstractLifeCycle</a></h3>
<code><a href="../../util/component/AbstractLifeCycle.html#FAILED">FAILED</a>, <a href="../../util/component/AbstractLifeCycle.html#RUNNING">RUNNING</a>, <a href="../../util/component/AbstractLifeCycle.html#STARTED">STARTED</a>, <a href="../../util/component/AbstractLifeCycle.html#STARTING">STARTING</a>, <a href="../../util/component/AbstractLifeCycle.html#STOPPED">STOPPED</a>, <a href="../../util/component/AbstractLifeCycle.html#STOPPING">STOPPING</a></code></li>
</ul>
<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">Modifier</th>
<th class="colSecond" scope="col">Constructor</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>&nbsp;</code></td>
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E()">WebSocketServerFactory</a></span>()</code></th>
<td class="colLast">
<div class="block">Entry point for Spring Boot's MockMVC framework</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>&nbsp;</code></td>
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(javax.servlet.ServletContext)">WebSocketServerFactory</a></span>&#8203;(javax.servlet.ServletContext&nbsp;context)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>&nbsp;</code></td>
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(javax.servlet.ServletContext,org.eclipse.jetty.io.ByteBufferPool)">WebSocketServerFactory</a></span>&#8203;(javax.servlet.ServletContext&nbsp;context,
<a href="../../io/ByteBufferPool.html" title="interface in org.eclipse.jetty.io">ByteBufferPool</a>&nbsp;bufferPool)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>&nbsp;</code></td>
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(javax.servlet.ServletContext,org.eclipse.jetty.websocket.api.WebSocketPolicy)">WebSocketServerFactory</a></span>&#8203;(javax.servlet.ServletContext&nbsp;context,
<a href="../api/WebSocketPolicy.html" title="class in org.eclipse.jetty.websocket.api">WebSocketPolicy</a>&nbsp;policy)</code></th>
<td class="colLast">
<div class="block">Entry point for <a href="../servlet/WebSocketServletFactory.Loader.html" title="class in org.eclipse.jetty.websocket.servlet"><code>WebSocketServletFactory.Loader</code></a></div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>&nbsp;</code></td>
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(javax.servlet.ServletContext,org.eclipse.jetty.websocket.api.WebSocketPolicy,org.eclipse.jetty.io.ByteBufferPool)">WebSocketServerFactory</a></span>&#8203;(javax.servlet.ServletContext&nbsp;context,
<a href="../api/WebSocketPolicy.html" title="class in org.eclipse.jetty.websocket.api">WebSocketPolicy</a>&nbsp;policy,
<a href="../../io/ByteBufferPool.html" title="interface in org.eclipse.jetty.io">ByteBufferPool</a>&nbsp;bufferPool)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected </code></td>
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(org.eclipse.jetty.websocket.api.WebSocketPolicy,java.util.concurrent.Executor,org.eclipse.jetty.io.ByteBufferPool)">WebSocketServerFactory</a></span>&#8203;(<a href="../api/WebSocketPolicy.html" title="class in org.eclipse.jetty.websocket.api">WebSocketPolicy</a>&nbsp;policy,
java.util.concurrent.Executor&nbsp;executor,
<a href="../../io/ByteBufferPool.html" title="interface in org.eclipse.jetty.io">ByteBufferPool</a>&nbsp;bufferPool)</code></th>
<td class="colLast">
<div class="block">Protected entry point for <a href="WebSocketHandler.html" title="class in org.eclipse.jetty.websocket.server"><code>WebSocketHandler</code></a></div>
</td>
</tr>
</table>
</li>
</ul>
</section>
<!-- ========== METHOD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span><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>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#acceptWebSocket(javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse)">acceptWebSocket</a></span>&#8203;(javax.servlet.http.HttpServletRequest&nbsp;request,
javax.servlet.http.HttpServletResponse&nbsp;response)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#acceptWebSocket(org.eclipse.jetty.websocket.servlet.WebSocketCreator,javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse)">acceptWebSocket</a></span>&#8203;(<a href="../servlet/WebSocketCreator.html" title="interface in org.eclipse.jetty.websocket.servlet">WebSocketCreator</a>&nbsp;creator,
javax.servlet.http.HttpServletRequest&nbsp;request,
javax.servlet.http.HttpServletResponse&nbsp;response)</code></th>
<td class="colLast">&nbsp;</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="#addSessionFactory(org.eclipse.jetty.websocket.common.SessionFactory)">addSessionFactory</a></span>&#8203;(<a href="../common/SessionFactory.html" title="interface in org.eclipse.jetty.websocket.common">SessionFactory</a>&nbsp;sessionFactory)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#addSessionListener(org.eclipse.jetty.websocket.common.WebSocketSessionListener)">addSessionListener</a></span>&#8203;(<a href="../common/WebSocketSessionListener.html" title="interface in org.eclipse.jetty.websocket.common">WebSocketSessionListener</a>&nbsp;listener)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>java.lang.Object</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#createWebSocket(org.eclipse.jetty.websocket.servlet.ServletUpgradeRequest,org.eclipse.jetty.websocket.servlet.ServletUpgradeResponse)">createWebSocket</a></span>&#8203;(<a href="../servlet/ServletUpgradeRequest.html" title="class in org.eclipse.jetty.websocket.servlet">ServletUpgradeRequest</a>&nbsp;req,
<a href="../servlet/ServletUpgradeResponse.html" title="class in org.eclipse.jetty.websocket.servlet">ServletUpgradeResponse</a>&nbsp;resp)</code></th>
<td class="colLast">
<div class="block">Default Creator logic</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#doStart()">doStart</a></span>()</code></th>
<td class="colLast">
<div class="block">Starts the managed lifecycle beans in the order they were added.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>protected void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#doStop()">doStop</a></span>()</code></th>
<td class="colLast">
<div class="block">Stops the managed lifecycle beans in the reverse order they were added.</div>
</td>
</tr>
<tr id="i7" 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 set of available Extensions by registered name.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code><a href="../../io/ByteBufferPool.html" title="interface in org.eclipse.jetty.io">ByteBufferPool</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getBufferPool()">getBufferPool</a></span>()</code></th>
<td class="colLast">
<div class="block">The configured Container Buffer Pool.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<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="#getCreator()">getCreator</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code><a href="../common/events/EventDriverFactory.html" title="class in org.eclipse.jetty.websocket.common.events">EventDriverFactory</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getEventDriverFactory()">getEventDriverFactory</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>java.util.concurrent.Executor</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getExecutor()">getExecutor</a></span>()</code></th>
<td class="colLast">
<div class="block">Executor in use by the container.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code><a href="../api/extensions/ExtensionFactory.html" title="class in org.eclipse.jetty.websocket.api.extensions">ExtensionFactory</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getExtensionFactory()">getExtensionFactory</a></span>()</code></th>
<td class="colLast">
<div class="block"><span class="deprecatedLabel">Deprecated.</span></div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code><a href="../../util/DecoratedObjectFactory.html" title="class in org.eclipse.jetty.util">DecoratedObjectFactory</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getObjectFactory()">getObjectFactory</a></span>()</code></th>
<td class="colLast">
<div class="block">Object Factory used to create objects.</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>java.util.Collection&lt;<a href="../common/WebSocketSession.html" title="class in org.eclipse.jetty.websocket.common">WebSocketSession</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getOpenSessions()">getOpenSessions</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code><a href="../api/WebSocketPolicy.html" title="class in org.eclipse.jetty.websocket.api">WebSocketPolicy</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getPolicy()">getPolicy</a></span>()</code></th>
<td class="colLast">
<div class="block">The policy the container is running on.</div>
</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code>java.util.Collection&lt;<a href="../common/WebSocketSessionListener.html" title="interface in org.eclipse.jetty.websocket.common">WebSocketSessionListener</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSessionListeners()">getSessionListeners</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code><a href="../../util/ssl/SslContextFactory.html" title="class in org.eclipse.jetty.util.ssl">SslContextFactory</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSslContextFactory()">getSslContextFactory</a></span>()</code></th>
<td class="colLast">
<div class="block">The SslContextFactory in use by the container.</div>
</td>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isUpgradeRequest(javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse)">isUpgradeRequest</a></span>&#8203;(javax.servlet.http.HttpServletRequest&nbsp;request,
javax.servlet.http.HttpServletResponse&nbsp;response)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i19" class="rowColor">
<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;websocketPojo)</code></th>
<td class="colLast">
<div class="block">Register a websocket class pojo with the default <a href="../servlet/WebSocketCreator.html" title="interface in org.eclipse.jetty.websocket.servlet"><code>WebSocketCreator</code></a>.</div>
</td>
</tr>
<tr id="i20" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#removeSessionListener(org.eclipse.jetty.websocket.common.WebSocketSessionListener)">removeSessionListener</a></span>&#8203;(<a href="../common/WebSocketSessionListener.html" title="interface in org.eclipse.jetty.websocket.common">WebSocketSessionListener</a>&nbsp;listener)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i21" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setCreator(org.eclipse.jetty.websocket.servlet.WebSocketCreator)">setCreator</a></span>&#8203;(<a href="../servlet/WebSocketCreator.html" title="interface in org.eclipse.jetty.websocket.servlet">WebSocketCreator</a>&nbsp;creator)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i22" 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.org.eclipse.jetty.util.component.ContainerLifeCycle">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.eclipse.jetty.util.component.<a href="../../util/component/ContainerLifeCycle.html" title="class in org.eclipse.jetty.util.component">ContainerLifeCycle</a></h3>
<code><a href="../../util/component/ContainerLifeCycle.html#addBean(java.lang.Object)">addBean</a>, <a href="../../util/component/ContainerLifeCycle.html#addBean(java.lang.Object,boolean)">addBean</a>, <a href="../../util/component/ContainerLifeCycle.html#addEventListener(org.eclipse.jetty.util.component.Container.Listener)">addEventListener</a>, <a href="../../util/component/ContainerLifeCycle.html#addManaged(org.eclipse.jetty.util.component.LifeCycle)">addManaged</a>, <a href="../../util/component/ContainerLifeCycle.html#contains(java.lang.Object)">contains</a>, <a href="../../util/component/ContainerLifeCycle.html#destroy()">destroy</a>, <a href="../../util/component/ContainerLifeCycle.html#dump()">dump</a>, <a href="../../util/component/ContainerLifeCycle.html#dump(java.lang.Appendable)">dump</a>, <a href="../../util/component/ContainerLifeCycle.html#dump(java.lang.Appendable,java.lang.String)">dump</a>, <a href="../../util/component/ContainerLifeCycle.html#dump(java.lang.Appendable,java.lang.String,java.util.Collection...)">dump</a>, <a href="../../util/component/ContainerLifeCycle.html#dump(org.eclipse.jetty.util.component.Dumpable)">dump</a>, <a href="../../util/component/ContainerLifeCycle.html#dumpBeans(java.lang.Appendable,java.lang.String,java.util.Collection...)">dumpBeans</a>, <a href="../../util/component/ContainerLifeCycle.html#dumpObject(java.lang.Appendable,java.lang.Object)">dumpObject</a>, <a href="../../util/component/ContainerLifeCycle.html#dumpObjects(java.lang.Appendable,java.lang.String,java.lang.Object...)">dumpObjects</a>, <a href="../../util/component/ContainerLifeCycle.html#dumpStdErr()">dumpStdErr</a>, <a href="../../util/component/ContainerLifeCycle.html#dumpThis(java.lang.Appendable)">dumpThis</a>, <a href="../../util/component/ContainerLifeCycle.html#getBean(java.lang.Class)">getBean</a>, <a href="../../util/component/ContainerLifeCycle.html#getBeans()">getBeans</a>, <a href="../../util/component/ContainerLifeCycle.html#getBeans(java.lang.Class)">getBeans</a>, <a href="../../util/component/ContainerLifeCycle.html#getContainedBeans(java.lang.Class)">getContainedBeans</a>, <a href="../../util/component/ContainerLifeCycle.html#getContainedBeans(java.lang.Class,java.util.Collection)">getContainedBeans</a>, <a href="../../util/component/ContainerLifeCycle.html#isAuto(java.lang.Object)">isAuto</a>, <a href="../../util/component/ContainerLifeCycle.html#isManaged(java.lang.Object)">isManaged</a>, <a href="../../util/component/ContainerLifeCycle.html#isUnmanaged(java.lang.Object)">isUnmanaged</a>, <a href="../../util/component/ContainerLifeCycle.html#manage(java.lang.Object)">manage</a>, <a href="../../util/component/ContainerLifeCycle.html#removeBean(java.lang.Object)">removeBean</a>, <a href="../../util/component/ContainerLifeCycle.html#removeBeans()">removeBeans</a>, <a href="../../util/component/ContainerLifeCycle.html#removeEventListener(org.eclipse.jetty.util.component.Container.Listener)">removeEventListener</a>, <a href="../../util/component/ContainerLifeCycle.html#setBeans(java.util.Collection)">setBeans</a>, <a href="../../util/component/ContainerLifeCycle.html#setStopTimeout(long)">setStopTimeout</a>, <a href="../../util/component/ContainerLifeCycle.html#start(org.eclipse.jetty.util.component.LifeCycle)">start</a>, <a href="../../util/component/ContainerLifeCycle.html#stop(org.eclipse.jetty.util.component.LifeCycle)">stop</a>, <a href="../../util/component/ContainerLifeCycle.html#unmanage(java.lang.Object)">unmanage</a>, <a href="../../util/component/ContainerLifeCycle.html#updateBean(java.lang.Object,java.lang.Object)">updateBean</a>, <a href="../../util/component/ContainerLifeCycle.html#updateBean(java.lang.Object,java.lang.Object,boolean)">updateBean</a>, <a href="../../util/component/ContainerLifeCycle.html#updateBeans(java.lang.Object%5B%5D,java.lang.Object%5B%5D)">updateBeans</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.org.eclipse.jetty.util.component.AbstractLifeCycle">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.eclipse.jetty.util.component.<a href="../../util/component/AbstractLifeCycle.html" title="class in org.eclipse.jetty.util.component">AbstractLifeCycle</a></h3>
<code><a href="../../util/component/AbstractLifeCycle.html#addLifeCycleListener(org.eclipse.jetty.util.component.LifeCycle.Listener)">addLifeCycleListener</a>, <a href="../../util/component/AbstractLifeCycle.html#getState()">getState</a>, <a href="../../util/component/AbstractLifeCycle.html#getState(org.eclipse.jetty.util.component.LifeCycle)">getState</a>, <a href="../../util/component/AbstractLifeCycle.html#getStopTimeout()">getStopTimeout</a>, <a href="../../util/component/AbstractLifeCycle.html#isFailed()">isFailed</a>, <a href="../../util/component/AbstractLifeCycle.html#isRunning()">isRunning</a>, <a href="../../util/component/AbstractLifeCycle.html#isStarted()">isStarted</a>, <a href="../../util/component/AbstractLifeCycle.html#isStarting()">isStarting</a>, <a href="../../util/component/AbstractLifeCycle.html#isStopped()">isStopped</a>, <a href="../../util/component/AbstractLifeCycle.html#isStopping()">isStopping</a>, <a href="../../util/component/AbstractLifeCycle.html#removeLifeCycleListener(org.eclipse.jetty.util.component.LifeCycle.Listener)">removeLifeCycleListener</a>, <a href="../../util/component/AbstractLifeCycle.html#start()">start</a>, <a href="../../util/component/AbstractLifeCycle.html#stop()">stop</a></code></li>
</ul>
<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>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.org.eclipse.jetty.websocket.common.scopes.WebSocketContainerScope">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.eclipse.jetty.websocket.common.scopes.<a href="../common/scopes/WebSocketContainerScope.html" title="interface in org.eclipse.jetty.websocket.common.scopes">WebSocketContainerScope</a></h3>
<code><a href="../common/scopes/WebSocketContainerScope.html#isRunning()">isRunning</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.org.eclipse.jetty.websocket.servlet.WebSocketServletFactory">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.eclipse.jetty.websocket.servlet.<a href="../servlet/WebSocketServletFactory.html" title="interface in org.eclipse.jetty.websocket.servlet">WebSocketServletFactory</a></h3>
<code><a href="../servlet/WebSocketServletFactory.html#start()">start</a>, <a href="../servlet/WebSocketServletFactory.html#stop()">stop</a></code></li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a id="&lt;init&gt;()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>WebSocketServerFactory</h4>
<pre>public&nbsp;WebSocketServerFactory()</pre>
<div class="block">Entry point for Spring Boot's MockMVC framework</div>
</li>
</ul>
<a id="&lt;init&gt;(javax.servlet.ServletContext)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>WebSocketServerFactory</h4>
<pre>public&nbsp;WebSocketServerFactory&#8203;(javax.servlet.ServletContext&nbsp;context)</pre>
</li>
</ul>
<a id="&lt;init&gt;(javax.servlet.ServletContext,org.eclipse.jetty.io.ByteBufferPool)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>WebSocketServerFactory</h4>
<pre>public&nbsp;WebSocketServerFactory&#8203;(javax.servlet.ServletContext&nbsp;context,
<a href="../../io/ByteBufferPool.html" title="interface in org.eclipse.jetty.io">ByteBufferPool</a>&nbsp;bufferPool)</pre>
</li>
</ul>
<a id="&lt;init&gt;(javax.servlet.ServletContext,org.eclipse.jetty.websocket.api.WebSocketPolicy)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>WebSocketServerFactory</h4>
<pre>public&nbsp;WebSocketServerFactory&#8203;(javax.servlet.ServletContext&nbsp;context,
<a href="../api/WebSocketPolicy.html" title="class in org.eclipse.jetty.websocket.api">WebSocketPolicy</a>&nbsp;policy)</pre>
<div class="block">Entry point for <a href="../servlet/WebSocketServletFactory.Loader.html" title="class in org.eclipse.jetty.websocket.servlet"><code>WebSocketServletFactory.Loader</code></a></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>context</code> - the servlet context</dd>
<dd><code>policy</code> - the policy to use</dd>
</dl>
</li>
</ul>
<a id="&lt;init&gt;(javax.servlet.ServletContext,org.eclipse.jetty.websocket.api.WebSocketPolicy,org.eclipse.jetty.io.ByteBufferPool)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>WebSocketServerFactory</h4>
<pre>public&nbsp;WebSocketServerFactory&#8203;(javax.servlet.ServletContext&nbsp;context,
<a href="../api/WebSocketPolicy.html" title="class in org.eclipse.jetty.websocket.api">WebSocketPolicy</a>&nbsp;policy,
<a href="../../io/ByteBufferPool.html" title="interface in org.eclipse.jetty.io">ByteBufferPool</a>&nbsp;bufferPool)</pre>
</li>
</ul>
<a id="&lt;init&gt;(org.eclipse.jetty.websocket.api.WebSocketPolicy,java.util.concurrent.Executor,org.eclipse.jetty.io.ByteBufferPool)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>WebSocketServerFactory</h4>
<pre>protected&nbsp;WebSocketServerFactory&#8203;(<a href="../api/WebSocketPolicy.html" title="class in org.eclipse.jetty.websocket.api">WebSocketPolicy</a>&nbsp;policy,
java.util.concurrent.Executor&nbsp;executor,
<a href="../../io/ByteBufferPool.html" title="interface in org.eclipse.jetty.io">ByteBufferPool</a>&nbsp;bufferPool)</pre>
<div class="block">Protected entry point for <a href="WebSocketHandler.html" title="class in org.eclipse.jetty.websocket.server"><code>WebSocketHandler</code></a></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>policy</code> - the policy to use</dd>
<dd><code>executor</code> - the executor to use</dd>
<dd><code>bufferPool</code> - the buffer pool to use</dd>
</dl>
</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="addSessionListener(org.eclipse.jetty.websocket.common.WebSocketSessionListener)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addSessionListener</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;addSessionListener&#8203;(<a href="../common/WebSocketSessionListener.html" title="interface in org.eclipse.jetty.websocket.common">WebSocketSessionListener</a>&nbsp;listener)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../common/scopes/WebSocketContainerScope.html#addSessionListener(org.eclipse.jetty.websocket.common.WebSocketSessionListener)">addSessionListener</a></code>&nbsp;in interface&nbsp;<code><a href="../common/scopes/WebSocketContainerScope.html" title="interface in org.eclipse.jetty.websocket.common.scopes">WebSocketContainerScope</a></code></dd>
</dl>
</li>
</ul>
<a id="removeSessionListener(org.eclipse.jetty.websocket.common.WebSocketSessionListener)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeSessionListener</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;removeSessionListener&#8203;(<a href="../common/WebSocketSessionListener.html" title="interface in org.eclipse.jetty.websocket.common">WebSocketSessionListener</a>&nbsp;listener)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../common/scopes/WebSocketContainerScope.html#removeSessionListener(org.eclipse.jetty.websocket.common.WebSocketSessionListener)">removeSessionListener</a></code>&nbsp;in interface&nbsp;<code><a href="../common/scopes/WebSocketContainerScope.html" title="interface in org.eclipse.jetty.websocket.common.scopes">WebSocketContainerScope</a></code></dd>
</dl>
</li>
</ul>
<a id="getSessionListeners()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSessionListeners</h4>
<pre class="methodSignature">public&nbsp;java.util.Collection&lt;<a href="../common/WebSocketSessionListener.html" title="interface in org.eclipse.jetty.websocket.common">WebSocketSessionListener</a>&gt;&nbsp;getSessionListeners()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../common/scopes/WebSocketContainerScope.html#getSessionListeners()">getSessionListeners</a></code>&nbsp;in interface&nbsp;<code><a href="../common/scopes/WebSocketContainerScope.html" title="interface in org.eclipse.jetty.websocket.common.scopes">WebSocketContainerScope</a></code></dd>
</dl>
</li>
</ul>
<a id="acceptWebSocket(javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>acceptWebSocket</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;acceptWebSocket&#8203;(javax.servlet.http.HttpServletRequest&nbsp;request,
javax.servlet.http.HttpServletResponse&nbsp;response)
throws java.io.IOException</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../servlet/WebSocketServletFactory.html#acceptWebSocket(javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse)">acceptWebSocket</a></code>&nbsp;in interface&nbsp;<code><a href="../servlet/WebSocketServletFactory.html" title="interface in org.eclipse.jetty.websocket.servlet">WebSocketServletFactory</a></code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.io.IOException</code></dd>
</dl>
</li>
</ul>
<a id="acceptWebSocket(org.eclipse.jetty.websocket.servlet.WebSocketCreator,javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>acceptWebSocket</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;acceptWebSocket&#8203;(<a href="../servlet/WebSocketCreator.html" title="interface in org.eclipse.jetty.websocket.servlet">WebSocketCreator</a>&nbsp;creator,
javax.servlet.http.HttpServletRequest&nbsp;request,
javax.servlet.http.HttpServletResponse&nbsp;response)
throws java.io.IOException</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../servlet/WebSocketServletFactory.html#acceptWebSocket(org.eclipse.jetty.websocket.servlet.WebSocketCreator,javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse)">acceptWebSocket</a></code>&nbsp;in interface&nbsp;<code><a href="../servlet/WebSocketServletFactory.html" title="interface in org.eclipse.jetty.websocket.servlet">WebSocketServletFactory</a></code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.io.IOException</code></dd>
</dl>
</li>
</ul>
<a id="addSessionFactory(org.eclipse.jetty.websocket.common.SessionFactory)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addSessionFactory</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;addSessionFactory&#8203;(<a href="../common/SessionFactory.html" title="interface in org.eclipse.jetty.websocket.common">SessionFactory</a>&nbsp;sessionFactory)</pre>
</li>
</ul>
<a id="createWebSocket(org.eclipse.jetty.websocket.servlet.ServletUpgradeRequest,org.eclipse.jetty.websocket.servlet.ServletUpgradeResponse)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createWebSocket</h4>
<pre class="methodSignature">public&nbsp;java.lang.Object&nbsp;createWebSocket&#8203;(<a href="../servlet/ServletUpgradeRequest.html" title="class in org.eclipse.jetty.websocket.servlet">ServletUpgradeRequest</a>&nbsp;req,
<a href="../servlet/ServletUpgradeResponse.html" title="class in org.eclipse.jetty.websocket.servlet">ServletUpgradeResponse</a>&nbsp;resp)</pre>
<div class="block">Default Creator logic</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../servlet/WebSocketCreator.html#createWebSocket(org.eclipse.jetty.websocket.servlet.ServletUpgradeRequest,org.eclipse.jetty.websocket.servlet.ServletUpgradeResponse)">createWebSocket</a></code>&nbsp;in interface&nbsp;<code><a href="../servlet/WebSocketCreator.html" title="interface in org.eclipse.jetty.websocket.servlet">WebSocketCreator</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>req</code> - the request details</dd>
<dd><code>resp</code> - the response details</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a websocket object to use, or null if no websocket should be created from this request.</dd>
</dl>
</li>
</ul>
<a id="doStart()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>doStart</h4>
<pre class="methodSignature">protected&nbsp;void&nbsp;doStart()
throws java.lang.Exception</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../util/component/ContainerLifeCycle.html#doStart()">ContainerLifeCycle</a></code></span></div>
<div class="block">Starts the managed lifecycle beans in the order they were added.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../util/component/ContainerLifeCycle.html#doStart()">doStart</a></code>&nbsp;in class&nbsp;<code><a href="../../util/component/ContainerLifeCycle.html" title="class in org.eclipse.jetty.util.component">ContainerLifeCycle</a></code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.Exception</code></dd>
</dl>
</li>
</ul>
<a id="doStop()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>doStop</h4>
<pre class="methodSignature">protected&nbsp;void&nbsp;doStop()
throws java.lang.Exception</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../util/component/ContainerLifeCycle.html#doStop()">ContainerLifeCycle</a></code></span></div>
<div class="block">Stops the managed lifecycle beans in the reverse order they were added.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../util/component/ContainerLifeCycle.html#doStop()">doStop</a></code>&nbsp;in class&nbsp;<code><a href="../../util/component/ContainerLifeCycle.html" title="class in org.eclipse.jetty.util.component">ContainerLifeCycle</a></code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.Exception</code></dd>
</dl>
</li>
</ul>
<a id="getBufferPool()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getBufferPool</h4>
<pre class="methodSignature">public&nbsp;<a href="../../io/ByteBufferPool.html" title="interface in org.eclipse.jetty.io">ByteBufferPool</a>&nbsp;getBufferPool()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../common/scopes/WebSocketContainerScope.html#getBufferPool()">WebSocketContainerScope</a></code></span></div>
<div class="block">The configured Container Buffer Pool.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../common/scopes/WebSocketContainerScope.html#getBufferPool()">getBufferPool</a></code>&nbsp;in interface&nbsp;<code><a href="../common/scopes/WebSocketContainerScope.html" title="interface in org.eclipse.jetty.websocket.common.scopes">WebSocketContainerScope</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the buffer pool (never null)</dd>
</dl>
</li>
</ul>
<a id="getCreator()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCreator</h4>
<pre class="methodSignature">public&nbsp;<a href="../servlet/WebSocketCreator.html" title="interface in org.eclipse.jetty.websocket.servlet">WebSocketCreator</a>&nbsp;getCreator()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../servlet/WebSocketServletFactory.html#getCreator()">getCreator</a></code>&nbsp;in interface&nbsp;<code><a href="../servlet/WebSocketServletFactory.html" title="interface in org.eclipse.jetty.websocket.servlet">WebSocketServletFactory</a></code></dd>
</dl>
</li>
</ul>
<a id="getExecutor()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getExecutor</h4>
<pre class="methodSignature">public&nbsp;java.util.concurrent.Executor&nbsp;getExecutor()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../common/scopes/WebSocketContainerScope.html#getExecutor()">WebSocketContainerScope</a></code></span></div>
<div class="block">Executor in use by the container.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../common/scopes/WebSocketContainerScope.html#getExecutor()">getExecutor</a></code>&nbsp;in interface&nbsp;<code><a href="../common/scopes/WebSocketContainerScope.html" title="interface in org.eclipse.jetty.websocket.common.scopes">WebSocketContainerScope</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the Executor in use by the container.</dd>
</dl>
</li>
</ul>
<a id="getObjectFactory()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getObjectFactory</h4>
<pre class="methodSignature">public&nbsp;<a href="../../util/DecoratedObjectFactory.html" title="class in org.eclipse.jetty.util">DecoratedObjectFactory</a>&nbsp;getObjectFactory()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../common/scopes/WebSocketContainerScope.html#getObjectFactory()">WebSocketContainerScope</a></code></span></div>
<div class="block">Object Factory used to create objects.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../common/scopes/WebSocketContainerScope.html#getObjectFactory()">getObjectFactory</a></code>&nbsp;in interface&nbsp;<code><a href="../common/scopes/WebSocketContainerScope.html" title="interface in org.eclipse.jetty.websocket.common.scopes">WebSocketContainerScope</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Object Factory used to create instances of objects.</dd>
</dl>
</li>
</ul>
<a id="getEventDriverFactory()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getEventDriverFactory</h4>
<pre class="methodSignature">public&nbsp;<a href="../common/events/EventDriverFactory.html" title="class in org.eclipse.jetty.websocket.common.events">EventDriverFactory</a>&nbsp;getEventDriverFactory()</pre>
</li>
</ul>
<a id="getAvailableExtensionNames()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAvailableExtensionNames</h4>
<pre class="methodSignature">public&nbsp;java.util.Set&lt;java.lang.String&gt;&nbsp;getAvailableExtensionNames()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../servlet/WebSocketServletFactory.html#getAvailableExtensionNames()">WebSocketServletFactory</a></code></span></div>
<div class="block">Get the set of available Extensions by registered name.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../servlet/WebSocketServletFactory.html#getAvailableExtensionNames()">getAvailableExtensionNames</a></code>&nbsp;in interface&nbsp;<code><a href="../servlet/WebSocketServletFactory.html" title="interface in org.eclipse.jetty.websocket.servlet">WebSocketServletFactory</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the set of available extensions by registered name.</dd>
</dl>
</li>
</ul>
<a id="getExtensionFactory()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getExtensionFactory</h4>
<pre class="methodSignature">@Deprecated
public&nbsp;<a href="../api/extensions/ExtensionFactory.html" title="class in org.eclipse.jetty.websocket.api.extensions">ExtensionFactory</a>&nbsp;getExtensionFactory()</pre>
<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../servlet/WebSocketServletFactory.html#getExtensionFactory()">WebSocketServletFactory</a></code></span></div>
<div class="block">Get the registered extensions for this WebSocket factory.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../servlet/WebSocketServletFactory.html#getExtensionFactory()">getExtensionFactory</a></code>&nbsp;in interface&nbsp;<code><a href="../servlet/WebSocketServletFactory.html" title="interface in org.eclipse.jetty.websocket.servlet">WebSocketServletFactory</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the ExtensionFactory</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../servlet/WebSocketServletFactory.html#getAvailableExtensionNames()"><code>WebSocketServletFactory.getAvailableExtensionNames()</code></a></dd>
</dl>
</li>
</ul>
<a id="getOpenSessions()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getOpenSessions</h4>
<pre class="methodSignature">public&nbsp;java.util.Collection&lt;<a href="../common/WebSocketSession.html" title="class in org.eclipse.jetty.websocket.common">WebSocketSession</a>&gt;&nbsp;getOpenSessions()</pre>
</li>
</ul>
<a id="getPolicy()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPolicy</h4>
<pre class="methodSignature">public&nbsp;<a href="../api/WebSocketPolicy.html" title="class in org.eclipse.jetty.websocket.api">WebSocketPolicy</a>&nbsp;getPolicy()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../common/scopes/WebSocketContainerScope.html#getPolicy()">WebSocketContainerScope</a></code></span></div>
<div class="block">The policy the container is running on.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../common/scopes/WebSocketContainerScope.html#getPolicy()">getPolicy</a></code>&nbsp;in interface&nbsp;<code><a href="../common/scopes/WebSocketContainerScope.html" title="interface in org.eclipse.jetty.websocket.common.scopes">WebSocketContainerScope</a></code></dd>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../servlet/WebSocketServletFactory.html#getPolicy()">getPolicy</a></code>&nbsp;in interface&nbsp;<code><a href="../servlet/WebSocketServletFactory.html" title="interface in org.eclipse.jetty.websocket.servlet">WebSocketServletFactory</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the websocket policy</dd>
</dl>
</li>
</ul>
<a id="getSslContextFactory()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSslContextFactory</h4>
<pre class="methodSignature">public&nbsp;<a href="../../util/ssl/SslContextFactory.html" title="class in org.eclipse.jetty.util.ssl">SslContextFactory</a>&nbsp;getSslContextFactory()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../common/scopes/WebSocketContainerScope.html#getSslContextFactory()">WebSocketContainerScope</a></code></span></div>
<div class="block">The SslContextFactory in use by the container.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../common/scopes/WebSocketContainerScope.html#getSslContextFactory()">getSslContextFactory</a></code>&nbsp;in interface&nbsp;<code><a href="../common/scopes/WebSocketContainerScope.html" title="interface in org.eclipse.jetty.websocket.common.scopes">WebSocketContainerScope</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the SslContextFactory in use by the container (can be null if no SSL context is defined)</dd>
</dl>
</li>
</ul>
<a id="isUpgradeRequest(javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isUpgradeRequest</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;isUpgradeRequest&#8203;(javax.servlet.http.HttpServletRequest&nbsp;request,
javax.servlet.http.HttpServletResponse&nbsp;response)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../servlet/WebSocketServletFactory.html#isUpgradeRequest(javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse)">isUpgradeRequest</a></code>&nbsp;in interface&nbsp;<code><a href="../servlet/WebSocketServletFactory.html" title="interface in org.eclipse.jetty.websocket.servlet">WebSocketServletFactory</a></code></dd>
</dl>
</li>
</ul>
<a id="register(java.lang.Class)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>register</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;register&#8203;(java.lang.Class&lt;?&gt;&nbsp;websocketPojo)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../servlet/WebSocketServletFactory.html#register(java.lang.Class)">WebSocketServletFactory</a></code></span></div>
<div class="block">Register a websocket class pojo with the default <a href="../servlet/WebSocketCreator.html" title="interface in org.eclipse.jetty.websocket.servlet"><code>WebSocketCreator</code></a>.
<p>
Note: only required if using the default <a href="../servlet/WebSocketCreator.html" title="interface in org.eclipse.jetty.websocket.servlet"><code>WebSocketCreator</code></a> provided by this factory.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../servlet/WebSocketServletFactory.html#register(java.lang.Class)">register</a></code>&nbsp;in interface&nbsp;<code><a href="../servlet/WebSocketServletFactory.html" title="interface in org.eclipse.jetty.websocket.servlet">WebSocketServletFactory</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>websocketPojo</code> - the class to instantiate for each incoming websocket upgrade request.</dd>
</dl>
</li>
</ul>
<a id="setCreator(org.eclipse.jetty.websocket.servlet.WebSocketCreator)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setCreator</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setCreator&#8203;(<a href="../servlet/WebSocketCreator.html" title="interface in org.eclipse.jetty.websocket.servlet">WebSocketCreator</a>&nbsp;creator)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../servlet/WebSocketServletFactory.html#setCreator(org.eclipse.jetty.websocket.servlet.WebSocketCreator)">setCreator</a></code>&nbsp;in interface&nbsp;<code><a href="../servlet/WebSocketServletFactory.html" title="interface in org.eclipse.jetty.websocket.servlet">WebSocketServletFactory</a></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><a href="../../util/component/AbstractLifeCycle.html#toString()">toString</a></code>&nbsp;in class&nbsp;<code><a href="../../util/component/AbstractLifeCycle.html" title="class in org.eclipse.jetty.util.component">AbstractLifeCycle</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/WebSocketServerFactory.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>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
<p class="legalCopy"><small>Copyright &#169; 1995&#x2013;2020 <a href="https://webtide.com">Webtide</a>. All rights reserved.</small></p>
</footer>
</body>
</html>