blob: 720a3452359231f569f71919472a1b2ea5f680a9 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (version 1.7.0_80) on Wed Jun 07 15:10:54 EDT 2017 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>ServletUpgradeRequest (Jetty :: Project 9.2.22.v20170606 API)</title>
<meta name="date" content="2017-06-07">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="ServletUpgradeRequest (Jetty :: Project 9.2.22.v20170606 API)";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/ServletUpgradeRequest.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 class="aboutLanguage"><em><script type="text/javascript"> var _gaq = _gaq || []; _gaq.push(['_setAccount', 'UA-1149868-7']); _gaq.push(['_trackPageview']); (function() { var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true; ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js'; var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s); })(); </script></em></div>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev Class</li>
<li><a href="../../../../../org/eclipse/jetty/websocket/servlet/ServletUpgradeResponse.html" title="class in org.eclipse.jetty.websocket.servlet"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/eclipse/jetty/websocket/servlet/ServletUpgradeRequest.html" target="_top">Frames</a></li>
<li><a href="ServletUpgradeRequest.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">All Classes</a></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>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_summary">Constr</a>&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><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.eclipse.jetty.websocket.servlet</div>
<h2 title="Class ServletUpgradeRequest" class="title">Class ServletUpgradeRequest</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li><a href="../../../../../org/eclipse/jetty/websocket/api/UpgradeRequest.html" title="class in org.eclipse.jetty.websocket.api">org.eclipse.jetty.websocket.api.UpgradeRequest</a></li>
<li>
<ul class="inheritance">
<li>org.eclipse.jetty.websocket.servlet.ServletUpgradeRequest</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><a href="../../../../../org/eclipse/jetty/websocket/server/ServletWebSocketRequest.html" title="class in org.eclipse.jetty.websocket.server">ServletWebSocketRequest</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="strong">ServletUpgradeRequest</span>
extends <a href="../../../../../org/eclipse/jetty/websocket/api/UpgradeRequest.html" title="class in org.eclipse.jetty.websocket.api">UpgradeRequest</a></pre>
<div class="block">Servlet specific <a href="../../../../../org/eclipse/jetty/websocket/api/UpgradeRequest.html" title="class in org.eclipse.jetty.websocket.api"><code>UpgradeRequest</code></a> implementation.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../../../org/eclipse/jetty/websocket/servlet/ServletUpgradeRequest.html#ServletUpgradeRequest(javax.servlet.http.HttpServletRequest)">ServletUpgradeRequest</a></strong>(<a href="http://docs.oracle.com/javaee/7/api/javax/servlet/http/HttpServletRequest.html?is-external=true" title="class or interface in javax.servlet.http">HttpServletRequest</a>&nbsp;httpRequest)</code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/eclipse/jetty/websocket/servlet/ServletUpgradeRequest.html#complete()">complete</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/security/cert/X509Certificate.html?is-external=true" title="class or interface in java.security.cert">X509Certificate</a>[]</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/eclipse/jetty/websocket/servlet/ServletUpgradeRequest.html#getCertificates()">getCertificates</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javaee/7/api/javax/servlet/http/HttpServletRequest.html?is-external=true" title="class or interface in javax.servlet.http">HttpServletRequest</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/eclipse/jetty/websocket/servlet/ServletUpgradeRequest.html#getHttpServletRequest()">getHttpServletRequest</a></strong>()</code>
<div class="block">Return the underlying HttpServletRequest that existed at Upgrade time.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/eclipse/jetty/websocket/servlet/ServletUpgradeRequest.html#getLocalAddress()">getLocalAddress</a></strong>()</code>
<div class="block">Equivalent to <a href="http://docs.oracle.com/javaee/7/api/javax/servlet/ServletRequest.html?is-external=true#getLocalAddr()" title="class or interface in javax.servlet"><code>ServletRequest.getLocalAddr()</code></a></div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/util/Locale.html?is-external=true" title="class or interface in java.util">Locale</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/eclipse/jetty/websocket/servlet/ServletUpgradeRequest.html#getLocale()">getLocale</a></strong>()</code>
<div class="block">Equivalent to <a href="http://docs.oracle.com/javaee/7/api/javax/servlet/ServletRequest.html?is-external=true#getLocale()" title="class or interface in javax.servlet"><code>ServletRequest.getLocale()</code></a></div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/util/Enumeration.html?is-external=true" title="class or interface in java.util">Enumeration</a>&lt;<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Locale.html?is-external=true" title="class or interface in java.util">Locale</a>&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/eclipse/jetty/websocket/servlet/ServletUpgradeRequest.html#getLocales()">getLocales</a></strong>()</code>
<div class="block">Equivalent to <a href="http://docs.oracle.com/javaee/7/api/javax/servlet/ServletRequest.html?is-external=true#getLocales()" title="class or interface in javax.servlet"><code>ServletRequest.getLocales()</code></a></div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/eclipse/jetty/websocket/servlet/ServletUpgradeRequest.html#getLocalHostName()">getLocalHostName</a></strong>()</code>
<div class="block">Equivalent to <a href="http://docs.oracle.com/javaee/7/api/javax/servlet/ServletRequest.html?is-external=true#getLocalName()" title="class or interface in javax.servlet"><code>ServletRequest.getLocalName()</code></a></div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/eclipse/jetty/websocket/servlet/ServletUpgradeRequest.html#getLocalPort()">getLocalPort</a></strong>()</code>
<div class="block">Equivalent to <a href="http://docs.oracle.com/javaee/7/api/javax/servlet/ServletRequest.html?is-external=true#getLocalPort()" title="class or interface in javax.servlet"><code>ServletRequest.getLocalPort()</code></a></div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/net/InetSocketAddress.html?is-external=true" title="class or interface in java.net">InetSocketAddress</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/eclipse/jetty/websocket/servlet/ServletUpgradeRequest.html#getLocalSocketAddress()">getLocalSocketAddress</a></strong>()</code>
<div class="block">Return a <a href="http://docs.oracle.com/javase/7/docs/api/java/net/InetSocketAddress.html?is-external=true" title="class or interface in java.net"><code>InetSocketAddress</code></a> for the local socket.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/security/Principal.html?is-external=true" title="class or interface in java.security">Principal</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/eclipse/jetty/websocket/servlet/ServletUpgradeRequest.html#getPrincipal()">getPrincipal</a></strong>()</code>
<div class="block"><strong>Deprecated.</strong>&nbsp;
<div class="block"><i>use <a href="../../../../../org/eclipse/jetty/websocket/servlet/ServletUpgradeRequest.html#getUserPrincipal()"><code>getUserPrincipal()</code></a> instead</i></div>
</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/eclipse/jetty/websocket/servlet/ServletUpgradeRequest.html#getRemoteAddress()">getRemoteAddress</a></strong>()</code>
<div class="block">Equivalent to <a href="http://docs.oracle.com/javaee/7/api/javax/servlet/ServletRequest.html?is-external=true#getRemoteAddr()" title="class or interface in javax.servlet"><code>ServletRequest.getRemoteAddr()</code></a></div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/eclipse/jetty/websocket/servlet/ServletUpgradeRequest.html#getRemoteHostName()">getRemoteHostName</a></strong>()</code>
<div class="block">Equivalent to <a href="http://docs.oracle.com/javaee/7/api/javax/servlet/ServletRequest.html?is-external=true#getRemoteHost()" title="class or interface in javax.servlet"><code>ServletRequest.getRemoteHost()</code></a></div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/eclipse/jetty/websocket/servlet/ServletUpgradeRequest.html#getRemotePort()">getRemotePort</a></strong>()</code>
<div class="block">Equivalent to <a href="http://docs.oracle.com/javaee/7/api/javax/servlet/ServletRequest.html?is-external=true#getRemotePort()" title="class or interface in javax.servlet"><code>ServletRequest.getRemotePort()</code></a></div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/net/InetSocketAddress.html?is-external=true" title="class or interface in java.net">InetSocketAddress</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/eclipse/jetty/websocket/servlet/ServletUpgradeRequest.html#getRemoteSocketAddress()">getRemoteSocketAddress</a></strong>()</code>
<div class="block">Return a <a href="http://docs.oracle.com/javase/7/docs/api/java/net/InetSocketAddress.html?is-external=true" title="class or interface in java.net"><code>InetSocketAddress</code></a> for the remote socket.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/eclipse/jetty/websocket/servlet/ServletUpgradeRequest.html#getRequestPath()">getRequestPath</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/eclipse/jetty/websocket/servlet/ServletUpgradeRequest.html#getServletAttribute(java.lang.String)">getServletAttribute</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name)</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/eclipse/jetty/websocket/servlet/ServletUpgradeRequest.html#getServletAttributes()">getServletAttributes</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/eclipse/jetty/websocket/servlet/ServletUpgradeRequest.html#getServletParameters()">getServletParameters</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javaee/7/api/javax/servlet/http/HttpSession.html?is-external=true" title="class or interface in javax.servlet.http">HttpSession</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/eclipse/jetty/websocket/servlet/ServletUpgradeRequest.html#getSession()">getSession</a></strong>()</code>
<div class="block">Return the HttpSession if it exists.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/security/Principal.html?is-external=true" title="class or interface in java.security">Principal</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/eclipse/jetty/websocket/servlet/ServletUpgradeRequest.html#getUserPrincipal()">getUserPrincipal</a></strong>()</code>
<div class="block">Equivalent to <a href="http://docs.oracle.com/javaee/7/api/javax/servlet/http/HttpServletRequest.html?is-external=true#getUserPrincipal()" title="class or interface in javax.servlet.http"><code>HttpServletRequest.getUserPrincipal()</code></a></div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/eclipse/jetty/websocket/servlet/ServletUpgradeRequest.html#isUserInRole(java.lang.String)">isUserInRole</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;role)</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/eclipse/jetty/websocket/servlet/ServletUpgradeRequest.html#setServletAttribute(java.lang.String,%20java.lang.Object)">setServletAttribute</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name,
<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;value)</code>&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_org.eclipse.jetty.websocket.api.UpgradeRequest">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.eclipse.jetty.websocket.api.<a href="../../../../../org/eclipse/jetty/websocket/api/UpgradeRequest.html" title="class in org.eclipse.jetty.websocket.api">UpgradeRequest</a></h3>
<code><a href="../../../../../org/eclipse/jetty/websocket/api/UpgradeRequest.html#addExtensions(org.eclipse.jetty.websocket.api.extensions.ExtensionConfig...)">addExtensions</a>, <a href="../../../../../org/eclipse/jetty/websocket/api/UpgradeRequest.html#addExtensions(java.lang.String...)">addExtensions</a>, <a href="../../../../../org/eclipse/jetty/websocket/api/UpgradeRequest.html#clearHeaders()">clearHeaders</a>, <a href="../../../../../org/eclipse/jetty/websocket/api/UpgradeRequest.html#getCookies()">getCookies</a>, <a href="../../../../../org/eclipse/jetty/websocket/api/UpgradeRequest.html#getExtensions()">getExtensions</a>, <a href="../../../../../org/eclipse/jetty/websocket/api/UpgradeRequest.html#getHeader(java.lang.String)">getHeader</a>, <a href="../../../../../org/eclipse/jetty/websocket/api/UpgradeRequest.html#getHeaderInt(java.lang.String)">getHeaderInt</a>, <a href="../../../../../org/eclipse/jetty/websocket/api/UpgradeRequest.html#getHeaders()">getHeaders</a>, <a href="../../../../../org/eclipse/jetty/websocket/api/UpgradeRequest.html#getHeaders(java.lang.String)">getHeaders</a>, <a href="../../../../../org/eclipse/jetty/websocket/api/UpgradeRequest.html#getHost()">getHost</a>, <a href="../../../../../org/eclipse/jetty/websocket/api/UpgradeRequest.html#getHttpVersion()">getHttpVersion</a>, <a href="../../../../../org/eclipse/jetty/websocket/api/UpgradeRequest.html#getMethod()">getMethod</a>, <a href="../../../../../org/eclipse/jetty/websocket/api/UpgradeRequest.html#getOrigin()">getOrigin</a>, <a href="../../../../../org/eclipse/jetty/websocket/api/UpgradeRequest.html#getParameterMap()">getParameterMap</a>, <a href="../../../../../org/eclipse/jetty/websocket/api/UpgradeRequest.html#getProtocolVersion()">getProtocolVersion</a>, <a href="../../../../../org/eclipse/jetty/websocket/api/UpgradeRequest.html#getQueryString()">getQueryString</a>, <a href="../../../../../org/eclipse/jetty/websocket/api/UpgradeRequest.html#getRequestURI()">getRequestURI</a>, <a href="../../../../../org/eclipse/jetty/websocket/api/UpgradeRequest.html#getSubProtocols()">getSubProtocols</a>, <a href="../../../../../org/eclipse/jetty/websocket/api/UpgradeRequest.html#hasSubProtocol(java.lang.String)">hasSubProtocol</a>, <a href="../../../../../org/eclipse/jetty/websocket/api/UpgradeRequest.html#isOrigin(java.lang.String)">isOrigin</a>, <a href="../../../../../org/eclipse/jetty/websocket/api/UpgradeRequest.html#isSecure()">isSecure</a>, <a href="../../../../../org/eclipse/jetty/websocket/api/UpgradeRequest.html#setCookies(java.util.List)">setCookies</a>, <a href="../../../../../org/eclipse/jetty/websocket/api/UpgradeRequest.html#setExtensions(java.util.List)">setExtensions</a>, <a href="../../../../../org/eclipse/jetty/websocket/api/UpgradeRequest.html#setHeader(java.lang.String,%20java.util.List)">setHeader</a>, <a href="../../../../../org/eclipse/jetty/websocket/api/UpgradeRequest.html#setHeader(java.lang.String,%20java.lang.String)">setHeader</a>, <a href="../../../../../org/eclipse/jetty/websocket/api/UpgradeRequest.html#setHeaders(java.util.Map)">setHeaders</a>, <a href="../../../../../org/eclipse/jetty/websocket/api/UpgradeRequest.html#setHttpVersion(java.lang.String)">setHttpVersion</a>, <a href="../../../../../org/eclipse/jetty/websocket/api/UpgradeRequest.html#setMethod(java.lang.String)">setMethod</a>, <a href="../../../../../org/eclipse/jetty/websocket/api/UpgradeRequest.html#setParameterMap(java.util.Map)">setParameterMap</a>, <a href="../../../../../org/eclipse/jetty/websocket/api/UpgradeRequest.html#setRequestURI(java.net.URI)">setRequestURI</a>, <a href="../../../../../org/eclipse/jetty/websocket/api/UpgradeRequest.html#setSession(java.lang.Object)">setSession</a>, <a href="../../../../../org/eclipse/jetty/websocket/api/UpgradeRequest.html#setSubProtocols(java.util.List)">setSubProtocols</a>, <a href="../../../../../org/eclipse/jetty/websocket/api/UpgradeRequest.html#setSubProtocols(java.lang.String...)">setSubProtocols</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long,%20int)" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="ServletUpgradeRequest(javax.servlet.http.HttpServletRequest)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>ServletUpgradeRequest</h4>
<pre>public&nbsp;ServletUpgradeRequest(<a href="http://docs.oracle.com/javaee/7/api/javax/servlet/http/HttpServletRequest.html?is-external=true" title="class or interface in javax.servlet.http">HttpServletRequest</a>&nbsp;httpRequest)
throws <a href="http://docs.oracle.com/javase/7/docs/api/java/net/URISyntaxException.html?is-external=true" title="class or interface in java.net">URISyntaxException</a></pre>
<dl><dt><span class="strong">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/net/URISyntaxException.html?is-external=true" title="class or interface in java.net">URISyntaxException</a></code></dd></dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getCertificates()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCertificates</h4>
<pre>public&nbsp;<a href="http://docs.oracle.com/javase/7/docs/api/java/security/cert/X509Certificate.html?is-external=true" title="class or interface in java.security.cert">X509Certificate</a>[]&nbsp;getCertificates()</pre>
</li>
</ul>
<a name="getHttpServletRequest()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getHttpServletRequest</h4>
<pre>public&nbsp;<a href="http://docs.oracle.com/javaee/7/api/javax/servlet/http/HttpServletRequest.html?is-external=true" title="class or interface in javax.servlet.http">HttpServletRequest</a>&nbsp;getHttpServletRequest()</pre>
<div class="block">Return the underlying HttpServletRequest that existed at Upgrade time.
<p/>
Note: many features of the HttpServletRequest are invalid when upgraded,
especially ones that deal with body content, streams, readers, and responses.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>a limited version of the underlying HttpServletRequest</dd></dl>
</li>
</ul>
<a name="getLocalAddress()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLocalAddress</h4>
<pre>public&nbsp;<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getLocalAddress()</pre>
<div class="block">Equivalent to <a href="http://docs.oracle.com/javaee/7/api/javax/servlet/ServletRequest.html?is-external=true#getLocalAddr()" title="class or interface in javax.servlet"><code>ServletRequest.getLocalAddr()</code></a></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the local address</dd></dl>
</li>
</ul>
<a name="getLocalHostName()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLocalHostName</h4>
<pre>public&nbsp;<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getLocalHostName()</pre>
<div class="block">Equivalent to <a href="http://docs.oracle.com/javaee/7/api/javax/servlet/ServletRequest.html?is-external=true#getLocalName()" title="class or interface in javax.servlet"><code>ServletRequest.getLocalName()</code></a></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the local host name</dd></dl>
</li>
</ul>
<a name="getLocalPort()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLocalPort</h4>
<pre>public&nbsp;int&nbsp;getLocalPort()</pre>
<div class="block">Equivalent to <a href="http://docs.oracle.com/javaee/7/api/javax/servlet/ServletRequest.html?is-external=true#getLocalPort()" title="class or interface in javax.servlet"><code>ServletRequest.getLocalPort()</code></a></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the local port</dd></dl>
</li>
</ul>
<a name="getLocalSocketAddress()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLocalSocketAddress</h4>
<pre>public&nbsp;<a href="http://docs.oracle.com/javase/7/docs/api/java/net/InetSocketAddress.html?is-external=true" title="class or interface in java.net">InetSocketAddress</a>&nbsp;getLocalSocketAddress()</pre>
<div class="block">Return a <a href="http://docs.oracle.com/javase/7/docs/api/java/net/InetSocketAddress.html?is-external=true" title="class or interface in java.net"><code>InetSocketAddress</code></a> for the local socket.
<p/>
Warning: this can cause a DNS lookup</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the local socket address</dd></dl>
</li>
</ul>
<a name="getLocale()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLocale</h4>
<pre>public&nbsp;<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Locale.html?is-external=true" title="class or interface in java.util">Locale</a>&nbsp;getLocale()</pre>
<div class="block">Equivalent to <a href="http://docs.oracle.com/javaee/7/api/javax/servlet/ServletRequest.html?is-external=true#getLocale()" title="class or interface in javax.servlet"><code>ServletRequest.getLocale()</code></a></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the preferred <code>Locale</code> for the client</dd></dl>
</li>
</ul>
<a name="getLocales()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLocales</h4>
<pre>public&nbsp;<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Enumeration.html?is-external=true" title="class or interface in java.util">Enumeration</a>&lt;<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Locale.html?is-external=true" title="class or interface in java.util">Locale</a>&gt;&nbsp;getLocales()</pre>
<div class="block">Equivalent to <a href="http://docs.oracle.com/javaee/7/api/javax/servlet/ServletRequest.html?is-external=true#getLocales()" title="class or interface in javax.servlet"><code>ServletRequest.getLocales()</code></a></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>an Enumeration of preferred Locale objects</dd></dl>
</li>
</ul>
<a name="getPrincipal()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPrincipal</h4>
<pre><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>
public&nbsp;<a href="http://docs.oracle.com/javase/7/docs/api/java/security/Principal.html?is-external=true" title="class or interface in java.security">Principal</a>&nbsp;getPrincipal()</pre>
<div class="block"><span class="strong">Deprecated.</span>&nbsp;<i>use <a href="../../../../../org/eclipse/jetty/websocket/servlet/ServletUpgradeRequest.html#getUserPrincipal()"><code>getUserPrincipal()</code></a> instead</i></div>
</li>
</ul>
<a name="getUserPrincipal()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getUserPrincipal</h4>
<pre>public&nbsp;<a href="http://docs.oracle.com/javase/7/docs/api/java/security/Principal.html?is-external=true" title="class or interface in java.security">Principal</a>&nbsp;getUserPrincipal()</pre>
<div class="block">Equivalent to <a href="http://docs.oracle.com/javaee/7/api/javax/servlet/http/HttpServletRequest.html?is-external=true#getUserPrincipal()" title="class or interface in javax.servlet.http"><code>HttpServletRequest.getUserPrincipal()</code></a></div>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code><a href="../../../../../org/eclipse/jetty/websocket/api/UpgradeRequest.html#getUserPrincipal()">getUserPrincipal</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/eclipse/jetty/websocket/api/UpgradeRequest.html" title="class in org.eclipse.jetty.websocket.api">UpgradeRequest</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>the user principal</dd></dl>
</li>
</ul>
<a name="getRemoteAddress()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRemoteAddress</h4>
<pre>public&nbsp;<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getRemoteAddress()</pre>
<div class="block">Equivalent to <a href="http://docs.oracle.com/javaee/7/api/javax/servlet/ServletRequest.html?is-external=true#getRemoteAddr()" title="class or interface in javax.servlet"><code>ServletRequest.getRemoteAddr()</code></a></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the remote address</dd></dl>
</li>
</ul>
<a name="getRemoteHostName()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRemoteHostName</h4>
<pre>public&nbsp;<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getRemoteHostName()</pre>
<div class="block">Equivalent to <a href="http://docs.oracle.com/javaee/7/api/javax/servlet/ServletRequest.html?is-external=true#getRemoteHost()" title="class or interface in javax.servlet"><code>ServletRequest.getRemoteHost()</code></a></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the remote host name</dd></dl>
</li>
</ul>
<a name="getRemotePort()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRemotePort</h4>
<pre>public&nbsp;int&nbsp;getRemotePort()</pre>
<div class="block">Equivalent to <a href="http://docs.oracle.com/javaee/7/api/javax/servlet/ServletRequest.html?is-external=true#getRemotePort()" title="class or interface in javax.servlet"><code>ServletRequest.getRemotePort()</code></a></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the remote port</dd></dl>
</li>
</ul>
<a name="getRemoteSocketAddress()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRemoteSocketAddress</h4>
<pre>public&nbsp;<a href="http://docs.oracle.com/javase/7/docs/api/java/net/InetSocketAddress.html?is-external=true" title="class or interface in java.net">InetSocketAddress</a>&nbsp;getRemoteSocketAddress()</pre>
<div class="block">Return a <a href="http://docs.oracle.com/javase/7/docs/api/java/net/InetSocketAddress.html?is-external=true" title="class or interface in java.net"><code>InetSocketAddress</code></a> for the remote socket.
<p/>
Warning: this can cause a DNS lookup</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the remote socket address</dd></dl>
</li>
</ul>
<a name="getServletAttributes()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getServletAttributes</h4>
<pre>public&nbsp;<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&gt;&nbsp;getServletAttributes()</pre>
</li>
</ul>
<a name="getServletParameters()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getServletParameters</h4>
<pre>public&nbsp;<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;&gt;&nbsp;getServletParameters()</pre>
</li>
</ul>
<a name="getSession()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSession</h4>
<pre>public&nbsp;<a href="http://docs.oracle.com/javaee/7/api/javax/servlet/http/HttpSession.html?is-external=true" title="class or interface in javax.servlet.http">HttpSession</a>&nbsp;getSession()</pre>
<div class="block">Return the HttpSession if it exists.
<p/>
Note: this is equivalent to <a href="http://docs.oracle.com/javaee/7/api/javax/servlet/http/HttpServletRequest.html?is-external=true#getSession(boolean)" title="class or interface in javax.servlet.http"><code>HttpServletRequest.getSession(boolean)</code></a>
and will not create a new HttpSession.</div>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code><a href="../../../../../org/eclipse/jetty/websocket/api/UpgradeRequest.html#getSession()">getSession</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/eclipse/jetty/websocket/api/UpgradeRequest.html" title="class in org.eclipse.jetty.websocket.api">UpgradeRequest</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>the Servlet HTTPSession on server side UpgradeRequests</dd></dl>
</li>
</ul>
<a name="setServletAttribute(java.lang.String, java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setServletAttribute</h4>
<pre>public&nbsp;void&nbsp;setServletAttribute(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name,
<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;value)</pre>
</li>
</ul>
<a name="getServletAttribute(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getServletAttribute</h4>
<pre>public&nbsp;<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;getServletAttribute(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name)</pre>
</li>
</ul>
<a name="isUserInRole(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isUserInRole</h4>
<pre>public&nbsp;boolean&nbsp;isUserInRole(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;role)</pre>
</li>
</ul>
<a name="getRequestPath()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRequestPath</h4>
<pre>public&nbsp;<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getRequestPath()</pre>
</li>
</ul>
<a name="complete()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>complete</h4>
<pre>public&nbsp;void&nbsp;complete()</pre>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!-- -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/ServletUpgradeRequest.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 class="aboutLanguage"><em><script type="text/javascript"> var _gaq = _gaq || []; _gaq.push(['_setAccount', 'UA-1149868-7']); _gaq.push(['_trackPageview']); (function() { var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true; ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js'; var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s); })(); </script></em></div>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev Class</li>
<li><a href="../../../../../org/eclipse/jetty/websocket/servlet/ServletUpgradeResponse.html" title="class in org.eclipse.jetty.websocket.servlet"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/eclipse/jetty/websocket/servlet/ServletUpgradeRequest.html" target="_top">Frames</a></li>
<li><a href="ServletUpgradeRequest.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.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>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_summary">Constr</a>&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><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 1995-2017 <a href="http://webtide.com">Webtide</a>. All Rights Reserved.</small></p>
</body>
</html>