| <!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>WebSocketServerFactory (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="WebSocketServerFactory (Jetty :: Project 9.3.24.v20180605 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"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":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete 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/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"> |
| <li><a href="../../../../../org/eclipse/jetty/websocket/server/WebSocketServerConnection.html" title="class in org.eclipse.jetty.websocket.server"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/eclipse/jetty/websocket/server/WebSocketUpgradeFilter.html" title="class in org.eclipse.jetty.websocket.server"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/eclipse/jetty/websocket/server/WebSocketServerFactory.html" target="_top">Frames</a></li> |
| <li><a href="WebSocketServerFactory.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../allclasses-noframe.html">All 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: </li> |
| <li><a href="#nested.classes.inherited.from.class.org.eclipse.jetty.util.component.AbstractLifeCycle">Nested</a> | </li> |
| <li><a href="#fields.inherited.from.class.org.eclipse.jetty.util.component.AbstractLifeCycle">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </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 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="../../../../../org/eclipse/jetty/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="../../../../../org/eclipse/jetty/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><a href="../../../../../org/eclipse/jetty/util/component/Container.html" title="interface in org.eclipse.jetty.util.component">Container</a>, <a href="../../../../../org/eclipse/jetty/util/component/Destroyable.html" title="interface in org.eclipse.jetty.util.component">Destroyable</a>, <a href="../../../../../org/eclipse/jetty/util/component/Dumpable.html" title="interface in org.eclipse.jetty.util.component">Dumpable</a>, <a href="../../../../../org/eclipse/jetty/util/component/LifeCycle.html" title="interface in org.eclipse.jetty.util.component">LifeCycle</a>, <a href="../../../../../org/eclipse/jetty/websocket/common/scopes/WebSocketContainerScope.html" title="interface in org.eclipse.jetty.websocket.common.scopes">WebSocketContainerScope</a>, <a href="../../../../../org/eclipse/jetty/websocket/servlet/WebSocketCreator.html" title="interface in org.eclipse.jetty.websocket.servlet">WebSocketCreator</a>, <a href="../../../../../org/eclipse/jetty/websocket/servlet/WebSocketServletFactory.html" title="interface in org.eclipse.jetty.websocket.servlet">WebSocketServletFactory</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public class <span class="typeNameLabel">WebSocketServerFactory</span> |
| extends <a href="../../../../../org/eclipse/jetty/util/component/ContainerLifeCycle.html" title="class in org.eclipse.jetty.util.component">ContainerLifeCycle</a> |
| implements <a href="../../../../../org/eclipse/jetty/websocket/servlet/WebSocketCreator.html" title="interface in org.eclipse.jetty.websocket.servlet">WebSocketCreator</a>, <a href="../../../../../org/eclipse/jetty/websocket/common/scopes/WebSocketContainerScope.html" title="interface in org.eclipse.jetty.websocket.common.scopes">WebSocketContainerScope</a>, <a href="../../../../../org/eclipse/jetty/websocket/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 ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="nested.class.summary"> |
| <!-- --> |
| </a> |
| <h3>Nested Class Summary</h3> |
| <ul class="blockList"> |
| <li class="blockList"><a name="nested.classes.inherited.from.class.org.eclipse.jetty.util.component.AbstractLifeCycle"> |
| <!-- --> |
| </a> |
| <h3>Nested classes/interfaces inherited from class org.eclipse.jetty.util.component.<a href="../../../../../org/eclipse/jetty/util/component/AbstractLifeCycle.html" title="class in org.eclipse.jetty.util.component">AbstractLifeCycle</a></h3> |
| <code><a href="../../../../../org/eclipse/jetty/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 name="nested.classes.inherited.from.class.org.eclipse.jetty.websocket.servlet.WebSocketServletFactory"> |
| <!-- --> |
| </a> |
| <h3>Nested classes/interfaces inherited from interface org.eclipse.jetty.websocket.servlet.<a href="../../../../../org/eclipse/jetty/websocket/servlet/WebSocketServletFactory.html" title="interface in org.eclipse.jetty.websocket.servlet">WebSocketServletFactory</a></h3> |
| <code><a href="../../../../../org/eclipse/jetty/websocket/servlet/WebSocketServletFactory.Loader.html" title="class in org.eclipse.jetty.websocket.servlet">WebSocketServletFactory.Loader</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="nested.classes.inherited.from.class.org.eclipse.jetty.util.component.Container"> |
| <!-- --> |
| </a> |
| <h3>Nested classes/interfaces inherited from interface org.eclipse.jetty.util.component.<a href="../../../../../org/eclipse/jetty/util/component/Container.html" title="interface in org.eclipse.jetty.util.component">Container</a></h3> |
| <code><a href="../../../../../org/eclipse/jetty/util/component/Container.InheritedListener.html" title="interface in org.eclipse.jetty.util.component">Container.InheritedListener</a>, <a href="../../../../../org/eclipse/jetty/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 name="nested.classes.inherited.from.class.org.eclipse.jetty.util.component.LifeCycle"> |
| <!-- --> |
| </a> |
| <h3>Nested classes/interfaces inherited from interface org.eclipse.jetty.util.component.<a href="../../../../../org/eclipse/jetty/util/component/LifeCycle.html" title="interface in org.eclipse.jetty.util.component">LifeCycle</a></h3> |
| <code><a href="../../../../../org/eclipse/jetty/util/component/LifeCycle.Listener.html" title="interface in org.eclipse.jetty.util.component">LifeCycle.Listener</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <ul class="blockList"> |
| <li class="blockList"><a name="fields.inherited.from.class.org.eclipse.jetty.util.component.AbstractLifeCycle"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from class org.eclipse.jetty.util.component.<a href="../../../../../org/eclipse/jetty/util/component/AbstractLifeCycle.html" title="class in org.eclipse.jetty.util.component">AbstractLifeCycle</a></h3> |
| <code><a href="../../../../../org/eclipse/jetty/util/component/AbstractLifeCycle.html#FAILED">FAILED</a>, <a href="../../../../../org/eclipse/jetty/util/component/AbstractLifeCycle.html#RUNNING">RUNNING</a>, <a href="../../../../../org/eclipse/jetty/util/component/AbstractLifeCycle.html#STARTED">STARTED</a>, <a href="../../../../../org/eclipse/jetty/util/component/AbstractLifeCycle.html#STARTING">STARTING</a>, <a href="../../../../../org/eclipse/jetty/util/component/AbstractLifeCycle.html#STOP_ON_FAILURE">STOP_ON_FAILURE</a>, <a href="../../../../../org/eclipse/jetty/util/component/AbstractLifeCycle.html#STOPPED">STOPPED</a>, <a href="../../../../../org/eclipse/jetty/util/component/AbstractLifeCycle.html#STOPPING">STOPPING</a></code></li> |
| </ul> |
| </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"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier</th> |
| <th class="colLast" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code> </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/jetty/websocket/server/WebSocketServerFactory.html#WebSocketServerFactory-javax.servlet.ServletContext-">WebSocketServerFactory</a></span>(javax.servlet.ServletContext context)</code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code> </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/jetty/websocket/server/WebSocketServerFactory.html#WebSocketServerFactory-javax.servlet.ServletContext-org.eclipse.jetty.io.ByteBufferPool-">WebSocketServerFactory</a></span>(javax.servlet.ServletContext context, |
| <a href="../../../../../org/eclipse/jetty/io/ByteBufferPool.html" title="interface in org.eclipse.jetty.io">ByteBufferPool</a> bufferPool)</code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code> </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/jetty/websocket/server/WebSocketServerFactory.html#WebSocketServerFactory-javax.servlet.ServletContext-org.eclipse.jetty.websocket.api.WebSocketPolicy-">WebSocketServerFactory</a></span>(javax.servlet.ServletContext context, |
| <a href="../../../../../org/eclipse/jetty/websocket/api/WebSocketPolicy.html" title="class in org.eclipse.jetty.websocket.api">WebSocketPolicy</a> policy)</code> |
| <div class="block">Entry point for <a href="../../../../../org/eclipse/jetty/websocket/servlet/WebSocketServletFactory.Loader.html" title="class in org.eclipse.jetty.websocket.servlet"><code>WebSocketServletFactory.Loader</code></a></div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code> </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/jetty/websocket/server/WebSocketServerFactory.html#WebSocketServerFactory-javax.servlet.ServletContext-org.eclipse.jetty.websocket.api.WebSocketPolicy-org.eclipse.jetty.io.ByteBufferPool-">WebSocketServerFactory</a></span>(javax.servlet.ServletContext context, |
| <a href="../../../../../org/eclipse/jetty/websocket/api/WebSocketPolicy.html" title="class in org.eclipse.jetty.websocket.api">WebSocketPolicy</a> policy, |
| <a href="../../../../../org/eclipse/jetty/io/ByteBufferPool.html" title="interface in org.eclipse.jetty.io">ByteBufferPool</a> bufferPool)</code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/jetty/websocket/server/WebSocketServerFactory.html#WebSocketServerFactory-org.eclipse.jetty.websocket.api.WebSocketPolicy-java.util.concurrent.Executor-org.eclipse.jetty.io.ByteBufferPool-">WebSocketServerFactory</a></span>(<a href="../../../../../org/eclipse/jetty/websocket/api/WebSocketPolicy.html" title="class in org.eclipse.jetty.websocket.api">WebSocketPolicy</a> policy, |
| java.util.concurrent.Executor executor, |
| <a href="../../../../../org/eclipse/jetty/io/ByteBufferPool.html" title="interface in org.eclipse.jetty.io">ByteBufferPool</a> bufferPool)</code> |
| <div class="block">Protected entry point for <a href="../../../../../org/eclipse/jetty/websocket/server/WebSocketHandler.html" title="class in org.eclipse.jetty.websocket.server"><code>WebSocketHandler</code></a></div> |
| </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"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </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>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/jetty/websocket/server/WebSocketServerFactory.html#acceptWebSocket-javax.servlet.http.HttpServletRequest-javax.servlet.http.HttpServletResponse-">acceptWebSocket</a></span>(javax.servlet.http.HttpServletRequest request, |
| javax.servlet.http.HttpServletResponse response)</code> </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/jetty/websocket/server/WebSocketServerFactory.html#acceptWebSocket-org.eclipse.jetty.websocket.servlet.WebSocketCreator-javax.servlet.http.HttpServletRequest-javax.servlet.http.HttpServletResponse-">acceptWebSocket</a></span>(<a href="../../../../../org/eclipse/jetty/websocket/servlet/WebSocketCreator.html" title="interface in org.eclipse.jetty.websocket.servlet">WebSocketCreator</a> creator, |
| javax.servlet.http.HttpServletRequest request, |
| javax.servlet.http.HttpServletResponse response)</code> </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/WebSocketServerFactory.html#addSessionFactory-org.eclipse.jetty.websocket.common.SessionFactory-">addSessionFactory</a></span>(<a href="../../../../../org/eclipse/jetty/websocket/common/SessionFactory.html" title="interface in org.eclipse.jetty.websocket.common">SessionFactory</a> sessionFactory)</code> </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/jetty/websocket/server/WebSocketServerFactory.html#addSessionListener-org.eclipse.jetty.websocket.common.WebSocketSession.Listener-">addSessionListener</a></span>(<a href="../../../../../org/eclipse/jetty/websocket/common/WebSocketSession.Listener.html" title="interface in org.eclipse.jetty.websocket.common">WebSocketSession.Listener</a> listener)</code> </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>java.lang.Object</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/jetty/websocket/server/WebSocketServerFactory.html#createWebSocket-org.eclipse.jetty.websocket.servlet.ServletUpgradeRequest-org.eclipse.jetty.websocket.servlet.ServletUpgradeResponse-">createWebSocket</a></span>(<a href="../../../../../org/eclipse/jetty/websocket/servlet/ServletUpgradeRequest.html" title="class in org.eclipse.jetty.websocket.servlet">ServletUpgradeRequest</a> req, |
| <a href="../../../../../org/eclipse/jetty/websocket/servlet/ServletUpgradeResponse.html" title="class in org.eclipse.jetty.websocket.servlet">ServletUpgradeResponse</a> resp)</code> |
| <div class="block">Default Creator logic</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/jetty/websocket/server/WebSocketServerFactory.html#doStart--">doStart</a></span>()</code> |
| <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><a href="../../../../../org/eclipse/jetty/io/ByteBufferPool.html" title="interface in org.eclipse.jetty.io">ByteBufferPool</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/jetty/websocket/server/WebSocketServerFactory.html#getBufferPool--">getBufferPool</a></span>()</code> |
| <div class="block">The configured Container Buffer Pool.</div> |
| </td> |
| </tr> |
| <tr id="i7" 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/WebSocketServerFactory.html#getCreator--">getCreator</a></span>()</code> </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/eclipse/jetty/websocket/common/events/EventDriverFactory.html" title="class in org.eclipse.jetty.websocket.common.events">EventDriverFactory</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/jetty/websocket/server/WebSocketServerFactory.html#getEventDriverFactory--">getEventDriverFactory</a></span>()</code> </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>java.util.concurrent.Executor</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/jetty/websocket/server/WebSocketServerFactory.html#getExecutor--">getExecutor</a></span>()</code> |
| <div class="block">Executor in use by the container.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/eclipse/jetty/websocket/api/extensions/ExtensionFactory.html" title="class in org.eclipse.jetty.websocket.api.extensions">ExtensionFactory</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/jetty/websocket/server/WebSocketServerFactory.html#getExtensionFactory--">getExtensionFactory</a></span>()</code> </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/eclipse/jetty/util/DecoratedObjectFactory.html" title="class in org.eclipse.jetty.util">DecoratedObjectFactory</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/jetty/websocket/server/WebSocketServerFactory.html#getObjectFactory--">getObjectFactory</a></span>()</code> |
| <div class="block">Object Factory used to create objects.</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code>java.util.Collection<<a href="../../../../../org/eclipse/jetty/websocket/common/WebSocketSession.html" title="class in org.eclipse.jetty.websocket.common">WebSocketSession</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/jetty/websocket/server/WebSocketServerFactory.html#getOpenSessions--">getOpenSessions</a></span>()</code> </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/eclipse/jetty/websocket/api/WebSocketPolicy.html" title="class in org.eclipse.jetty.websocket.api">WebSocketPolicy</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/jetty/websocket/server/WebSocketServerFactory.html#getPolicy--">getPolicy</a></span>()</code> |
| <div class="block">The policy the container is running on.</div> |
| </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/eclipse/jetty/util/ssl/SslContextFactory.html" title="class in org.eclipse.jetty.util.ssl">SslContextFactory</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/jetty/websocket/server/WebSocketServerFactory.html#getSslContextFactory--">getSslContextFactory</a></span>()</code> |
| <div class="block">The SslContextFactory in use by the container.</div> |
| </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/jetty/websocket/server/WebSocketServerFactory.html#isUpgradeRequest-javax.servlet.http.HttpServletRequest-javax.servlet.http.HttpServletResponse-">isUpgradeRequest</a></span>(javax.servlet.http.HttpServletRequest request, |
| javax.servlet.http.HttpServletResponse response)</code> </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/jetty/websocket/server/WebSocketServerFactory.html#onSessionClosed-org.eclipse.jetty.websocket.common.WebSocketSession-">onSessionClosed</a></span>(<a href="../../../../../org/eclipse/jetty/websocket/common/WebSocketSession.html" title="class in org.eclipse.jetty.websocket.common">WebSocketSession</a> session)</code> |
| <div class="block">A Session has been closed</div> |
| </td> |
| </tr> |
| <tr id="i17" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/jetty/websocket/server/WebSocketServerFactory.html#onSessionOpened-org.eclipse.jetty.websocket.common.WebSocketSession-">onSessionOpened</a></span>(<a href="../../../../../org/eclipse/jetty/websocket/common/WebSocketSession.html" title="class in org.eclipse.jetty.websocket.common">WebSocketSession</a> session)</code> |
| <div class="block">A Session has been opened</div> |
| </td> |
| </tr> |
| <tr id="i18" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/jetty/websocket/server/WebSocketServerFactory.html#register-java.lang.Class-">register</a></span>(java.lang.Class<?> websocketPojo)</code> |
| <div class="block">Register a websocket class pojo with the default <a href="../../../../../org/eclipse/jetty/websocket/servlet/WebSocketCreator.html" title="interface in org.eclipse.jetty.websocket.servlet"><code>WebSocketCreator</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i19" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/jetty/websocket/server/WebSocketServerFactory.html#removeSessionListener-org.eclipse.jetty.websocket.common.WebSocketSession.Listener-">removeSessionListener</a></span>(<a href="../../../../../org/eclipse/jetty/websocket/common/WebSocketSession.Listener.html" title="interface in org.eclipse.jetty.websocket.common">WebSocketSession.Listener</a> listener)</code> </td> |
| </tr> |
| <tr id="i20" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/jetty/websocket/server/WebSocketServerFactory.html#setCreator-org.eclipse.jetty.websocket.servlet.WebSocketCreator-">setCreator</a></span>(<a href="../../../../../org/eclipse/jetty/websocket/servlet/WebSocketCreator.html" title="interface in org.eclipse.jetty.websocket.servlet">WebSocketCreator</a> creator)</code> </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.eclipse.jetty.util.component.ContainerLifeCycle"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.eclipse.jetty.util.component.<a href="../../../../../org/eclipse/jetty/util/component/ContainerLifeCycle.html" title="class in org.eclipse.jetty.util.component">ContainerLifeCycle</a></h3> |
| <code><a href="../../../../../org/eclipse/jetty/util/component/ContainerLifeCycle.html#addBean-java.lang.Object-">addBean</a>, <a href="../../../../../org/eclipse/jetty/util/component/ContainerLifeCycle.html#addBean-java.lang.Object-boolean-">addBean</a>, <a href="../../../../../org/eclipse/jetty/util/component/ContainerLifeCycle.html#addBean-java.lang.Object-org.eclipse.jetty.util.component.ContainerLifeCycle.Managed-">addBean</a>, <a href="../../../../../org/eclipse/jetty/util/component/ContainerLifeCycle.html#addEventListener-org.eclipse.jetty.util.component.Container.Listener-">addEventListener</a>, <a href="../../../../../org/eclipse/jetty/util/component/ContainerLifeCycle.html#addManaged-org.eclipse.jetty.util.component.LifeCycle-">addManaged</a>, <a href="../../../../../org/eclipse/jetty/util/component/ContainerLifeCycle.html#contains-java.lang.Object-">contains</a>, <a href="../../../../../org/eclipse/jetty/util/component/ContainerLifeCycle.html#destroy--">destroy</a>, <a href="../../../../../org/eclipse/jetty/util/component/ContainerLifeCycle.html#doStop--">doStop</a>, <a href="../../../../../org/eclipse/jetty/util/component/ContainerLifeCycle.html#dump--">dump</a>, <a href="../../../../../org/eclipse/jetty/util/component/ContainerLifeCycle.html#dump-java.lang.Appendable-">dump</a>, <a href="../../../../../org/eclipse/jetty/util/component/ContainerLifeCycle.html#dump-java.lang.Appendable-java.lang.String-">dump</a>, <a href="../../../../../org/eclipse/jetty/util/component/ContainerLifeCycle.html#dump-java.lang.Appendable-java.lang.String-java.util.Collection...-">dump</a>, <a href="../../../../../org/eclipse/jetty/util/component/ContainerLifeCycle.html#dump-org.eclipse.jetty.util.component.Dumpable-">dump</a>, <a href="../../../../../org/eclipse/jetty/util/component/ContainerLifeCycle.html#dumpBeans-java.lang.Appendable-java.lang.String-java.util.Collection...-">dumpBeans</a>, <a href="../../../../../org/eclipse/jetty/util/component/ContainerLifeCycle.html#dumpObject-java.lang.Appendable-java.lang.Object-">dumpObject</a>, <a href="../../../../../org/eclipse/jetty/util/component/ContainerLifeCycle.html#dumpStdErr--">dumpStdErr</a>, <a href="../../../../../org/eclipse/jetty/util/component/ContainerLifeCycle.html#dumpThis-java.lang.Appendable-">dumpThis</a>, <a href="../../../../../org/eclipse/jetty/util/component/ContainerLifeCycle.html#getBean-java.lang.Class-">getBean</a>, <a href="../../../../../org/eclipse/jetty/util/component/ContainerLifeCycle.html#getBeans--">getBeans</a>, <a href="../../../../../org/eclipse/jetty/util/component/ContainerLifeCycle.html#getBeans-java.lang.Class-">getBeans</a>, <a href="../../../../../org/eclipse/jetty/util/component/ContainerLifeCycle.html#isManaged-java.lang.Object-">isManaged</a>, <a href="../../../../../org/eclipse/jetty/util/component/ContainerLifeCycle.html#manage-java.lang.Object-">manage</a>, <a href="../../../../../org/eclipse/jetty/util/component/ContainerLifeCycle.html#removeBean-java.lang.Object-">removeBean</a>, <a href="../../../../../org/eclipse/jetty/util/component/ContainerLifeCycle.html#removeBeans--">removeBeans</a>, <a href="../../../../../org/eclipse/jetty/util/component/ContainerLifeCycle.html#removeEventListener-org.eclipse.jetty.util.component.Container.Listener-">removeEventListener</a>, <a href="../../../../../org/eclipse/jetty/util/component/ContainerLifeCycle.html#setBeans-java.util.Collection-">setBeans</a>, <a href="../../../../../org/eclipse/jetty/util/component/ContainerLifeCycle.html#setStopTimeout-long-">setStopTimeout</a>, <a href="../../../../../org/eclipse/jetty/util/component/ContainerLifeCycle.html#start-org.eclipse.jetty.util.component.LifeCycle-">start</a>, <a href="../../../../../org/eclipse/jetty/util/component/ContainerLifeCycle.html#stop-org.eclipse.jetty.util.component.LifeCycle-">stop</a>, <a href="../../../../../org/eclipse/jetty/util/component/ContainerLifeCycle.html#unmanage-java.lang.Object-">unmanage</a>, <a href="../../../../../org/eclipse/jetty/util/component/ContainerLifeCycle.html#updateBean-java.lang.Object-java.lang.Object-">updateBean</a>, <a href="../../../../../org/eclipse/jetty/util/component/ContainerLifeCycle.html#updateBean-java.lang.Object-java.lang.Object-boolean-">updateBean</a>, <a href="../../../../../org/eclipse/jetty/util/component/ContainerLifeCycle.html#updateBeans-java.lang.Object:A-java.lang.Object:A-">updateBeans</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.eclipse.jetty.util.component.AbstractLifeCycle"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.eclipse.jetty.util.component.<a href="../../../../../org/eclipse/jetty/util/component/AbstractLifeCycle.html" title="class in org.eclipse.jetty.util.component">AbstractLifeCycle</a></h3> |
| <code><a href="../../../../../org/eclipse/jetty/util/component/AbstractLifeCycle.html#addLifeCycleListener-org.eclipse.jetty.util.component.LifeCycle.Listener-">addLifeCycleListener</a>, <a href="../../../../../org/eclipse/jetty/util/component/AbstractLifeCycle.html#getState--">getState</a>, <a href="../../../../../org/eclipse/jetty/util/component/AbstractLifeCycle.html#getState-org.eclipse.jetty.util.component.LifeCycle-">getState</a>, <a href="../../../../../org/eclipse/jetty/util/component/AbstractLifeCycle.html#getStopTimeout--">getStopTimeout</a>, <a href="../../../../../org/eclipse/jetty/util/component/AbstractLifeCycle.html#isFailed--">isFailed</a>, <a href="../../../../../org/eclipse/jetty/util/component/AbstractLifeCycle.html#isRunning--">isRunning</a>, <a href="../../../../../org/eclipse/jetty/util/component/AbstractLifeCycle.html#isStarted--">isStarted</a>, <a href="../../../../../org/eclipse/jetty/util/component/AbstractLifeCycle.html#isStarting--">isStarting</a>, <a href="../../../../../org/eclipse/jetty/util/component/AbstractLifeCycle.html#isStopped--">isStopped</a>, <a href="../../../../../org/eclipse/jetty/util/component/AbstractLifeCycle.html#isStopping--">isStopping</a>, <a href="../../../../../org/eclipse/jetty/util/component/AbstractLifeCycle.html#removeLifeCycleListener-org.eclipse.jetty.util.component.LifeCycle.Listener-">removeLifeCycleListener</a>, <a href="../../../../../org/eclipse/jetty/util/component/AbstractLifeCycle.html#start--">start</a>, <a href="../../../../../org/eclipse/jetty/util/component/AbstractLifeCycle.html#stop--">stop</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.Object</h3> |
| <code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.eclipse.jetty.websocket.common.scopes.WebSocketContainerScope"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.eclipse.jetty.websocket.common.scopes.<a href="../../../../../org/eclipse/jetty/websocket/common/scopes/WebSocketContainerScope.html" title="interface in org.eclipse.jetty.websocket.common.scopes">WebSocketContainerScope</a></h3> |
| <code><a href="../../../../../org/eclipse/jetty/websocket/common/scopes/WebSocketContainerScope.html#isRunning--">isRunning</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.eclipse.jetty.websocket.servlet.WebSocketServletFactory"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.eclipse.jetty.websocket.servlet.<a href="../../../../../org/eclipse/jetty/websocket/servlet/WebSocketServletFactory.html" title="interface in org.eclipse.jetty.websocket.servlet">WebSocketServletFactory</a></h3> |
| <code><a href="../../../../../org/eclipse/jetty/websocket/servlet/WebSocketServletFactory.html#start--">start</a>, <a href="../../../../../org/eclipse/jetty/websocket/servlet/WebSocketServletFactory.html#stop--">stop</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="WebSocketServerFactory-javax.servlet.ServletContext-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>WebSocketServerFactory</h4> |
| <pre>public WebSocketServerFactory(javax.servlet.ServletContext context)</pre> |
| </li> |
| </ul> |
| <a name="WebSocketServerFactory-javax.servlet.ServletContext-org.eclipse.jetty.io.ByteBufferPool-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>WebSocketServerFactory</h4> |
| <pre>public WebSocketServerFactory(javax.servlet.ServletContext context, |
| <a href="../../../../../org/eclipse/jetty/io/ByteBufferPool.html" title="interface in org.eclipse.jetty.io">ByteBufferPool</a> bufferPool)</pre> |
| </li> |
| </ul> |
| <a name="WebSocketServerFactory-javax.servlet.ServletContext-org.eclipse.jetty.websocket.api.WebSocketPolicy-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>WebSocketServerFactory</h4> |
| <pre>public WebSocketServerFactory(javax.servlet.ServletContext context, |
| <a href="../../../../../org/eclipse/jetty/websocket/api/WebSocketPolicy.html" title="class in org.eclipse.jetty.websocket.api">WebSocketPolicy</a> policy)</pre> |
| <div class="block">Entry point for <a href="../../../../../org/eclipse/jetty/websocket/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 name="WebSocketServerFactory-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 WebSocketServerFactory(javax.servlet.ServletContext context, |
| <a href="../../../../../org/eclipse/jetty/websocket/api/WebSocketPolicy.html" title="class in org.eclipse.jetty.websocket.api">WebSocketPolicy</a> policy, |
| <a href="../../../../../org/eclipse/jetty/io/ByteBufferPool.html" title="interface in org.eclipse.jetty.io">ByteBufferPool</a> bufferPool)</pre> |
| </li> |
| </ul> |
| <a name="WebSocketServerFactory-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 WebSocketServerFactory(<a href="../../../../../org/eclipse/jetty/websocket/api/WebSocketPolicy.html" title="class in org.eclipse.jetty.websocket.api">WebSocketPolicy</a> policy, |
| java.util.concurrent.Executor executor, |
| <a href="../../../../../org/eclipse/jetty/io/ByteBufferPool.html" title="interface in org.eclipse.jetty.io">ByteBufferPool</a> bufferPool)</pre> |
| <div class="block">Protected entry point for <a href="../../../../../org/eclipse/jetty/websocket/server/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> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="addSessionListener-org.eclipse.jetty.websocket.common.WebSocketSession.Listener-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addSessionListener</h4> |
| <pre>public void addSessionListener(<a href="../../../../../org/eclipse/jetty/websocket/common/WebSocketSession.Listener.html" title="interface in org.eclipse.jetty.websocket.common">WebSocketSession.Listener</a> listener)</pre> |
| </li> |
| </ul> |
| <a name="removeSessionListener-org.eclipse.jetty.websocket.common.WebSocketSession.Listener-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>removeSessionListener</h4> |
| <pre>public void removeSessionListener(<a href="../../../../../org/eclipse/jetty/websocket/common/WebSocketSession.Listener.html" title="interface in org.eclipse.jetty.websocket.common">WebSocketSession.Listener</a> listener)</pre> |
| </li> |
| </ul> |
| <a name="acceptWebSocket-javax.servlet.http.HttpServletRequest-javax.servlet.http.HttpServletResponse-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>acceptWebSocket</h4> |
| <pre>public boolean acceptWebSocket(javax.servlet.http.HttpServletRequest request, |
| javax.servlet.http.HttpServletResponse response) |
| throws java.io.IOException</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/eclipse/jetty/websocket/servlet/WebSocketServletFactory.html#acceptWebSocket-javax.servlet.http.HttpServletRequest-javax.servlet.http.HttpServletResponse-">acceptWebSocket</a></code> in interface <code><a href="../../../../../org/eclipse/jetty/websocket/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 name="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>public boolean acceptWebSocket(<a href="../../../../../org/eclipse/jetty/websocket/servlet/WebSocketCreator.html" title="interface in org.eclipse.jetty.websocket.servlet">WebSocketCreator</a> creator, |
| javax.servlet.http.HttpServletRequest request, |
| javax.servlet.http.HttpServletResponse response) |
| throws java.io.IOException</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/eclipse/jetty/websocket/servlet/WebSocketServletFactory.html#acceptWebSocket-org.eclipse.jetty.websocket.servlet.WebSocketCreator-javax.servlet.http.HttpServletRequest-javax.servlet.http.HttpServletResponse-">acceptWebSocket</a></code> in interface <code><a href="../../../../../org/eclipse/jetty/websocket/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 name="addSessionFactory-org.eclipse.jetty.websocket.common.SessionFactory-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addSessionFactory</h4> |
| <pre>public void addSessionFactory(<a href="../../../../../org/eclipse/jetty/websocket/common/SessionFactory.html" title="interface in org.eclipse.jetty.websocket.common">SessionFactory</a> sessionFactory)</pre> |
| </li> |
| </ul> |
| <a name="createWebSocket-org.eclipse.jetty.websocket.servlet.ServletUpgradeRequest-org.eclipse.jetty.websocket.servlet.ServletUpgradeResponse-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createWebSocket</h4> |
| <pre>public java.lang.Object createWebSocket(<a href="../../../../../org/eclipse/jetty/websocket/servlet/ServletUpgradeRequest.html" title="class in org.eclipse.jetty.websocket.servlet">ServletUpgradeRequest</a> req, |
| <a href="../../../../../org/eclipse/jetty/websocket/servlet/ServletUpgradeResponse.html" title="class in org.eclipse.jetty.websocket.servlet">ServletUpgradeResponse</a> resp)</pre> |
| <div class="block">Default Creator logic</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/eclipse/jetty/websocket/servlet/WebSocketCreator.html#createWebSocket-org.eclipse.jetty.websocket.servlet.ServletUpgradeRequest-org.eclipse.jetty.websocket.servlet.ServletUpgradeResponse-">createWebSocket</a></code> in interface <code><a href="../../../../../org/eclipse/jetty/websocket/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 name="doStart--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>doStart</h4> |
| <pre>protected void doStart() |
| throws java.lang.Exception</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../org/eclipse/jetty/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="../../../../../org/eclipse/jetty/util/component/ContainerLifeCycle.html#doStart--">doStart</a></code> in class <code><a href="../../../../../org/eclipse/jetty/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 name="getBufferPool--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getBufferPool</h4> |
| <pre>public <a href="../../../../../org/eclipse/jetty/io/ByteBufferPool.html" title="interface in org.eclipse.jetty.io">ByteBufferPool</a> getBufferPool()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/eclipse/jetty/websocket/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="../../../../../org/eclipse/jetty/websocket/common/scopes/WebSocketContainerScope.html#getBufferPool--">getBufferPool</a></code> in interface <code><a href="../../../../../org/eclipse/jetty/websocket/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 name="getCreator--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCreator</h4> |
| <pre>public <a href="../../../../../org/eclipse/jetty/websocket/servlet/WebSocketCreator.html" title="interface in org.eclipse.jetty.websocket.servlet">WebSocketCreator</a> getCreator()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/eclipse/jetty/websocket/servlet/WebSocketServletFactory.html#getCreator--">getCreator</a></code> in interface <code><a href="../../../../../org/eclipse/jetty/websocket/servlet/WebSocketServletFactory.html" title="interface in org.eclipse.jetty.websocket.servlet">WebSocketServletFactory</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getExecutor--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getExecutor</h4> |
| <pre>public java.util.concurrent.Executor getExecutor()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/eclipse/jetty/websocket/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="../../../../../org/eclipse/jetty/websocket/common/scopes/WebSocketContainerScope.html#getExecutor--">getExecutor</a></code> in interface <code><a href="../../../../../org/eclipse/jetty/websocket/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 name="getObjectFactory--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getObjectFactory</h4> |
| <pre>public <a href="../../../../../org/eclipse/jetty/util/DecoratedObjectFactory.html" title="class in org.eclipse.jetty.util">DecoratedObjectFactory</a> getObjectFactory()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/eclipse/jetty/websocket/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="../../../../../org/eclipse/jetty/websocket/common/scopes/WebSocketContainerScope.html#getObjectFactory--">getObjectFactory</a></code> in interface <code><a href="../../../../../org/eclipse/jetty/websocket/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 name="getEventDriverFactory--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getEventDriverFactory</h4> |
| <pre>public <a href="../../../../../org/eclipse/jetty/websocket/common/events/EventDriverFactory.html" title="class in org.eclipse.jetty.websocket.common.events">EventDriverFactory</a> getEventDriverFactory()</pre> |
| </li> |
| </ul> |
| <a name="getExtensionFactory--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getExtensionFactory</h4> |
| <pre>public <a href="../../../../../org/eclipse/jetty/websocket/api/extensions/ExtensionFactory.html" title="class in org.eclipse.jetty.websocket.api.extensions">ExtensionFactory</a> getExtensionFactory()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/eclipse/jetty/websocket/servlet/WebSocketServletFactory.html#getExtensionFactory--">getExtensionFactory</a></code> in interface <code><a href="../../../../../org/eclipse/jetty/websocket/servlet/WebSocketServletFactory.html" title="interface in org.eclipse.jetty.websocket.servlet">WebSocketServletFactory</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getOpenSessions--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getOpenSessions</h4> |
| <pre>public java.util.Collection<<a href="../../../../../org/eclipse/jetty/websocket/common/WebSocketSession.html" title="class in org.eclipse.jetty.websocket.common">WebSocketSession</a>> getOpenSessions()</pre> |
| </li> |
| </ul> |
| <a name="getPolicy--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPolicy</h4> |
| <pre>public <a href="../../../../../org/eclipse/jetty/websocket/api/WebSocketPolicy.html" title="class in org.eclipse.jetty.websocket.api">WebSocketPolicy</a> getPolicy()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/eclipse/jetty/websocket/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="../../../../../org/eclipse/jetty/websocket/common/scopes/WebSocketContainerScope.html#getPolicy--">getPolicy</a></code> in interface <code><a href="../../../../../org/eclipse/jetty/websocket/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="../../../../../org/eclipse/jetty/websocket/servlet/WebSocketServletFactory.html#getPolicy--">getPolicy</a></code> in interface <code><a href="../../../../../org/eclipse/jetty/websocket/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 name="getSslContextFactory--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSslContextFactory</h4> |
| <pre>public <a href="../../../../../org/eclipse/jetty/util/ssl/SslContextFactory.html" title="class in org.eclipse.jetty.util.ssl">SslContextFactory</a> getSslContextFactory()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/eclipse/jetty/websocket/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="../../../../../org/eclipse/jetty/websocket/common/scopes/WebSocketContainerScope.html#getSslContextFactory--">getSslContextFactory</a></code> in interface <code><a href="../../../../../org/eclipse/jetty/websocket/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 name="isUpgradeRequest-javax.servlet.http.HttpServletRequest-javax.servlet.http.HttpServletResponse-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isUpgradeRequest</h4> |
| <pre>public boolean isUpgradeRequest(javax.servlet.http.HttpServletRequest request, |
| javax.servlet.http.HttpServletResponse response)</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/eclipse/jetty/websocket/servlet/WebSocketServletFactory.html#isUpgradeRequest-javax.servlet.http.HttpServletRequest-javax.servlet.http.HttpServletResponse-">isUpgradeRequest</a></code> in interface <code><a href="../../../../../org/eclipse/jetty/websocket/servlet/WebSocketServletFactory.html" title="interface in org.eclipse.jetty.websocket.servlet">WebSocketServletFactory</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="onSessionOpened-org.eclipse.jetty.websocket.common.WebSocketSession-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>onSessionOpened</h4> |
| <pre>public void onSessionOpened(<a href="../../../../../org/eclipse/jetty/websocket/common/WebSocketSession.html" title="class in org.eclipse.jetty.websocket.common">WebSocketSession</a> session)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/eclipse/jetty/websocket/common/scopes/WebSocketContainerScope.html#onSessionOpened-org.eclipse.jetty.websocket.common.WebSocketSession-">WebSocketContainerScope</a></code></span></div> |
| <div class="block">A Session has been opened</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/eclipse/jetty/websocket/common/scopes/WebSocketContainerScope.html#onSessionOpened-org.eclipse.jetty.websocket.common.WebSocketSession-">onSessionOpened</a></code> in interface <code><a href="../../../../../org/eclipse/jetty/websocket/common/scopes/WebSocketContainerScope.html" title="interface in org.eclipse.jetty.websocket.common.scopes">WebSocketContainerScope</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>session</code> - the session that was opened</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="onSessionClosed-org.eclipse.jetty.websocket.common.WebSocketSession-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>onSessionClosed</h4> |
| <pre>public void onSessionClosed(<a href="../../../../../org/eclipse/jetty/websocket/common/WebSocketSession.html" title="class in org.eclipse.jetty.websocket.common">WebSocketSession</a> session)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/eclipse/jetty/websocket/common/scopes/WebSocketContainerScope.html#onSessionClosed-org.eclipse.jetty.websocket.common.WebSocketSession-">WebSocketContainerScope</a></code></span></div> |
| <div class="block">A Session has been closed</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/eclipse/jetty/websocket/common/scopes/WebSocketContainerScope.html#onSessionClosed-org.eclipse.jetty.websocket.common.WebSocketSession-">onSessionClosed</a></code> in interface <code><a href="../../../../../org/eclipse/jetty/websocket/common/scopes/WebSocketContainerScope.html" title="interface in org.eclipse.jetty.websocket.common.scopes">WebSocketContainerScope</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>session</code> - the session that was closed</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="register-java.lang.Class-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>register</h4> |
| <pre>public void register(java.lang.Class<?> websocketPojo)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/eclipse/jetty/websocket/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="../../../../../org/eclipse/jetty/websocket/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="../../../../../org/eclipse/jetty/websocket/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="../../../../../org/eclipse/jetty/websocket/servlet/WebSocketServletFactory.html#register-java.lang.Class-">register</a></code> in interface <code><a href="../../../../../org/eclipse/jetty/websocket/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 name="setCreator-org.eclipse.jetty.websocket.servlet.WebSocketCreator-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>setCreator</h4> |
| <pre>public void setCreator(<a href="../../../../../org/eclipse/jetty/websocket/servlet/WebSocketCreator.html" title="interface in org.eclipse.jetty.websocket.servlet">WebSocketCreator</a> creator)</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/eclipse/jetty/websocket/servlet/WebSocketServletFactory.html#setCreator-org.eclipse.jetty.websocket.servlet.WebSocketCreator-">setCreator</a></code> in interface <code><a href="../../../../../org/eclipse/jetty/websocket/servlet/WebSocketServletFactory.html" title="interface in org.eclipse.jetty.websocket.servlet">WebSocketServletFactory</a></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/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"> |
| <li><a href="../../../../../org/eclipse/jetty/websocket/server/WebSocketServerConnection.html" title="class in org.eclipse.jetty.websocket.server"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/eclipse/jetty/websocket/server/WebSocketUpgradeFilter.html" title="class in org.eclipse.jetty.websocket.server"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/eclipse/jetty/websocket/server/WebSocketServerFactory.html" target="_top">Frames</a></li> |
| <li><a href="WebSocketServerFactory.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../allclasses-noframe.html">All 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: </li> |
| <li><a href="#nested.classes.inherited.from.class.org.eclipse.jetty.util.component.AbstractLifeCycle">Nested</a> | </li> |
| <li><a href="#fields.inherited.from.class.org.eclipse.jetty.util.component.AbstractLifeCycle">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </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 © 1995–2018 <a href="http://webtide.com">Webtide</a>. All rights reserved.</small></p> |
| </body> |
| </html> |