| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (11.0.10) on Tue Mar 30 10:45:41 CDT 2021 --> |
| <title>ClientUpgradeRequest (Eclipse Jetty API Doc - v10.0.2)</title> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="dc.created" content="2021-03-30"> |
| <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="ClientUpgradeRequest (Eclipse Jetty API Doc - v10.0.2)"; |
| } |
| } |
| 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":9,"i22":10,"i23":10,"i24":10,"i25":10,"i26":10,"i27":10,"i28":10,"i29":10}; |
| var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| var pathtoroot = "../../../../../"; |
| var useModuleDirectories = true; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <header role="banner"> |
| <nav role="navigation"> |
| <div class="fixedNav"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a id="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/ClientUpgradeRequest.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../allclasses.html">All Classes</a></li> |
| </ul> |
| <ul class="navListSearch"> |
| <li><label for="search">SEARCH:</label> |
| <input type="text" id="search" value="search" disabled="disabled"> |
| <input type="reset" id="reset" value="reset" disabled="disabled"> |
| </li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a id="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| </div> |
| <div class="navPadding"> </div> |
| <script type="text/javascript"><!-- |
| $('.navPadding').css('padding-top', $('.fixedNav').css("height")); |
| //--> |
| </script> |
| </nav> |
| </header> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <main role="main"> |
| <div class="header"> |
| <div class="subTitle"><span class="packageLabelInType">Package</span> <a href="package-summary.html">org.eclipse.jetty.websocket.client</a></div> |
| <h2 title="Class ClientUpgradeRequest" class="title">Class ClientUpgradeRequest</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.eclipse.jetty.websocket.client.ClientUpgradeRequest</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></dd> |
| </dl> |
| <hr> |
| <pre>public final class <span class="typeNameLabel">ClientUpgradeRequest</span> |
| extends java.lang.Object |
| implements <a href="../api/UpgradeRequest.html" title="interface in org.eclipse.jetty.websocket.api">UpgradeRequest</a></pre> |
| <div class="block">Client based UpgradeRequest API</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <table class="memberSummary"> |
| <caption><span>Fields</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Field</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static java.lang.String</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#ABNF_REQUIRED_QUOTING">ABNF_REQUIRED_QUOTING</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">ABNF from RFC 2616, RFC 822, and RFC 6455 specified characters requiring quoting.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </section> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Constructor</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr class="altColor"> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E()">ClientUpgradeRequest</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(java.net.URI)">ClientUpgradeRequest</a></span>​(java.net.URI uri)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </section> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Method</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#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.ExtensionConfig...)">addExtensions</a></span>​(<a href="../api/ExtensionConfig.html" title="interface in org.eclipse.jetty.websocket.api">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>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="i3" class="rowColor"> |
| <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="i4" class="altColor"> |
| <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="i5" class="rowColor"> |
| <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="i6" class="altColor"> |
| <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="i7" 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="#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="i8" class="altColor"> |
| <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="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.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="i11" class="rowColor"> |
| <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="i12" class="altColor"> |
| <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="i13" class="rowColor"> |
| <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="i14" class="altColor"> |
| <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="i15" class="rowColor"> |
| <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="i16" 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="i17" class="rowColor"> |
| <td class="colFirst"><code>long</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getTimeout()">getTimeout</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i18" 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="i19" 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 test)</code></th> |
| <td class="colLast"> |
| <div class="block">Test if a specific sub-protocol is offered</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="#isSecure()">isSecure</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Test if connection is secure.</div> |
| </td> |
| </tr> |
| <tr id="i21" class="rowColor"> |
| <td class="colFirst"><code>static java.lang.String</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#joinValues(java.util.List)">joinValues</a></span>​(java.util.List<java.lang.String> values)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i22" class="altColor"> |
| <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="i23" class="rowColor"> |
| <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="../api/ExtensionConfig.html" title="interface in org.eclipse.jetty.websocket.api">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="i24" 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.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="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.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="i26" class="altColor"> |
| <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="i27" class="rowColor"> |
| <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="i28" class="altColor"> |
| <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> |
| <tr id="i29" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setTimeout(long,java.util.concurrent.TimeUnit)">setTimeout</a></span>​(long timeout, |
| java.util.concurrent.TimeUnit unit)</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"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="field.detail"> |
| <!-- --> |
| </a> |
| <h3>Field Detail</h3> |
| <a id="ABNF_REQUIRED_QUOTING"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>ABNF_REQUIRED_QUOTING</h4> |
| <pre>public static final java.lang.String ABNF_REQUIRED_QUOTING</pre> |
| <div class="block">ABNF from RFC 2616, RFC 822, and RFC 6455 specified characters requiring quoting.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../constant-values.html#org.eclipse.jetty.websocket.client.ClientUpgradeRequest.ABNF_REQUIRED_QUOTING">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a id="<init>()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>ClientUpgradeRequest</h4> |
| <pre>public ClientUpgradeRequest()</pre> |
| </li> |
| </ul> |
| <a id="<init>(java.net.URI)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>ClientUpgradeRequest</h4> |
| <pre>public ClientUpgradeRequest​(java.net.URI uri)</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="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 test)</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>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="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="addExtensions(org.eclipse.jetty.websocket.api.ExtensionConfig...)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addExtensions</h4> |
| <pre class="methodSignature">public void addExtensions​(<a href="../api/ExtensionConfig.html" title="interface in org.eclipse.jetty.websocket.api">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="../api/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">public 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="../api/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="setCookies(java.util.List)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setCookies</h4> |
| <pre class="methodSignature">public 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">public void setExtensions​(java.util.List<<a href="../api/ExtensionConfig.html" title="interface in org.eclipse.jetty.websocket.api">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">public 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">public 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">public 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="setSubProtocols(java.util.List)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setSubProtocols</h4> |
| <pre class="methodSignature">public 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="blockList"> |
| <li class="blockList"> |
| <h4>setSubProtocols</h4> |
| <pre class="methodSignature">public 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> |
| <a id="setTimeout(long,java.util.concurrent.TimeUnit)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setTimeout</h4> |
| <pre class="methodSignature">public void setTimeout​(long timeout, |
| java.util.concurrent.TimeUnit unit)</pre> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>timeout</code> - the total timeout for the request/response conversation of the WebSocket handshake; |
| use zero or a negative value to disable the timeout</dd> |
| <dd><code>unit</code> - the timeout unit</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getTimeout()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getTimeout</h4> |
| <pre class="methodSignature">public long getTimeout()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the total timeout for this request, in milliseconds; |
| zero or negative if the timeout is disabled</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="joinValues(java.util.List)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>joinValues</h4> |
| <pre class="methodSignature">public static java.lang.String joinValues​(java.util.List<java.lang.String> values)</pre> |
| </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/ClientUpgradeRequest.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../allclasses.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a id="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </nav> |
| <p class="legalCopy"><small>Copyright © 1995–2021 <a href="https://webtide.com">Webtide</a>. All rights reserved.</small></p> |
| </footer> |
| </body> |
| </html> |