| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (11.0.7) on Wed Jul 29 16:44:05 EDT 2020 --> |
| <title>NativeWebSocketConfiguration (Jetty :: Project 9.4.31.v20200723 API)</title> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="dc.created" content="2020-07-29"> |
| <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="NativeWebSocketConfiguration (Jetty :: Project 9.4.31.v20200723 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":42,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":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/NativeWebSocketConfiguration.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 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: </li> |
| <li><a href="#nested.class.summary">Nested</a> | </li> |
| <li><a href="#field.summary">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 id="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| </div> |
| <div class="navPadding"> </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> <a href="package-summary.html">org.eclipse.jetty.websocket.server</a></div> |
| <h2 title="Class NativeWebSocketConfiguration" class="title">Class NativeWebSocketConfiguration</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.NativeWebSocketConfiguration</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/Dumpable.DumpableContainer.html" title="interface in org.eclipse.jetty.util.component">Dumpable.DumpableContainer</a></code>, <code><a href="../../util/component/LifeCycle.html" title="interface in org.eclipse.jetty.util.component">LifeCycle</a></code>, <code><a href="MappedWebSocketCreator.html" title="interface in org.eclipse.jetty.websocket.server">MappedWebSocketCreator</a></code></dd> |
| </dl> |
| <hr> |
| <pre>public class <span class="typeNameLabel">NativeWebSocketConfiguration</span> |
| extends <a href="../../util/component/ContainerLifeCycle.html" title="class in org.eclipse.jetty.util.component">ContainerLifeCycle</a> |
| implements <a href="MappedWebSocketCreator.html" title="interface in org.eclipse.jetty.websocket.server">MappedWebSocketCreator</a></pre> |
| <div class="block">Interface for Configuring Jetty Server Native WebSockets |
| <p> |
| Only applicable if using <a href="WebSocketUpgradeFilter.html" title="class in org.eclipse.jetty.websocket.server"><code>WebSocketUpgradeFilter</code></a> |
| </p></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 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 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.Dumpable"> |
| <!-- --> |
| </a> |
| <h3>Nested classes/interfaces inherited from interface org.eclipse.jetty.util.component.<a href="../../util/component/Dumpable.html" title="interface in org.eclipse.jetty.util.component">Dumpable</a></h3> |
| <code><a href="../../util/component/Dumpable.DumpableContainer.html" title="interface in org.eclipse.jetty.util.component">Dumpable.DumpableContainer</a></code></li> |
| </ul> |
| <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 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> |
| </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 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 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"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Constructor</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr class="altColor"> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(javax.servlet.ServletContext)">NativeWebSocketConfiguration</a></span>​(javax.servlet.ServletContext context)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(org.eclipse.jetty.websocket.server.WebSocketServerFactory)">NativeWebSocketConfiguration</a></span>​(<a href="WebSocketServerFactory.html" title="class in org.eclipse.jetty.websocket.server">WebSocketServerFactory</a> webSocketServerFactory)</code></th> |
| <td class="colLast"> </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"> </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><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Method</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#addMapping(java.lang.String,java.lang.Class)">addMapping</a></span>​(java.lang.String rawspec, |
| java.lang.Class<?> endpointClass)</code></th> |
| <td class="colLast"> |
| <div class="block">Manually add a WebSocket mapping.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#addMapping(java.lang.String,org.eclipse.jetty.websocket.servlet.WebSocketCreator)">addMapping</a></span>​(java.lang.String rawspec, |
| <a href="../servlet/WebSocketCreator.html" title="interface in org.eclipse.jetty.websocket.servlet">WebSocketCreator</a> creator)</code></th> |
| <td class="colLast"> |
| <div class="block">Add a mapping, of a pathspec to a WebSocketCreator.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#addMapping(org.eclipse.jetty.http.pathmap.PathSpec,java.lang.Class)">addMapping</a></span>​(<a href="../../http/pathmap/PathSpec.html" title="interface in org.eclipse.jetty.http.pathmap">PathSpec</a> pathSpec, |
| java.lang.Class<?> endpointClass)</code></th> |
| <td class="colLast"> |
| <div class="block">Manually add a WebSocket mapping.</div> |
| </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="#addMapping(org.eclipse.jetty.http.pathmap.PathSpec,org.eclipse.jetty.websocket.servlet.WebSocketCreator)">addMapping</a></span>​(<a href="../../http/pathmap/PathSpec.html" title="interface in org.eclipse.jetty.http.pathmap">PathSpec</a> pathSpec, |
| <a href="../servlet/WebSocketCreator.html" title="interface in org.eclipse.jetty.websocket.servlet">WebSocketCreator</a> creator)</code></th> |
| <td class="colLast"> |
| <div class="block">Manually add a WebSocket mapping.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#addMapping(org.eclipse.jetty.websocket.server.pathmap.PathSpec,org.eclipse.jetty.websocket.servlet.WebSocketCreator)">addMapping</a></span>​(<a href="pathmap/PathSpec.html" title="class in org.eclipse.jetty.websocket.server.pathmap">PathSpec</a> spec, |
| <a href="../servlet/WebSocketCreator.html" title="interface in org.eclipse.jetty.websocket.servlet">WebSocketCreator</a> creator)</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="deprecationComment">use <a href="#addMapping(org.eclipse.jetty.http.pathmap.PathSpec,org.eclipse.jetty.websocket.servlet.WebSocketCreator)"><code>addMapping(PathSpec, WebSocketCreator)</code></a> instead.</div> |
| </div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>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="i6" class="altColor"> |
| <td class="colFirst"><code><a href="WebSocketServerFactory.html" title="class in org.eclipse.jetty.websocket.server">WebSocketServerFactory</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getFactory()">getFactory</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Get WebSocketServerFactory being used.</div> |
| </td> |
| </tr> |
| <tr id="i7" 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="#getMapping(java.lang.String)">getMapping</a></span>​(java.lang.String rawspec)</code></th> |
| <td class="colLast"> |
| <div class="block">/** |
| Returns the creator for the given path spec.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code><a href="../../http/pathmap/MappedResource.html" title="class in org.eclipse.jetty.http.pathmap">MappedResource</a><<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="#getMatch(java.lang.String)">getMatch</a></span>​(java.lang.String target)</code></th> |
| <td class="colLast"> |
| <div class="block">Get the matching <a href="../../http/pathmap/MappedResource.html" title="class in org.eclipse.jetty.http.pathmap"><code>MappedResource</code></a> for the provided target.</div> |
| </td> |
| </tr> |
| <tr id="i9" 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">Used to configure the Default <a href="../api/WebSocketPolicy.html" title="class in org.eclipse.jetty.websocket.api"><code>WebSocketPolicy</code></a> used by all endpoints that |
| don't redeclare the values.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#removeMapping(java.lang.String)">removeMapping</a></span>​(java.lang.String rawspec)</code></th> |
| <td class="colLast"> |
| <div class="block">Removes the mapping based on the given path spec.</div> |
| </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 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#doStart()">doStart</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 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>, <a href="../../util/component/AbstractLifeCycle.html#toString()">toString</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 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 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.util.component.Dumpable.DumpableContainer"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.eclipse.jetty.util.component.<a href="../../util/component/Dumpable.DumpableContainer.html" title="interface in org.eclipse.jetty.util.component">Dumpable.DumpableContainer</a></h3> |
| <code><a href="../../util/component/Dumpable.DumpableContainer.html#isDumpable(java.lang.Object)">isDumpable</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="<init>(javax.servlet.ServletContext)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>NativeWebSocketConfiguration</h4> |
| <pre>public NativeWebSocketConfiguration​(javax.servlet.ServletContext context)</pre> |
| </li> |
| </ul> |
| <a id="<init>(org.eclipse.jetty.websocket.server.WebSocketServerFactory)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>NativeWebSocketConfiguration</h4> |
| <pre>public NativeWebSocketConfiguration​(<a href="WebSocketServerFactory.html" title="class in org.eclipse.jetty.websocket.server">WebSocketServerFactory</a> webSocketServerFactory)</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| <!-- ============ METHOD DETAIL ========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a id="doStop()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>doStop</h4> |
| <pre class="methodSignature">public void doStop() |
| throws java.lang.Exception</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from class: <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> in class <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="getFactory()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFactory</h4> |
| <pre class="methodSignature">public <a href="WebSocketServerFactory.html" title="class in org.eclipse.jetty.websocket.server">WebSocketServerFactory</a> getFactory()</pre> |
| <div class="block">Get WebSocketServerFactory being used.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the WebSocketServerFactory being used.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getMatch(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMatch</h4> |
| <pre class="methodSignature">public <a href="../../http/pathmap/MappedResource.html" title="class in org.eclipse.jetty.http.pathmap">MappedResource</a><<a href="../servlet/WebSocketCreator.html" title="interface in org.eclipse.jetty.websocket.servlet">WebSocketCreator</a>> getMatch​(java.lang.String target)</pre> |
| <div class="block">Get the matching <a href="../../http/pathmap/MappedResource.html" title="class in org.eclipse.jetty.http.pathmap"><code>MappedResource</code></a> for the provided target.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>target</code> - the target path</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the matching resource, or null if no match.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getPolicy()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPolicy</h4> |
| <pre class="methodSignature">public <a href="../api/WebSocketPolicy.html" title="class in org.eclipse.jetty.websocket.api">WebSocketPolicy</a> getPolicy()</pre> |
| <div class="block">Used to configure the Default <a href="../api/WebSocketPolicy.html" title="class in org.eclipse.jetty.websocket.api"><code>WebSocketPolicy</code></a> used by all endpoints that |
| don't redeclare the values.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the default policy for all WebSockets</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="addMapping(org.eclipse.jetty.http.pathmap.PathSpec,org.eclipse.jetty.websocket.servlet.WebSocketCreator)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addMapping</h4> |
| <pre class="methodSignature">public void addMapping​(<a href="../../http/pathmap/PathSpec.html" title="interface in org.eclipse.jetty.http.pathmap">PathSpec</a> pathSpec, |
| <a href="../servlet/WebSocketCreator.html" title="interface in org.eclipse.jetty.websocket.servlet">WebSocketCreator</a> creator)</pre> |
| <div class="block">Manually add a WebSocket mapping. |
| <p> |
| If mapping is added before this configuration is started, then it is persisted through |
| stop/start of this configuration's lifecycle. Otherwise it will be removed when |
| this configuration is stopped. |
| </p></div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="MappedWebSocketCreator.html#addMapping(org.eclipse.jetty.http.pathmap.PathSpec,org.eclipse.jetty.websocket.servlet.WebSocketCreator)">addMapping</a></code> in interface <code><a href="MappedWebSocketCreator.html" title="interface in org.eclipse.jetty.websocket.server">MappedWebSocketCreator</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>pathSpec</code> - the pathspec to respond on</dd> |
| <dd><code>creator</code> - the websocket creator to activate on the provided mapping.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="addMapping(org.eclipse.jetty.websocket.server.pathmap.PathSpec,org.eclipse.jetty.websocket.servlet.WebSocketCreator)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addMapping</h4> |
| <pre class="methodSignature">@Deprecated |
| public void addMapping​(<a href="pathmap/PathSpec.html" title="class in org.eclipse.jetty.websocket.server.pathmap">PathSpec</a> spec, |
| <a href="../servlet/WebSocketCreator.html" title="interface in org.eclipse.jetty.websocket.servlet">WebSocketCreator</a> creator)</pre> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="deprecationComment">use <a href="#addMapping(org.eclipse.jetty.http.pathmap.PathSpec,org.eclipse.jetty.websocket.servlet.WebSocketCreator)"><code>addMapping(PathSpec, WebSocketCreator)</code></a> instead.</div> |
| </div> |
| <div class="block">Manually add a WebSocket mapping.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="MappedWebSocketCreator.html#addMapping(org.eclipse.jetty.websocket.server.pathmap.PathSpec,org.eclipse.jetty.websocket.servlet.WebSocketCreator)">addMapping</a></code> in interface <code><a href="MappedWebSocketCreator.html" title="interface in org.eclipse.jetty.websocket.server">MappedWebSocketCreator</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>spec</code> - the pathspec to respond on</dd> |
| <dd><code>creator</code> - the websocket creator to activate on the provided mapping</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="addMapping(org.eclipse.jetty.http.pathmap.PathSpec,java.lang.Class)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addMapping</h4> |
| <pre class="methodSignature">public void addMapping​(<a href="../../http/pathmap/PathSpec.html" title="interface in org.eclipse.jetty.http.pathmap">PathSpec</a> pathSpec, |
| java.lang.Class<?> endpointClass)</pre> |
| <div class="block">Manually add a WebSocket mapping.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>pathSpec</code> - the pathspec to respond on</dd> |
| <dd><code>endpointClass</code> - the endpoint class to use for new upgrade requests on the provided |
| pathspec (can be an <a href="../api/annotations/WebSocket.html" title="annotation in org.eclipse.jetty.websocket.api.annotations"><code>WebSocket</code></a> annotated |
| POJO, or implementing <a href="../api/WebSocketListener.html" title="interface in org.eclipse.jetty.websocket.api"><code>WebSocketListener</code></a>)</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="addMapping(java.lang.String,org.eclipse.jetty.websocket.servlet.WebSocketCreator)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addMapping</h4> |
| <pre class="methodSignature">public void addMapping​(java.lang.String rawspec, |
| <a href="../servlet/WebSocketCreator.html" title="interface in org.eclipse.jetty.websocket.servlet">WebSocketCreator</a> creator)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="MappedWebSocketCreator.html#addMapping(java.lang.String,org.eclipse.jetty.websocket.servlet.WebSocketCreator)">MappedWebSocketCreator</a></code></span></div> |
| <div class="block">Add a mapping, of a pathspec to a WebSocketCreator. |
| <p> |
| Recognized Path Spec syntaxes |
| </p> |
| <dl> |
| <dt><code>/path/to</code> or <code>/</code> or <code>*.ext</code> or <code>servlet|{spec}</code></dt> |
| <dd>Servlet Syntax</dd> |
| <dt><code>^{spec}</code> or <code>regex|{spec}</code></dt> |
| <dd>Regex Syntax</dd> |
| <dt><code>uri-template|{spec}</code></dt> |
| <dd>URI Template (see JSR356 and RFC6570 level 1)</dd> |
| </dl></div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="MappedWebSocketCreator.html#addMapping(java.lang.String,org.eclipse.jetty.websocket.servlet.WebSocketCreator)">addMapping</a></code> in interface <code><a href="MappedWebSocketCreator.html" title="interface in org.eclipse.jetty.websocket.server">MappedWebSocketCreator</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>rawspec</code> - the path spec to use.</dd> |
| <dd><code>creator</code> - the websocket creator for this specific mapping</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getMapping(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMapping</h4> |
| <pre class="methodSignature">public <a href="../servlet/WebSocketCreator.html" title="interface in org.eclipse.jetty.websocket.servlet">WebSocketCreator</a> getMapping​(java.lang.String rawspec)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="MappedWebSocketCreator.html#getMapping(java.lang.String)">MappedWebSocketCreator</a></code></span></div> |
| <div class="block">/** |
| Returns the creator for the given path spec.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="MappedWebSocketCreator.html#getMapping(java.lang.String)">getMapping</a></code> in interface <code><a href="MappedWebSocketCreator.html" title="interface in org.eclipse.jetty.websocket.server">MappedWebSocketCreator</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>rawspec</code> - the spec to test for (using the same spec syntax as seen in <a href="MappedWebSocketCreator.html#addMapping(java.lang.String,org.eclipse.jetty.websocket.servlet.WebSocketCreator)"><code>MappedWebSocketCreator.addMapping(String, WebSocketCreator)</code></a>)</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the websocket creator if path spec exists, or null</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="removeMapping(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>removeMapping</h4> |
| <pre class="methodSignature">public boolean removeMapping​(java.lang.String rawspec)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="MappedWebSocketCreator.html#removeMapping(java.lang.String)">MappedWebSocketCreator</a></code></span></div> |
| <div class="block">Removes the mapping based on the given path spec.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="MappedWebSocketCreator.html#removeMapping(java.lang.String)">removeMapping</a></code> in interface <code><a href="MappedWebSocketCreator.html" title="interface in org.eclipse.jetty.websocket.server">MappedWebSocketCreator</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>rawspec</code> - the path spec to remove (using the same spec syntax as seen in <a href="MappedWebSocketCreator.html#addMapping(java.lang.String,org.eclipse.jetty.websocket.servlet.WebSocketCreator)"><code>MappedWebSocketCreator.addMapping(String, WebSocketCreator)</code></a>)</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if underlying mapping were altered, false otherwise</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="addMapping(java.lang.String,java.lang.Class)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>addMapping</h4> |
| <pre class="methodSignature">public void addMapping​(java.lang.String rawspec, |
| java.lang.Class<?> endpointClass)</pre> |
| <div class="block">Manually add a WebSocket mapping.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>rawspec</code> - the pathspec to map to (see <a href="MappedWebSocketCreator.html#addMapping(java.lang.String,org.eclipse.jetty.websocket.servlet.WebSocketCreator)"><code>MappedWebSocketCreator.addMapping(String, WebSocketCreator)</code></a> for syntax details)</dd> |
| <dd><code>endpointClass</code> - the endpoint class to use for new upgrade requests on the provided |
| pathspec (can be an <a href="../api/annotations/WebSocket.html" title="annotation in org.eclipse.jetty.websocket.api.annotations"><code>WebSocket</code></a> annotated |
| POJO, or implementing <a href="../api/WebSocketListener.html" title="interface in org.eclipse.jetty.websocket.api"><code>WebSocketListener</code></a>)</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/NativeWebSocketConfiguration.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 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: </li> |
| <li><a href="#nested.class.summary">Nested</a> | </li> |
| <li><a href="#field.summary">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 id="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </nav> |
| <p class="legalCopy"><small>Copyright © 1995–2020 <a href="https://webtide.com">Webtide</a>. All rights reserved.</small></p> |
| </footer> |
| </body> |
| </html> |