| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) on Thu Sep 15 14:13:16 CDT 2022 --> |
| <title>JakartaWebSocketSession (Eclipse Jetty API Doc - v11.0.12)</title> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="dc.created" content="2022-09-15"> |
| <meta name="description" content="declaration: package: org.eclipse.jetty.websocket.jakarta.common, class: JakartaWebSocketSession"> |
| <meta name="generator" content="javadoc/ClassWriterImpl"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../script-dir/jquery-ui.min.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../jquery-ui.overrides.css" title="Style"> |
| <script type="text/javascript" src="../../../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../../../script-dir/jquery-3.5.1.min.js"></script> |
| <script type="text/javascript" src="../../../../../../script-dir/jquery-ui.min.js"></script> |
| </head> |
| <body class="class-declaration-page"> |
| <script type="text/javascript">var evenRowColor = "even-row-color"; |
| var oddRowColor = "odd-row-color"; |
| var tableTab = "table-tab"; |
| var activeTableTab = "active-table-tab"; |
| var pathtoroot = "../../../../../../"; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <div class="flex-box"> |
| <header role="banner" class="flex-header"> |
| <nav role="navigation"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="top-nav" id="navbar-top"> |
| <div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> |
| <ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> |
| <li><a href="../../../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="nav-bar-cell1-rev">Class</li> |
| <li><a href="class-use/JakartaWebSocketSession.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#class">Help</a></li> |
| </ul> |
| </div> |
| <div class="sub-nav"> |
| <div> |
| <ul class="sub-nav-list"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li><a href="#constructor-summary">Constr</a> | </li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor-detail">Constr</a> | </li> |
| <li><a href="#method-detail">Method</a></li> |
| </ul> |
| </div> |
| <div class="nav-list-search"><label for="search-input">SEARCH:</label> |
| <input type="text" id="search-input" value="search" disabled="disabled"> |
| <input type="reset" id="reset-button" value="reset" disabled="disabled"> |
| </div> |
| </div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <span class="skip-nav" id="skip-navbar-top"></span></nav> |
| </header> |
| <div class="flex-content"> |
| <main role="main"> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.eclipse.jetty.websocket.jakarta.common</a></div> |
| <h1 title="Class JakartaWebSocketSession" class="title">Class JakartaWebSocketSession</h1> |
| </div> |
| <div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> |
| <div class="inheritance">org.eclipse.jetty.websocket.jakarta.common.JakartaWebSocketSession</div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code>jakarta.websocket.Session</code>, <code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/Closeable.html" title="class or interface in java.io" class="external-link">Closeable</a></code>, <code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/AutoCloseable.html" title="class or interface in java.lang" class="external-link">AutoCloseable</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">JakartaWebSocketSession</span> |
| <span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> |
| implements jakarta.websocket.Session</span></div> |
| <div class="block">Client Session for the JSR.</div> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <li> |
| <section class="constructor-summary" id="constructor-summary"> |
| <h2>Constructor Summary</h2> |
| <div class="caption"><span>Constructors</span></div> |
| <div class="summary-table two-column-summary"> |
| <div class="table-header col-first">Constructor</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(org.eclipse.jetty.websocket.jakarta.common.JakartaWebSocketContainer,org.eclipse.jetty.websocket.core.CoreSession,org.eclipse.jetty.websocket.jakarta.common.JakartaWebSocketFrameHandler,jakarta.websocket.EndpointConfig)" class="member-name-link">JakartaWebSocketSession</a><wbr>(<a href="JakartaWebSocketContainer.html" title="class in org.eclipse.jetty.websocket.jakarta.common">JakartaWebSocketContainer</a> container, |
| <a href="../../core/CoreSession.html" title="interface in org.eclipse.jetty.websocket.core">CoreSession</a> coreSession, |
| <a href="JakartaWebSocketFrameHandler.html" title="class in org.eclipse.jetty.websocket.jakarta.common">JakartaWebSocketFrameHandler</a> frameHandler, |
| jakarta.websocket.EndpointConfig endpointConfig)</code></div> |
| <div class="col-last even-row-color"> </div> |
| </div> |
| </section> |
| </li> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <li> |
| <section class="method-summary" id="method-summary"> |
| <h2>Method Summary</h2> |
| <div id="method-summary-table"> |
| <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> |
| <div id="method-summary-table.tabpanel" role="tabpanel"> |
| <div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Method</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#abort()" class="member-name-link">abort</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#addMessageHandler(jakarta.websocket.MessageHandler)" class="member-name-link">addMessageHandler</a><wbr>(jakarta.websocket.MessageHandler handler)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"></div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><T> void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#addMessageHandler(java.lang.Class,jakarta.websocket.MessageHandler.Partial)" class="member-name-link">addMessageHandler</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><T> clazz, |
| jakarta.websocket.MessageHandler.Partial<T> handler)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"></div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><T> void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#addMessageHandler(java.lang.Class,jakarta.websocket.MessageHandler.Whole)" class="member-name-link">addMessageHandler</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><T> clazz, |
| jakarta.websocket.MessageHandler.Whole<T> handler)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"></div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#close()" class="member-name-link">close</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"></div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#close(jakarta.websocket.CloseReason)" class="member-name-link">close</a><wbr>(jakarta.websocket.CloseReason closeReason)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"></div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#filterReturnType(java.lang.Object)" class="member-name-link">filterReturnType</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> obj)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Access for MethodHandle implementations to filter the return value of user provided TEXT/BINARY |
| based message handling methods.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>jakarta.websocket.RemoteEndpoint.Async</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getAsyncRemote()" class="member-name-link">getAsyncRemote</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"></div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>jakarta.websocket.RemoteEndpoint.Basic</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getBasicRemote()" class="member-name-link">getBasicRemote</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"></div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>jakarta.websocket.WebSocketContainer</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getContainer()" class="member-name-link">getContainer</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"></div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="JakartaWebSocketContainer.html" title="class in org.eclipse.jetty.websocket.jakarta.common">JakartaWebSocketContainer</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getContainerImpl()" class="member-name-link">getContainerImpl</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../../core/CoreSession.html" title="interface in org.eclipse.jetty.websocket.core">CoreSession</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getCoreSession()" class="member-name-link">getCoreSession</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="decoders/AvailableDecoders.html" title="class in org.eclipse.jetty.websocket.jakarta.common.decoders">AvailableDecoders</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getDecoders()" class="member-name-link">getDecoders</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="encoders/AvailableEncoders.html" title="class in org.eclipse.jetty.websocket.jakarta.common.encoders">AvailableEncoders</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getEncoders()" class="member-name-link">getEncoders</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getEndpoint()" class="member-name-link">getEndpoint</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="JakartaWebSocketFrameHandler.html" title="class in org.eclipse.jetty.websocket.jakarta.common">JakartaWebSocketFrameHandler</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getFrameHandler()" class="member-name-link">getFrameHandler</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getId()" class="member-name-link">getId</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"></div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getMaxBinaryMessageBufferSize()" class="member-name-link">getMaxBinaryMessageBufferSize</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"></div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>long</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getMaxIdleTimeout()" class="member-name-link">getMaxIdleTimeout</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"></div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getMaxTextMessageBufferSize()" class="member-name-link">getMaxTextMessageBufferSize</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"></div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Set.html" title="class or interface in java.util" class="external-link">Set</a><jakarta.websocket.MessageHandler></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getMessageHandlers()" class="member-name-link">getMessageHandlers</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"></div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><jakarta.websocket.Extension></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getNegotiatedExtensions()" class="member-name-link">getNegotiatedExtensions</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"></div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getNegotiatedSubprotocol()" class="member-name-link">getNegotiatedSubprotocol</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"></div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Set.html" title="class or interface in java.util" class="external-link">Set</a><jakarta.websocket.Session></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getOpenSessions()" class="member-name-link">getOpenSessions</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"></div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getPathParameters()" class="member-name-link">getPathParameters</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"></div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getProtocolVersion()" class="member-name-link">getProtocolVersion</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"></div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getQueryString()" class="member-name-link">getQueryString</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"></div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>>></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getRequestParameterMap()" class="member-name-link">getRequestParameterMap</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"></div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/net/URI.html" title="class or interface in java.net" class="external-link">URI</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getRequestURI()" class="member-name-link">getRequestURI</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"></div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/security/Principal.html" title="class or interface in java.security" class="external-link">Principal</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getUserPrincipal()" class="member-name-link">getUserPrincipal</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"></div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getUserProperties()" class="member-name-link">getUserProperties</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"></div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isOpen()" class="member-name-link">isOpen</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"></div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isSecure()" class="member-name-link">isSecure</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"></div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#removeMessageHandler(jakarta.websocket.MessageHandler)" class="member-name-link">removeMessageHandler</a><wbr>(jakarta.websocket.MessageHandler handler)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setMaxBinaryMessageBufferSize(int)" class="member-name-link">setMaxBinaryMessageBufferSize</a><wbr>(int length)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Maximum size of a whole BINARY message that this implementation can buffer.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setMaxIdleTimeout(long)" class="member-name-link">setMaxIdleTimeout</a><wbr>(long milliseconds)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"></div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setMaxTextMessageBufferSize(int)" class="member-name-link">setMaxTextMessageBufferSize</a><wbr>(int length)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Maximum size of a whole TEXT message that this implementation can buffer.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#toString()" class="member-name-link">toString</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> |
| <code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <li> |
| <section class="constructor-details" id="constructor-detail"> |
| <h2>Constructor Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="<init>(org.eclipse.jetty.websocket.jakarta.common.JakartaWebSocketContainer,org.eclipse.jetty.websocket.core.CoreSession,org.eclipse.jetty.websocket.jakarta.common.JakartaWebSocketFrameHandler,jakarta.websocket.EndpointConfig)"> |
| <h3>JakartaWebSocketSession</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">JakartaWebSocketSession</span><wbr><span class="parameters">(<a href="JakartaWebSocketContainer.html" title="class in org.eclipse.jetty.websocket.jakarta.common">JakartaWebSocketContainer</a> container, |
| <a href="../../core/CoreSession.html" title="interface in org.eclipse.jetty.websocket.core">CoreSession</a> coreSession, |
| <a href="JakartaWebSocketFrameHandler.html" title="class in org.eclipse.jetty.websocket.jakarta.common">JakartaWebSocketFrameHandler</a> frameHandler, |
| jakarta.websocket.EndpointConfig endpointConfig)</span></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li> |
| <section class="method-details" id="method-detail"> |
| <h2>Method Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="getCoreSession()"> |
| <h3>getCoreSession</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../../core/CoreSession.html" title="interface in org.eclipse.jetty.websocket.core">CoreSession</a></span> <span class="element-name">getCoreSession</span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="addMessageHandler(java.lang.Class,jakarta.websocket.MessageHandler.Partial)"> |
| <h3>addMessageHandler</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="type-parameters"><T></span> <span class="return-type">void</span> <span class="element-name">addMessageHandler</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><T> clazz, |
| jakarta.websocket.MessageHandler.Partial<T> handler)</span></div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code>addMessageHandler</code> in interface <code>jakarta.websocket.Session</code></dd> |
| <dt>Since:</dt> |
| <dd>JSR356 v1.1</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list-long"> |
| <li><code>Session.addMessageHandler(Class, MessageHandler.Partial)</code></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="addMessageHandler(java.lang.Class,jakarta.websocket.MessageHandler.Whole)"> |
| <h3>addMessageHandler</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="type-parameters"><T></span> <span class="return-type">void</span> <span class="element-name">addMessageHandler</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><T> clazz, |
| jakarta.websocket.MessageHandler.Whole<T> handler)</span></div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code>addMessageHandler</code> in interface <code>jakarta.websocket.Session</code></dd> |
| <dt>Since:</dt> |
| <dd>JSR356 v1.1</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list-long"> |
| <li><code>Session.addMessageHandler(Class, MessageHandler.Whole)</code></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="addMessageHandler(jakarta.websocket.MessageHandler)"> |
| <h3>addMessageHandler</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">addMessageHandler</span><wbr><span class="parameters">(jakarta.websocket.MessageHandler handler)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IllegalStateException.html" title="class or interface in java.lang" class="external-link">IllegalStateException</a></span></div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code>addMessageHandler</code> in interface <code>jakarta.websocket.Session</code></dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IllegalStateException.html" title="class or interface in java.lang" class="external-link">IllegalStateException</a></code></dd> |
| <dt>Since:</dt> |
| <dd>JSR356 v1.0</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list-long"> |
| <li><code>Session.addMessageHandler(MessageHandler)</code></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="close()"> |
| <h3>close</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">close</span>()</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/AutoCloseable.html#close()" title="class or interface in java.lang" class="external-link">close</a></code> in interface <code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/AutoCloseable.html" title="class or interface in java.lang" class="external-link">AutoCloseable</a></code></dd> |
| <dt>Specified by:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/Closeable.html#close()" title="class or interface in java.io" class="external-link">close</a></code> in interface <code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/Closeable.html" title="class or interface in java.io" class="external-link">Closeable</a></code></dd> |
| <dt>Specified by:</dt> |
| <dd><code>close</code> in interface <code>jakarta.websocket.Session</code></dd> |
| <dt>Since:</dt> |
| <dd>JSR356 v1.0</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><code>Session.close()</code></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="close(jakarta.websocket.CloseReason)"> |
| <h3>close</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">close</span><wbr><span class="parameters">(jakarta.websocket.CloseReason closeReason)</span></div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code>close</code> in interface <code>jakarta.websocket.Session</code></dd> |
| <dt>Since:</dt> |
| <dd>JSR356 v1.0</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><code>Session.close(CloseReason)</code></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="filterReturnType(java.lang.Object)"> |
| <h3>filterReturnType</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">filterReturnType</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> obj)</span></div> |
| <div class="block">Access for MethodHandle implementations to filter the return value of user provided TEXT/BINARY |
| based message handling methods.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>obj</code> - the return object</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getAsyncRemote()"> |
| <h3>getAsyncRemote</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">jakarta.websocket.RemoteEndpoint.Async</span> <span class="element-name">getAsyncRemote</span>()</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code>getAsyncRemote</code> in interface <code>jakarta.websocket.Session</code></dd> |
| <dt>Since:</dt> |
| <dd>JSR356 v1.0</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><code>Session.getAsyncRemote()</code></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getBasicRemote()"> |
| <h3>getBasicRemote</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">jakarta.websocket.RemoteEndpoint.Basic</span> <span class="element-name">getBasicRemote</span>()</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code>getBasicRemote</code> in interface <code>jakarta.websocket.Session</code></dd> |
| <dt>Since:</dt> |
| <dd>JSR356 v1.0</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><code>Session.getBasicRemote()</code></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getContainer()"> |
| <h3>getContainer</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">jakarta.websocket.WebSocketContainer</span> <span class="element-name">getContainer</span>()</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code>getContainer</code> in interface <code>jakarta.websocket.Session</code></dd> |
| <dt>Since:</dt> |
| <dd>JSR356 v1.0</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><code>Session.getContainer()</code></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getContainerImpl()"> |
| <h3>getContainerImpl</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="JakartaWebSocketContainer.html" title="class in org.eclipse.jetty.websocket.jakarta.common">JakartaWebSocketContainer</a></span> <span class="element-name">getContainerImpl</span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getDecoders()"> |
| <h3>getDecoders</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="decoders/AvailableDecoders.html" title="class in org.eclipse.jetty.websocket.jakarta.common.decoders">AvailableDecoders</a></span> <span class="element-name">getDecoders</span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getEncoders()"> |
| <h3>getEncoders</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="encoders/AvailableEncoders.html" title="class in org.eclipse.jetty.websocket.jakarta.common.encoders">AvailableEncoders</a></span> <span class="element-name">getEncoders</span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getEndpoint()"> |
| <h3>getEndpoint</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span> <span class="element-name">getEndpoint</span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getFrameHandler()"> |
| <h3>getFrameHandler</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="JakartaWebSocketFrameHandler.html" title="class in org.eclipse.jetty.websocket.jakarta.common">JakartaWebSocketFrameHandler</a></span> <span class="element-name">getFrameHandler</span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="abort()"> |
| <h3>abort</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">abort</span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getId()"> |
| <h3>getId</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">getId</span>()</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code>getId</code> in interface <code>jakarta.websocket.Session</code></dd> |
| <dt>Since:</dt> |
| <dd>JSR356 v1.0</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><code>Session.getId()</code></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getMaxBinaryMessageBufferSize()"> |
| <h3>getMaxBinaryMessageBufferSize</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">getMaxBinaryMessageBufferSize</span>()</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code>getMaxBinaryMessageBufferSize</code> in interface <code>jakarta.websocket.Session</code></dd> |
| <dt>Since:</dt> |
| <dd>JSR356 v1.0</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list-long"> |
| <li><code>Session.getMaxBinaryMessageBufferSize()</code></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setMaxBinaryMessageBufferSize(int)"> |
| <h3>setMaxBinaryMessageBufferSize</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setMaxBinaryMessageBufferSize</span><wbr><span class="parameters">(int length)</span></div> |
| <div class="block">Maximum size of a whole BINARY message that this implementation can buffer.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code>setMaxBinaryMessageBufferSize</code> in interface <code>jakarta.websocket.Session</code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>length</code> - the length in bytes</dd> |
| <dt>Since:</dt> |
| <dd>JSR356 v1.0</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list-long"> |
| <li><code>Session.setMaxBinaryMessageBufferSize(int)</code></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getMaxIdleTimeout()"> |
| <h3>getMaxIdleTimeout</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">long</span> <span class="element-name">getMaxIdleTimeout</span>()</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code>getMaxIdleTimeout</code> in interface <code>jakarta.websocket.Session</code></dd> |
| <dt>Since:</dt> |
| <dd>JSR356 v1.0</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><code>Session.getMaxIdleTimeout()</code></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setMaxIdleTimeout(long)"> |
| <h3>setMaxIdleTimeout</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setMaxIdleTimeout</span><wbr><span class="parameters">(long milliseconds)</span></div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code>setMaxIdleTimeout</code> in interface <code>jakarta.websocket.Session</code></dd> |
| <dt>Since:</dt> |
| <dd>JSR356 v1.0</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list-long"> |
| <li><code>Session.setMaxIdleTimeout(long)</code></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getMaxTextMessageBufferSize()"> |
| <h3>getMaxTextMessageBufferSize</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">getMaxTextMessageBufferSize</span>()</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code>getMaxTextMessageBufferSize</code> in interface <code>jakarta.websocket.Session</code></dd> |
| <dt>Since:</dt> |
| <dd>JSR356 v1.0</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list-long"> |
| <li><code>Session.getMaxTextMessageBufferSize()</code></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setMaxTextMessageBufferSize(int)"> |
| <h3>setMaxTextMessageBufferSize</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setMaxTextMessageBufferSize</span><wbr><span class="parameters">(int length)</span></div> |
| <div class="block">Maximum size of a whole TEXT message that this implementation can buffer.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code>setMaxTextMessageBufferSize</code> in interface <code>jakarta.websocket.Session</code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>length</code> - the length in bytes</dd> |
| <dt>Since:</dt> |
| <dd>JSR356 v1.0</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list-long"> |
| <li><code>Session.setMaxTextMessageBufferSize(int)</code></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getMessageHandlers()"> |
| <h3>getMessageHandlers</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Set.html" title="class or interface in java.util" class="external-link">Set</a><jakarta.websocket.MessageHandler></span> <span class="element-name">getMessageHandlers</span>()</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code>getMessageHandlers</code> in interface <code>jakarta.websocket.Session</code></dd> |
| <dt>Since:</dt> |
| <dd>JSR356 v1.0</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><code>Session.getMessageHandlers()</code></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getNegotiatedExtensions()"> |
| <h3>getNegotiatedExtensions</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><jakarta.websocket.Extension></span> <span class="element-name">getNegotiatedExtensions</span>()</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code>getNegotiatedExtensions</code> in interface <code>jakarta.websocket.Session</code></dd> |
| <dt>Since:</dt> |
| <dd>JSR356 v1.0</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list-long"> |
| <li><code>Session.getNegotiatedExtensions()</code></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getNegotiatedSubprotocol()"> |
| <h3>getNegotiatedSubprotocol</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">getNegotiatedSubprotocol</span>()</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code>getNegotiatedSubprotocol</code> in interface <code>jakarta.websocket.Session</code></dd> |
| <dt>Since:</dt> |
| <dd>JSR356 v1.0</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list-long"> |
| <li><code>Session.getNegotiatedSubprotocol()</code></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getOpenSessions()"> |
| <h3>getOpenSessions</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Set.html" title="class or interface in java.util" class="external-link">Set</a><jakarta.websocket.Session></span> <span class="element-name">getOpenSessions</span>()</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code>getOpenSessions</code> in interface <code>jakarta.websocket.Session</code></dd> |
| <dt>Since:</dt> |
| <dd>JSR356 v1.0</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><code>Session.getOpenSessions()</code></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getPathParameters()"> |
| <h3>getPathParameters</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>></span> <span class="element-name">getPathParameters</span>()</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code>getPathParameters</code> in interface <code>jakarta.websocket.Session</code></dd> |
| <dt>Since:</dt> |
| <dd>JSR356 v1.0</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><code>Session.getPathParameters()</code></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getProtocolVersion()"> |
| <h3>getProtocolVersion</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">getProtocolVersion</span>()</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code>getProtocolVersion</code> in interface <code>jakarta.websocket.Session</code></dd> |
| <dt>Since:</dt> |
| <dd>JSR356 v1.0</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><code>Session.getProtocolVersion()</code></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getQueryString()"> |
| <h3>getQueryString</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">getQueryString</span>()</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code>getQueryString</code> in interface <code>jakarta.websocket.Session</code></dd> |
| <dt>Since:</dt> |
| <dd>JSR356 v1.0</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><code>Session.getQueryString()</code></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getRequestParameterMap()"> |
| <h3>getRequestParameterMap</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>>></span> <span class="element-name">getRequestParameterMap</span>()</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code>getRequestParameterMap</code> in interface <code>jakarta.websocket.Session</code></dd> |
| <dt>Since:</dt> |
| <dd>JSR356 v1.0</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list-long"> |
| <li><code>Session.getRequestParameterMap()</code></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getRequestURI()"> |
| <h3>getRequestURI</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/net/URI.html" title="class or interface in java.net" class="external-link">URI</a></span> <span class="element-name">getRequestURI</span>()</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code>getRequestURI</code> in interface <code>jakarta.websocket.Session</code></dd> |
| <dt>Since:</dt> |
| <dd>JSR356 v1.0</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><code>)</code></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getUserPrincipal()"> |
| <h3>getUserPrincipal</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/security/Principal.html" title="class or interface in java.security" class="external-link">Principal</a></span> <span class="element-name">getUserPrincipal</span>()</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code>getUserPrincipal</code> in interface <code>jakarta.websocket.Session</code></dd> |
| <dt>Since:</dt> |
| <dd>JSR356 v1.0</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><code>Session.getUserPrincipal()</code></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getUserProperties()"> |
| <h3>getUserProperties</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>></span> <span class="element-name">getUserProperties</span>()</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code>getUserProperties</code> in interface <code>jakarta.websocket.Session</code></dd> |
| <dt>Since:</dt> |
| <dd>JSR356 v1.0</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><code>Session.getUserProperties()</code></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isOpen()"> |
| <h3>isOpen</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isOpen</span>()</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code>isOpen</code> in interface <code>jakarta.websocket.Session</code></dd> |
| <dt>Since:</dt> |
| <dd>JSR356 v1.0</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><code>Session.isOpen()</code></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isSecure()"> |
| <h3>isSecure</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isSecure</span>()</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code>isSecure</code> in interface <code>jakarta.websocket.Session</code></dd> |
| <dt>Since:</dt> |
| <dd>JSR356 v1.0</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><code>Session.isSecure()</code></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="removeMessageHandler(jakarta.websocket.MessageHandler)"> |
| <h3>removeMessageHandler</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">removeMessageHandler</span><wbr><span class="parameters">(jakarta.websocket.MessageHandler handler)</span></div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code>removeMessageHandler</code> in interface <code>jakarta.websocket.Session</code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="toString()"> |
| <h3>toString</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">toString</span>()</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a></code> in class <code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| <footer role="contentinfo"> |
| <hr> |
| <p class="legal-copy"><small>Copyright © 1995–2022 <a href="https://webtide.com">Webtide</a>. All rights reserved.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |
