| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (11.0.10) on Fri Feb 26 09:50:23 CST 2021 --> |
| <title>ServletUpgradeResponse (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="ServletUpgradeResponse (Jetty :: Project 9.4.38.v20210224 API)"; |
| } |
| } |
| 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}; |
| 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 = 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/ServletUpgradeResponse.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.servlet</a></div> |
| <h2 title="Class ServletUpgradeResponse" class="title">Class ServletUpgradeResponse</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.eclipse.jetty.websocket.servlet.ServletUpgradeResponse</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code><a href="../api/UpgradeResponse.html" title="interface in org.eclipse.jetty.websocket.api">UpgradeResponse</a></code></dd> |
| </dl> |
| <dl> |
| <dt>Direct Known Subclasses:</dt> |
| <dd><code><a href="../server/ServletWebSocketResponse.html" title="class in org.eclipse.jetty.websocket.server">ServletWebSocketResponse</a></code></dd> |
| </dl> |
| <hr> |
| <pre>public class <span class="typeNameLabel">ServletUpgradeResponse</span> |
| extends java.lang.Object |
| implements <a href="../api/UpgradeResponse.html" title="interface in org.eclipse.jetty.websocket.api">UpgradeResponse</a></pre> |
| <div class="block">Servlet Specific UpgradeResponse implementation.</div> |
| </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(javax.servlet.http.HttpServletResponse)">ServletUpgradeResponse</a></span>​(javax.servlet.http.HttpServletResponse response)</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>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#addHeader(java.lang.String,java.lang.String)">addHeader</a></span>​(java.lang.String name, |
| java.lang.String value)</code></th> |
| <td class="colLast"> |
| <div class="block">Add a header value to the response.</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="#complete()">complete</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getAcceptedSubProtocol()">getAcceptedSubProtocol</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Get the accepted WebSocket protocol.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>java.util.List<<a href="../api/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 extensions that should be used for the websocket.</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 header value</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>java.util.Set<java.lang.String></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getHeaderNames()">getHeaderNames</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Get the header names</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 map</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 multi-value header value</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getStatusCode()">getStatusCode</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Get the HTTP Response Status Code</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="#getStatusReason()">getStatusReason</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Get the HTTP Response Status Reason</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isCommitted()">isCommitted</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isExtensionsNegotiated()">isExtensionsNegotiated</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isSubprotocolNegotiated()">isSubprotocolNegotiated</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isSuccess()">isSuccess</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Test if upgrade response is successful.</div> |
| </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#sendError(int,java.lang.String)">sendError</a></span>​(int statusCode, |
| java.lang.String message)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#sendForbidden(java.lang.String)">sendForbidden</a></span>​(java.lang.String message)</code></th> |
| <td class="colLast"> |
| <div class="block">Issue a forbidden upgrade response.</div> |
| </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setAcceptedSubProtocol(java.lang.String)">setAcceptedSubProtocol</a></span>​(java.lang.String protocol)</code></th> |
| <td class="colLast"> |
| <div class="block">Set the accepted WebSocket Protocol.</div> |
| </td> |
| </tr> |
| <tr id="i17" 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/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 extensions that are approved for use with this websocket.</div> |
| </td> |
| </tr> |
| <tr id="i18" 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 header</div> |
| </td> |
| </tr> |
| <tr id="i19" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setStatusCode(int)">setStatusCode</a></span>​(int statusCode)</code></th> |
| <td class="colLast"> |
| <div class="block">Set the HTTP Response status code</div> |
| </td> |
| </tr> |
| <tr id="i20" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setStatusReason(java.lang.String)">setStatusReason</a></span>​(java.lang.String statusReason)</code></th> |
| <td class="colLast"> |
| <div class="block">Set the HTTP Response status reason phrase</div> |
| </td> |
| </tr> |
| <tr id="i21" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setSuccess(boolean)">setSuccess</a></span>​(boolean success)</code></th> |
| <td class="colLast"> |
| <div class="block">Set the success of the upgrade response.</div> |
| </td> |
| </tr> |
| <tr id="i22" class="altColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#toString()">toString</a></span>()</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, 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>(javax.servlet.http.HttpServletResponse)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>ServletUpgradeResponse</h4> |
| <pre>public ServletUpgradeResponse​(javax.servlet.http.HttpServletResponse response)</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="addHeader(java.lang.String,java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addHeader</h4> |
| <pre class="methodSignature">public void addHeader​(java.lang.String name, |
| java.lang.String value)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../api/UpgradeResponse.html#addHeader(java.lang.String,java.lang.String)">UpgradeResponse</a></code></span></div> |
| <div class="block">Add a header value to the response.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../api/UpgradeResponse.html#addHeader(java.lang.String,java.lang.String)">addHeader</a></code> in interface <code><a href="../api/UpgradeResponse.html" title="interface in org.eclipse.jetty.websocket.api">UpgradeResponse</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - the header name</dd> |
| <dd><code>value</code> - the header value</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"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../api/UpgradeResponse.html#setHeader(java.lang.String,java.lang.String)">UpgradeResponse</a></code></span></div> |
| <div class="block">Set a header |
| <p> |
| Overrides previous value of header (if set)</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../api/UpgradeResponse.html#setHeader(java.lang.String,java.lang.String)">setHeader</a></code> in interface <code><a href="../api/UpgradeResponse.html" title="interface in org.eclipse.jetty.websocket.api">UpgradeResponse</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - the header name</dd> |
| <dd><code>value</code> - the header value</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="complete()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>complete</h4> |
| <pre class="methodSignature">public void complete()</pre> |
| </li> |
| </ul> |
| <a id="getAcceptedSubProtocol()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAcceptedSubProtocol</h4> |
| <pre class="methodSignature">public java.lang.String getAcceptedSubProtocol()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../api/UpgradeResponse.html#getAcceptedSubProtocol()">UpgradeResponse</a></code></span></div> |
| <div class="block">Get the accepted WebSocket protocol.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../api/UpgradeResponse.html#getAcceptedSubProtocol()">getAcceptedSubProtocol</a></code> in interface <code><a href="../api/UpgradeResponse.html" title="interface in org.eclipse.jetty.websocket.api">UpgradeResponse</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the accepted WebSocket protocol.</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/extensions/ExtensionConfig.html" title="class in org.eclipse.jetty.websocket.api.extensions">ExtensionConfig</a>> getExtensions()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../api/UpgradeResponse.html#getExtensions()">UpgradeResponse</a></code></span></div> |
| <div class="block">Get the list of extensions that should be used for the websocket.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../api/UpgradeResponse.html#getExtensions()">getExtensions</a></code> in interface <code><a href="../api/UpgradeResponse.html" title="interface in org.eclipse.jetty.websocket.api">UpgradeResponse</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the list of negotiated extensions to use.</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/UpgradeResponse.html#getHeader(java.lang.String)">UpgradeResponse</a></code></span></div> |
| <div class="block">Get a header value</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../api/UpgradeResponse.html#getHeader(java.lang.String)">getHeader</a></code> in interface <code><a href="../api/UpgradeResponse.html" title="interface in org.eclipse.jetty.websocket.api">UpgradeResponse</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 (null if header doesn't exist)</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getHeaderNames()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getHeaderNames</h4> |
| <pre class="methodSignature">public java.util.Set<java.lang.String> getHeaderNames()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../api/UpgradeResponse.html#getHeaderNames()">UpgradeResponse</a></code></span></div> |
| <div class="block">Get the header names</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../api/UpgradeResponse.html#getHeaderNames()">getHeaderNames</a></code> in interface <code><a href="../api/UpgradeResponse.html" title="interface in org.eclipse.jetty.websocket.api">UpgradeResponse</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the set of header names</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/UpgradeResponse.html#getHeaders()">UpgradeResponse</a></code></span></div> |
| <div class="block">Get the headers map</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../api/UpgradeResponse.html#getHeaders()">getHeaders</a></code> in interface <code><a href="../api/UpgradeResponse.html" title="interface in org.eclipse.jetty.websocket.api">UpgradeResponse</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the map of 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/UpgradeResponse.html#getHeaders(java.lang.String)">UpgradeResponse</a></code></span></div> |
| <div class="block">Get the multi-value header value</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../api/UpgradeResponse.html#getHeaders(java.lang.String)">getHeaders</a></code> in interface <code><a href="../api/UpgradeResponse.html" title="interface in org.eclipse.jetty.websocket.api">UpgradeResponse</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 list of values (null if header doesn't exist)</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getStatusCode()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getStatusCode</h4> |
| <pre class="methodSignature">public int getStatusCode()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../api/UpgradeResponse.html#getStatusCode()">UpgradeResponse</a></code></span></div> |
| <div class="block">Get the HTTP Response Status Code</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../api/UpgradeResponse.html#getStatusCode()">getStatusCode</a></code> in interface <code><a href="../api/UpgradeResponse.html" title="interface in org.eclipse.jetty.websocket.api">UpgradeResponse</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the status code</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getStatusReason()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getStatusReason</h4> |
| <pre class="methodSignature">public java.lang.String getStatusReason()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../api/UpgradeResponse.html#getStatusReason()">UpgradeResponse</a></code></span></div> |
| <div class="block">Get the HTTP Response Status Reason</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../api/UpgradeResponse.html#getStatusReason()">getStatusReason</a></code> in interface <code><a href="../api/UpgradeResponse.html" title="interface in org.eclipse.jetty.websocket.api">UpgradeResponse</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the HTTP Response status reason</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="isCommitted()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isCommitted</h4> |
| <pre class="methodSignature">public boolean isCommitted()</pre> |
| </li> |
| </ul> |
| <a id="isExtensionsNegotiated()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isExtensionsNegotiated</h4> |
| <pre class="methodSignature">public boolean isExtensionsNegotiated()</pre> |
| </li> |
| </ul> |
| <a id="isSubprotocolNegotiated()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isSubprotocolNegotiated</h4> |
| <pre class="methodSignature">public boolean isSubprotocolNegotiated()</pre> |
| </li> |
| </ul> |
| <a id="isSuccess()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isSuccess</h4> |
| <pre class="methodSignature">public boolean isSuccess()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../api/UpgradeResponse.html#isSuccess()">UpgradeResponse</a></code></span></div> |
| <div class="block">Test if upgrade response is successful. |
| <p> |
| Merely notes if the response was sent as a WebSocket Upgrade, |
| or was failed (resulting in no upgrade handshake)</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../api/UpgradeResponse.html#isSuccess()">isSuccess</a></code> in interface <code><a href="../api/UpgradeResponse.html" title="interface in org.eclipse.jetty.websocket.api">UpgradeResponse</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if upgrade response was generated, false if no upgrade response was generated</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="sendError(int,java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>sendError</h4> |
| <pre class="methodSignature">public void sendError​(int statusCode, |
| java.lang.String message) |
| throws java.io.IOException</pre> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.io.IOException</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="sendForbidden(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>sendForbidden</h4> |
| <pre class="methodSignature">public void sendForbidden​(java.lang.String message) |
| throws java.io.IOException</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../api/UpgradeResponse.html#sendForbidden(java.lang.String)">UpgradeResponse</a></code></span></div> |
| <div class="block">Issue a forbidden upgrade response. |
| <p> |
| This means that the websocket endpoint was valid, but the conditions to use a WebSocket resulted in a forbidden |
| access. |
| <p> |
| Use this when the origin or authentication is invalid.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../api/UpgradeResponse.html#sendForbidden(java.lang.String)">sendForbidden</a></code> in interface <code><a href="../api/UpgradeResponse.html" title="interface in org.eclipse.jetty.websocket.api">UpgradeResponse</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>message</code> - the short 1 line detail message about the forbidden response</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.io.IOException</code> - if unable to send the forbidden</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setAcceptedSubProtocol(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setAcceptedSubProtocol</h4> |
| <pre class="methodSignature">public void setAcceptedSubProtocol​(java.lang.String protocol)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../api/UpgradeResponse.html#setAcceptedSubProtocol(java.lang.String)">UpgradeResponse</a></code></span></div> |
| <div class="block">Set the accepted WebSocket Protocol.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../api/UpgradeResponse.html#setAcceptedSubProtocol(java.lang.String)">setAcceptedSubProtocol</a></code> in interface <code><a href="../api/UpgradeResponse.html" title="interface in org.eclipse.jetty.websocket.api">UpgradeResponse</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>protocol</code> - the protocol to list as accepted</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/extensions/ExtensionConfig.html" title="class in org.eclipse.jetty.websocket.api.extensions">ExtensionConfig</a>> configs)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../api/UpgradeResponse.html#setExtensions(java.util.List)">UpgradeResponse</a></code></span></div> |
| <div class="block">Set the list of extensions that are approved for use with this websocket. |
| <p> |
| Notes: |
| <ul> |
| <li>Per the spec you cannot add extensions that have not been seen in the <a href="../api/UpgradeRequest.html" title="interface in org.eclipse.jetty.websocket.api"><code>UpgradeRequest</code></a>, just remove |
| entries you don't want to use</li> |
| <li>If this is unused, or a null is passed, then the list negotiation will follow default behavior and use the |
| complete list of extensions that are |
| available in this WebSocket server implementation.</li> |
| </ul></div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../api/UpgradeResponse.html#setExtensions(java.util.List)">setExtensions</a></code> in interface <code><a href="../api/UpgradeResponse.html" title="interface in org.eclipse.jetty.websocket.api">UpgradeResponse</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>configs</code> - the list of extensions to use.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setStatusCode(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setStatusCode</h4> |
| <pre class="methodSignature">public void setStatusCode​(int statusCode)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../api/UpgradeResponse.html#setStatusCode(int)">UpgradeResponse</a></code></span></div> |
| <div class="block">Set the HTTP Response status code</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../api/UpgradeResponse.html#setStatusCode(int)">setStatusCode</a></code> in interface <code><a href="../api/UpgradeResponse.html" title="interface in org.eclipse.jetty.websocket.api">UpgradeResponse</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>statusCode</code> - the status code</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setStatusReason(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setStatusReason</h4> |
| <pre class="methodSignature">public void setStatusReason​(java.lang.String statusReason)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../api/UpgradeResponse.html#setStatusReason(java.lang.String)">UpgradeResponse</a></code></span></div> |
| <div class="block">Set the HTTP Response status reason phrase |
| <p> |
| Note, not all implementation of UpgradeResponse can support this feature</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../api/UpgradeResponse.html#setStatusReason(java.lang.String)">setStatusReason</a></code> in interface <code><a href="../api/UpgradeResponse.html" title="interface in org.eclipse.jetty.websocket.api">UpgradeResponse</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>statusReason</code> - the status reason phrase</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setSuccess(boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setSuccess</h4> |
| <pre class="methodSignature">public void setSuccess​(boolean success)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../api/UpgradeResponse.html#setSuccess(boolean)">UpgradeResponse</a></code></span></div> |
| <div class="block">Set the success of the upgrade response. |
| <p></div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../api/UpgradeResponse.html#setSuccess(boolean)">setSuccess</a></code> in interface <code><a href="../api/UpgradeResponse.html" title="interface in org.eclipse.jetty.websocket.api">UpgradeResponse</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>success</code> - true to indicate a response to the upgrade handshake was sent, false to indicate no upgrade |
| response was sent</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="toString()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>toString</h4> |
| <pre class="methodSignature">public java.lang.String toString()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code>toString</code> in class <code>java.lang.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/ServletUpgradeResponse.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> |
