| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) on Thu Sep 15 14:13:16 CDT 2022 --> |
| <title>DelegatedServerUpgradeResponse (Eclipse Jetty API Doc - v11.0.12)</title> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="dc.created" content="2022-09-15"> |
| <meta name="description" content="declaration: package: org.eclipse.jetty.websocket.server.internal, class: DelegatedServerUpgradeResponse"> |
| <meta name="generator" content="javadoc/ClassWriterImpl"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../script-dir/jquery-ui.min.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../jquery-ui.overrides.css" title="Style"> |
| <script type="text/javascript" src="../../../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../../../script-dir/jquery-3.5.1.min.js"></script> |
| <script type="text/javascript" src="../../../../../../script-dir/jquery-ui.min.js"></script> |
| </head> |
| <body class="class-declaration-page"> |
| <script type="text/javascript">var evenRowColor = "even-row-color"; |
| var oddRowColor = "odd-row-color"; |
| var tableTab = "table-tab"; |
| var activeTableTab = "active-table-tab"; |
| var pathtoroot = "../../../../../../"; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <div class="flex-box"> |
| <header role="banner" class="flex-header"> |
| <nav role="navigation"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="top-nav" id="navbar-top"> |
| <div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> |
| <ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> |
| <li><a href="../../../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="nav-bar-cell1-rev">Class</li> |
| <li><a href="class-use/DelegatedServerUpgradeResponse.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../../help-doc.html#class">Help</a></li> |
| </ul> |
| </div> |
| <div class="sub-nav"> |
| <div> |
| <ul class="sub-nav-list"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li><a href="#constructor-summary">Constr</a> | </li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor-detail">Constr</a> | </li> |
| <li><a href="#method-detail">Method</a></li> |
| </ul> |
| </div> |
| <div class="nav-list-search"><label for="search-input">SEARCH:</label> |
| <input type="text" id="search-input" value="search" disabled="disabled"> |
| <input type="reset" id="reset-button" value="reset" disabled="disabled"> |
| </div> |
| </div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <span class="skip-nav" id="skip-navbar-top"></span></nav> |
| </header> |
| <div class="flex-content"> |
| <main role="main"> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.eclipse.jetty.websocket.server.internal</a></div> |
| <h1 title="Class DelegatedServerUpgradeResponse" class="title">Class DelegatedServerUpgradeResponse</h1> |
| </div> |
| <div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> |
| <div class="inheritance">org.eclipse.jetty.websocket.server.internal.DelegatedServerUpgradeResponse</div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code><a href="../../api/UpgradeResponse.html" title="interface in org.eclipse.jetty.websocket.api">UpgradeResponse</a></code>, <code><a href="../JettyServerUpgradeResponse.html" title="interface in org.eclipse.jetty.websocket.server">JettyServerUpgradeResponse</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">DelegatedServerUpgradeResponse</span> |
| <span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> |
| implements <a href="../JettyServerUpgradeResponse.html" title="interface in org.eclipse.jetty.websocket.server">JettyServerUpgradeResponse</a></span></div> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <li> |
| <section class="constructor-summary" id="constructor-summary"> |
| <h2>Constructor Summary</h2> |
| <div class="caption"><span>Constructors</span></div> |
| <div class="summary-table two-column-summary"> |
| <div class="table-header col-first">Constructor</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(org.eclipse.jetty.websocket.core.server.ServerUpgradeResponse)" class="member-name-link">DelegatedServerUpgradeResponse</a><wbr>(<a href="../../core/server/ServerUpgradeResponse.html" title="class in org.eclipse.jetty.websocket.core.server">ServerUpgradeResponse</a> response)</code></div> |
| <div class="col-last even-row-color"> </div> |
| </div> |
| </section> |
| </li> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <li> |
| <section class="method-summary" id="method-summary"> |
| <h2>Method Summary</h2> |
| <div id="method-summary-table"> |
| <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> |
| <div id="method-summary-table.tabpanel" role="tabpanel"> |
| <div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Method</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#addHeader(java.lang.String,java.lang.String)" class="member-name-link">addHeader</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> value)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Add a header value to the response.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getAcceptedSubProtocol()" class="member-name-link">getAcceptedSubProtocol</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Get the accepted WebSocket protocol.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="../../api/ExtensionConfig.html" title="interface in org.eclipse.jetty.websocket.api">ExtensionConfig</a>></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getExtensions()" class="member-name-link">getExtensions</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Get the list of extensions that should be used for the websocket.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getHeader(java.lang.String)" class="member-name-link">getHeader</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Get a header value</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Set.html" title="class or interface in java.util" class="external-link">Set</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getHeaderNames()" class="member-name-link">getHeaderNames</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Get the header names</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>>></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getHeaders()" class="member-name-link">getHeaders</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Get the headers map</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getHeaders(java.lang.String)" class="member-name-link">getHeaders</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Get the multi-value header value</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getStatusCode()" class="member-name-link">getStatusCode</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Get the HTTP Response Status Code</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isCommitted()" class="member-name-link">isCommitted</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns a boolean indicating if the response has been committed.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#sendError(int,java.lang.String)" class="member-name-link">sendError</a><wbr>(int statusCode, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> message)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Sends an error response to the client using the specified status.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#sendForbidden(java.lang.String)" class="member-name-link">sendForbidden</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> message)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Issue a forbidden upgrade response.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setAcceptedSubProtocol(java.lang.String)" class="member-name-link">setAcceptedSubProtocol</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> protocol)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Set the accepted WebSocket Protocol.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setExtensions(java.util.List)" class="member-name-link">setExtensions</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="../../api/ExtensionConfig.html" title="interface in org.eclipse.jetty.websocket.api">ExtensionConfig</a>> configs)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Set the list of extensions that are approved for use with this websocket.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setHeader(java.lang.String,java.lang.String)" class="member-name-link">setHeader</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> value)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Set a header</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setHeader(java.lang.String,java.util.List)" class="member-name-link">setHeader</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>> values)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Set a header</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setStatusCode(int)" class="member-name-link">setStatusCode</a><wbr>(int statusCode)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Set the HTTP Response status code</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> |
| <code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <li> |
| <section class="constructor-details" id="constructor-detail"> |
| <h2>Constructor Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="<init>(org.eclipse.jetty.websocket.core.server.ServerUpgradeResponse)"> |
| <h3>DelegatedServerUpgradeResponse</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">DelegatedServerUpgradeResponse</span><wbr><span class="parameters">(<a href="../../core/server/ServerUpgradeResponse.html" title="class in org.eclipse.jetty.websocket.core.server">ServerUpgradeResponse</a> response)</span></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li> |
| <section class="method-details" id="method-detail"> |
| <h2>Method Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="addHeader(java.lang.String,java.lang.String)"> |
| <h3>addHeader</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">addHeader</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> value)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../JettyServerUpgradeResponse.html#addHeader(java.lang.String,java.lang.String)">JettyServerUpgradeResponse</a></code></span></div> |
| <div class="block">Add a header value to the response.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../JettyServerUpgradeResponse.html#addHeader(java.lang.String,java.lang.String)">addHeader</a></code> in interface <code><a href="../JettyServerUpgradeResponse.html" title="interface in org.eclipse.jetty.websocket.server">JettyServerUpgradeResponse</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>name</code> - the header name</dd> |
| <dd><code>value</code> - the header value</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setHeader(java.lang.String,java.lang.String)"> |
| <h3>setHeader</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setHeader</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> value)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../JettyServerUpgradeResponse.html#setHeader(java.lang.String,java.lang.String)">JettyServerUpgradeResponse</a></code></span></div> |
| <div class="block">Set a header |
| <p> |
| Overrides previous value of header (if set)</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../JettyServerUpgradeResponse.html#setHeader(java.lang.String,java.lang.String)">setHeader</a></code> in interface <code><a href="../JettyServerUpgradeResponse.html" title="interface in org.eclipse.jetty.websocket.server">JettyServerUpgradeResponse</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>name</code> - the header name</dd> |
| <dd><code>value</code> - the header value</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setHeader(java.lang.String,java.util.List)"> |
| <h3>setHeader</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setHeader</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>> values)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../JettyServerUpgradeResponse.html#setHeader(java.lang.String,java.util.List)">JettyServerUpgradeResponse</a></code></span></div> |
| <div class="block">Set a header |
| <p> |
| Overrides previous value of header (if set)</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../JettyServerUpgradeResponse.html#setHeader(java.lang.String,java.util.List)">setHeader</a></code> in interface <code><a href="../JettyServerUpgradeResponse.html" title="interface in org.eclipse.jetty.websocket.server">JettyServerUpgradeResponse</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>name</code> - the header name</dd> |
| <dd><code>values</code> - the header values</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getAcceptedSubProtocol()"> |
| <h3>getAcceptedSubProtocol</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">getAcceptedSubProtocol</span>()</div> |
| <div class="block"><span class="descfrm-type-label">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 class="notes"> |
| <dt>Specified by:</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>Returns:</dt> |
| <dd>the accepted WebSocket protocol.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getExtensions()"> |
| <h3>getExtensions</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="../../api/ExtensionConfig.html" title="interface in org.eclipse.jetty.websocket.api">ExtensionConfig</a>></span> <span class="element-name">getExtensions</span>()</div> |
| <div class="block"><span class="descfrm-type-label">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 class="notes"> |
| <dt>Specified by:</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>Returns:</dt> |
| <dd>the list of negotiated extensions to use.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getHeader(java.lang.String)"> |
| <h3>getHeader</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">getHeader</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name)</span></div> |
| <div class="block"><span class="descfrm-type-label">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 class="notes"> |
| <dt>Specified by:</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>Parameters:</dt> |
| <dd><code>name</code> - the header name</dd> |
| <dt>Returns:</dt> |
| <dd>the value (null if header doesn't exist)</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getHeaderNames()"> |
| <h3>getHeaderNames</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Set.html" title="class or interface in java.util" class="external-link">Set</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>></span> <span class="element-name">getHeaderNames</span>()</div> |
| <div class="block"><span class="descfrm-type-label">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 class="notes"> |
| <dt>Specified by:</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>Returns:</dt> |
| <dd>the set of header names</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getHeaders()"> |
| <h3>getHeaders</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>>></span> <span class="element-name">getHeaders</span>()</div> |
| <div class="block"><span class="descfrm-type-label">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 class="notes"> |
| <dt>Specified by:</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>Returns:</dt> |
| <dd>the map of headers</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getHeaders(java.lang.String)"> |
| <h3>getHeaders</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>></span> <span class="element-name">getHeaders</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name)</span></div> |
| <div class="block"><span class="descfrm-type-label">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 class="notes"> |
| <dt>Specified by:</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>Parameters:</dt> |
| <dd><code>name</code> - the header name</dd> |
| <dt>Returns:</dt> |
| <dd>the list of values (null if header doesn't exist)</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getStatusCode()"> |
| <h3>getStatusCode</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">getStatusCode</span>()</div> |
| <div class="block"><span class="descfrm-type-label">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 class="notes"> |
| <dt>Specified by:</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>Returns:</dt> |
| <dd>the status code</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="sendForbidden(java.lang.String)"> |
| <h3>sendForbidden</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">sendForbidden</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> message)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../JettyServerUpgradeResponse.html#sendForbidden(java.lang.String)">JettyServerUpgradeResponse</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 class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../JettyServerUpgradeResponse.html#sendForbidden(java.lang.String)">sendForbidden</a></code> in interface <code><a href="../JettyServerUpgradeResponse.html" title="interface in org.eclipse.jetty.websocket.server">JettyServerUpgradeResponse</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>message</code> - the short 1 line detail message about the forbidden response</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code> - if unable to send the forbidden</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setAcceptedSubProtocol(java.lang.String)"> |
| <h3>setAcceptedSubProtocol</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setAcceptedSubProtocol</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> protocol)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../JettyServerUpgradeResponse.html#setAcceptedSubProtocol(java.lang.String)">JettyServerUpgradeResponse</a></code></span></div> |
| <div class="block">Set the accepted WebSocket Protocol.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../JettyServerUpgradeResponse.html#setAcceptedSubProtocol(java.lang.String)">setAcceptedSubProtocol</a></code> in interface <code><a href="../JettyServerUpgradeResponse.html" title="interface in org.eclipse.jetty.websocket.server">JettyServerUpgradeResponse</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>protocol</code> - the protocol to list as accepted</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setExtensions(java.util.List)"> |
| <h3>setExtensions</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setExtensions</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="../../api/ExtensionConfig.html" title="interface in org.eclipse.jetty.websocket.api">ExtensionConfig</a>> configs)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../JettyServerUpgradeResponse.html#setExtensions(java.util.List)">JettyServerUpgradeResponse</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 class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../JettyServerUpgradeResponse.html#setExtensions(java.util.List)">setExtensions</a></code> in interface <code><a href="../JettyServerUpgradeResponse.html" title="interface in org.eclipse.jetty.websocket.server">JettyServerUpgradeResponse</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>configs</code> - the list of extensions to use.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setStatusCode(int)"> |
| <h3>setStatusCode</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setStatusCode</span><wbr><span class="parameters">(int statusCode)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../JettyServerUpgradeResponse.html#setStatusCode(int)">JettyServerUpgradeResponse</a></code></span></div> |
| <div class="block">Set the HTTP Response status code</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../JettyServerUpgradeResponse.html#setStatusCode(int)">setStatusCode</a></code> in interface <code><a href="../JettyServerUpgradeResponse.html" title="interface in org.eclipse.jetty.websocket.server">JettyServerUpgradeResponse</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>statusCode</code> - the status code</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isCommitted()"> |
| <h3>isCommitted</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isCommitted</span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../JettyServerUpgradeResponse.html#isCommitted()">JettyServerUpgradeResponse</a></code></span></div> |
| <div class="block">Returns a boolean indicating if the response has been committed. |
| A committed response has already had its status code and headers written.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../JettyServerUpgradeResponse.html#isCommitted()">isCommitted</a></code> in interface <code><a href="../JettyServerUpgradeResponse.html" title="interface in org.eclipse.jetty.websocket.server">JettyServerUpgradeResponse</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>a boolean indicating if the response has been committed.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="sendError(int,java.lang.String)"> |
| <h3>sendError</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">sendError</span><wbr><span class="parameters">(int statusCode, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> message)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../JettyServerUpgradeResponse.html#sendError(int,java.lang.String)">JettyServerUpgradeResponse</a></code></span></div> |
| <div class="block">Sends an error response to the client using the specified status.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../JettyServerUpgradeResponse.html#sendError(int,java.lang.String)">sendError</a></code> in interface <code><a href="../JettyServerUpgradeResponse.html" title="interface in org.eclipse.jetty.websocket.server">JettyServerUpgradeResponse</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>statusCode</code> - the error status code</dd> |
| <dd><code>message</code> - the descriptive message</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code> - If an input or output exception occurs</dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| <footer role="contentinfo"> |
| <hr> |
| <p class="legal-copy"><small>Copyright © 1995–2022 <a href="https://webtide.com">Webtide</a>. All rights reserved.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |