| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (11.0.8) on Thu Oct 22 13:32:16 CDT 2020 --> |
| <title>JavaxWebSocketServerFrameHandlerFactory (Jetty :: Javadoc Build 10.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="JavaxWebSocketServerFrameHandlerFactory (Jetty :: Javadoc Build 10.0.0.beta3 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"i0":10,"i1":10}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| 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/JavaxWebSocketServerFrameHandlerFactory.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><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.javax.server.internal</a></div> |
| <h2 title="Class JavaxWebSocketServerFrameHandlerFactory" class="title">Class JavaxWebSocketServerFrameHandlerFactory</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="../../common/JavaxWebSocketFrameHandlerFactory.html" title="class in org.eclipse.jetty.websocket.javax.common">org.eclipse.jetty.websocket.javax.common.JavaxWebSocketFrameHandlerFactory</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="../../client/internal/JavaxWebSocketClientFrameHandlerFactory.html" title="class in org.eclipse.jetty.websocket.javax.client.internal">org.eclipse.jetty.websocket.javax.client.internal.JavaxWebSocketClientFrameHandlerFactory</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.eclipse.jetty.websocket.javax.server.internal.JavaxWebSocketServerFrameHandlerFactory</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/server/internal/FrameHandlerFactory.html" title="interface in org.eclipse.jetty.websocket.util.server.internal">FrameHandlerFactory</a></code></dd> |
| </dl> |
| <hr> |
| <pre>public class <span class="typeNameLabel">JavaxWebSocketServerFrameHandlerFactory</span> |
| extends <a href="../../client/internal/JavaxWebSocketClientFrameHandlerFactory.html" title="class in org.eclipse.jetty.websocket.javax.client.internal">JavaxWebSocketClientFrameHandlerFactory</a> |
| implements <a href="../../../util/server/internal/FrameHandlerFactory.html" title="interface in org.eclipse.jetty.websocket.util.server.internal">FrameHandlerFactory</a></pre> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- =========== 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.websocket.javax.common.JavaxWebSocketFrameHandlerFactory"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from class org.eclipse.jetty.websocket.javax.common.<a href="../../common/JavaxWebSocketFrameHandlerFactory.html" title="class in org.eclipse.jetty.websocket.javax.common">JavaxWebSocketFrameHandlerFactory</a></h3> |
| <code><a href="../../common/JavaxWebSocketFrameHandlerFactory.html#container">container</a>, <a href="../../common/JavaxWebSocketFrameHandlerFactory.html#paramIdentifier">paramIdentifier</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(org.eclipse.jetty.websocket.javax.common.JavaxWebSocketContainer)">JavaxWebSocketServerFrameHandlerFactory</a></span>​(<a href="../../common/JavaxWebSocketContainer.html" title="class in org.eclipse.jetty.websocket.javax.common">JavaxWebSocketContainer</a> container)</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></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><a href="../../common/JavaxWebSocketFrameHandlerMetadata.html" title="class in org.eclipse.jetty.websocket.javax.common">JavaxWebSocketFrameHandlerMetadata</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getMetadata(java.lang.Class,javax.websocket.EndpointConfig)">getMetadata</a></span>​(java.lang.Class<?> endpointClass, |
| javax.websocket.EndpointConfig endpointConfig)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../core/FrameHandler.html" title="interface in org.eclipse.jetty.websocket.core">FrameHandler</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#newFrameHandler(java.lang.Object,org.eclipse.jetty.websocket.util.server.internal.ServerUpgradeRequest,org.eclipse.jetty.websocket.util.server.internal.ServerUpgradeResponse)">newFrameHandler</a></span>​(java.lang.Object websocketPojo, |
| <a href="../../../util/server/internal/ServerUpgradeRequest.html" title="class in org.eclipse.jetty.websocket.util.server.internal">ServerUpgradeRequest</a> upgradeRequest, |
| <a href="../../../util/server/internal/ServerUpgradeResponse.html" title="class in org.eclipse.jetty.websocket.util.server.internal">ServerUpgradeResponse</a> upgradeResponse)</code></th> |
| <td class="colLast"> |
| <div class="block">Create a FrameHandler from the provided websocketPojo.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.org.eclipse.jetty.websocket.javax.client.internal.JavaxWebSocketClientFrameHandlerFactory"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.eclipse.jetty.websocket.javax.client.internal.<a href="../../client/internal/JavaxWebSocketClientFrameHandlerFactory.html" title="class in org.eclipse.jetty.websocket.javax.client.internal">JavaxWebSocketClientFrameHandlerFactory</a></h3> |
| <code><a href="../../client/internal/JavaxWebSocketClientFrameHandlerFactory.html#newDefaultEndpointConfig(java.lang.Class)">newDefaultEndpointConfig</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.org.eclipse.jetty.websocket.javax.common.JavaxWebSocketFrameHandlerFactory"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.eclipse.jetty.websocket.javax.common.<a href="../../common/JavaxWebSocketFrameHandlerFactory.html" title="class in org.eclipse.jetty.websocket.javax.common">JavaxWebSocketFrameHandlerFactory</a></h3> |
| <code><a href="../../common/JavaxWebSocketFrameHandlerFactory.html#bindTemplateVariables(java.lang.invoke.MethodHandle,java.lang.String%5B%5D,java.util.Map)">bindTemplateVariables</a>, <a href="../../common/JavaxWebSocketFrameHandlerFactory.html#createEndpointMetadata(javax.websocket.EndpointConfig)">createEndpointMetadata</a>, <a href="../../common/JavaxWebSocketFrameHandlerFactory.html#createMessageSink(org.eclipse.jetty.websocket.javax.common.JavaxWebSocketSession,org.eclipse.jetty.websocket.javax.common.JavaxWebSocketMessageMetadata)">createMessageSink</a>, <a href="../../common/JavaxWebSocketFrameHandlerFactory.html#discoverJavaxFrameHandlerMetadata(java.lang.Class,org.eclipse.jetty.websocket.javax.common.JavaxWebSocketFrameHandlerMetadata)">discoverJavaxFrameHandlerMetadata</a>, <a href="../../common/JavaxWebSocketFrameHandlerFactory.html#getApplicationMethodHandleLookup(java.lang.Class)">getApplicationMethodHandleLookup</a>, <a href="../../common/JavaxWebSocketFrameHandlerFactory.html#getServerMethodHandleLookup()">getServerMethodHandleLookup</a>, <a href="../../common/JavaxWebSocketFrameHandlerFactory.html#newJavaxWebSocketFrameHandler(java.lang.Object,org.eclipse.jetty.websocket.javax.common.UpgradeRequest)">newJavaxWebSocketFrameHandler</a>, <a href="../../common/JavaxWebSocketFrameHandlerFactory.html#wrapNonVoidReturnType(java.lang.invoke.MethodHandle,org.eclipse.jetty.websocket.javax.common.JavaxWebSocketSession)">wrapNonVoidReturnType</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, toString, wait, wait, wait</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>(org.eclipse.jetty.websocket.javax.common.JavaxWebSocketContainer)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>JavaxWebSocketServerFrameHandlerFactory</h4> |
| <pre>public JavaxWebSocketServerFrameHandlerFactory​(<a href="../../common/JavaxWebSocketContainer.html" title="class in org.eclipse.jetty.websocket.javax.common">JavaxWebSocketContainer</a> container)</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="getMetadata(java.lang.Class,javax.websocket.EndpointConfig)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMetadata</h4> |
| <pre class="methodSignature">public <a href="../../common/JavaxWebSocketFrameHandlerMetadata.html" title="class in org.eclipse.jetty.websocket.javax.common">JavaxWebSocketFrameHandlerMetadata</a> getMetadata​(java.lang.Class<?> endpointClass, |
| javax.websocket.EndpointConfig endpointConfig)</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../client/internal/JavaxWebSocketClientFrameHandlerFactory.html#getMetadata(java.lang.Class,javax.websocket.EndpointConfig)">getMetadata</a></code> in class <code><a href="../../client/internal/JavaxWebSocketClientFrameHandlerFactory.html" title="class in org.eclipse.jetty.websocket.javax.client.internal">JavaxWebSocketClientFrameHandlerFactory</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="newFrameHandler(java.lang.Object,org.eclipse.jetty.websocket.util.server.internal.ServerUpgradeRequest,org.eclipse.jetty.websocket.util.server.internal.ServerUpgradeResponse)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>newFrameHandler</h4> |
| <pre class="methodSignature">public <a href="../../../core/FrameHandler.html" title="interface in org.eclipse.jetty.websocket.core">FrameHandler</a> newFrameHandler​(java.lang.Object websocketPojo, |
| <a href="../../../util/server/internal/ServerUpgradeRequest.html" title="class in org.eclipse.jetty.websocket.util.server.internal">ServerUpgradeRequest</a> upgradeRequest, |
| <a href="../../../util/server/internal/ServerUpgradeResponse.html" title="class in org.eclipse.jetty.websocket.util.server.internal">ServerUpgradeResponse</a> upgradeResponse)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../util/server/internal/FrameHandlerFactory.html#newFrameHandler(java.lang.Object,org.eclipse.jetty.websocket.util.server.internal.ServerUpgradeRequest,org.eclipse.jetty.websocket.util.server.internal.ServerUpgradeResponse)">FrameHandlerFactory</a></code></span></div> |
| <div class="block">Create a FrameHandler from the provided websocketPojo.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../util/server/internal/FrameHandlerFactory.html#newFrameHandler(java.lang.Object,org.eclipse.jetty.websocket.util.server.internal.ServerUpgradeRequest,org.eclipse.jetty.websocket.util.server.internal.ServerUpgradeResponse)">newFrameHandler</a></code> in interface <code><a href="../../../util/server/internal/FrameHandlerFactory.html" title="interface in org.eclipse.jetty.websocket.util.server.internal">FrameHandlerFactory</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>websocketPojo</code> - the websocket pojo to work with</dd> |
| <dd><code>upgradeRequest</code> - the Upgrade Handshake Request used to create the FrameHandler</dd> |
| <dd><code>upgradeResponse</code> - the Upgrade Handshake Response used to create the FrameHandler</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the API specific FrameHandler, or null if this implementation is unable to create |
| the FrameHandler (allowing another <a href="../../../util/server/internal/FrameHandlerFactory.html" title="interface in org.eclipse.jetty.websocket.util.server.internal"><code>FrameHandlerFactory</code></a> to try)</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/JavaxWebSocketServerFrameHandlerFactory.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><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> |