blob: eaef873e38165f36e47a8c548cc251a177d05aaa [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (11.0.11) on Mon Jun 14 16:44:01 EDT 2021 -->
<title>JettyServerUpgradeRequest (Eclipse Jetty API Doc - v11.0.5)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2021-06-14">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../jquery/jquery-ui.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
<script type="text/javascript" src="../../../../../jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../../../jquery/jquery-3.5.1.js"></script>
<script type="text/javascript" src="../../../../../jquery/jquery-ui.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="JettyServerUpgradeRequest (Eclipse Jetty API Doc - v11.0.5)";
}
}
catch(err) {
}
//-->
var data = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":6,"i12":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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/JettyServerUpgradeRequest.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&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</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">&nbsp;</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>&nbsp;<a href="package-summary.html">org.eclipse.jetty.websocket.server</a></div>
<h2 title="Interface JettyServerUpgradeRequest" class="title">Interface JettyServerUpgradeRequest</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Superinterfaces:</dt>
<dd><code><a href="../api/UpgradeRequest.html" title="interface in org.eclipse.jetty.websocket.api">UpgradeRequest</a></code></dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><code><a href="internal/DelegatedServerUpgradeRequest.html" title="class in org.eclipse.jetty.websocket.server.internal">DelegatedServerUpgradeRequest</a></code></dd>
</dl>
<hr>
<pre>public interface <span class="typeNameLabel">JettyServerUpgradeRequest</span>
extends <a href="../api/UpgradeRequest.html" title="interface in org.eclipse.jetty.websocket.api">UpgradeRequest</a></pre>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>java.security.cert.X509Certificate[]</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getCertificates()">getCertificates</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>jakarta.servlet.http.HttpServletRequest</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getHttpServletRequest()">getHttpServletRequest</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>java.util.Locale</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getLocale()">getLocale</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>java.util.Enumeration&lt;java.util.Locale&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getLocales()">getLocales</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>java.net.SocketAddress</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getLocalSocketAddress()">getLocalSocketAddress</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>java.net.SocketAddress</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getRemoteSocketAddress()">getRemoteSocketAddress</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getRequestPath()">getRequestPath</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>java.lang.Object</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getServletAttribute(java.lang.String)">getServletAttribute</a></span>&#8203;(java.lang.String&nbsp;name)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>java.util.Map&lt;java.lang.String,&#8203;java.lang.Object&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getServletAttributes()">getServletAttributes</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>java.util.Map&lt;java.lang.String,&#8203;java.util.List&lt;java.lang.String&gt;&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getServletParameters()">getServletParameters</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>java.lang.Object</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSession()">getSession</a></span>()</code></th>
<td class="colLast">
<div class="block">Access the Servlet HTTP Session (if present)</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isUserInRole(java.lang.String)">isUserInRole</a></span>&#8203;(java.lang.String&nbsp;role)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setServletAttribute(java.lang.String,java.lang.Object)">setServletAttribute</a></span>&#8203;(java.lang.String&nbsp;name,
java.lang.Object&nbsp;value)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.org.eclipse.jetty.websocket.api.UpgradeRequest">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.eclipse.jetty.websocket.api.<a href="../api/UpgradeRequest.html" title="interface in org.eclipse.jetty.websocket.api">UpgradeRequest</a></h3>
<code><a href="../api/UpgradeRequest.html#getCookies()">getCookies</a>, <a href="../api/UpgradeRequest.html#getExtensions()">getExtensions</a>, <a href="../api/UpgradeRequest.html#getHeader(java.lang.String)">getHeader</a>, <a href="../api/UpgradeRequest.html#getHeaderInt(java.lang.String)">getHeaderInt</a>, <a href="../api/UpgradeRequest.html#getHeaders()">getHeaders</a>, <a href="../api/UpgradeRequest.html#getHeaders(java.lang.String)">getHeaders</a>, <a href="../api/UpgradeRequest.html#getHost()">getHost</a>, <a href="../api/UpgradeRequest.html#getHttpVersion()">getHttpVersion</a>, <a href="../api/UpgradeRequest.html#getMethod()">getMethod</a>, <a href="../api/UpgradeRequest.html#getOrigin()">getOrigin</a>, <a href="../api/UpgradeRequest.html#getParameterMap()">getParameterMap</a>, <a href="../api/UpgradeRequest.html#getProtocolVersion()">getProtocolVersion</a>, <a href="../api/UpgradeRequest.html#getQueryString()">getQueryString</a>, <a href="../api/UpgradeRequest.html#getRequestURI()">getRequestURI</a>, <a href="../api/UpgradeRequest.html#getSubProtocols()">getSubProtocols</a>, <a href="../api/UpgradeRequest.html#getUserPrincipal()">getUserPrincipal</a>, <a href="../api/UpgradeRequest.html#hasSubProtocol(java.lang.String)">hasSubProtocol</a>, <a href="../api/UpgradeRequest.html#isSecure()">isSecure</a></code></li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="getSession()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSession</h4>
<pre class="methodSignature">java.lang.Object&nbsp;getSession()</pre>
<div class="block">Access the Servlet HTTP Session (if present)
<p>
Note: Never present on a Client UpgradeRequest.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the Servlet HTTPSession on server side UpgradeRequests</dd>
</dl>
</li>
</ul>
<a id="getCertificates()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCertificates</h4>
<pre class="methodSignature">java.security.cert.X509Certificate[]&nbsp;getCertificates()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The <code>X509Certificate</code> instance at request attribute "jakarta.servlet.request.X509Certificate" or null.</dd>
</dl>
</li>
</ul>
<a id="getHttpServletRequest()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getHttpServletRequest</h4>
<pre class="methodSignature">jakarta.servlet.http.HttpServletRequest&nbsp;getHttpServletRequest()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Immutable version of <code>HttpServletRequest</code></dd>
</dl>
</li>
</ul>
<a id="getLocale()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLocale</h4>
<pre class="methodSignature">java.util.Locale&nbsp;getLocale()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The requested Locale</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><code>ServletRequest.getLocale()</code></dd>
</dl>
</li>
</ul>
<a id="getLocales()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLocales</h4>
<pre class="methodSignature">java.util.Enumeration&lt;java.util.Locale&gt;&nbsp;getLocales()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The requested Locales</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><code>ServletRequest.getLocales()</code></dd>
</dl>
</li>
</ul>
<a id="getLocalSocketAddress()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLocalSocketAddress</h4>
<pre class="methodSignature">java.net.SocketAddress&nbsp;getLocalSocketAddress()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The local requested address, which is typically an <code>InetSocketAddress</code>, but may be another derivation of <code>SocketAddress</code></dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><code>ServletRequest.getLocalAddr()</code>,
<code>ServletRequest.getLocalPort()</code></dd>
</dl>
</li>
</ul>
<a id="getRemoteSocketAddress()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRemoteSocketAddress</h4>
<pre class="methodSignature">java.net.SocketAddress&nbsp;getRemoteSocketAddress()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The remote request address, which is typically an <code>InetSocketAddress</code>, but may be another derivation of <code>SocketAddress</code></dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><code>ServletRequest.getRemoteAddr()</code>,
<code>ServletRequest.getRemotePort()</code></dd>
</dl>
</li>
</ul>
<a id="getRequestPath()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRequestPath</h4>
<pre class="methodSignature">java.lang.String&nbsp;getRequestPath()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The request URI path within the context</dd>
</dl>
</li>
</ul>
<a id="getServletAttribute(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getServletAttribute</h4>
<pre class="methodSignature">java.lang.Object&nbsp;getServletAttribute&#8203;(java.lang.String&nbsp;name)</pre>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - Attribute name</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Attribute value or null</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><code>ServletRequest.getAttribute(String)</code></dd>
</dl>
</li>
</ul>
<a id="getServletAttributes()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getServletAttributes</h4>
<pre class="methodSignature">java.util.Map&lt;java.lang.String,&#8203;java.lang.Object&gt;&nbsp;getServletAttributes()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Request attribute map</dd>
</dl>
</li>
</ul>
<a id="getServletParameters()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getServletParameters</h4>
<pre class="methodSignature">java.util.Map&lt;java.lang.String,&#8203;java.util.List&lt;java.lang.String&gt;&gt;&nbsp;getServletParameters()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Request parameters</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><code>ServletRequest.getParameterMap()</code></dd>
</dl>
</li>
</ul>
<a id="isUserInRole(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isUserInRole</h4>
<pre class="methodSignature">boolean&nbsp;isUserInRole&#8203;(java.lang.String&nbsp;role)</pre>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>role</code> - The user role</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>True if the requests user has the role</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><code>HttpServletRequest.isUserInRole(String)</code></dd>
</dl>
</li>
</ul>
<a id="setServletAttribute(java.lang.String,java.lang.Object)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>setServletAttribute</h4>
<pre class="methodSignature">void&nbsp;setServletAttribute&#8203;(java.lang.String&nbsp;name,
java.lang.Object&nbsp;value)</pre>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - Attribute name</dd>
<dd><code>value</code> - Attribute value to set</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><code>ServletRequest.setAttribute(String, Object)</code></dd>
</dl>
</li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
</div>
</main>
<!-- ========= END OF CLASS DATA ========= -->
<footer role="contentinfo">
<nav role="navigation">
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a id="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/JettyServerUpgradeRequest.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&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</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 &#169; 1995&#x2013;2021 <a href="https://webtide.com">Webtide</a>. All rights reserved.</small></p>
</footer>
</body>
</html>