| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (11.0.11) on Mon Jun 14 16:37:38 EDT 2021 --> |
| <title>MappedWebSocketCreator (Jetty :: Project 9.4.42.v20210604 API)</title> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="dc.created" content="2021-06-14"> |
| <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.5.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="MappedWebSocketCreator (Jetty :: Project 9.4.42.v20210604 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"i0":6,"i1":6,"i2":38,"i3":6,"i4":6}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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/MappedWebSocketCreator.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>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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="Interface MappedWebSocketCreator" class="title">Interface MappedWebSocketCreator</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><code><a href="NativeWebSocketConfiguration.html" title="class in org.eclipse.jetty.websocket.server">NativeWebSocketConfiguration</a></code>, <code><a href="WebSocketUpgradeFilter.html" title="class in org.eclipse.jetty.websocket.server">WebSocketUpgradeFilter</a></code>, <code><a href="WebSocketUpgradeHandlerWrapper.html" title="class in org.eclipse.jetty.websocket.server">WebSocketUpgradeHandlerWrapper</a></code></dd> |
| </dl> |
| <hr> |
| <pre>public interface <span class="typeNameLabel">MappedWebSocketCreator</span></pre> |
| <div class="block">Common interface for MappedWebSocketCreator</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract 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,org.eclipse.jetty.websocket.servlet.WebSocketCreator)">addMapping</a></span>​(java.lang.String 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">Add a mapping, of a pathspec to a WebSocketCreator.</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(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> 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">Add a mapping.</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.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(org.eclipse.jetty.http.pathmap.PathSpec, WebSocketCreator)</code></a> instead.</div> |
| </div> |
| </td> |
| </tr> |
| <tr id="i3" 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 spec)</code></th> |
| <td class="colLast"> |
| <div class="block">/** |
| Returns the creator for the given path spec.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#removeMapping(java.lang.String)">removeMapping</a></span>​(java.lang.String spec)</code></th> |
| <td class="colLast"> |
| <div class="block">Removes the mapping based on the given path spec.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a id="addMapping(java.lang.String,org.eclipse.jetty.websocket.servlet.WebSocketCreator)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addMapping</h4> |
| <pre class="methodSignature">void addMapping​(java.lang.String spec, |
| <a href="../servlet/WebSocketCreator.html" title="interface in org.eclipse.jetty.websocket.servlet">WebSocketCreator</a> creator)</pre> |
| <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="paramLabel">Parameters:</span></dt> |
| <dd><code>spec</code> - the path spec to use.</dd> |
| <dd><code>creator</code> - the websocket creator for this specific mapping</dd> |
| </dl> |
| </li> |
| </ul> |
| <a 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 |
| 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(org.eclipse.jetty.http.pathmap.PathSpec, WebSocketCreator)</code></a> instead. |
| (support classes moved to generic jetty-http project)</div> |
| </div> |
| <div class="block">Add a mapping.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>spec</code> - the path spec to use</dd> |
| <dd><code>creator</code> - the creator for the mapping</dd> |
| </dl> |
| </li> |
| </ul> |
| <a 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">void addMapping​(<a href="../../http/pathmap/PathSpec.html" title="interface in org.eclipse.jetty.http.pathmap">PathSpec</a> spec, |
| <a href="../servlet/WebSocketCreator.html" title="interface in org.eclipse.jetty.websocket.servlet">WebSocketCreator</a> creator)</pre> |
| <div class="block">Add a mapping.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>spec</code> - the path spec to use</dd> |
| <dd><code>creator</code> - the creator for the mapping</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>9.2.20</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getMapping(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMapping</h4> |
| <pre class="methodSignature"><a href="../servlet/WebSocketCreator.html" title="interface in org.eclipse.jetty.websocket.servlet">WebSocketCreator</a> getMapping​(java.lang.String spec)</pre> |
| <div class="block">/** |
| Returns the creator for the given path spec.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>spec</code> - the spec to test for (using the same spec syntax as seen in <a href="#addMapping(java.lang.String,org.eclipse.jetty.websocket.servlet.WebSocketCreator)"><code>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="blockListLast"> |
| <li class="blockList"> |
| <h4>removeMapping</h4> |
| <pre class="methodSignature">boolean removeMapping​(java.lang.String spec)</pre> |
| <div class="block">Removes the mapping based on the given path spec.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>spec</code> - the path spec to remove (using the same spec syntax as seen in <a href="#addMapping(java.lang.String,org.eclipse.jetty.websocket.servlet.WebSocketCreator)"><code>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> |
| </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/MappedWebSocketCreator.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>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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–2021 <a href="https://webtide.com">Webtide</a>. All rights reserved.</small></p> |
| </footer> |
| </body> |
| </html> |
