| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (11.0.11) on Mon Jun 14 16:44:01 EDT 2021 --> |
| <title>DelegatedServerUpgradeRequest (Eclipse Jetty API Doc - v11.0.5)</title> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="dc.created" content="2021-06-14"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../jquery/jquery-ui.css" title="Style"> |
| <script type="text/javascript" src="../../../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../../../jquery/jszip/dist/jszip.min.js"></script> |
| <script type="text/javascript" src="../../../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script> |
| <!--[if IE]> |
| <script type="text/javascript" src="../../../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script> |
| <![endif]--> |
| <script type="text/javascript" src="../../../../../../jquery/jquery-3.5.1.js"></script> |
| <script type="text/javascript" src="../../../../../../jquery/jquery-ui.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="DelegatedServerUpgradeRequest (Eclipse Jetty API Doc - v11.0.5)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10,"i21":10,"i22":10,"i23":10,"i24":10,"i25":10,"i26":10,"i27":10,"i28":10,"i29":10,"i30":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/DelegatedServerUpgradeRequest.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../../allclasses.html">All Classes</a></li> |
| </ul> |
| <ul class="navListSearch"> |
| <li><label for="search">SEARCH:</label> |
| <input type="text" id="search" value="search" disabled="disabled"> |
| <input type="reset" id="reset" value="reset" disabled="disabled"> |
| </li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a id="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| </div> |
| <div class="navPadding"> </div> |
| <script type="text/javascript"><!-- |
| $('.navPadding').css('padding-top', $('.fixedNav').css("height")); |
| //--> |
| </script> |
| </nav> |
| </header> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <main role="main"> |
| <div class="header"> |
| <div class="subTitle"><span class="packageLabelInType">Package</span> <a href="package-summary.html">org.eclipse.jetty.websocket.server.internal</a></div> |
| <h2 title="Class DelegatedServerUpgradeRequest" class="title">Class DelegatedServerUpgradeRequest</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.eclipse.jetty.websocket.server.internal.DelegatedServerUpgradeRequest</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code><a href="../../api/UpgradeRequest.html" title="interface in org.eclipse.jetty.websocket.api">UpgradeRequest</a></code>, <code><a href="../JettyServerUpgradeRequest.html" title="interface in org.eclipse.jetty.websocket.server">JettyServerUpgradeRequest</a></code></dd> |
| </dl> |
| <hr> |
| <pre>public class <span class="typeNameLabel">DelegatedServerUpgradeRequest</span> |
| extends java.lang.Object |
| implements <a href="../JettyServerUpgradeRequest.html" title="interface in org.eclipse.jetty.websocket.server">JettyServerUpgradeRequest</a></pre> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== 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.core.server.ServerUpgradeRequest)">DelegatedServerUpgradeRequest</a></span>​(<a href="../../core/server/ServerUpgradeRequest.html" title="class in org.eclipse.jetty.websocket.core.server">ServerUpgradeRequest</a> request)</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>java.security.cert.X509Certificate[]</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getCertificates()">getCertificates</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>java.util.List<java.net.HttpCookie></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getCookies()">getCookies</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Get the list of Cookies on the Upgrade request</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>java.util.List<<a href="../../api/ExtensionConfig.html" title="interface in org.eclipse.jetty.websocket.api">ExtensionConfig</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getExtensions()">getExtensions</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Get the list of WebSocket Extension Configurations for this Upgrade Request.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getHeader(java.lang.String)">getHeader</a></span>​(java.lang.String name)</code></th> |
| <td class="colLast"> |
| <div class="block">Get a specific Header value from Upgrade Request</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getHeaderInt(java.lang.String)">getHeaderInt</a></span>​(java.lang.String name)</code></th> |
| <td class="colLast"> |
| <div class="block">Get the specific Header value, as an <code>int</code>, from the Upgrade Request.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>java.util.Map<java.lang.String,​java.util.List<java.lang.String>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getHeaders()">getHeaders</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Get the headers as a Map of keys to value lists.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>java.util.List<java.lang.String></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getHeaders(java.lang.String)">getHeaders</a></span>​(java.lang.String name)</code></th> |
| <td class="colLast"> |
| <div class="block">Get the specific header values (for multi-value headers)</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getHost()">getHost</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">The host of the Upgrade Request URI</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>jakarta.servlet.http.HttpServletRequest</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getHttpServletRequest()">getHttpServletRequest</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getHttpVersion()">getHttpVersion</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">The HTTP version used for this Upgrade Request</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>java.util.Locale</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getLocale()">getLocale</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code>java.util.Enumeration<java.util.Locale></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getLocales()">getLocales</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code>java.net.SocketAddress</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getLocalSocketAddress()">getLocalSocketAddress</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getMethod()">getMethod</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">The HTTP method for this Upgrade Request.</div> |
| </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getOrigin()">getOrigin</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">The WebSocket Origin of this Upgrade Request</div> |
| </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code>java.util.Map<java.lang.String,​java.util.List<java.lang.String>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getParameterMap()">getParameterMap</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns a map of the query parameters of the request.</div> |
| </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getProtocolVersion()">getProtocolVersion</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Get the WebSocket Protocol Version</div> |
| </td> |
| </tr> |
| <tr id="i17" class="rowColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getQueryString()">getQueryString</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Get the Query String of the request URI.</div> |
| </td> |
| </tr> |
| <tr id="i18" class="altColor"> |
| <td class="colFirst"><code>java.net.SocketAddress</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getRemoteSocketAddress()">getRemoteSocketAddress</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i19" class="rowColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getRequestPath()">getRequestPath</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i20" class="altColor"> |
| <td class="colFirst"><code>java.net.URI</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getRequestURI()">getRequestURI</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Get the Request URI</div> |
| </td> |
| </tr> |
| <tr id="i21" class="rowColor"> |
| <td class="colFirst"><code>java.lang.Object</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getServletAttribute(java.lang.String)">getServletAttribute</a></span>​(java.lang.String name)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i22" class="altColor"> |
| <td class="colFirst"><code>java.util.Map<java.lang.String,​java.lang.Object></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getServletAttributes()">getServletAttributes</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i23" class="rowColor"> |
| <td class="colFirst"><code>java.util.Map<java.lang.String,​java.util.List<java.lang.String>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getServletParameters()">getServletParameters</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i24" class="altColor"> |
| <td class="colFirst"><code>jakarta.servlet.http.HttpSession</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSession()">getSession</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Access the Servlet HTTP Session (if present)</div> |
| </td> |
| </tr> |
| <tr id="i25" class="rowColor"> |
| <td class="colFirst"><code>java.util.List<java.lang.String></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSubProtocols()">getSubProtocols</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Get the list of offered WebSocket sub-protocols.</div> |
| </td> |
| </tr> |
| <tr id="i26" class="altColor"> |
| <td class="colFirst"><code>java.security.Principal</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getUserPrincipal()">getUserPrincipal</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Get the User Principal for this request.</div> |
| </td> |
| </tr> |
| <tr id="i27" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#hasSubProtocol(java.lang.String)">hasSubProtocol</a></span>​(java.lang.String subprotocol)</code></th> |
| <td class="colLast"> |
| <div class="block">Test if a specific sub-protocol is offered</div> |
| </td> |
| </tr> |
| <tr id="i28" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isSecure()">isSecure</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Test if connection is secure.</div> |
| </td> |
| </tr> |
| <tr id="i29" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isUserInRole(java.lang.String)">isUserInRole</a></span>​(java.lang.String role)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i30" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setServletAttribute(java.lang.String,java.lang.Object)">setServletAttribute</a></span>​(java.lang.String name, |
| java.lang.Object value)</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> |
| </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.core.server.ServerUpgradeRequest)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>DelegatedServerUpgradeRequest</h4> |
| <pre>public DelegatedServerUpgradeRequest​(<a href="../../core/server/ServerUpgradeRequest.html" title="class in org.eclipse.jetty.websocket.core.server">ServerUpgradeRequest</a> request)</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="getCookies()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCookies</h4> |
| <pre class="methodSignature">public java.util.List<java.net.HttpCookie> getCookies()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../api/UpgradeRequest.html#getCookies()">UpgradeRequest</a></code></span></div> |
| <div class="block">Get the list of Cookies on the Upgrade request</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../api/UpgradeRequest.html#getCookies()">getCookies</a></code> in interface <code><a href="../../api/UpgradeRequest.html" title="interface in org.eclipse.jetty.websocket.api">UpgradeRequest</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the list of Cookies</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getExtensions()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getExtensions</h4> |
| <pre class="methodSignature">public java.util.List<<a href="../../api/ExtensionConfig.html" title="interface in org.eclipse.jetty.websocket.api">ExtensionConfig</a>> getExtensions()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../api/UpgradeRequest.html#getExtensions()">UpgradeRequest</a></code></span></div> |
| <div class="block">Get the list of WebSocket Extension Configurations for this Upgrade Request. |
| <p> |
| This is merely the list of requested Extensions to use, see <a href="../../api/UpgradeResponse.html#getExtensions()"><code>UpgradeResponse.getExtensions()</code></a> for what was |
| negotiated</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../api/UpgradeRequest.html#getExtensions()">getExtensions</a></code> in interface <code><a href="../../api/UpgradeRequest.html" title="interface in org.eclipse.jetty.websocket.api">UpgradeRequest</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the list of Extension configurations (in the order they were specified)</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getHeader(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getHeader</h4> |
| <pre class="methodSignature">public java.lang.String getHeader​(java.lang.String name)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../api/UpgradeRequest.html#getHeader(java.lang.String)">UpgradeRequest</a></code></span></div> |
| <div class="block">Get a specific Header value from Upgrade Request</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../api/UpgradeRequest.html#getHeader(java.lang.String)">getHeader</a></code> in interface <code><a href="../../api/UpgradeRequest.html" title="interface in org.eclipse.jetty.websocket.api">UpgradeRequest</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - the name of the header</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the value of the header (null if header does not exist)</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getHeaderInt(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getHeaderInt</h4> |
| <pre class="methodSignature">public int getHeaderInt​(java.lang.String name)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../api/UpgradeRequest.html#getHeaderInt(java.lang.String)">UpgradeRequest</a></code></span></div> |
| <div class="block">Get the specific Header value, as an <code>int</code>, from the Upgrade Request.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../api/UpgradeRequest.html#getHeaderInt(java.lang.String)">getHeaderInt</a></code> in interface <code><a href="../../api/UpgradeRequest.html" title="interface in org.eclipse.jetty.websocket.api">UpgradeRequest</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - the name of the header</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the value of the header as an <code>int</code> (-1 if header does not exist)</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getHeaders()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getHeaders</h4> |
| <pre class="methodSignature">public java.util.Map<java.lang.String,​java.util.List<java.lang.String>> getHeaders()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../api/UpgradeRequest.html#getHeaders()">UpgradeRequest</a></code></span></div> |
| <div class="block">Get the headers as a Map of keys to value lists.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../api/UpgradeRequest.html#getHeaders()">getHeaders</a></code> in interface <code><a href="../../api/UpgradeRequest.html" title="interface in org.eclipse.jetty.websocket.api">UpgradeRequest</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the headers</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getHeaders(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getHeaders</h4> |
| <pre class="methodSignature">public java.util.List<java.lang.String> getHeaders​(java.lang.String name)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../api/UpgradeRequest.html#getHeaders(java.lang.String)">UpgradeRequest</a></code></span></div> |
| <div class="block">Get the specific header values (for multi-value headers)</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../api/UpgradeRequest.html#getHeaders(java.lang.String)">getHeaders</a></code> in interface <code><a href="../../api/UpgradeRequest.html" title="interface in org.eclipse.jetty.websocket.api">UpgradeRequest</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - the header name</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the value list (null if no header exists)</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getHost()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getHost</h4> |
| <pre class="methodSignature">public java.lang.String getHost()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../api/UpgradeRequest.html#getHost()">UpgradeRequest</a></code></span></div> |
| <div class="block">The host of the Upgrade Request URI</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../api/UpgradeRequest.html#getHost()">getHost</a></code> in interface <code><a href="../../api/UpgradeRequest.html" title="interface in org.eclipse.jetty.websocket.api">UpgradeRequest</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>host of the request URI</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getHttpVersion()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getHttpVersion</h4> |
| <pre class="methodSignature">public java.lang.String getHttpVersion()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../api/UpgradeRequest.html#getHttpVersion()">UpgradeRequest</a></code></span></div> |
| <div class="block">The HTTP version used for this Upgrade Request |
| <p> |
| As of <a href="http://tools.ietf.org/html/rfc6455">RFC6455 (December 2011)</a> this is always |
| <code>HTTP/1.1</code></div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../api/UpgradeRequest.html#getHttpVersion()">getHttpVersion</a></code> in interface <code><a href="../../api/UpgradeRequest.html" title="interface in org.eclipse.jetty.websocket.api">UpgradeRequest</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the HTTP Version used</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getMethod()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMethod</h4> |
| <pre class="methodSignature">public java.lang.String getMethod()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../api/UpgradeRequest.html#getMethod()">UpgradeRequest</a></code></span></div> |
| <div class="block">The HTTP method for this Upgrade Request. |
| <p> |
| As of <a href="http://tools.ietf.org/html/rfc6455">RFC6455 (December 2011)</a> this is always <code>GET</code></div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../api/UpgradeRequest.html#getMethod()">getMethod</a></code> in interface <code><a href="../../api/UpgradeRequest.html" title="interface in org.eclipse.jetty.websocket.api">UpgradeRequest</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the HTTP method used</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getOrigin()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getOrigin</h4> |
| <pre class="methodSignature">public java.lang.String getOrigin()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../api/UpgradeRequest.html#getOrigin()">UpgradeRequest</a></code></span></div> |
| <div class="block">The WebSocket Origin of this Upgrade Request |
| <p> |
| See <a href="http://tools.ietf.org/html/rfc6455#section-10.2">RFC6455: Section 10.2</a> for details. |
| <p> |
| Equivalent to <a href="../../api/UpgradeRequest.html#getHeader(java.lang.String)"><code>UpgradeRequest.getHeader(String)</code></a> passed the "Origin" header.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../api/UpgradeRequest.html#getOrigin()">getOrigin</a></code> in interface <code><a href="../../api/UpgradeRequest.html" title="interface in org.eclipse.jetty.websocket.api">UpgradeRequest</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the Origin header</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getParameterMap()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getParameterMap</h4> |
| <pre class="methodSignature">public java.util.Map<java.lang.String,​java.util.List<java.lang.String>> getParameterMap()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../api/UpgradeRequest.html#getParameterMap()">UpgradeRequest</a></code></span></div> |
| <div class="block">Returns a map of the query parameters of the request.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../api/UpgradeRequest.html#getParameterMap()">getParameterMap</a></code> in interface <code><a href="../../api/UpgradeRequest.html" title="interface in org.eclipse.jetty.websocket.api">UpgradeRequest</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a unmodifiable map of query parameters of the request.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getProtocolVersion()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getProtocolVersion</h4> |
| <pre class="methodSignature">public java.lang.String getProtocolVersion()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../api/UpgradeRequest.html#getProtocolVersion()">UpgradeRequest</a></code></span></div> |
| <div class="block">Get the WebSocket Protocol Version |
| <p> |
| As of <a href="http://tools.ietf.org/html/rfc6455#section-11.6">RFC6455</a>, Jetty only supports version |
| <code>13</code></div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../api/UpgradeRequest.html#getProtocolVersion()">getProtocolVersion</a></code> in interface <code><a href="../../api/UpgradeRequest.html" title="interface in org.eclipse.jetty.websocket.api">UpgradeRequest</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the WebSocket protocol version</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getQueryString()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getQueryString</h4> |
| <pre class="methodSignature">public java.lang.String getQueryString()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../api/UpgradeRequest.html#getQueryString()">UpgradeRequest</a></code></span></div> |
| <div class="block">Get the Query String of the request URI.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../api/UpgradeRequest.html#getQueryString()">getQueryString</a></code> in interface <code><a href="../../api/UpgradeRequest.html" title="interface in org.eclipse.jetty.websocket.api">UpgradeRequest</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the request uri query string</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getRequestURI()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getRequestURI</h4> |
| <pre class="methodSignature">public java.net.URI getRequestURI()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../api/UpgradeRequest.html#getRequestURI()">UpgradeRequest</a></code></span></div> |
| <div class="block">Get the Request URI</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../api/UpgradeRequest.html#getRequestURI()">getRequestURI</a></code> in interface <code><a href="../../api/UpgradeRequest.html" title="interface in org.eclipse.jetty.websocket.api">UpgradeRequest</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the request URI</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getSession()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSession</h4> |
| <pre class="methodSignature">public jakarta.servlet.http.HttpSession getSession()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../JettyServerUpgradeRequest.html#getSession()">JettyServerUpgradeRequest</a></code></span></div> |
| <div class="block">Access the Servlet HTTP Session (if present) |
| <p> |
| Note: Never present on a Client UpgradeRequest.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../JettyServerUpgradeRequest.html#getSession()">getSession</a></code> in interface <code><a href="../JettyServerUpgradeRequest.html" title="interface in org.eclipse.jetty.websocket.server">JettyServerUpgradeRequest</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the Servlet HTTPSession on server side UpgradeRequests</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getSubProtocols()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSubProtocols</h4> |
| <pre class="methodSignature">public java.util.List<java.lang.String> getSubProtocols()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../api/UpgradeRequest.html#getSubProtocols()">UpgradeRequest</a></code></span></div> |
| <div class="block">Get the list of offered WebSocket sub-protocols.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../api/UpgradeRequest.html#getSubProtocols()">getSubProtocols</a></code> in interface <code><a href="../../api/UpgradeRequest.html" title="interface in org.eclipse.jetty.websocket.api">UpgradeRequest</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the list of offered sub-protocols</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getUserPrincipal()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getUserPrincipal</h4> |
| <pre class="methodSignature">public java.security.Principal getUserPrincipal()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../api/UpgradeRequest.html#getUserPrincipal()">UpgradeRequest</a></code></span></div> |
| <div class="block">Get the User Principal for this request. |
| <p> |
| Only applicable when using UpgradeRequest from server side.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../api/UpgradeRequest.html#getUserPrincipal()">getUserPrincipal</a></code> in interface <code><a href="../../api/UpgradeRequest.html" title="interface in org.eclipse.jetty.websocket.api">UpgradeRequest</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the user principal</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="hasSubProtocol(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>hasSubProtocol</h4> |
| <pre class="methodSignature">public boolean hasSubProtocol​(java.lang.String subprotocol)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../api/UpgradeRequest.html#hasSubProtocol(java.lang.String)">UpgradeRequest</a></code></span></div> |
| <div class="block">Test if a specific sub-protocol is offered</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../api/UpgradeRequest.html#hasSubProtocol(java.lang.String)">hasSubProtocol</a></code> in interface <code><a href="../../api/UpgradeRequest.html" title="interface in org.eclipse.jetty.websocket.api">UpgradeRequest</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>subprotocol</code> - the sub-protocol to test for</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if sub-protocol exists on request</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="isSecure()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isSecure</h4> |
| <pre class="methodSignature">public boolean isSecure()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../api/UpgradeRequest.html#isSecure()">UpgradeRequest</a></code></span></div> |
| <div class="block">Test if connection is secure.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../api/UpgradeRequest.html#isSecure()">isSecure</a></code> in interface <code><a href="../../api/UpgradeRequest.html" title="interface in org.eclipse.jetty.websocket.api">UpgradeRequest</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if connection is secure.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getCertificates()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCertificates</h4> |
| <pre class="methodSignature">public java.security.cert.X509Certificate[] getCertificates()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../JettyServerUpgradeRequest.html#getCertificates()">getCertificates</a></code> in interface <code><a href="../JettyServerUpgradeRequest.html" title="interface in org.eclipse.jetty.websocket.server">JettyServerUpgradeRequest</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The <code>X509Certificate</code> instance at request attribute "jakarta.servlet.request.X509Certificate" or null.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getHttpServletRequest()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getHttpServletRequest</h4> |
| <pre class="methodSignature">public jakarta.servlet.http.HttpServletRequest getHttpServletRequest()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../JettyServerUpgradeRequest.html#getHttpServletRequest()">getHttpServletRequest</a></code> in interface <code><a href="../JettyServerUpgradeRequest.html" title="interface in org.eclipse.jetty.websocket.server">JettyServerUpgradeRequest</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Immutable version of <code>HttpServletRequest</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getLocale()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getLocale</h4> |
| <pre class="methodSignature">public java.util.Locale getLocale()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../JettyServerUpgradeRequest.html#getLocale()">getLocale</a></code> in interface <code><a href="../JettyServerUpgradeRequest.html" title="interface in org.eclipse.jetty.websocket.server">JettyServerUpgradeRequest</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The requested Locale</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><code>ServletRequest.getLocale()</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getLocales()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getLocales</h4> |
| <pre class="methodSignature">public java.util.Enumeration<java.util.Locale> getLocales()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../JettyServerUpgradeRequest.html#getLocales()">getLocales</a></code> in interface <code><a href="../JettyServerUpgradeRequest.html" title="interface in org.eclipse.jetty.websocket.server">JettyServerUpgradeRequest</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The requested Locales</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><code>ServletRequest.getLocales()</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getLocalSocketAddress()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getLocalSocketAddress</h4> |
| <pre class="methodSignature">public java.net.SocketAddress getLocalSocketAddress()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../JettyServerUpgradeRequest.html#getLocalSocketAddress()">getLocalSocketAddress</a></code> in interface <code><a href="../JettyServerUpgradeRequest.html" title="interface in org.eclipse.jetty.websocket.server">JettyServerUpgradeRequest</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The local requested address, which is typically an <code>InetSocketAddress</code>, but may be another derivation of <code>SocketAddress</code></dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><code>ServletRequest.getLocalAddr()</code>, |
| <code>ServletRequest.getLocalPort()</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getRemoteSocketAddress()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getRemoteSocketAddress</h4> |
| <pre class="methodSignature">public java.net.SocketAddress getRemoteSocketAddress()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../JettyServerUpgradeRequest.html#getRemoteSocketAddress()">getRemoteSocketAddress</a></code> in interface <code><a href="../JettyServerUpgradeRequest.html" title="interface in org.eclipse.jetty.websocket.server">JettyServerUpgradeRequest</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The remote request address, which is typically an <code>InetSocketAddress</code>, but may be another derivation of <code>SocketAddress</code></dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><code>ServletRequest.getRemoteAddr()</code>, |
| <code>ServletRequest.getRemotePort()</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getRequestPath()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getRequestPath</h4> |
| <pre class="methodSignature">public java.lang.String getRequestPath()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../JettyServerUpgradeRequest.html#getRequestPath()">getRequestPath</a></code> in interface <code><a href="../JettyServerUpgradeRequest.html" title="interface in org.eclipse.jetty.websocket.server">JettyServerUpgradeRequest</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The request URI path within the context</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getServletAttribute(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getServletAttribute</h4> |
| <pre class="methodSignature">public java.lang.Object getServletAttribute​(java.lang.String name)</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../JettyServerUpgradeRequest.html#getServletAttribute(java.lang.String)">getServletAttribute</a></code> in interface <code><a href="../JettyServerUpgradeRequest.html" title="interface in org.eclipse.jetty.websocket.server">JettyServerUpgradeRequest</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - Attribute name</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Attribute value or null</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><code>ServletRequest.getAttribute(String)</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getServletAttributes()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getServletAttributes</h4> |
| <pre class="methodSignature">public java.util.Map<java.lang.String,​java.lang.Object> getServletAttributes()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../JettyServerUpgradeRequest.html#getServletAttributes()">getServletAttributes</a></code> in interface <code><a href="../JettyServerUpgradeRequest.html" title="interface in org.eclipse.jetty.websocket.server">JettyServerUpgradeRequest</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Request attribute map</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getServletParameters()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getServletParameters</h4> |
| <pre class="methodSignature">public java.util.Map<java.lang.String,​java.util.List<java.lang.String>> getServletParameters()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../JettyServerUpgradeRequest.html#getServletParameters()">getServletParameters</a></code> in interface <code><a href="../JettyServerUpgradeRequest.html" title="interface in org.eclipse.jetty.websocket.server">JettyServerUpgradeRequest</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Request parameters</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><code>ServletRequest.getParameterMap()</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="isUserInRole(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isUserInRole</h4> |
| <pre class="methodSignature">public boolean isUserInRole​(java.lang.String role)</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../JettyServerUpgradeRequest.html#isUserInRole(java.lang.String)">isUserInRole</a></code> in interface <code><a href="../JettyServerUpgradeRequest.html" title="interface in org.eclipse.jetty.websocket.server">JettyServerUpgradeRequest</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>role</code> - The user role</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>True if the requests user has the role</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><code>HttpServletRequest.isUserInRole(String)</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setServletAttribute(java.lang.String,java.lang.Object)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>setServletAttribute</h4> |
| <pre class="methodSignature">public void setServletAttribute​(java.lang.String name, |
| java.lang.Object value)</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../JettyServerUpgradeRequest.html#setServletAttribute(java.lang.String,java.lang.Object)">setServletAttribute</a></code> in interface <code><a href="../JettyServerUpgradeRequest.html" title="interface in org.eclipse.jetty.websocket.server">JettyServerUpgradeRequest</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - Attribute name</dd> |
| <dd><code>value</code> - Attribute value to set</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><code>ServletRequest.setAttribute(String, Object)</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/DelegatedServerUpgradeRequest.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../../allclasses.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li><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–2021 <a href="https://webtide.com">Webtide</a>. All rights reserved.</small></p> |
| </footer> |
| </body> |
| </html> |