Added:
tomcat/site/trunk/docs/tomcat-8.0-doc/servletapi/javax/servlet/http/HttpServletRequest.html
URL:
http://svn.apache.org/viewvc/tomcat/site/trunk/docs/tomcat-8.0-doc/servletapi/javax/servlet/http/HttpServletRequest.html?rev=1510665&view=auto
==============================================================================
---
tomcat/site/trunk/docs/tomcat-8.0-doc/servletapi/javax/servlet/http/HttpServletRequest.html
(added)
+++
tomcat/site/trunk/docs/tomcat-8.0-doc/servletapi/javax/servlet/http/HttpServletRequest.html
Mon Aug 5 19:10:09 2013
@@ -0,0 +1,1109 @@
+<!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_25) on Thu Aug 01 21:15:52 BST 2013
-->
+<title>HttpServletRequest (Servlet 3.0 API Documentation - Apache Tomcat
8.0.0-RC1)</title>
+<meta name="date" content="2013-08-01">
+<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="HttpServletRequest (Servlet 3.0 API
Documentation - Apache Tomcat 8.0.0-RC1)";
+ }
+//-->
+</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="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><b>Servlet 3.0 - Apache Tomcat
8.0.0-RC1</b></em></div>
+</div>
+<div class="subNav">
+<ul class="navList">
+<li><a href="../../../javax/servlet/http/HttpServlet.html" title="class in
javax.servlet.http"><span class="strong">Prev Class</span></a></li>
+<li><a href="../../../javax/servlet/http/HttpServletRequestWrapper.html"
title="class in javax.servlet.http"><span class="strong">Next
Class</span></a></li>
+</ul>
+<ul class="navList">
+<li><a href="../../../index.html?javax/servlet/http/HttpServletRequest.html"
target="_top">Frames</a></li>
+<li><a href="HttpServletRequest.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: </li>
+<li>Nested | </li>
+<li><a href="#field_summary">Field</a> | </li>
+<li>Constr | </li>
+<li><a href="#method_summary">Method</a></li>
+</ul>
+<ul class="subNavList">
+<li>Detail: </li>
+<li><a href="#field_detail">Field</a> | </li>
+<li>Constr | </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">javax.servlet.http</div>
+<h2 title="Interface HttpServletRequest" class="title">Interface
HttpServletRequest</h2>
+</div>
+<div class="contentContainer">
+<div class="description">
+<ul class="blockList">
+<li class="blockList">
+<dl>
+<dt>All Superinterfaces:</dt>
+<dd><a href="../../../javax/servlet/ServletRequest.html" title="interface in
javax.servlet">ServletRequest</a></dd>
+</dl>
+<dl>
+<dt>All Known Implementing Classes:</dt>
+<dd><a href="../../../javax/servlet/http/HttpServletRequestWrapper.html"
title="class in javax.servlet.http">HttpServletRequestWrapper</a></dd>
+</dl>
+<hr>
+<br>
+<pre>public interface <span class="strong">HttpServletRequest</span>
+extends <a href="../../../javax/servlet/ServletRequest.html" title="interface
in javax.servlet">ServletRequest</a></pre>
+<div class="block">Extends the <a
href="../../../javax/servlet/ServletRequest.html" title="interface in
javax.servlet"><code>ServletRequest</code></a> interface to provide request
+ information for HTTP servlets.
+ <p>
+ The servlet container creates an <code>HttpServletRequest</code> object and
+ passes it as an argument to the servlet's service methods
+ (<code>doGet</code>, <code>doPost</code>, etc).</div>
+</li>
+</ul>
+</div>
+<div class="summary">
+<ul class="blockList">
+<li class="blockList">
+<!-- =========== FIELD SUMMARY =========== -->
+<ul class="blockList">
+<li class="blockList"><a name="field_summary">
+<!-- -->
+</a>
+<h3>Field Summary</h3>
+<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0"
summary="Field Summary table, listing fields, and an explanation">
+<caption><span>Fields</span><span class="tabEnd"> </span></caption>
+<tr>
+<th class="colFirst" scope="col">Modifier and Type</th>
+<th class="colLast" scope="col">Field and Description</th>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>static java.lang.String</code></td>
+<td class="colLast"><code><strong><a
href="../../../javax/servlet/http/HttpServletRequest.html#BASIC_AUTH">BASIC_AUTH</a></strong></code>
+<div class="block">String identifier for Basic authentication.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>static java.lang.String</code></td>
+<td class="colLast"><code><strong><a
href="../../../javax/servlet/http/HttpServletRequest.html#CLIENT_CERT_AUTH">CLIENT_CERT_AUTH</a></strong></code>
+<div class="block">String identifier for Client Certificate
authentication.</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>static java.lang.String</code></td>
+<td class="colLast"><code><strong><a
href="../../../javax/servlet/http/HttpServletRequest.html#DIGEST_AUTH">DIGEST_AUTH</a></strong></code>
+<div class="block">String identifier for Digest authentication.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>static java.lang.String</code></td>
+<td class="colLast"><code><strong><a
href="../../../javax/servlet/http/HttpServletRequest.html#FORM_AUTH">FORM_AUTH</a></strong></code>
+<div class="block">String identifier for Form authentication.</div>
+</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"> </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>boolean</code></td>
+<td class="colLast"><code><strong><a
href="../../../javax/servlet/http/HttpServletRequest.html#authenticate(javax.servlet.http.HttpServletResponse)">authenticate</a></strong>(<a
href="../../../javax/servlet/http/HttpServletResponse.html" title="interface
in javax.servlet.http">HttpServletResponse</a> response)</code>
+<div class="block">Triggers the same authentication process as would be
triggered if the
+ request is for a resource that is protected by a security constraint.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>java.lang.String</code></td>
+<td class="colLast"><code><strong><a
href="../../../javax/servlet/http/HttpServletRequest.html#changeSessionId()">changeSessionId</a></strong>()</code>
+<div class="block">Changes the session ID of the session associated with this
request.</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>java.lang.String</code></td>
+<td class="colLast"><code><strong><a
href="../../../javax/servlet/http/HttpServletRequest.html#getAuthType()">getAuthType</a></strong>()</code>
+<div class="block">Returns the name of the authentication scheme used to
protect the
+ servlet.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>java.lang.String</code></td>
+<td class="colLast"><code><strong><a
href="../../../javax/servlet/http/HttpServletRequest.html#getContextPath()">getContextPath</a></strong>()</code>
+<div class="block">Returns the portion of the request URI that indicates the
context of the
+ request.</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code><a href="../../../javax/servlet/http/Cookie.html"
title="class in javax.servlet.http">Cookie</a>[]</code></td>
+<td class="colLast"><code><strong><a
href="../../../javax/servlet/http/HttpServletRequest.html#getCookies()">getCookies</a></strong>()</code>
+<div class="block">Returns an array containing all of the <code>Cookie</code>
objects the
+ client sent with this request.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>long</code></td>
+<td class="colLast"><code><strong><a
href="../../../javax/servlet/http/HttpServletRequest.html#getDateHeader(java.lang.String)">getDateHeader</a></strong>(java.lang.String name)</code>
+<div class="block">Returns the value of the specified request header as a
<code>long</code>
+ value that represents a <code>Date</code> object.</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>java.lang.String</code></td>
+<td class="colLast"><code><strong><a
href="../../../javax/servlet/http/HttpServletRequest.html#getHeader(java.lang.String)">getHeader</a></strong>(java.lang.String name)</code>
+<div class="block">Returns the value of the specified request header as a
+ <code>String</code>.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td
class="colFirst"><code>java.util.Enumeration<java.lang.String></code></td>
+<td class="colLast"><code><strong><a
href="../../../javax/servlet/http/HttpServletRequest.html#getHeaderNames()">getHeaderNames</a></strong>()</code>
+<div class="block">Returns an enumeration of all the header names this request
contains.</div>
+</td>
+</tr>
+<tr class="altColor">
+<td
class="colFirst"><code>java.util.Enumeration<java.lang.String></code></td>
+<td class="colLast"><code><strong><a
href="../../../javax/servlet/http/HttpServletRequest.html#getHeaders(java.lang.String)">getHeaders</a></strong>(java.lang.String name)</code>
+<div class="block">Returns all the values of the specified request header as an
+ <code>Enumeration</code> of <code>String</code> objects.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>int</code></td>
+<td class="colLast"><code><strong><a
href="../../../javax/servlet/http/HttpServletRequest.html#getIntHeader(java.lang.String)">getIntHeader</a></strong>(java.lang.String name)</code>
+<div class="block">Returns the value of the specified request header as an
<code>int</code>.</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>java.lang.String</code></td>
+<td class="colLast"><code><strong><a
href="../../../javax/servlet/http/HttpServletRequest.html#getMethod()">getMethod</a></strong>()</code>
+<div class="block">Returns the name of the HTTP method with which this request
was made, for
+ example, GET, POST, or PUT.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code><a href="../../../javax/servlet/http/Part.html"
title="interface in javax.servlet.http">Part</a></code></td>
+<td class="colLast"><code><strong><a
href="../../../javax/servlet/http/HttpServletRequest.html#getPart(java.lang.String)">getPart</a></strong>(java.lang.String name)</code>
+<div class="block">Gets the named Part or null if the Part does not
exist.</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>java.util.Collection<<a
href="../../../javax/servlet/http/Part.html" title="interface in
javax.servlet.http">Part</a>></code></td>
+<td class="colLast"><code><strong><a
href="../../../javax/servlet/http/HttpServletRequest.html#getParts()">getParts</a></strong>()</code>
+<div class="block">Return a collection of all uploaded Parts.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>java.lang.String</code></td>
+<td class="colLast"><code><strong><a
href="../../../javax/servlet/http/HttpServletRequest.html#getPathInfo()">getPathInfo</a></strong>()</code>
+<div class="block">Returns any extra path information associated with the URL
the client
+ sent when it made this request.</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>java.lang.String</code></td>
+<td class="colLast"><code><strong><a
href="../../../javax/servlet/http/HttpServletRequest.html#getPathTranslated()">getPathTranslated</a></strong>()</code>
+<div class="block">Returns any extra path information after the servlet name
but before the
+ query string, and translates it to a real path.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>java.lang.String</code></td>
+<td class="colLast"><code><strong><a
href="../../../javax/servlet/http/HttpServletRequest.html#getQueryString()">getQueryString</a></strong>()</code>
+<div class="block">Returns the query string that is contained in the request
URL after the
+ path.</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>java.lang.String</code></td>
+<td class="colLast"><code><strong><a
href="../../../javax/servlet/http/HttpServletRequest.html#getRemoteUser()">getRemoteUser</a></strong>()</code>
+<div class="block">Returns the login of the user making this request, if the
user has been
+ authenticated, or <code>null</code> if the user has not been
+ authenticated.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>java.lang.String</code></td>
+<td class="colLast"><code><strong><a
href="../../../javax/servlet/http/HttpServletRequest.html#getRequestedSessionId()">getRequestedSessionId</a></strong>()</code>
+<div class="block">Returns the session ID specified by the client.</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>java.lang.String</code></td>
+<td class="colLast"><code><strong><a
href="../../../javax/servlet/http/HttpServletRequest.html#getRequestURI()">getRequestURI</a></strong>()</code>
+<div class="block">Returns the part of this request's URL from the protocol
name up to the
+ query string in the first line of the HTTP request.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>java.lang.StringBuffer</code></td>
+<td class="colLast"><code><strong><a
href="../../../javax/servlet/http/HttpServletRequest.html#getRequestURL()">getRequestURL</a></strong>()</code>
+<div class="block">Reconstructs the URL the client used to make the
request.</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>java.lang.String</code></td>
+<td class="colLast"><code><strong><a
href="../../../javax/servlet/http/HttpServletRequest.html#getServletPath()">getServletPath</a></strong>()</code>
+<div class="block">Returns the part of this request's URL that calls the
servlet.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code><a
href="../../../javax/servlet/http/HttpSession.html" title="interface in
javax.servlet.http">HttpSession</a></code></td>
+<td class="colLast"><code><strong><a
href="../../../javax/servlet/http/HttpServletRequest.html#getSession()">getSession</a></strong>()</code>
+<div class="block">Returns the current session associated with this request,
or if the
+ request does not have a session, creates one.</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code><a
href="../../../javax/servlet/http/HttpSession.html" title="interface in
javax.servlet.http">HttpSession</a></code></td>
+<td class="colLast"><code><strong><a
href="../../../javax/servlet/http/HttpServletRequest.html#getSession(boolean)">getSession</a></strong>(boolean create)</code>
+<div class="block">Returns the current <code>HttpSession</code> associated
with this request
+ or, if there is no current session and <code>create</code> is true,
+ returns a new session.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>java.security.Principal</code></td>
+<td class="colLast"><code><strong><a
href="../../../javax/servlet/http/HttpServletRequest.html#getUserPrincipal()">getUserPrincipal</a></strong>()</code>
+<div class="block">Returns a <code>java.security.Principal</code> object
containing the name
+ of the current authenticated user.</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>boolean</code></td>
+<td class="colLast"><code><strong><a
href="../../../javax/servlet/http/HttpServletRequest.html#isRequestedSessionIdFromCookie()">isRequestedSessionIdFromCookie</a></strong>()</code>
+<div class="block">Checks whether the requested session ID came in as a
cookie.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>boolean</code></td>
+<td class="colLast"><code><strong><a
href="../../../javax/servlet/http/HttpServletRequest.html#isRequestedSessionIdFromUrl()">isRequestedSessionIdFromUrl</a></strong>()</code>
+<div class="block"><strong>Deprecated.</strong>
+<div class="block"><i>As of Version 2.1 of the Java Servlet API, use
+ <a
href="../../../javax/servlet/http/HttpServletRequest.html#isRequestedSessionIdFromURL()"><code>isRequestedSessionIdFromURL()</code></a>
instead.</i></div>
+</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>boolean</code></td>
+<td class="colLast"><code><strong><a
href="../../../javax/servlet/http/HttpServletRequest.html#isRequestedSessionIdFromURL()">isRequestedSessionIdFromURL</a></strong>()</code>
+<div class="block">Checks whether the requested session ID came in as part of
the request
+ URL.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>boolean</code></td>
+<td class="colLast"><code><strong><a
href="../../../javax/servlet/http/HttpServletRequest.html#isRequestedSessionIdValid()">isRequestedSessionIdValid</a></strong>()</code>
+<div class="block">Checks whether the requested session ID is still
valid.</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>boolean</code></td>
+<td class="colLast"><code><strong><a
href="../../../javax/servlet/http/HttpServletRequest.html#isUserInRole(java.lang.String)">isUserInRole</a></strong>(java.lang.String role)</code>
+<div class="block">Returns a boolean indicating whether the authenticated user
is included
+ in the specified logical "role".</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><strong><a
href="../../../javax/servlet/http/HttpServletRequest.html#login(java.lang.String,
java.lang.String)">login</a></strong>(java.lang.String username,
+ java.lang.String password)</code>
+<div class="block">Authenticate the provided user name and password and then
associated the
+ authenticated user with the request.</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><strong><a
href="../../../javax/servlet/http/HttpServletRequest.html#logout()">logout</a></strong>()</code>
+<div class="block">Removes any authenticated user from the request.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code><T extends <a
href="../../../javax/servlet/http/HttpUpgradeHandler.html" title="interface in
javax.servlet.http">HttpUpgradeHandler</a>> <br>T</code></td>
+<td class="colLast"><code><strong><a
href="../../../javax/servlet/http/HttpServletRequest.html#upgrade(java.lang.Class)">upgrade</a></strong>(java.lang.Class<T> httpUpgradeHandlerClass)</code>
+<div class="block">Start the HTTP upgrade process and pass the connection to
the provided
+ protocol handler once the current request/response pair has completed
+ processing.</div>
+</td>
+</tr>
+</table>
+<ul class="blockList">
+<li class="blockList"><a
name="methods_inherited_from_class_javax.servlet.ServletRequest">
+<!-- -->
+</a>
+<h3>Methods inherited from interface javax.servlet.<a
href="../../../javax/servlet/ServletRequest.html" title="interface in
javax.servlet">ServletRequest</a></h3>
+<code><a
href="../../../javax/servlet/ServletRequest.html#getAsyncContext()">getAsyncContext</a>,
<a
href="../../../javax/servlet/ServletRequest.html#getAttribute(java.lang.String)">getAttribute</a>,
<a
href="../../../javax/servlet/ServletRequest.html#getAttributeNames()">getAttributeNames</a>,
<a
href="../../../javax/servlet/ServletRequest.html#getCharacterEncoding()">getCharacterEncoding</a>,
<a
href="../../../javax/servlet/ServletRequest.html#getContentLength()">getContentLength</a>,
<a
href="../../../javax/servlet/ServletRequest.html#getContentLengthLong()">getContentLengthLong</a>,
<a
href="../../../javax/servlet/ServletRequest.html#getContentType()">getContentType</a>,
<a
href="../../../javax/servlet/ServletRequest.html#getDispatcherType()">getDispatcherType</a>,
<a
href="../../../javax/servlet/ServletRequest.html#getInputStream()">getInputStream</a>,
<a
href="../../../javax/servlet/ServletRequest.html#getLocalAddr()">getLocalAddr</a>,
<a href="../../../javax/servlet/ServletRe
quest.html#getLocale()">getLocale</a>, <a
href="../../../javax/servlet/ServletRequest.html#getLocales()">getLocales</a>,
<a
href="../../../javax/servlet/ServletRequest.html#getLocalName()">getLocalName</a>,
<a
href="../../../javax/servlet/ServletRequest.html#getLocalPort()">getLocalPort</a>,
<a
href="../../../javax/servlet/ServletRequest.html#getParameter(java.lang.String)">getParameter</a>,
<a
href="../../../javax/servlet/ServletRequest.html#getParameterMap()">getParameterMap</a>,
<a
href="../../../javax/servlet/ServletRequest.html#getParameterNames()">getParameterNames</a>,
<a
href="../../../javax/servlet/ServletRequest.html#getParameterValues(java.lang.String)">getParameterValues</a>,
<a
href="../../../javax/servlet/ServletRequest.html#getProtocol()">getProtocol</a>,
<a
href="../../../javax/servlet/ServletRequest.html#getReader()">getReader</a>, <a
href="../../../javax/servlet/ServletRequest.html#getRealPath(java.lang.String)">getRealPath</a>,
<a href="../../../javax/servlet/Serv
letRequest.html#getRemoteAddr()">getRemoteAddr</a>, <a
href="../../../javax/servlet/ServletRequest.html#getRemoteHost()">getRemoteHost</a>,
<a
href="../../../javax/servlet/ServletRequest.html#getRemotePort()">getRemotePort</a>,
<a
href="../../../javax/servlet/ServletRequest.html#getRequestDispatcher(java.lang.String)">getRequestDispatcher</a>,
<a
href="../../../javax/servlet/ServletRequest.html#getScheme()">getScheme</a>, <a
href="../../../javax/servlet/ServletRequest.html#getServerName()">getServerName</a>,
<a
href="../../../javax/servlet/ServletRequest.html#getServerPort()">getServerPort</a>,
<a
href="../../../javax/servlet/ServletRequest.html#getServletContext()">getServletContext</a>,
<a
href="../../../javax/servlet/ServletRequest.html#isAsyncStarted()">isAsyncStarted</a>,
<a
href="../../../javax/servlet/ServletRequest.html#isAsyncSupported()">isAsyncSupported</a>,
<a href="../../../javax/servlet/ServletRequest.html#isSecure()">isSecure</a>,
<a href="../../../javax/servlet/Servl
etRequest.html#removeAttribute(java.lang.String)">removeAttribute</a>, <a
href="../../../javax/servlet/ServletRequest.html#setAttribute(java.lang.String,
java.lang.Object)">setAttribute</a>, <a
href="../../../javax/servlet/ServletRequest.html#setCharacterEncoding(java.lang.String)">setCharacterEncoding</a>,
<a
href="../../../javax/servlet/ServletRequest.html#startAsync()">startAsync</a>,
<a
href="../../../javax/servlet/ServletRequest.html#startAsync(javax.servlet.ServletRequest,
javax.servlet.ServletResponse)">startAsync</a></code></li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+</div>
+<div class="details">
+<ul class="blockList">
+<li class="blockList">
+<!-- ============ FIELD DETAIL =========== -->
+<ul class="blockList">
+<li class="blockList"><a name="field_detail">
+<!-- -->
+</a>
+<h3>Field Detail</h3>
+<a name="BASIC_AUTH">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>BASIC_AUTH</h4>
+<pre>static final java.lang.String BASIC_AUTH</pre>
+<div class="block">String identifier for Basic authentication. Value
"BASIC"</div>
+<dl><dt><span class="strong">See Also:</span></dt><dd><a
href="../../../constant-values.html#javax.servlet.http.HttpServletRequest.BASIC_AUTH">Constant
Field Values</a></dd></dl>
+</li>
+</ul>
+<a name="FORM_AUTH">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>FORM_AUTH</h4>
+<pre>static final java.lang.String FORM_AUTH</pre>
+<div class="block">String identifier for Form authentication. Value
"FORM"</div>
+<dl><dt><span class="strong">See Also:</span></dt><dd><a
href="../../../constant-values.html#javax.servlet.http.HttpServletRequest.FORM_AUTH">Constant
Field Values</a></dd></dl>
+</li>
+</ul>
+<a name="CLIENT_CERT_AUTH">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>CLIENT_CERT_AUTH</h4>
+<pre>static final java.lang.String CLIENT_CERT_AUTH</pre>
+<div class="block">String identifier for Client Certificate authentication.
Value
+ "CLIENT_CERT"</div>
+<dl><dt><span class="strong">See Also:</span></dt><dd><a
href="../../../constant-values.html#javax.servlet.http.HttpServletRequest.CLIENT_CERT_AUTH">Constant
Field Values</a></dd></dl>
+</li>
+</ul>
+<a name="DIGEST_AUTH">
+<!-- -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>DIGEST_AUTH</h4>
+<pre>static final java.lang.String DIGEST_AUTH</pre>
+<div class="block">String identifier for Digest authentication. Value
"DIGEST"</div>
+<dl><dt><span class="strong">See Also:</span></dt><dd><a
href="../../../constant-values.html#javax.servlet.http.HttpServletRequest.DIGEST_AUTH">Constant
Field Values</a></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="getAuthType()">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getAuthType</h4>
+<pre>java.lang.String getAuthType()</pre>
+<div class="block">Returns the name of the authentication scheme used to
protect the
+ servlet. All servlet containers support basic, form and client
+ certificate authentication, and may additionally support digest
+ authentication. If the servlet is not authenticated <code>null</code> is
+ returned.
+ <p>
+ Same as the value of the CGI variable AUTH_TYPE.</div>
+<dl><dt><span class="strong">Returns:</span></dt><dd>one of the static members
BASIC_AUTH, FORM_AUTH, CLIENT_CERT_AUTH,
+ DIGEST_AUTH (suitable for == comparison) or the
+ container-specific string indicating the authentication scheme,
+ or <code>null</code> if the request was not authenticated.</dd></dl>
+</li>
+</ul>
+<a name="getCookies()">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getCookies</h4>
+<pre><a href="../../../javax/servlet/http/Cookie.html" title="class in
javax.servlet.http">Cookie</a>[] getCookies()</pre>
+<div class="block">Returns an array containing all of the <code>Cookie</code>
objects the
+ client sent with this request. This method returns <code>null</code> if
+ no cookies were sent.</div>
+<dl><dt><span class="strong">Returns:</span></dt><dd>an array of all the
<code>Cookies</code> included with this
+ request, or <code>null</code> if the request has no cookies</dd></dl>
+</li>
+</ul>
+<a name="getDateHeader(java.lang.String)">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getDateHeader</h4>
+<pre>long getDateHeader(java.lang.String name)</pre>
+<div class="block">Returns the value of the specified request header as a
<code>long</code>
+ value that represents a <code>Date</code> object. Use this method with
+ headers that contain dates, such as <code>If-Modified-Since</code>.
+ <p>
+ The date is returned as the number of milliseconds since January 1, 1970
+ GMT. The header name is case insensitive.
+ <p>
+ If the request did not have a header of the specified name, this method
+ returns -1. If the header can't be converted to a date, the method throws
+ an <code>IllegalArgumentException</code>.</div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - a
<code>String</code> specifying the name of the header</dd>
+<dt><span class="strong">Returns:</span></dt><dd>a <code>long</code> value
representing the date specified in the
+ header expressed as the number of milliseconds since January 1,
+ 1970 GMT, or -1 if the named header was not included with the
+ request</dd>
+<dt><span class="strong">Throws:</span></dt>
+<dd><code>java.lang.IllegalArgumentException</code> - If the header value
can't be converted to a date</dd></dl>
+</li>
+</ul>
+<a name="getHeader(java.lang.String)">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getHeader</h4>
+<pre>java.lang.String getHeader(java.lang.String name)</pre>
+<div class="block">Returns the value of the specified request header as a
+ <code>String</code>. If the request did not include a header of the
+ specified name, this method returns <code>null</code>. If there are
+ multiple headers with the same name, this method returns the first head
+ in the request. The header name is case insensitive. You can use this
+ method with any request header.</div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - a
<code>String</code> specifying the header name</dd>
+<dt><span class="strong">Returns:</span></dt><dd>a <code>String</code>
containing the value of the requested
+ header, or <code>null</code> if the request does not have a
+ header of that name</dd></dl>
+</li>
+</ul>
+<a name="getHeaders(java.lang.String)">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getHeaders</h4>
+<pre>java.util.Enumeration<java.lang.String> getHeaders(java.lang.String name)</pre>
+<div class="block">Returns all the values of the specified request header as an
+ <code>Enumeration</code> of <code>String</code> objects.
+ <p>
+ Some headers, such as <code>Accept-Language</code> can be sent by clients
+ as several headers each with a different value rather than sending the
+ header as a comma separated list.
+ <p>
+ If the request did not include any headers of the specified name, this
+ method returns an empty <code>Enumeration</code>. The header name is case
+ insensitive. You can use this method with any request header.</div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - a
<code>String</code> specifying the header name</dd>
+<dt><span class="strong">Returns:</span></dt><dd>an <code>Enumeration</code>
containing the values of the requested
+ header. If the request does not have any headers of that name
+ return an empty enumeration. If the container does not allow
+ access to header information, return null</dd></dl>
+</li>
+</ul>
+<a name="getHeaderNames()">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getHeaderNames</h4>
+<pre>java.util.Enumeration<java.lang.String> getHeaderNames()</pre>
+<div class="block">Returns an enumeration of all the header names this request
contains. If
+ the request has no headers, this method returns an empty enumeration.
+ <p>
+ Some servlet containers do not allow servlets to access headers using
+ this method, in which case this method returns <code>null</code></div>
+<dl><dt><span class="strong">Returns:</span></dt><dd>an enumeration of all the
header names sent with this request; if
+ the request has no headers, an empty enumeration; if the servlet
+ container does not allow servlets to use this method,
+ <code>null</code></dd></dl>
+</li>
+</ul>
+<a name="getIntHeader(java.lang.String)">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getIntHeader</h4>
+<pre>int getIntHeader(java.lang.String name)</pre>
+<div class="block">Returns the value of the specified request header as an
<code>int</code>.
+ If the request does not have a header of the specified name, this method
+ returns -1. If the header cannot be converted to an integer, this method
+ throws a <code>NumberFormatException</code>.
+ <p>
+ The header name is case insensitive.</div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - a
<code>String</code> specifying the name of a request header</dd>
+<dt><span class="strong">Returns:</span></dt><dd>an integer expressing the
value of the request header or -1 if the
+ request doesn't have a header of this name</dd>
+<dt><span class="strong">Throws:</span></dt>
+<dd><code>java.lang.NumberFormatException</code> - If the header value can't
be converted to an
+ <code>int</code></dd></dl>
+</li>
+</ul>
+<a name="getMethod()">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getMethod</h4>
+<pre>java.lang.String getMethod()</pre>
+<div class="block">Returns the name of the HTTP method with which this request
was made, for
+ example, GET, POST, or PUT. Same as the value of the CGI variable
+ REQUEST_METHOD.</div>
+<dl><dt><span class="strong">Returns:</span></dt><dd>a <code>String</code>
specifying the name of the method with
+ which this request was made</dd></dl>
+</li>
+</ul>
+<a name="getPathInfo()">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getPathInfo</h4>
+<pre>java.lang.String getPathInfo()</pre>
+<div class="block">Returns any extra path information associated with the URL
the client
+ sent when it made this request. The extra path information follows the
+ servlet path but precedes the query string and will start with a "/"
+ character.
+ <p>
+ This method returns <code>null</code> if there was no extra path
+ information.
+ <p>
+ Same as the value of the CGI variable PATH_INFO.</div>
+<dl><dt><span class="strong">Returns:</span></dt><dd>a <code>String</code>,
decoded by the web container, specifying
+ extra path information that comes after the servlet path but
+ before the query string in the request URL; or <code>null</code>
+ if the URL does not have any extra path information</dd></dl>
+</li>
+</ul>
+<a name="getPathTranslated()">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getPathTranslated</h4>
+<pre>java.lang.String getPathTranslated()</pre>
+<div class="block">Returns any extra path information after the servlet name
but before the
+ query string, and translates it to a real path. Same as the value of the
+ CGI variable PATH_TRANSLATED.
+ <p>
+ If the URL does not have any extra path information, this method returns
+ <code>null</code> or the servlet container cannot translate the virtual
+ path to a real path for any reason (such as when the web application is
+ executed from an archive). The web container does not decode this
string.</div>
+<dl><dt><span class="strong">Returns:</span></dt><dd>a <code>String</code>
specifying the real path, or
+ <code>null</code> if the URL does not have any extra path
+ information</dd></dl>
+</li>
+</ul>
+<a name="getContextPath()">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getContextPath</h4>
+<pre>java.lang.String getContextPath()</pre>
+<div class="block">Returns the portion of the request URI that indicates the
context of the
+ request. The context path always comes first in a request URI. The path
+ starts with a "/" character but does not end with a "/" character. For
+ servlets in the default (root) context, this method returns "". The
+ container does not decode this string.</div>
+<dl><dt><span class="strong">Returns:</span></dt><dd>a <code>String</code>
specifying the portion of the request URI
+ that indicates the context of the request</dd></dl>
+</li>
+</ul>
+<a name="getQueryString()">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getQueryString</h4>
+<pre>java.lang.String getQueryString()</pre>
+<div class="block">Returns the query string that is contained in the request
URL after the
+ path. This method returns <code>null</code> if the URL does not have a
+ query string. Same as the value of the CGI variable QUERY_STRING.</div>
+<dl><dt><span class="strong">Returns:</span></dt><dd>a <code>String</code>
containing the query string or
+ <code>null</code> if the URL contains no query string. The value
+ is not decoded by the container.</dd></dl>
+</li>
+</ul>
+<a name="getRemoteUser()">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getRemoteUser</h4>
+<pre>java.lang.String getRemoteUser()</pre>
+<div class="block">Returns the login of the user making this request, if the
user has been
+ authenticated, or <code>null</code> if the user has not been
+ authenticated. Whether the user name is sent with each subsequent request
+ depends on the browser and type of authentication. Same as the value of
+ the CGI variable REMOTE_USER.</div>
+<dl><dt><span class="strong">Returns:</span></dt><dd>a <code>String</code>
specifying the login of the user making
+ this request, or <code>null</code> if the user login is not
known</dd></dl>
+</li>
+</ul>
+<a name="isUserInRole(java.lang.String)">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>isUserInRole</h4>
+<pre>boolean isUserInRole(java.lang.String role)</pre>
+<div class="block">Returns a boolean indicating whether the authenticated user
is included
+ in the specified logical "role". Roles and role membership can be defined
+ using deployment descriptors. If the user has not been authenticated, the
+ method returns <code>false</code>.</div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>role</code> - a
<code>String</code> specifying the name of the role</dd>
+<dt><span class="strong">Returns:</span></dt><dd>a <code>boolean</code>
indicating whether the user making this
+ request belongs to a given role; <code>false</code> if the user
+ has not been authenticated</dd></dl>
+</li>
+</ul>
+<a name="getUserPrincipal()">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getUserPrincipal</h4>
+<pre>java.security.Principal getUserPrincipal()</pre>
+<div class="block">Returns a <code>java.security.Principal</code> object
containing the name
+ of the current authenticated user. If the user has not been
+ authenticated, the method returns <code>null</code>.</div>
+<dl><dt><span class="strong">Returns:</span></dt><dd>a
<code>java.security.Principal</code> containing the name of the
+ user making this request; <code>null</code> if the user has not
+ been authenticated</dd></dl>
+</li>
+</ul>
+<a name="getRequestedSessionId()">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getRequestedSessionId</h4>
+<pre>java.lang.String getRequestedSessionId()</pre>
+<div class="block">Returns the session ID specified by the client. This may
not be the same
+ as the ID of the current valid session for this request. If the client
+ did not specify a session ID, this method returns <code>null</code>.</div>
+<dl><dt><span class="strong">Returns:</span></dt><dd>a <code>String</code>
specifying the session ID, or
+ <code>null</code> if the request did not specify a session
ID</dd><dt><span class="strong">See Also:</span></dt><dd><a
href="../../../javax/servlet/http/HttpServletRequest.html#isRequestedSessionIdValid()"><code>isRequestedSessionIdValid()</code></a></dd></dl>
+</li>
+</ul>
+<a name="getRequestURI()">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getRequestURI</h4>
+<pre>java.lang.String getRequestURI()</pre>
+<div class="block">Returns the part of this request's URL from the protocol
name up to the
+ query string in the first line of the HTTP request. The web container
+ does not decode this String. For example:
+ <table summary="Examples of Returned Values">
+ <tr align=left>
+ <th>First line of HTTP request</th>
+ <th>Returned Value</th>
+ <tr>
+ <td>POST /some/path.html HTTP/1.1
+ <td>
+ <td>/some/path.html
+ <tr>
+ <td>GET http://foo.bar/a.html HTTP/1.0
+ <td>
+ <td>/a.html
+ <tr>
+ <td>HEAD /xyz?a=b HTTP/1.1
+ <td>
+ <td>/xyz
+ </table>
+ <p>
+ To reconstruct an URL with a scheme and host, use
+ <a
href="../../../javax/servlet/http/HttpServletRequest.html#getRequestURL()"><code>getRequestURL()</code></a>.</div>
+<dl><dt><span class="strong">Returns:</span></dt><dd>a <code>String</code>
containing the part of the URL from the
+ protocol name up to the query string</dd><dt><span class="strong">See
Also:</span></dt><dd><a
href="../../../javax/servlet/http/HttpServletRequest.html#getRequestURL()"><code>getRequestURL()</code></a></dd></dl>
+</li>
+</ul>
+<a name="getRequestURL()">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getRequestURL</h4>
+<pre>java.lang.StringBuffer getRequestURL()</pre>
+<div class="block">Reconstructs the URL the client used to make the request.
The returned
+ URL contains a protocol, server name, port number, and server path, but
+ it does not include query string parameters.
+ <p>
+ Because this method returns a <code>StringBuffer</code>, not a string,
+ you can modify the URL easily, for example, to append query parameters.
+ <p>
+ This method is useful for creating redirect messages and for reporting
+ errors.</div>
+<dl><dt><span class="strong">Returns:</span></dt><dd>a
<code>StringBuffer</code> object containing the reconstructed
+ URL</dd></dl>
+</li>
+</ul>
+<a name="getServletPath()">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getServletPath</h4>
+<pre>java.lang.String getServletPath()</pre>
+<div class="block">Returns the part of this request's URL that calls the
servlet. This path
+ starts with a "/" character and includes either the servlet name or a
+ path to the servlet, but does not include any extra path information or a
+ query string. Same as the value of the CGI variable SCRIPT_NAME.
+ <p>
+ This method will return an empty string ("") if the servlet used to
+ process this request was matched using the "/*" pattern.</div>
+<dl><dt><span class="strong">Returns:</span></dt><dd>a <code>String</code>
containing the name or path of the servlet
+ being called, as specified in the request URL, decoded, or an
+ empty string if the servlet used to process the request is
+ matched using the "/*" pattern.</dd></dl>
+</li>
+</ul>
+<a name="getSession(boolean)">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getSession</h4>
+<pre><a href="../../../javax/servlet/http/HttpSession.html" title="interface
in
javax.servlet.http">HttpSession</a> getSession(boolean create)</pre>
+<div class="block">Returns the current <code>HttpSession</code> associated
with this request
+ or, if there is no current session and <code>create</code> is true,
+ returns a new session.
+ <p>
+ If <code>create</code> is <code>false</code> and the request has no valid
+ <code>HttpSession</code>, this method returns <code>null</code>.
+ <p>
+ To make sure the session is properly maintained, you must call this
+ method before the response is committed. If the container is using
+ cookies to maintain session integrity and is asked to create a new
+ session when the response is committed, an IllegalStateException is
+ thrown.</div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>create</code> -
<code>true</code> to create a new session for this request if
+ necessary; <code>false</code> to return <code>null</code> if
+ there's no current session</dd>
+<dt><span class="strong">Returns:</span></dt><dd>the <code>HttpSession</code>
associated with this request or
+ <code>null</code> if <code>create</code> is <code>false</code>
+ and the request has no valid session</dd><dt><span class="strong">See
Also:</span></dt><dd><a
href="../../../javax/servlet/http/HttpServletRequest.html#getSession()"><code>getSession()</code></a></dd></dl>
+</li>
+</ul>
+<a name="getSession()">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getSession</h4>
+<pre><a href="../../../javax/servlet/http/HttpSession.html" title="interface
in javax.servlet.http">HttpSession</a> getSession()</pre>
+<div class="block">Returns the current session associated with this request,
or if the
+ request does not have a session, creates one.</div>
+<dl><dt><span class="strong">Returns:</span></dt><dd>the
<code>HttpSession</code> associated with this request</dd><dt><span
class="strong">See Also:</span></dt><dd><a
href="../../../javax/servlet/http/HttpServletRequest.html#getSession(boolean)"><code>getSession(boolean)</code></a></dd></dl>
+</li>
+</ul>
+<a name="changeSessionId()">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>changeSessionId</h4>
+<pre>java.lang.String changeSessionId()</pre>
+<div class="block">Changes the session ID of the session associated with this
request. This
+ method does not create a new session object it only changes the ID of the
+ current session.</div>
+<dl><dt><span class="strong">Returns:</span></dt><dd>the new session ID
allocated to the session</dd><dt><span class="strong">Since:</span></dt>
+ <dd>Servlet 3.1</dd>
+<dt><span class="strong">See Also:</span></dt><dd><a
href="../../../javax/servlet/http/HttpSessionIdListener.html" title="interface
in javax.servlet.http"><code>HttpSessionIdListener</code></a></dd></dl>
+</li>
+</ul>
+<a name="isRequestedSessionIdValid()">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>isRequestedSessionIdValid</h4>
+<pre>boolean isRequestedSessionIdValid()</pre>
+<div class="block">Checks whether the requested session ID is still
valid.</div>
+<dl><dt><span class="strong">Returns:</span></dt><dd><code>true</code> if this
request has an id for a valid session
+ in the current session context; <code>false</code>
otherwise</dd><dt><span class="strong">See Also:</span></dt><dd><a
href="../../../javax/servlet/http/HttpServletRequest.html#getRequestedSessionId()"><code>getRequestedSessionId()</code></a>,
+<a
href="../../../javax/servlet/http/HttpServletRequest.html#getSession(boolean)"><code>getSession(boolean)</code></a></dd></dl>
+</li>
+</ul>
+<a name="isRequestedSessionIdFromCookie()">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>isRequestedSessionIdFromCookie</h4>
+<pre>boolean isRequestedSessionIdFromCookie()</pre>
+<div class="block">Checks whether the requested session ID came in as a
cookie.</div>
+<dl><dt><span class="strong">Returns:</span></dt><dd><code>true</code> if the
session ID came in as a cookie;
+ otherwise, <code>false</code></dd><dt><span class="strong">See
Also:</span></dt><dd><a
href="../../../javax/servlet/http/HttpServletRequest.html#getSession(boolean)"><code>getSession(boolean)</code></a></dd></dl>
+</li>
+</ul>
+<a name="isRequestedSessionIdFromURL()">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>isRequestedSessionIdFromURL</h4>
+<pre>boolean isRequestedSessionIdFromURL()</pre>
+<div class="block">Checks whether the requested session ID came in as part of
the request
+ URL.</div>
+<dl><dt><span class="strong">Returns:</span></dt><dd><code>true</code> if the
session ID came in as part of a URL;
+ otherwise, <code>false</code></dd><dt><span class="strong">See
Also:</span></dt><dd><a
href="../../../javax/servlet/http/HttpServletRequest.html#getSession(boolean)"><code>getSession(boolean)</code></a></dd></dl>
+</li>
+</ul>
+<a name="isRequestedSessionIdFromUrl()">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>isRequestedSessionIdFromUrl</h4>
+<pre>boolean isRequestedSessionIdFromUrl()</pre>
+<div class="block"><span class="strong">Deprecated.</span> <i>As of
Version 2.1 of the Java Servlet API, use
+ <a
href="../../../javax/servlet/http/HttpServletRequest.html#isRequestedSessionIdFromURL()"><code>isRequestedSessionIdFromURL()</code></a>
instead.</i></div>
+</li>
+</ul>
+<a name="authenticate(javax.servlet.http.HttpServletResponse)">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>authenticate</h4>
+<pre>boolean authenticate(<a
href="../../../javax/servlet/http/HttpServletResponse.html" title="interface in
javax.servlet.http">HttpServletResponse</a> response)
+ throws java.io.IOException,
+ <a
href="../../../javax/servlet/ServletException.html" title="class in
javax.servlet">ServletException</a></pre>
+<div class="block">Triggers the same authentication process as would be
triggered if the
+ request is for a resource that is protected by a security constraint.</div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>response</code>
- The response to use to return any authentication
+ challenge</dd>
+<dt><span class="strong">Returns:</span></dt><dd><code>true</code> if the user
is successfully authenticated and
+ <code>false</code> if not</dd>
+<dt><span class="strong">Throws:</span></dt>
+<dd><code>java.io.IOException</code></dd>
+<dd><code><a href="../../../javax/servlet/ServletException.html" title="class
in javax.servlet">ServletException</a></code></dd><dt><span
class="strong">Since:</span></dt>
+ <dd>Servlet 3.0</dd></dl>
+</li>
+</ul>
+<a name="login(java.lang.String, java.lang.String)">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>login</h4>
+<pre>void login(java.lang.String username,
+ java.lang.String password)
+ throws <a href="../../../javax/servlet/ServletException.html"
title="class in javax.servlet">ServletException</a></pre>
+<div class="block">Authenticate the provided user name and password and then
associated the
+ authenticated user with the request.</div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>username</code>
- The user name to authenticate</dd><dd><code>password</code> - The password to
use to authenticate the user</dd>
+<dt><span class="strong">Throws:</span></dt>
+<dd><code><a href="../../../javax/servlet/ServletException.html" title="class
in javax.servlet">ServletException</a></code> - If any of <a
href="../../../javax/servlet/http/HttpServletRequest.html#getRemoteUser()"><code>getRemoteUser()</code></a>,
+ <a
href="../../../javax/servlet/http/HttpServletRequest.html#getUserPrincipal()"><code>getUserPrincipal()</code></a>
or <a
href="../../../javax/servlet/http/HttpServletRequest.html#getAuthType()"><code>getAuthType()</code></a>
are
+ non-null, if the configured authenticator does not support
+ user name and password authentication or if the
+ authentication fails</dd><dt><span
class="strong">Since:</span></dt>
+ <dd>Servlet 3.0</dd></dl>
+</li>
+</ul>
+<a name="logout()">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>logout</h4>
+<pre>void logout()
+ throws <a href="../../../javax/servlet/ServletException.html"
title="class in javax.servlet">ServletException</a></pre>
+<div class="block">Removes any authenticated user from the request.</div>
+<dl><dt><span class="strong">Throws:</span></dt>
+<dd><code><a href="../../../javax/servlet/ServletException.html" title="class
in javax.servlet">ServletException</a></code> - If the logout
fails</dd><dt><span class="strong">Since:</span></dt>
+ <dd>Servlet 3.0</dd></dl>
+</li>
+</ul>
+<a name="getParts()">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getParts</h4>
+<pre>java.util.Collection<<a href="../../../javax/servlet/http/Part.html"
title="interface in javax.servlet.http">Part</a>> getParts()
+ throws java.io.IOException,
+ <a
href="../../../javax/servlet/ServletException.html" title="class in
javax.servlet">ServletException</a></pre>
+<div class="block">Return a collection of all uploaded Parts.</div>
+<dl><dt><span class="strong">Returns:</span></dt><dd>A collection of all
uploaded Parts.</dd>
+<dt><span class="strong">Throws:</span></dt>
+<dd><code>java.io.IOException</code> - if an I/O error occurs</dd>
+<dd><code>java.lang.IllegalStateException</code> - if size limits are
exceeded</dd>
+<dd><code><a href="../../../javax/servlet/ServletException.html" title="class
in javax.servlet">ServletException</a></code> - if the request is not
multipart/form-data</dd><dt><span class="strong">Since:</span></dt>
+ <dd>Servlet 3.0</dd></dl>
+</li>
+</ul>
+<a name="getPart(java.lang.String)">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getPart</h4>
+<pre><a href="../../../javax/servlet/http/Part.html" title="interface in
javax.servlet.http">Part</a> getPart(java.lang.String name)
+ throws java.io.IOException,
+ <a href="../../../javax/servlet/ServletException.html"
title="class in javax.servlet">ServletException</a></pre>
+<div class="block">Gets the named Part or null if the Part does not exist.
Triggers upload
+ of all Parts.</div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> -
</dd>
+<dt><span class="strong">Returns:</span></dt><dd>The named Part or null if the
Part does not exist</dd>
+<dt><span class="strong">Throws:</span></dt>
+<dd><code>java.io.IOException</code> - if an I/O error occurs</dd>
+<dd><code>java.lang.IllegalStateException</code> - if size limits are
exceeded</dd>
+<dd><code><a href="../../../javax/servlet/ServletException.html" title="class
in javax.servlet">ServletException</a></code> - if the request is not
multipart/form-data</dd><dt><span class="strong">Since:</span></dt>
+ <dd>Servlet 3.0</dd></dl>
+</li>
+</ul>
+<a name="upgrade(java.lang.Class)">
+<!-- -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>upgrade</h4>
+<pre><T extends <a
href="../../../javax/servlet/http/HttpUpgradeHandler.html" title="interface in
javax.servlet.http">HttpUpgradeHandler</a>> T upgrade(java.lang.Class<T> httpUpgradeHandlerClass)
+ throws java.io.IOException,
+ <a
href="../../../javax/servlet/ServletException.html" title="class in
javax.servlet">ServletException</a></pre>
+<div class="block">Start the HTTP upgrade process and pass the connection to
the provided
+ protocol handler once the current request/response pair has completed
+ processing. Calling this method sets the response status to <a
href="../../../javax/servlet/http/HttpServletResponse.html#SC_SWITCHING_PROTOCOLS"><code>HttpServletResponse.SC_SWITCHING_PROTOCOLS</code></a>
and flushes the response.
+ Protocol specific headers must have already been set before this method
+ is called.</div>
+<dl><dt><span class="strong">Throws:</span></dt>
+<dd><code>java.io.IOException</code> - if an I/O error occurred during the
upgrade</dd>
+<dd><code><a href="../../../javax/servlet/ServletException.html" title="class
in javax.servlet">ServletException</a></code> - if the given
httpUpgradeHandlerClass fails to be instantiated</dd><dt><span
class="strong">Since:</span></dt>
+ <dd>Servlet 3.1</dd></dl>
+</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="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><b>Servlet 3.0 - Apache Tomcat
8.0.0-RC1</b></em></div>
+</div>
+<div class="subNav">
+<ul class="navList">
+<li><a href="../../../javax/servlet/http/HttpServlet.html" title="class in
javax.servlet.http"><span class="strong">Prev Class</span></a></li>
+<li><a href="../../../javax/servlet/http/HttpServletRequestWrapper.html"
title="class in javax.servlet.http"><span class="strong">Next
Class</span></a></li>
+</ul>
+<ul class="navList">
+<li><a href="../../../index.html?javax/servlet/http/HttpServletRequest.html"
target="_top">Frames</a></li>
+<li><a href="HttpServletRequest.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: </li>
+<li>Nested | </li>
+<li><a href="#field_summary">Field</a> | </li>
+<li>Constr | </li>
+<li><a href="#method_summary">Method</a></li>
+</ul>
+<ul class="subNavList">
+<li>Detail: </li>
+<li><a href="#field_detail">Field</a> | </li>
+<li>Constr | </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 © 2000-2013 Apache Software
Foundation. All Rights Reserved.</small></p>
+</body>
+</html>
Propchange:
tomcat/site/trunk/docs/tomcat-8.0-doc/servletapi/javax/servlet/http/HttpServletRequest.html
------------------------------------------------------------------------------
svn:eol-style = native
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscr...@tomcat.apache.org
For additional commands, e-mail: dev-h...@tomcat.apache.org
