| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (11.0.10) on Fri Feb 26 09:50:23 CST 2021 --> |
| <title>UpgradeRequest (Jetty :: Project 9.4.38.v20210224 API)</title> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="dc.created" content="2021-02-26"> |
| <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="UpgradeRequest (Jetty :: Project 9.4.38.v20210224 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"i0":6,"i1":6,"i2":38,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":6,"i12":6,"i13":6,"i14":6,"i15":6,"i16":6,"i17":6,"i18":6,"i19":6,"i20":6,"i21":6,"i22":6,"i23":6,"i24":6,"i25":6,"i26":6,"i27":6,"i28":6,"i29":6,"i30":6,"i31":6,"i32":6,"i33":6}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],32:["t6","Deprecated Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| var pathtoroot = "../../../../../"; |
| var useModuleDirectories = false; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <header role="banner"> |
| <nav role="navigation"> |
| <div class="fixedNav"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a id="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/UpgradeRequest.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../allclasses.html">All Classes</a></li> |
| </ul> |
| <ul class="navListSearch"> |
| <li><label for="search">SEARCH:</label> |
| <input type="text" id="search" value="search" disabled="disabled"> |
| <input type="reset" id="reset" value="reset" disabled="disabled"> |
| </li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a id="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| </div> |
| <div class="navPadding"> </div> |
| <script type="text/javascript"><!-- |
| $('.navPadding').css('padding-top', $('.fixedNav').css("height")); |
| //--> |
| </script> |
| </nav> |
| </header> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <main role="main"> |
| <div class="header"> |
| <div class="subTitle"><span class="packageLabelInType">Package</span> <a href="package-summary.html">org.eclipse.jetty.websocket.api</a></div> |
| <h2 title="Interface UpgradeRequest" class="title">Interface UpgradeRequest</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><code><a href="../client/ClientUpgradeRequest.html" title="class in org.eclipse.jetty.websocket.client">ClientUpgradeRequest</a></code>, <code><a href="../servlet/ServletUpgradeRequest.html" title="class in org.eclipse.jetty.websocket.servlet">ServletUpgradeRequest</a></code>, <code><a href="../server/ServletWebSocketRequest.html" title="class in org.eclipse.jetty.websocket.server">ServletWebSocketRequest</a></code>, <code><a href="../common/UpgradeRequestAdapter.html" title="class in org.eclipse.jetty.websocket.common">UpgradeRequestAdapter</a></code></dd> |
| </dl> |
| <hr> |
| <pre>public interface <span class="typeNameLabel">UpgradeRequest</span></pre> |
| <div class="block">The HTTP Upgrade to WebSocket Request</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Method</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#addExtensions(java.lang.String...)">addExtensions</a></span>​(java.lang.String... configs)</code></th> |
| <td class="colLast"> |
| <div class="block">Add WebSocket Extension Configuration(s) to request</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#addExtensions(org.eclipse.jetty.websocket.api.extensions.ExtensionConfig...)">addExtensions</a></span>​(<a href="extensions/ExtensionConfig.html" title="class in org.eclipse.jetty.websocket.api.extensions">ExtensionConfig</a>... configs)</code></th> |
| <td class="colLast"> |
| <div class="block">Add WebSocket Extension Configuration(s) to Upgrade Request.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#clearHeaders()">clearHeaders</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="deprecationComment">(no longer supported, as this can undo the required upgrade request headers)</div> |
| </div> |
| </td> |
| </tr> |
| <tr id="i3" 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="i4" class="altColor"> |
| <td class="colFirst"><code>java.util.List<<a href="extensions/ExtensionConfig.html" title="class in org.eclipse.jetty.websocket.api.extensions">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="i5" 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="i6" 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="i7" 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="i8" 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="i9" 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="i10" class="altColor"> |
| <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="i11" 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="i12" 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="i13" 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="i14" 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="i15" 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="i16" 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="i17" class="rowColor"> |
| <td class="colFirst"><code>java.lang.Object</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="i18" 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="#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="i19" class="rowColor"> |
| <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="i20" class="altColor"> |
| <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 test)</code></th> |
| <td class="colLast"> |
| <div class="block">Test if a specific sub-protocol is offered</div> |
| </td> |
| </tr> |
| <tr id="i21" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isOrigin(java.lang.String)">isOrigin</a></span>​(java.lang.String test)</code></th> |
| <td class="colLast"> |
| <div class="block">Test if supplied Origin is the same as the Request</div> |
| </td> |
| </tr> |
| <tr id="i22" 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="i23" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setCookies(java.util.List)">setCookies</a></span>​(java.util.List<java.net.HttpCookie> cookies)</code></th> |
| <td class="colLast"> |
| <div class="block">Set the list of Cookies on the request</div> |
| </td> |
| </tr> |
| <tr id="i24" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setExtensions(java.util.List)">setExtensions</a></span>​(java.util.List<<a href="extensions/ExtensionConfig.html" title="class in org.eclipse.jetty.websocket.api.extensions">ExtensionConfig</a>> configs)</code></th> |
| <td class="colLast"> |
| <div class="block">Set the list of WebSocket Extension configurations on the request.</div> |
| </td> |
| </tr> |
| <tr id="i25" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setHeader(java.lang.String,java.lang.String)">setHeader</a></span>​(java.lang.String name, |
| java.lang.String value)</code></th> |
| <td class="colLast"> |
| <div class="block">Set a specific header value</div> |
| </td> |
| </tr> |
| <tr id="i26" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setHeader(java.lang.String,java.util.List)">setHeader</a></span>​(java.lang.String name, |
| java.util.List<java.lang.String> values)</code></th> |
| <td class="colLast"> |
| <div class="block">Set a specific header with multi-value field</div> |
| </td> |
| </tr> |
| <tr id="i27" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setHeaders(java.util.Map)">setHeaders</a></span>​(java.util.Map<java.lang.String,​java.util.List<java.lang.String>> headers)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets multiple headers on the request.</div> |
| </td> |
| </tr> |
| <tr id="i28" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setHttpVersion(java.lang.String)">setHttpVersion</a></span>​(java.lang.String httpVersion)</code></th> |
| <td class="colLast"> |
| <div class="block">Set the HTTP Version to use.</div> |
| </td> |
| </tr> |
| <tr id="i29" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setMethod(java.lang.String)">setMethod</a></span>​(java.lang.String method)</code></th> |
| <td class="colLast"> |
| <div class="block">Set the HTTP method to use.</div> |
| </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="#setRequestURI(java.net.URI)">setRequestURI</a></span>​(java.net.URI uri)</code></th> |
| <td class="colLast"> |
| <div class="block">Set the Request URI to use for this request.</div> |
| </td> |
| </tr> |
| <tr id="i31" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setSession(java.lang.Object)">setSession</a></span>​(java.lang.Object session)</code></th> |
| <td class="colLast"> |
| <div class="block">Set the Session associated with this request.</div> |
| </td> |
| </tr> |
| <tr id="i32" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setSubProtocols(java.lang.String...)">setSubProtocols</a></span>​(java.lang.String... protocols)</code></th> |
| <td class="colLast"> |
| <div class="block">Set the offered WebSocket Sub-Protocol list.</div> |
| </td> |
| </tr> |
| <tr id="i33" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setSubProtocols(java.util.List)">setSubProtocols</a></span>​(java.util.List<java.lang.String> protocols)</code></th> |
| <td class="colLast"> |
| <div class="block">Set the offered WebSocket Sub-Protocol list.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a id="addExtensions(org.eclipse.jetty.websocket.api.extensions.ExtensionConfig...)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addExtensions</h4> |
| <pre class="methodSignature">void addExtensions​(<a href="extensions/ExtensionConfig.html" title="class in org.eclipse.jetty.websocket.api.extensions">ExtensionConfig</a>... configs)</pre> |
| <div class="block">Add WebSocket Extension Configuration(s) to Upgrade Request. |
| <p> |
| This is merely the list of requested Extensions to use, see <a href="UpgradeResponse.html#getExtensions()"><code>UpgradeResponse.getExtensions()</code></a> for what was |
| negotiated</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>configs</code> - the configuration(s) to add</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="addExtensions(java.lang.String...)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addExtensions</h4> |
| <pre class="methodSignature">void addExtensions​(java.lang.String... configs)</pre> |
| <div class="block">Add WebSocket Extension Configuration(s) to request |
| <p> |
| This is merely the list of requested Extensions to use, see <a href="UpgradeResponse.html#getExtensions()"><code>UpgradeResponse.getExtensions()</code></a> for what was |
| negotiated</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>configs</code> - the configuration(s) to add</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="clearHeaders()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>clearHeaders</h4> |
| <pre class="methodSignature">@Deprecated |
| void clearHeaders()</pre> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="deprecationComment">(no longer supported, as this can undo the required upgrade request headers)</div> |
| </div> |
| <div class="block">Remove all headers from request.</div> |
| </li> |
| </ul> |
| <a id="getCookies()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCookies</h4> |
| <pre class="methodSignature">java.util.List<java.net.HttpCookie> getCookies()</pre> |
| <div class="block">Get the list of Cookies on the Upgrade request</div> |
| <dl> |
| <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">java.util.List<<a href="extensions/ExtensionConfig.html" title="class in org.eclipse.jetty.websocket.api.extensions">ExtensionConfig</a>> getExtensions()</pre> |
| <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="UpgradeResponse.html#getExtensions()"><code>UpgradeResponse.getExtensions()</code></a> for what was |
| negotiated</div> |
| <dl> |
| <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">java.lang.String getHeader​(java.lang.String name)</pre> |
| <div class="block">Get a specific Header value from Upgrade Request</div> |
| <dl> |
| <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">int getHeaderInt​(java.lang.String name)</pre> |
| <div class="block">Get the specific Header value, as an <code>int</code>, from the Upgrade Request.</div> |
| <dl> |
| <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> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.NumberFormatException</code> - if unable to parse value as an int.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getHeaders()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getHeaders</h4> |
| <pre class="methodSignature">java.util.Map<java.lang.String,​java.util.List<java.lang.String>> getHeaders()</pre> |
| <div class="block">Get the headers as a Map of keys to value lists.</div> |
| <dl> |
| <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">java.util.List<java.lang.String> getHeaders​(java.lang.String name)</pre> |
| <div class="block">Get the specific header values (for multi-value headers)</div> |
| <dl> |
| <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">java.lang.String getHost()</pre> |
| <div class="block">The host of the Upgrade Request URI</div> |
| <dl> |
| <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">java.lang.String getHttpVersion()</pre> |
| <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="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">java.lang.String getMethod()</pre> |
| <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="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">java.lang.String getOrigin()</pre> |
| <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="#getHeader(java.lang.String)"><code>getHeader(String)</code></a> passed the "Origin" header.</div> |
| <dl> |
| <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">java.util.Map<java.lang.String,​java.util.List<java.lang.String>> getParameterMap()</pre> |
| <div class="block">Returns a map of the query parameters of the request.</div> |
| <dl> |
| <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">java.lang.String getProtocolVersion()</pre> |
| <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="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">java.lang.String getQueryString()</pre> |
| <div class="block">Get the Query String of the request URI.</div> |
| <dl> |
| <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">java.net.URI getRequestURI()</pre> |
| <div class="block">Get the Request URI</div> |
| <dl> |
| <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">java.lang.Object getSession()</pre> |
| <div class="block">Access the Servlet HTTP Session (if present) |
| <p> |
| Note: Never present on a Client UpgradeRequest.</div> |
| <dl> |
| <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">java.util.List<java.lang.String> getSubProtocols()</pre> |
| <div class="block">Get the list of offered WebSocket sub-protocols.</div> |
| <dl> |
| <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">java.security.Principal getUserPrincipal()</pre> |
| <div class="block">Get the User Principal for this request. |
| <p> |
| Only applicable when using UpgradeRequest from server side.</div> |
| <dl> |
| <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">boolean hasSubProtocol​(java.lang.String test)</pre> |
| <div class="block">Test if a specific sub-protocol is offered</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>test</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="isOrigin(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isOrigin</h4> |
| <pre class="methodSignature">boolean isOrigin​(java.lang.String test)</pre> |
| <div class="block">Test if supplied Origin is the same as the Request</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>test</code> - the supplied origin</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if the supplied origin matches the request origin</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="isSecure()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isSecure</h4> |
| <pre class="methodSignature">boolean isSecure()</pre> |
| <div class="block">Test if connection is secure.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if connection is secure.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setCookies(java.util.List)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setCookies</h4> |
| <pre class="methodSignature">void setCookies​(java.util.List<java.net.HttpCookie> cookies)</pre> |
| <div class="block">Set the list of Cookies on the request</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>cookies</code> - the cookies to use</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setExtensions(java.util.List)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setExtensions</h4> |
| <pre class="methodSignature">void setExtensions​(java.util.List<<a href="extensions/ExtensionConfig.html" title="class in org.eclipse.jetty.websocket.api.extensions">ExtensionConfig</a>> configs)</pre> |
| <div class="block">Set the list of WebSocket Extension configurations on the request.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>configs</code> - the list of extension configurations</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setHeader(java.lang.String,java.util.List)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setHeader</h4> |
| <pre class="methodSignature">void setHeader​(java.lang.String name, |
| java.util.List<java.lang.String> values)</pre> |
| <div class="block">Set a specific header with multi-value field |
| <p> |
| Overrides any previous value for this named header</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - the name of the header</dd> |
| <dd><code>values</code> - the multi-value field</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setHeader(java.lang.String,java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setHeader</h4> |
| <pre class="methodSignature">void setHeader​(java.lang.String name, |
| java.lang.String value)</pre> |
| <div class="block">Set a specific header value |
| <p> |
| Overrides any previous value for this named header</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - the header to set</dd> |
| <dd><code>value</code> - the value to set it to</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setHeaders(java.util.Map)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setHeaders</h4> |
| <pre class="methodSignature">void setHeaders​(java.util.Map<java.lang.String,​java.util.List<java.lang.String>> headers)</pre> |
| <div class="block">Sets multiple headers on the request. |
| <p> |
| Only sets those headers provided, does not remove |
| headers that exist on request and are not provided in the |
| parameter for this method. |
| <p> |
| Convenience method vs calling <a href="#setHeader(java.lang.String,java.util.List)"><code>setHeader(String, List)</code></a> multiple times.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>headers</code> - the headers to set</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setHttpVersion(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setHttpVersion</h4> |
| <pre class="methodSignature">void setHttpVersion​(java.lang.String httpVersion)</pre> |
| <div class="block">Set the HTTP Version to use. |
| <p> |
| As of <a href="http://tools.ietf.org/html/rfc6455">RFC6455 (December 2011)</a> this should always be |
| <code>HTTP/1.1</code></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>httpVersion</code> - the HTTP version to use.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setMethod(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setMethod</h4> |
| <pre class="methodSignature">void setMethod​(java.lang.String method)</pre> |
| <div class="block">Set the HTTP method to use. |
| <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="paramLabel">Parameters:</span></dt> |
| <dd><code>method</code> - the HTTP method to use.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setRequestURI(java.net.URI)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setRequestURI</h4> |
| <pre class="methodSignature">void setRequestURI​(java.net.URI uri)</pre> |
| <div class="block">Set the Request URI to use for this request. |
| <p> |
| Must be an absolute URI with scheme <code>'ws'</code> or <code>'wss'</code></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>uri</code> - the Request URI</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setSession(java.lang.Object)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setSession</h4> |
| <pre class="methodSignature">void setSession​(java.lang.Object session)</pre> |
| <div class="block">Set the Session associated with this request. |
| <p> |
| Typically used to associate the Servlet HttpSession object.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>session</code> - the session object to associate with this request</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setSubProtocols(java.util.List)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setSubProtocols</h4> |
| <pre class="methodSignature">void setSubProtocols​(java.util.List<java.lang.String> protocols)</pre> |
| <div class="block">Set the offered WebSocket Sub-Protocol list.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>protocols</code> - the offered sub-protocol list</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setSubProtocols(java.lang.String...)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>setSubProtocols</h4> |
| <pre class="methodSignature">void setSubProtocols​(java.lang.String... protocols)</pre> |
| <div class="block">Set the offered WebSocket Sub-Protocol list.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>protocols</code> - the offered sub-protocol list</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/UpgradeRequest.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../allclasses.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a id="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </nav> |
| <p class="legalCopy"><small>Copyright © 1995–2021 <a href="https://webtide.com">Webtide</a>. All rights reserved.</small></p> |
| </footer> |
| </body> |
| </html> |
