| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (11.0.8) on Thu Oct 22 13:40:13 CDT 2020 --> |
| <title>WebSocketMapping (Jetty :: Javadoc Build 11.0.0.beta3 API)</title> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="dc.created" content="2020-10-22"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../../jquery/jquery-ui.css" title="Style"> |
| <script type="text/javascript" src="../../../../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../../../../jquery/jszip/dist/jszip.min.js"></script> |
| <script type="text/javascript" src="../../../../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script> |
| <!--[if IE]> |
| <script type="text/javascript" src="../../../../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script> |
| <![endif]--> |
| <script type="text/javascript" src="../../../../../../../jquery/jquery-3.3.1.js"></script> |
| <script type="text/javascript" src="../../../../../../../jquery/jquery-migrate-3.0.1.js"></script> |
| <script type="text/javascript" src="../../../../../../../jquery/jquery-ui.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="WebSocketMapping (Jetty :: Javadoc Build 11.0.0.beta3 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"i0":10,"i1":10,"i2":10,"i3":9,"i4":9,"i5":10,"i6":10,"i7":10,"i8":9,"i9":10,"i10":10}; |
| var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| var pathtoroot = "../../../../../../../"; |
| var useModuleDirectories = true; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <header role="banner"> |
| <nav role="navigation"> |
| <div class="fixedNav"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a id="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/WebSocketMapping.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><a href="#field.detail">Field</a> | </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.util.server.internal</a></div> |
| <h2 title="Class WebSocketMapping" class="title">Class WebSocketMapping</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.eclipse.jetty.websocket.util.server.internal.WebSocketMapping</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code>java.util.EventListener</code>, <code><a href="../../../../util/component/Dumpable.html" title="interface in org.eclipse.jetty.util.component">Dumpable</a></code>, <code><a href="../../../../util/component/LifeCycle.Listener.html" title="interface in org.eclipse.jetty.util.component">LifeCycle.Listener</a></code></dd> |
| </dl> |
| <hr> |
| <pre>public class <span class="typeNameLabel">WebSocketMapping</span> |
| extends java.lang.Object |
| implements <a href="../../../../util/component/Dumpable.html" title="interface in org.eclipse.jetty.util.component">Dumpable</a>, <a href="../../../../util/component/LifeCycle.Listener.html" title="interface in org.eclipse.jetty.util.component">LifeCycle.Listener</a></pre> |
| <div class="block">Mapping of pathSpec to a tupple of <a href="WebSocketCreator.html" title="interface in org.eclipse.jetty.websocket.util.server.internal"><code>WebSocketCreator</code></a>, <a href="FrameHandlerFactory.html" title="interface in org.eclipse.jetty.websocket.util.server.internal"><code>FrameHandlerFactory</code></a> and |
| <a href="../../../core/Configuration.Customizer.html" title="interface in org.eclipse.jetty.websocket.core"><code>Configuration.Customizer</code></a>. |
| <p> |
| When the <a href="#upgrade(jakarta.servlet.http.HttpServletRequest,jakarta.servlet.http.HttpServletResponse,org.eclipse.jetty.websocket.core.Configuration.Customizer)"><code>upgrade(HttpServletRequest, HttpServletResponse, Configuration.Customizer)</code></a> |
| method is called, a match for the pathSpec is looked for. If one is found then the |
| creator is used to create a POJO for the WebSocket endpoint, the factory is used to |
| wrap that POJO with a <a href="../../../core/FrameHandler.html" title="interface in org.eclipse.jetty.websocket.core"><code>FrameHandler</code></a> and the customizer is used to configure the resulting |
| <a href="../../../core/CoreSession.html" title="interface in org.eclipse.jetty.websocket.core"><code>CoreSession</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.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> |
| </li> |
| </ul> |
| </section> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <table class="memberSummary"> |
| <caption><span>Fields</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Field</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static java.lang.String</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#DEFAULT_KEY">DEFAULT_KEY</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| </table> |
| <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()">WebSocketMapping</a></span>()</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.core.WebSocketComponents)">WebSocketMapping</a></span>​(<a href="../../../core/WebSocketComponents.html" title="class in org.eclipse.jetty.websocket.core">WebSocketComponents</a> components)</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="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></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="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(org.eclipse.jetty.http.pathmap.PathSpec,org.eclipse.jetty.websocket.util.server.internal.WebSocketCreator,org.eclipse.jetty.websocket.util.server.internal.FrameHandlerFactory,org.eclipse.jetty.websocket.core.Configuration.Customizer)">addMapping</a></span>​(<a href="../../../../http/pathmap/PathSpec.html" title="interface in org.eclipse.jetty.http.pathmap">PathSpec</a> pathSpec, |
| <a href="WebSocketCreator.html" title="interface in org.eclipse.jetty.websocket.util.server.internal">WebSocketCreator</a> creator, |
| <a href="FrameHandlerFactory.html" title="interface in org.eclipse.jetty.websocket.util.server.internal">FrameHandlerFactory</a> factory, |
| <a href="../../../core/Configuration.Customizer.html" title="interface in org.eclipse.jetty.websocket.core">Configuration.Customizer</a> customizer)</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>java.lang.String</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#dump()">dump</a></span>()</code></th> |
| <td class="colLast"> </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="#dump(java.lang.Appendable,java.lang.String)">dump</a></span>​(java.lang.Appendable out, |
| java.lang.String indent)</code></th> |
| <td class="colLast"> |
| <div class="block">Dump this object (and children) into an Appendable using the provided indent after any new lines.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>static <a href="WebSocketMapping.html" title="class in org.eclipse.jetty.websocket.util.server.internal">WebSocketMapping</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#ensureMapping(jakarta.servlet.ServletContext,java.lang.String)">ensureMapping</a></span>​(jakarta.servlet.ServletContext servletContext, |
| java.lang.String mappingKey)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>static <a href="WebSocketMapping.html" title="class in org.eclipse.jetty.websocket.util.server.internal">WebSocketMapping</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getMapping(jakarta.servlet.ServletContext,java.lang.String)">getMapping</a></span>​(jakarta.servlet.ServletContext servletContext, |
| java.lang.String mappingKey)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code><a href="WebSocketCreator.html" title="interface in org.eclipse.jetty.websocket.util.server.internal">WebSocketCreator</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getMapping(org.eclipse.jetty.http.pathmap.PathSpec)">getMapping</a></span>​(<a href="../../../../http/pathmap/PathSpec.html" title="interface in org.eclipse.jetty.http.pathmap">PathSpec</a> pathSpec)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code><a href="../../../core/server/WebSocketNegotiator.html" title="interface in org.eclipse.jetty.websocket.core.server">WebSocketNegotiator</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getMatchedNegotiator(java.lang.String,java.util.function.Consumer)">getMatchedNegotiator</a></span>​(java.lang.String target, |
| java.util.function.Consumer<<a href="../../../../http/pathmap/PathSpec.html" title="interface in org.eclipse.jetty.http.pathmap">PathSpec</a>> pathSpecConsumer)</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="i7" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#lifeCycleStopping(org.eclipse.jetty.util.component.LifeCycle)">lifeCycleStopping</a></span>​(<a href="../../../../util/component/LifeCycle.html" title="interface in org.eclipse.jetty.util.component">LifeCycle</a> context)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>static <a href="../../../../http/pathmap/PathSpec.html" title="interface in org.eclipse.jetty.http.pathmap">PathSpec</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#parsePathSpec(java.lang.String)">parsePathSpec</a></span>​(java.lang.String rawSpec)</code></th> |
| <td class="colLast"> |
| <div class="block">Parse a PathSpec string into a PathSpec instance.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#removeMapping(org.eclipse.jetty.http.pathmap.PathSpec)">removeMapping</a></span>​(<a href="../../../../http/pathmap/PathSpec.html" title="interface in org.eclipse.jetty.http.pathmap">PathSpec</a> pathSpec)</code></th> |
| <td class="colLast"> </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="#upgrade(jakarta.servlet.http.HttpServletRequest,jakarta.servlet.http.HttpServletResponse,org.eclipse.jetty.websocket.core.Configuration.Customizer)">upgrade</a></span>​(jakarta.servlet.http.HttpServletRequest request, |
| jakarta.servlet.http.HttpServletResponse response, |
| <a href="../../../core/Configuration.Customizer.html" title="interface in org.eclipse.jetty.websocket.core">Configuration.Customizer</a> defaultCustomizer)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| </table> |
| <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, toString, 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.LifeCycle.Listener"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.eclipse.jetty.util.component.<a href="../../../../util/component/LifeCycle.Listener.html" title="interface in org.eclipse.jetty.util.component">LifeCycle.Listener</a></h3> |
| <code><a href="../../../../util/component/LifeCycle.Listener.html#lifeCycleFailure(org.eclipse.jetty.util.component.LifeCycle,java.lang.Throwable)">lifeCycleFailure</a>, <a href="../../../../util/component/LifeCycle.Listener.html#lifeCycleStarted(org.eclipse.jetty.util.component.LifeCycle)">lifeCycleStarted</a>, <a href="../../../../util/component/LifeCycle.Listener.html#lifeCycleStarting(org.eclipse.jetty.util.component.LifeCycle)">lifeCycleStarting</a>, <a href="../../../../util/component/LifeCycle.Listener.html#lifeCycleStopped(org.eclipse.jetty.util.component.LifeCycle)">lifeCycleStopped</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="field.detail"> |
| <!-- --> |
| </a> |
| <h3>Field Detail</h3> |
| <a id="DEFAULT_KEY"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>DEFAULT_KEY</h4> |
| <pre>public static final java.lang.String DEFAULT_KEY</pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../../../constant-values.html#org.eclipse.jetty.websocket.util.server.internal.WebSocketMapping.DEFAULT_KEY">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a id="<init>()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>WebSocketMapping</h4> |
| <pre>public WebSocketMapping()</pre> |
| </li> |
| </ul> |
| <a id="<init>(org.eclipse.jetty.websocket.core.WebSocketComponents)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>WebSocketMapping</h4> |
| <pre>public WebSocketMapping​(<a href="../../../core/WebSocketComponents.html" title="class in org.eclipse.jetty.websocket.core">WebSocketComponents</a> components)</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="getMapping(jakarta.servlet.ServletContext,java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMapping</h4> |
| <pre class="methodSignature">public static <a href="WebSocketMapping.html" title="class in org.eclipse.jetty.websocket.util.server.internal">WebSocketMapping</a> getMapping​(jakarta.servlet.ServletContext servletContext, |
| java.lang.String mappingKey)</pre> |
| </li> |
| </ul> |
| <a id="getMapping(org.eclipse.jetty.http.pathmap.PathSpec)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMapping</h4> |
| <pre class="methodSignature">public <a href="WebSocketCreator.html" title="interface in org.eclipse.jetty.websocket.util.server.internal">WebSocketCreator</a> getMapping​(<a href="../../../../http/pathmap/PathSpec.html" title="interface in org.eclipse.jetty.http.pathmap">PathSpec</a> pathSpec)</pre> |
| </li> |
| </ul> |
| <a id="ensureMapping(jakarta.servlet.ServletContext,java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>ensureMapping</h4> |
| <pre class="methodSignature">public static <a href="WebSocketMapping.html" title="class in org.eclipse.jetty.websocket.util.server.internal">WebSocketMapping</a> ensureMapping​(jakarta.servlet.ServletContext servletContext, |
| java.lang.String mappingKey)</pre> |
| </li> |
| </ul> |
| <a id="parsePathSpec(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>parsePathSpec</h4> |
| <pre class="methodSignature">public static <a href="../../../../http/pathmap/PathSpec.html" title="interface in org.eclipse.jetty.http.pathmap">PathSpec</a> parsePathSpec​(java.lang.String rawSpec)</pre> |
| <div class="block">Parse a PathSpec string into a PathSpec instance. |
| <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>rawSpec</code> - the raw path spec as String to parse.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the <a href="../../../../http/pathmap/PathSpec.html" title="interface in org.eclipse.jetty.http.pathmap"><code>PathSpec</code></a> implementation for the rawSpec</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="lifeCycleStopping(org.eclipse.jetty.util.component.LifeCycle)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>lifeCycleStopping</h4> |
| <pre class="methodSignature">public void lifeCycleStopping​(<a href="../../../../util/component/LifeCycle.html" title="interface in org.eclipse.jetty.util.component">LifeCycle</a> context)</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../util/component/LifeCycle.Listener.html#lifeCycleStopping(org.eclipse.jetty.util.component.LifeCycle)">lifeCycleStopping</a></code> in interface <code><a href="../../../../util/component/LifeCycle.Listener.html" title="interface in org.eclipse.jetty.util.component">LifeCycle.Listener</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="dump()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>dump</h4> |
| <pre class="methodSignature">public java.lang.String dump()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../util/component/Dumpable.html#dump()">dump</a></code> in interface <code><a href="../../../../util/component/Dumpable.html" title="interface in org.eclipse.jetty.util.component">Dumpable</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="dump(java.lang.Appendable,java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>dump</h4> |
| <pre class="methodSignature">public void dump​(java.lang.Appendable out, |
| java.lang.String indent) |
| throws java.io.IOException</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../util/component/Dumpable.html#dump(java.lang.Appendable,java.lang.String)">Dumpable</a></code></span></div> |
| <div class="block">Dump this object (and children) into an Appendable using the provided indent after any new lines. |
| The indent should not be applied to the first object dumped.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../util/component/Dumpable.html#dump(java.lang.Appendable,java.lang.String)">dump</a></code> in interface <code><a href="../../../../util/component/Dumpable.html" title="interface in org.eclipse.jetty.util.component">Dumpable</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>out</code> - The appendable to dump to</dd> |
| <dd><code>indent</code> - The indent to apply after any new lines.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.io.IOException</code> - if unable to write to Appendable</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="addMapping(org.eclipse.jetty.http.pathmap.PathSpec,org.eclipse.jetty.websocket.util.server.internal.WebSocketCreator,org.eclipse.jetty.websocket.util.server.internal.FrameHandlerFactory,org.eclipse.jetty.websocket.core.Configuration.Customizer)"> |
| <!-- --> |
| </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="WebSocketCreator.html" title="interface in org.eclipse.jetty.websocket.util.server.internal">WebSocketCreator</a> creator, |
| <a href="FrameHandlerFactory.html" title="interface in org.eclipse.jetty.websocket.util.server.internal">FrameHandlerFactory</a> factory, |
| <a href="../../../core/Configuration.Customizer.html" title="interface in org.eclipse.jetty.websocket.core">Configuration.Customizer</a> customizer) |
| throws <a href="../../../core/exception/WebSocketException.html" title="class in org.eclipse.jetty.websocket.core.exception">WebSocketException</a></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="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> |
| <dd><code>factory</code> - the factory to use to create a FrameHandler for the websocket</dd> |
| <dd><code>customizer</code> - the customizer to use to customize the WebSocket session.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../core/exception/WebSocketException.html" title="class in org.eclipse.jetty.websocket.core.exception">WebSocketException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="removeMapping(org.eclipse.jetty.http.pathmap.PathSpec)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>removeMapping</h4> |
| <pre class="methodSignature">public boolean removeMapping​(<a href="../../../../http/pathmap/PathSpec.html" title="interface in org.eclipse.jetty.http.pathmap">PathSpec</a> pathSpec)</pre> |
| </li> |
| </ul> |
| <a id="getMatchedNegotiator(java.lang.String,java.util.function.Consumer)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMatchedNegotiator</h4> |
| <pre class="methodSignature">public <a href="../../../core/server/WebSocketNegotiator.html" title="interface in org.eclipse.jetty.websocket.core.server">WebSocketNegotiator</a> getMatchedNegotiator​(java.lang.String target, |
| java.util.function.Consumer<<a href="../../../../http/pathmap/PathSpec.html" title="interface in org.eclipse.jetty.http.pathmap">PathSpec</a>> pathSpecConsumer)</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> |
| <dd><code>pathSpecConsumer</code> - the path</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the matching resource, or null if no match.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="upgrade(jakarta.servlet.http.HttpServletRequest,jakarta.servlet.http.HttpServletResponse,org.eclipse.jetty.websocket.core.Configuration.Customizer)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>upgrade</h4> |
| <pre class="methodSignature">public boolean upgrade​(jakarta.servlet.http.HttpServletRequest request, |
| jakarta.servlet.http.HttpServletResponse response, |
| <a href="../../../core/Configuration.Customizer.html" title="interface in org.eclipse.jetty.websocket.core">Configuration.Customizer</a> defaultCustomizer) |
| throws java.io.IOException</pre> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.io.IOException</code></dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </main> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <footer role="contentinfo"> |
| <nav role="navigation"> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a id="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/WebSocketMapping.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><a href="#field.detail">Field</a> | </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> |
