You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@tomcat.apache.org by ma...@apache.org on 2013/08/05 21:10:11 UTC
svn commit: r1510665 [22/26] - in
/tomcat/site/trunk/docs/tomcat-8.0-doc/servletapi: ./ javax/ javax/servlet/
javax/servlet/annotation/ javax/servlet/descriptor/ javax/servlet/http/
resources/
Added: tomcat/site/trunk/docs/tomcat-8.0-doc/servletapi/javax/servlet/http/HttpServletResponseWrapper.html
URL: http://svn.apache.org/viewvc/tomcat/site/trunk/docs/tomcat-8.0-doc/servletapi/javax/servlet/http/HttpServletResponseWrapper.html?rev=1510665&view=auto
==============================================================================
--- tomcat/site/trunk/docs/tomcat-8.0-doc/servletapi/javax/servlet/http/HttpServletResponseWrapper.html (added)
+++ tomcat/site/trunk/docs/tomcat-8.0-doc/servletapi/javax/servlet/http/HttpServletResponseWrapper.html Mon Aug 5 19:10:09 2013
@@ -0,0 +1,828 @@
+<!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>HttpServletResponseWrapper (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="HttpServletResponseWrapper (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/HttpServletResponse.html" title="interface in javax.servlet.http"><span class="strong">Prev Class</span></a></li>
+<li><a href="../../../javax/servlet/http/HttpSession.html" title="interface in javax.servlet.http"><span class="strong">Next Class</span></a></li>
+</ul>
+<ul class="navList">
+<li><a href="../../../index.html?javax/servlet/http/HttpServletResponseWrapper.html" target="_top">Frames</a></li>
+<li><a href="HttpServletResponseWrapper.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>Field | </li>
+<li><a href="#constructor_summary">Constr</a> | </li>
+<li><a href="#method_summary">Method</a></li>
+</ul>
+<ul class="subNavList">
+<li>Detail: </li>
+<li>Field | </li>
+<li><a href="#constructor_detail">Constr</a> | </li>
+<li><a href="#method_detail">Method</a></li>
+</ul>
+</div>
+<a 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="Class HttpServletResponseWrapper" class="title">Class HttpServletResponseWrapper</h2>
+</div>
+<div class="contentContainer">
+<ul class="inheritance">
+<li>java.lang.Object</li>
+<li>
+<ul class="inheritance">
+<li><a href="../../../javax/servlet/ServletResponseWrapper.html" title="class in javax.servlet">javax.servlet.ServletResponseWrapper</a></li>
+<li>
+<ul class="inheritance">
+<li>javax.servlet.http.HttpServletResponseWrapper</li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+<div class="description">
+<ul class="blockList">
+<li class="blockList">
+<dl>
+<dt>All Implemented Interfaces:</dt>
+<dd><a href="../../../javax/servlet/http/HttpServletResponse.html" title="interface in javax.servlet.http">HttpServletResponse</a>, <a href="../../../javax/servlet/ServletResponse.html" title="interface in javax.servlet">ServletResponse</a></dd>
+</dl>
+<hr>
+<br>
+<pre>public class <span class="strong">HttpServletResponseWrapper</span>
+extends <a href="../../../javax/servlet/ServletResponseWrapper.html" title="class in javax.servlet">ServletResponseWrapper</a>
+implements <a href="../../../javax/servlet/http/HttpServletResponse.html" title="interface in javax.servlet.http">HttpServletResponse</a></pre>
+<div class="block">Provides a convenient implementation of the HttpServletResponse interface
+ that can be subclassed by developers wishing to adapt the response from a
+ Servlet. This class implements the Wrapper or Decorator pattern. Methods
+ default to calling through to the wrapped response object.</div>
+<dl><dt><span class="strong">Since:</span></dt>
+ <dd>v 2.3</dd>
+<dt><span class="strong">Version:</span></dt>
+ <dd>$Version$</dd>
+<dt><span class="strong">Author:</span></dt>
+ <dd>Various</dd>
+<dt><span class="strong">See Also:</span></dt><dd><a href="../../../javax/servlet/http/HttpServletResponse.html" title="interface in javax.servlet.http"><code>HttpServletResponse</code></a></dd></dl>
+</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>
+<ul class="blockList">
+<li class="blockList"><a name="fields_inherited_from_class_javax.servlet.http.HttpServletResponse">
+<!-- -->
+</a>
+<h3>Fields inherited from interface javax.servlet.http.<a href="../../../javax/servlet/http/HttpServletResponse.html" title="interface in javax.servlet.http">HttpServletResponse</a></h3>
+<code><a href="../../../javax/servlet/http/HttpServletResponse.html#SC_ACCEPTED">SC_ACCEPTED</a>, <a href="../../../javax/servlet/http/HttpServletResponse.html#SC_BAD_GATEWAY">SC_BAD_GATEWAY</a>, <a href="../../../javax/servlet/http/HttpServletResponse.html#SC_BAD_REQUEST">SC_BAD_REQUEST</a>, <a href="../../../javax/servlet/http/HttpServletResponse.html#SC_CONFLICT">SC_CONFLICT</a>, <a href="../../../javax/servlet/http/HttpServletResponse.html#SC_CONTINUE">SC_CONTINUE</a>, <a href="../../../javax/servlet/http/HttpServletResponse.html#SC_CREATED">SC_CREATED</a>, <a href="../../../javax/servlet/http/HttpServletResponse.html#SC_EXPECTATION_FAILED">SC_EXPECTATION_FAILED</a>, <a href="../../../javax/servlet/http/HttpServletResponse.html#SC_FORBIDDEN">SC_FORBIDDEN</a>, <a href="../../../javax/servlet/http/HttpServletResponse.html#SC_FOUND">SC_FOUND</a>, <a href="../../../javax/servlet/http/HttpServletResponse.html#SC_GATEWAY_TIMEOUT">SC_GATEWAY_TIMEOUT</a>, <a href="../../../javax/servlet
/http/HttpServletResponse.html#SC_GONE">SC_GONE</a>, <a href="../../../javax/servlet/http/HttpServletResponse.html#SC_HTTP_VERSION_NOT_SUPPORTED">SC_HTTP_VERSION_NOT_SUPPORTED</a>, <a href="../../../javax/servlet/http/HttpServletResponse.html#SC_INTERNAL_SERVER_ERROR">SC_INTERNAL_SERVER_ERROR</a>, <a href="../../../javax/servlet/http/HttpServletResponse.html#SC_LENGTH_REQUIRED">SC_LENGTH_REQUIRED</a>, <a href="../../../javax/servlet/http/HttpServletResponse.html#SC_METHOD_NOT_ALLOWED">SC_METHOD_NOT_ALLOWED</a>, <a href="../../../javax/servlet/http/HttpServletResponse.html#SC_MOVED_PERMANENTLY">SC_MOVED_PERMANENTLY</a>, <a href="../../../javax/servlet/http/HttpServletResponse.html#SC_MOVED_TEMPORARILY">SC_MOVED_TEMPORARILY</a>, <a href="../../../javax/servlet/http/HttpServletResponse.html#SC_MULTIPLE_CHOICES">SC_MULTIPLE_CHOICES</a>, <a href="../../../javax/servlet/http/HttpServletResponse.html#SC_NO_CONTENT">SC_NO_CONTENT</a>, <a href="../../../javax/servlet/http/HttpServletResponse
.html#SC_NON_AUTHORITATIVE_INFORMATION">SC_NON_AUTHORITATIVE_INFORMATION</a>, <a href="../../../javax/servlet/http/HttpServletResponse.html#SC_NOT_ACCEPTABLE">SC_NOT_ACCEPTABLE</a>, <a href="../../../javax/servlet/http/HttpServletResponse.html#SC_NOT_FOUND">SC_NOT_FOUND</a>, <a href="../../../javax/servlet/http/HttpServletResponse.html#SC_NOT_IMPLEMENTED">SC_NOT_IMPLEMENTED</a>, <a href="../../../javax/servlet/http/HttpServletResponse.html#SC_NOT_MODIFIED">SC_NOT_MODIFIED</a>, <a href="../../../javax/servlet/http/HttpServletResponse.html#SC_OK">SC_OK</a>, <a href="../../../javax/servlet/http/HttpServletResponse.html#SC_PARTIAL_CONTENT">SC_PARTIAL_CONTENT</a>, <a href="../../../javax/servlet/http/HttpServletResponse.html#SC_PAYMENT_REQUIRED">SC_PAYMENT_REQUIRED</a>, <a href="../../../javax/servlet/http/HttpServletResponse.html#SC_PRECONDITION_FAILED">SC_PRECONDITION_FAILED</a>, <a href="../../../javax/servlet/http/HttpServletResponse.html#SC_PROXY_AUTHENTICATION_REQUIRED">SC_PROXY_AU
THENTICATION_REQUIRED</a>, <a href="../../../javax/servlet/http/HttpServletResponse.html#SC_REQUEST_ENTITY_TOO_LARGE">SC_REQUEST_ENTITY_TOO_LARGE</a>, <a href="../../../javax/servlet/http/HttpServletResponse.html#SC_REQUEST_TIMEOUT">SC_REQUEST_TIMEOUT</a>, <a href="../../../javax/servlet/http/HttpServletResponse.html#SC_REQUEST_URI_TOO_LONG">SC_REQUEST_URI_TOO_LONG</a>, <a href="../../../javax/servlet/http/HttpServletResponse.html#SC_REQUESTED_RANGE_NOT_SATISFIABLE">SC_REQUESTED_RANGE_NOT_SATISFIABLE</a>, <a href="../../../javax/servlet/http/HttpServletResponse.html#SC_RESET_CONTENT">SC_RESET_CONTENT</a>, <a href="../../../javax/servlet/http/HttpServletResponse.html#SC_SEE_OTHER">SC_SEE_OTHER</a>, <a href="../../../javax/servlet/http/HttpServletResponse.html#SC_SERVICE_UNAVAILABLE">SC_SERVICE_UNAVAILABLE</a>, <a href="../../../javax/servlet/http/HttpServletResponse.html#SC_SWITCHING_PROTOCOLS">SC_SWITCHING_PROTOCOLS</a>, <a href="../../../javax/servlet/http/HttpServletResponse.html#
SC_TEMPORARY_REDIRECT">SC_TEMPORARY_REDIRECT</a>, <a href="../../../javax/servlet/http/HttpServletResponse.html#SC_UNAUTHORIZED">SC_UNAUTHORIZED</a>, <a href="../../../javax/servlet/http/HttpServletResponse.html#SC_UNSUPPORTED_MEDIA_TYPE">SC_UNSUPPORTED_MEDIA_TYPE</a>, <a href="../../../javax/servlet/http/HttpServletResponse.html#SC_USE_PROXY">SC_USE_PROXY</a></code></li>
+</ul>
+</li>
+</ul>
+<!-- ======== 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"> </span></caption>
+<tr>
+<th class="colOne" scope="col">Constructor and Description</th>
+</tr>
+<tr class="altColor">
+<td class="colOne"><code><strong><a href="../../../javax/servlet/http/HttpServletResponseWrapper.html#HttpServletResponseWrapper(javax.servlet.http.HttpServletResponse)">HttpServletResponseWrapper</a></strong>(<a href="../../../javax/servlet/http/HttpServletResponse.html" title="interface in javax.servlet.http">HttpServletResponse</a> response)</code>
+<div class="block">Constructs a response adaptor wrapping the given response.</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>void</code></td>
+<td class="colLast"><code><strong><a href="../../../javax/servlet/http/HttpServletResponseWrapper.html#addCookie(javax.servlet.http.Cookie)">addCookie</a></strong>(<a href="../../../javax/servlet/http/Cookie.html" title="class in javax.servlet.http">Cookie</a> cookie)</code>
+<div class="block">The default behavior of this method is to call addCookie(Cookie cookie)
+ on the wrapped response object.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><strong><a href="../../../javax/servlet/http/HttpServletResponseWrapper.html#addDateHeader(java.lang.String, long)">addDateHeader</a></strong>(java.lang.String name,
+ long date)</code>
+<div class="block">The default behavior of this method is to call addDateHeader(String name,
+ long date) on the wrapped response object.</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><strong><a href="../../../javax/servlet/http/HttpServletResponseWrapper.html#addHeader(java.lang.String, java.lang.String)">addHeader</a></strong>(java.lang.String name,
+ java.lang.String value)</code>
+<div class="block">The default behavior of this method is to return addHeader(String name,
+ String value) on the wrapped response object.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><strong><a href="../../../javax/servlet/http/HttpServletResponseWrapper.html#addIntHeader(java.lang.String, int)">addIntHeader</a></strong>(java.lang.String name,
+ int value)</code>
+<div class="block">The default behavior of this method is to call addIntHeader(String name,
+ int value) on the wrapped response object.</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>boolean</code></td>
+<td class="colLast"><code><strong><a href="../../../javax/servlet/http/HttpServletResponseWrapper.html#containsHeader(java.lang.String)">containsHeader</a></strong>(java.lang.String name)</code>
+<div class="block">The default behavior of this method is to call containsHeader(String
+ name) on the wrapped response object.</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/HttpServletResponseWrapper.html#encodeRedirectUrl(java.lang.String)">encodeRedirectUrl</a></strong>(java.lang.String url)</code>
+<div class="block"><strong>Deprecated.</strong>
+<div class="block"><i>As of Version 3.0 of the Java Servlet API</i></div>
+</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/HttpServletResponseWrapper.html#encodeRedirectURL(java.lang.String)">encodeRedirectURL</a></strong>(java.lang.String url)</code>
+<div class="block">The default behavior of this method is to return encodeRedirectURL(String
+ url) on the wrapped response object.</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/HttpServletResponseWrapper.html#encodeUrl(java.lang.String)">encodeUrl</a></strong>(java.lang.String url)</code>
+<div class="block"><strong>Deprecated.</strong>
+<div class="block"><i>As of Version 3.0 of the Java Servlet API</i></div>
+</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/HttpServletResponseWrapper.html#encodeURL(java.lang.String)">encodeURL</a></strong>(java.lang.String url)</code>
+<div class="block">The default behavior of this method is to call encodeURL(String url) on
+ the wrapped response object.</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/HttpServletResponseWrapper.html#getHeader(java.lang.String)">getHeader</a></strong>(java.lang.String name)</code>
+<div class="block">Return the value for the specified header, or <code>null</code> if this
+ header has not been set.</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>java.util.Collection<java.lang.String></code></td>
+<td class="colLast"><code><strong><a href="../../../javax/servlet/http/HttpServletResponseWrapper.html#getHeaderNames()">getHeaderNames</a></strong>()</code>
+<div class="block">Return an Iterable of all the header names set for this response.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>java.util.Collection<java.lang.String></code></td>
+<td class="colLast"><code><strong><a href="../../../javax/servlet/http/HttpServletResponseWrapper.html#getHeaders(java.lang.String)">getHeaders</a></strong>(java.lang.String name)</code>
+<div class="block">Return a Collection of all the header values associated with the
+ specified header name.</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>int</code></td>
+<td class="colLast"><code><strong><a href="../../../javax/servlet/http/HttpServletResponseWrapper.html#getStatus()">getStatus</a></strong>()</code>
+<div class="block">Return the HTTP status code associated with this Response.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><strong><a href="../../../javax/servlet/http/HttpServletResponseWrapper.html#sendError(int)">sendError</a></strong>(int sc)</code>
+<div class="block">The default behavior of this method is to call sendError(int sc) on the
+ wrapped response object.</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><strong><a href="../../../javax/servlet/http/HttpServletResponseWrapper.html#sendError(int, java.lang.String)">sendError</a></strong>(int sc,
+ java.lang.String msg)</code>
+<div class="block">The default behavior of this method is to call sendError(int sc, String
+ msg) on the wrapped response object.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><strong><a href="../../../javax/servlet/http/HttpServletResponseWrapper.html#sendRedirect(java.lang.String)">sendRedirect</a></strong>(java.lang.String location)</code>
+<div class="block">The default behavior of this method is to return sendRedirect(String
+ location) on the wrapped response object.</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><strong><a href="../../../javax/servlet/http/HttpServletResponseWrapper.html#setDateHeader(java.lang.String, long)">setDateHeader</a></strong>(java.lang.String name,
+ long date)</code>
+<div class="block">The default behavior of this method is to call setDateHeader(String name,
+ long date) on the wrapped response object.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><strong><a href="../../../javax/servlet/http/HttpServletResponseWrapper.html#setHeader(java.lang.String, java.lang.String)">setHeader</a></strong>(java.lang.String name,
+ java.lang.String value)</code>
+<div class="block">The default behavior of this method is to return setHeader(String name,
+ String value) on the wrapped response object.</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><strong><a href="../../../javax/servlet/http/HttpServletResponseWrapper.html#setIntHeader(java.lang.String, int)">setIntHeader</a></strong>(java.lang.String name,
+ int value)</code>
+<div class="block">The default behavior of this method is to call setIntHeader(String name,
+ int value) on the wrapped response object.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><strong><a href="../../../javax/servlet/http/HttpServletResponseWrapper.html#setStatus(int)">setStatus</a></strong>(int sc)</code>
+<div class="block">The default behavior of this method is to call setStatus(int sc) on the
+ wrapped response object.</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><strong><a href="../../../javax/servlet/http/HttpServletResponseWrapper.html#setStatus(int, java.lang.String)">setStatus</a></strong>(int sc,
+ java.lang.String sm)</code>
+<div class="block"><strong>Deprecated.</strong>
+<div class="block"><i>As of Version 3.0 of the Java Servlet API</i></div>
+</div>
+</td>
+</tr>
+</table>
+<ul class="blockList">
+<li class="blockList"><a name="methods_inherited_from_class_javax.servlet.ServletResponseWrapper">
+<!-- -->
+</a>
+<h3>Methods inherited from class javax.servlet.<a href="../../../javax/servlet/ServletResponseWrapper.html" title="class in javax.servlet">ServletResponseWrapper</a></h3>
+<code><a href="../../../javax/servlet/ServletResponseWrapper.html#flushBuffer()">flushBuffer</a>, <a href="../../../javax/servlet/ServletResponseWrapper.html#getBufferSize()">getBufferSize</a>, <a href="../../../javax/servlet/ServletResponseWrapper.html#getCharacterEncoding()">getCharacterEncoding</a>, <a href="../../../javax/servlet/ServletResponseWrapper.html#getContentType()">getContentType</a>, <a href="../../../javax/servlet/ServletResponseWrapper.html#getLocale()">getLocale</a>, <a href="../../../javax/servlet/ServletResponseWrapper.html#getOutputStream()">getOutputStream</a>, <a href="../../../javax/servlet/ServletResponseWrapper.html#getResponse()">getResponse</a>, <a href="../../../javax/servlet/ServletResponseWrapper.html#getWriter()">getWriter</a>, <a href="../../../javax/servlet/ServletResponseWrapper.html#isCommitted()">isCommitted</a>, <a href="../../../javax/servlet/ServletResponseWrapper.html#isWrapperFor(java.lang.Class)">isWrapperFor</a>, <a href="../../../javax/se
rvlet/ServletResponseWrapper.html#isWrapperFor(javax.servlet.ServletResponse)">isWrapperFor</a>, <a href="../../../javax/servlet/ServletResponseWrapper.html#reset()">reset</a>, <a href="../../../javax/servlet/ServletResponseWrapper.html#resetBuffer()">resetBuffer</a>, <a href="../../../javax/servlet/ServletResponseWrapper.html#setBufferSize(int)">setBufferSize</a>, <a href="../../../javax/servlet/ServletResponseWrapper.html#setCharacterEncoding(java.lang.String)">setCharacterEncoding</a>, <a href="../../../javax/servlet/ServletResponseWrapper.html#setContentLength(int)">setContentLength</a>, <a href="../../../javax/servlet/ServletResponseWrapper.html#setContentLengthLong(long)">setContentLengthLong</a>, <a href="../../../javax/servlet/ServletResponseWrapper.html#setContentType(java.lang.String)">setContentType</a>, <a href="../../../javax/servlet/ServletResponseWrapper.html#setLocale(java.util.Locale)">setLocale</a>, <a href="../../../javax/servlet/ServletResponseWrapper.html#setRes
ponse(javax.servlet.ServletResponse)">setResponse</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 java.lang.Object</h3>
+<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
+</ul>
+<ul class="blockList">
+<li class="blockList"><a name="methods_inherited_from_class_javax.servlet.ServletResponse">
+<!-- -->
+</a>
+<h3>Methods inherited from interface javax.servlet.<a href="../../../javax/servlet/ServletResponse.html" title="interface in javax.servlet">ServletResponse</a></h3>
+<code><a href="../../../javax/servlet/ServletResponse.html#flushBuffer()">flushBuffer</a>, <a href="../../../javax/servlet/ServletResponse.html#getBufferSize()">getBufferSize</a>, <a href="../../../javax/servlet/ServletResponse.html#getCharacterEncoding()">getCharacterEncoding</a>, <a href="../../../javax/servlet/ServletResponse.html#getContentType()">getContentType</a>, <a href="../../../javax/servlet/ServletResponse.html#getLocale()">getLocale</a>, <a href="../../../javax/servlet/ServletResponse.html#getOutputStream()">getOutputStream</a>, <a href="../../../javax/servlet/ServletResponse.html#getWriter()">getWriter</a>, <a href="../../../javax/servlet/ServletResponse.html#isCommitted()">isCommitted</a>, <a href="../../../javax/servlet/ServletResponse.html#reset()">reset</a>, <a href="../../../javax/servlet/ServletResponse.html#resetBuffer()">resetBuffer</a>, <a href="../../../javax/servlet/ServletResponse.html#setBufferSize(int)">setBufferSize</a>, <a href="../../../javax/servlet/S
ervletResponse.html#setCharacterEncoding(java.lang.String)">setCharacterEncoding</a>, <a href="../../../javax/servlet/ServletResponse.html#setContentLength(int)">setContentLength</a>, <a href="../../../javax/servlet/ServletResponse.html#setContentLengthLong(long)">setContentLengthLong</a>, <a href="../../../javax/servlet/ServletResponse.html#setContentType(java.lang.String)">setContentType</a>, <a href="../../../javax/servlet/ServletResponse.html#setLocale(java.util.Locale)">setLocale</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="HttpServletResponseWrapper(javax.servlet.http.HttpServletResponse)">
+<!-- -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>HttpServletResponseWrapper</h4>
+<pre>public HttpServletResponseWrapper(<a href="../../../javax/servlet/http/HttpServletResponse.html" title="interface in javax.servlet.http">HttpServletResponse</a> response)</pre>
+<div class="block">Constructs a response adaptor wrapping the given response.</div>
+<dl><dt><span class="strong">Throws:</span></dt>
+<dd><code>java.lang.IllegalArgumentException</code> - if the response is null</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="addCookie(javax.servlet.http.Cookie)">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>addCookie</h4>
+<pre>public void addCookie(<a href="../../../javax/servlet/http/Cookie.html" title="class in javax.servlet.http">Cookie</a> cookie)</pre>
+<div class="block">The default behavior of this method is to call addCookie(Cookie cookie)
+ on the wrapped response object.</div>
+<dl>
+<dt><strong>Specified by:</strong></dt>
+<dd><code><a href="../../../javax/servlet/http/HttpServletResponse.html#addCookie(javax.servlet.http.Cookie)">addCookie</a></code> in interface <code><a href="../../../javax/servlet/http/HttpServletResponse.html" title="interface in javax.servlet.http">HttpServletResponse</a></code></dd>
+<dt><span class="strong">Parameters:</span></dt><dd><code>cookie</code> - the Cookie to return to the client</dd></dl>
+</li>
+</ul>
+<a name="containsHeader(java.lang.String)">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>containsHeader</h4>
+<pre>public boolean containsHeader(java.lang.String name)</pre>
+<div class="block">The default behavior of this method is to call containsHeader(String
+ name) on the wrapped response object.</div>
+<dl>
+<dt><strong>Specified by:</strong></dt>
+<dd><code><a href="../../../javax/servlet/http/HttpServletResponse.html#containsHeader(java.lang.String)">containsHeader</a></code> in interface <code><a href="../../../javax/servlet/http/HttpServletResponse.html" title="interface in javax.servlet.http">HttpServletResponse</a></code></dd>
+<dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - the header name</dd>
+<dt><span class="strong">Returns:</span></dt><dd><code>true</code> if the named response header has already been
+ set; <code>false</code> otherwise</dd></dl>
+</li>
+</ul>
+<a name="encodeURL(java.lang.String)">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>encodeURL</h4>
+<pre>public java.lang.String encodeURL(java.lang.String url)</pre>
+<div class="block">The default behavior of this method is to call encodeURL(String url) on
+ the wrapped response object.</div>
+<dl>
+<dt><strong>Specified by:</strong></dt>
+<dd><code><a href="../../../javax/servlet/http/HttpServletResponse.html#encodeURL(java.lang.String)">encodeURL</a></code> in interface <code><a href="../../../javax/servlet/http/HttpServletResponse.html" title="interface in javax.servlet.http">HttpServletResponse</a></code></dd>
+<dt><span class="strong">Parameters:</span></dt><dd><code>url</code> - the url to be encoded.</dd>
+<dt><span class="strong">Returns:</span></dt><dd>the encoded URL if encoding is needed; the unchanged URL
+ otherwise.</dd></dl>
+</li>
+</ul>
+<a name="encodeRedirectURL(java.lang.String)">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>encodeRedirectURL</h4>
+<pre>public java.lang.String encodeRedirectURL(java.lang.String url)</pre>
+<div class="block">The default behavior of this method is to return encodeRedirectURL(String
+ url) on the wrapped response object.</div>
+<dl>
+<dt><strong>Specified by:</strong></dt>
+<dd><code><a href="../../../javax/servlet/http/HttpServletResponse.html#encodeRedirectURL(java.lang.String)">encodeRedirectURL</a></code> in interface <code><a href="../../../javax/servlet/http/HttpServletResponse.html" title="interface in javax.servlet.http">HttpServletResponse</a></code></dd>
+<dt><span class="strong">Parameters:</span></dt><dd><code>url</code> - the url to be encoded.</dd>
+<dt><span class="strong">Returns:</span></dt><dd>the encoded URL if encoding is needed; the unchanged URL
+ otherwise.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../javax/servlet/http/HttpServletResponse.html#sendRedirect(java.lang.String)"><code>HttpServletResponse.sendRedirect(java.lang.String)</code></a>,
+<a href="../../../javax/servlet/http/HttpServletResponse.html#encodeUrl(java.lang.String)"><code>HttpServletResponse.encodeUrl(java.lang.String)</code></a></dd></dl>
+</li>
+</ul>
+<a name="encodeUrl(java.lang.String)">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>encodeUrl</h4>
+<pre>public java.lang.String encodeUrl(java.lang.String url)</pre>
+<div class="block"><span class="strong">Deprecated.</span> <i>As of Version 3.0 of the Java Servlet API</i></div>
+<div class="block">The default behavior of this method is to call encodeUrl(String url) on
+ the wrapped response object.</div>
+<dl>
+<dt><strong>Specified by:</strong></dt>
+<dd><code><a href="../../../javax/servlet/http/HttpServletResponse.html#encodeUrl(java.lang.String)">encodeUrl</a></code> in interface <code><a href="../../../javax/servlet/http/HttpServletResponse.html" title="interface in javax.servlet.http">HttpServletResponse</a></code></dd>
+<dt><span class="strong">Parameters:</span></dt><dd><code>url</code> - the url to be encoded.</dd>
+<dt><span class="strong">Returns:</span></dt><dd>the encoded URL if encoding is needed; the unchanged URL
+ otherwise.</dd></dl>
+</li>
+</ul>
+<a name="encodeRedirectUrl(java.lang.String)">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>encodeRedirectUrl</h4>
+<pre>public java.lang.String encodeRedirectUrl(java.lang.String url)</pre>
+<div class="block"><span class="strong">Deprecated.</span> <i>As of Version 3.0 of the Java Servlet API</i></div>
+<div class="block">The default behavior of this method is to return encodeRedirectUrl(String
+ url) on the wrapped response object.</div>
+<dl>
+<dt><strong>Specified by:</strong></dt>
+<dd><code><a href="../../../javax/servlet/http/HttpServletResponse.html#encodeRedirectUrl(java.lang.String)">encodeRedirectUrl</a></code> in interface <code><a href="../../../javax/servlet/http/HttpServletResponse.html" title="interface in javax.servlet.http">HttpServletResponse</a></code></dd>
+<dt><span class="strong">Parameters:</span></dt><dd><code>url</code> - the url to be encoded.</dd>
+<dt><span class="strong">Returns:</span></dt><dd>the encoded URL if encoding is needed; the unchanged URL
+ otherwise.</dd></dl>
+</li>
+</ul>
+<a name="sendError(int, java.lang.String)">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>sendError</h4>
+<pre>public void sendError(int sc,
+ java.lang.String msg)
+ throws java.io.IOException</pre>
+<div class="block">The default behavior of this method is to call sendError(int sc, String
+ msg) on the wrapped response object.</div>
+<dl>
+<dt><strong>Specified by:</strong></dt>
+<dd><code><a href="../../../javax/servlet/http/HttpServletResponse.html#sendError(int, java.lang.String)">sendError</a></code> in interface <code><a href="../../../javax/servlet/http/HttpServletResponse.html" title="interface in javax.servlet.http">HttpServletResponse</a></code></dd>
+<dt><span class="strong">Parameters:</span></dt><dd><code>sc</code> - the error status code</dd><dd><code>msg</code> - the descriptive message</dd>
+<dt><span class="strong">Throws:</span></dt>
+<dd><code>java.io.IOException</code> - If an input or output exception occurs</dd></dl>
+</li>
+</ul>
+<a name="sendError(int)">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>sendError</h4>
+<pre>public void sendError(int sc)
+ throws java.io.IOException</pre>
+<div class="block">The default behavior of this method is to call sendError(int sc) on the
+ wrapped response object.</div>
+<dl>
+<dt><strong>Specified by:</strong></dt>
+<dd><code><a href="../../../javax/servlet/http/HttpServletResponse.html#sendError(int)">sendError</a></code> in interface <code><a href="../../../javax/servlet/http/HttpServletResponse.html" title="interface in javax.servlet.http">HttpServletResponse</a></code></dd>
+<dt><span class="strong">Parameters:</span></dt><dd><code>sc</code> - the error status code</dd>
+<dt><span class="strong">Throws:</span></dt>
+<dd><code>java.io.IOException</code> - If an input or output exception occurs</dd></dl>
+</li>
+</ul>
+<a name="sendRedirect(java.lang.String)">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>sendRedirect</h4>
+<pre>public void sendRedirect(java.lang.String location)
+ throws java.io.IOException</pre>
+<div class="block">The default behavior of this method is to return sendRedirect(String
+ location) on the wrapped response object.</div>
+<dl>
+<dt><strong>Specified by:</strong></dt>
+<dd><code><a href="../../../javax/servlet/http/HttpServletResponse.html#sendRedirect(java.lang.String)">sendRedirect</a></code> in interface <code><a href="../../../javax/servlet/http/HttpServletResponse.html" title="interface in javax.servlet.http">HttpServletResponse</a></code></dd>
+<dt><span class="strong">Parameters:</span></dt><dd><code>location</code> - the redirect location URL</dd>
+<dt><span class="strong">Throws:</span></dt>
+<dd><code>java.io.IOException</code> - If an input or output exception occurs</dd></dl>
+</li>
+</ul>
+<a name="setDateHeader(java.lang.String, long)">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>setDateHeader</h4>
+<pre>public void setDateHeader(java.lang.String name,
+ long date)</pre>
+<div class="block">The default behavior of this method is to call setDateHeader(String name,
+ long date) on the wrapped response object.</div>
+<dl>
+<dt><strong>Specified by:</strong></dt>
+<dd><code><a href="../../../javax/servlet/http/HttpServletResponse.html#setDateHeader(java.lang.String, long)">setDateHeader</a></code> in interface <code><a href="../../../javax/servlet/http/HttpServletResponse.html" title="interface in javax.servlet.http">HttpServletResponse</a></code></dd>
+<dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - the name of the header to set</dd><dd><code>date</code> - the assigned date value</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../javax/servlet/http/HttpServletResponse.html#containsHeader(java.lang.String)"><code>HttpServletResponse.containsHeader(java.lang.String)</code></a>,
+<a href="../../../javax/servlet/http/HttpServletResponse.html#addDateHeader(java.lang.String, long)"><code>HttpServletResponse.addDateHeader(java.lang.String, long)</code></a></dd></dl>
+</li>
+</ul>
+<a name="addDateHeader(java.lang.String, long)">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>addDateHeader</h4>
+<pre>public void addDateHeader(java.lang.String name,
+ long date)</pre>
+<div class="block">The default behavior of this method is to call addDateHeader(String name,
+ long date) on the wrapped response object.</div>
+<dl>
+<dt><strong>Specified by:</strong></dt>
+<dd><code><a href="../../../javax/servlet/http/HttpServletResponse.html#addDateHeader(java.lang.String, long)">addDateHeader</a></code> in interface <code><a href="../../../javax/servlet/http/HttpServletResponse.html" title="interface in javax.servlet.http">HttpServletResponse</a></code></dd>
+<dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - the name of the header to set</dd><dd><code>date</code> - the additional date value</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../javax/servlet/http/HttpServletResponse.html#setDateHeader(java.lang.String, long)"><code>HttpServletResponse.setDateHeader(java.lang.String, long)</code></a></dd></dl>
+</li>
+</ul>
+<a name="setHeader(java.lang.String, java.lang.String)">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>setHeader</h4>
+<pre>public void setHeader(java.lang.String name,
+ java.lang.String value)</pre>
+<div class="block">The default behavior of this method is to return setHeader(String name,
+ String value) on the wrapped response object.</div>
+<dl>
+<dt><strong>Specified by:</strong></dt>
+<dd><code><a href="../../../javax/servlet/http/HttpServletResponse.html#setHeader(java.lang.String, java.lang.String)">setHeader</a></code> in interface <code><a href="../../../javax/servlet/http/HttpServletResponse.html" title="interface in javax.servlet.http">HttpServletResponse</a></code></dd>
+<dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - the name of the header</dd><dd><code>value</code> - the header value If it contains octet string, it should be
+ encoded according to RFC 2047
+ (http://www.ietf.org/rfc/rfc2047.txt)</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../javax/servlet/http/HttpServletResponse.html#containsHeader(java.lang.String)"><code>HttpServletResponse.containsHeader(java.lang.String)</code></a>,
+<a href="../../../javax/servlet/http/HttpServletResponse.html#addHeader(java.lang.String, java.lang.String)"><code>HttpServletResponse.addHeader(java.lang.String, java.lang.String)</code></a></dd></dl>
+</li>
+</ul>
+<a name="addHeader(java.lang.String, java.lang.String)">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>addHeader</h4>
+<pre>public void addHeader(java.lang.String name,
+ java.lang.String value)</pre>
+<div class="block">The default behavior of this method is to return addHeader(String name,
+ String value) on the wrapped response object.</div>
+<dl>
+<dt><strong>Specified by:</strong></dt>
+<dd><code><a href="../../../javax/servlet/http/HttpServletResponse.html#addHeader(java.lang.String, java.lang.String)">addHeader</a></code> in interface <code><a href="../../../javax/servlet/http/HttpServletResponse.html" title="interface in javax.servlet.http">HttpServletResponse</a></code></dd>
+<dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - the name of the header</dd><dd><code>value</code> - the additional header value If it contains octet string, it
+ should be encoded according to RFC 2047
+ (http://www.ietf.org/rfc/rfc2047.txt)</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../javax/servlet/http/HttpServletResponse.html#setHeader(java.lang.String, java.lang.String)"><code>HttpServletResponse.setHeader(java.lang.String, java.lang.String)</code></a></dd></dl>
+</li>
+</ul>
+<a name="setIntHeader(java.lang.String, int)">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>setIntHeader</h4>
+<pre>public void setIntHeader(java.lang.String name,
+ int value)</pre>
+<div class="block">The default behavior of this method is to call setIntHeader(String name,
+ int value) on the wrapped response object.</div>
+<dl>
+<dt><strong>Specified by:</strong></dt>
+<dd><code><a href="../../../javax/servlet/http/HttpServletResponse.html#setIntHeader(java.lang.String, int)">setIntHeader</a></code> in interface <code><a href="../../../javax/servlet/http/HttpServletResponse.html" title="interface in javax.servlet.http">HttpServletResponse</a></code></dd>
+<dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - the name of the header</dd><dd><code>value</code> - the assigned integer value</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../javax/servlet/http/HttpServletResponse.html#containsHeader(java.lang.String)"><code>HttpServletResponse.containsHeader(java.lang.String)</code></a>,
+<a href="../../../javax/servlet/http/HttpServletResponse.html#addIntHeader(java.lang.String, int)"><code>HttpServletResponse.addIntHeader(java.lang.String, int)</code></a></dd></dl>
+</li>
+</ul>
+<a name="addIntHeader(java.lang.String, int)">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>addIntHeader</h4>
+<pre>public void addIntHeader(java.lang.String name,
+ int value)</pre>
+<div class="block">The default behavior of this method is to call addIntHeader(String name,
+ int value) on the wrapped response object.</div>
+<dl>
+<dt><strong>Specified by:</strong></dt>
+<dd><code><a href="../../../javax/servlet/http/HttpServletResponse.html#addIntHeader(java.lang.String, int)">addIntHeader</a></code> in interface <code><a href="../../../javax/servlet/http/HttpServletResponse.html" title="interface in javax.servlet.http">HttpServletResponse</a></code></dd>
+<dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - the name of the header</dd><dd><code>value</code> - the assigned integer value</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../javax/servlet/http/HttpServletResponse.html#setIntHeader(java.lang.String, int)"><code>HttpServletResponse.setIntHeader(java.lang.String, int)</code></a></dd></dl>
+</li>
+</ul>
+<a name="setStatus(int)">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>setStatus</h4>
+<pre>public void setStatus(int sc)</pre>
+<div class="block">The default behavior of this method is to call setStatus(int sc) on the
+ wrapped response object.</div>
+<dl>
+<dt><strong>Specified by:</strong></dt>
+<dd><code><a href="../../../javax/servlet/http/HttpServletResponse.html#setStatus(int)">setStatus</a></code> in interface <code><a href="../../../javax/servlet/http/HttpServletResponse.html" title="interface in javax.servlet.http">HttpServletResponse</a></code></dd>
+<dt><span class="strong">Parameters:</span></dt><dd><code>sc</code> - the status code</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../javax/servlet/http/HttpServletResponse.html#sendError(int, java.lang.String)"><code>HttpServletResponse.sendError(int, java.lang.String)</code></a></dd></dl>
+</li>
+</ul>
+<a name="setStatus(int, java.lang.String)">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>setStatus</h4>
+<pre>public void setStatus(int sc,
+ java.lang.String sm)</pre>
+<div class="block"><span class="strong">Deprecated.</span> <i>As of Version 3.0 of the Java Servlet API</i></div>
+<div class="block">The default behavior of this method is to call setStatus(int sc, String
+ sm) on the wrapped response object.</div>
+<dl>
+<dt><strong>Specified by:</strong></dt>
+<dd><code><a href="../../../javax/servlet/http/HttpServletResponse.html#setStatus(int, java.lang.String)">setStatus</a></code> in interface <code><a href="../../../javax/servlet/http/HttpServletResponse.html" title="interface in javax.servlet.http">HttpServletResponse</a></code></dd>
+<dt><span class="strong">Parameters:</span></dt><dd><code>sc</code> - the status code</dd><dd><code>sm</code> - the status message</dd></dl>
+</li>
+</ul>
+<a name="getStatus()">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getStatus</h4>
+<pre>public int getStatus()</pre>
+<div class="block">Return the HTTP status code associated with this Response.
+ <p>
+ The default implementation is to call
+ <a href="../../../javax/servlet/http/HttpServletResponse.html#getStatus()"><code>HttpServletResponse.getStatus()</code></a>
+ on the wrapper <a href="../../../javax/servlet/http/HttpServletResponse.html" title="interface in javax.servlet.http"><code>HttpServletResponse</code></a>.</div>
+<dl>
+<dt><strong>Specified by:</strong></dt>
+<dd><code><a href="../../../javax/servlet/http/HttpServletResponse.html#getStatus()">getStatus</a></code> in interface <code><a href="../../../javax/servlet/http/HttpServletResponse.html" title="interface in javax.servlet.http">HttpServletResponse</a></code></dd>
+<dt><span class="strong">Since:</span></dt>
+ <dd>Servlet 3.0</dd></dl>
+</li>
+</ul>
+<a name="getHeader(java.lang.String)">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getHeader</h4>
+<pre>public java.lang.String getHeader(java.lang.String name)</pre>
+<div class="block">Return the value for the specified header, or <code>null</code> if this
+ header has not been set. If more than one value was added for this
+ name, only the first is returned; use <a href="../../../javax/servlet/http/HttpServletResponse.html#getHeaders(java.lang.String)"><code>HttpServletResponse.getHeaders(String)</code></a> to
+ retrieve all of them.
+ <p>
+ The default implementation is to call
+ <a href="../../../javax/servlet/http/HttpServletResponse.html#getHeader(java.lang.String)"><code>HttpServletResponse.getHeader(String)</code></a>
+ on the wrapper <a href="../../../javax/servlet/http/HttpServletResponse.html" title="interface in javax.servlet.http"><code>HttpServletResponse</code></a>.</div>
+<dl>
+<dt><strong>Specified by:</strong></dt>
+<dd><code><a href="../../../javax/servlet/http/HttpServletResponse.html#getHeader(java.lang.String)">getHeader</a></code> in interface <code><a href="../../../javax/servlet/http/HttpServletResponse.html" title="interface in javax.servlet.http">HttpServletResponse</a></code></dd>
+<dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - Header name to look up</dd><dt><span class="strong">Since:</span></dt>
+ <dd>Servlet 3.0</dd></dl>
+</li>
+</ul>
+<a name="getHeaders(java.lang.String)">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getHeaders</h4>
+<pre>public java.util.Collection<java.lang.String> getHeaders(java.lang.String name)</pre>
+<div class="block">Return a Collection of all the header values associated with the
+ specified header name.
+ <p>
+ The default implementation is to call
+ <a href="../../../javax/servlet/http/HttpServletResponse.html#getHeaders(java.lang.String)"><code>HttpServletResponse.getHeaders(String)</code></a>
+ on the wrapper <a href="../../../javax/servlet/http/HttpServletResponse.html" title="interface in javax.servlet.http"><code>HttpServletResponse</code></a>.</div>
+<dl>
+<dt><strong>Specified by:</strong></dt>
+<dd><code><a href="../../../javax/servlet/http/HttpServletResponse.html#getHeaders(java.lang.String)">getHeaders</a></code> in interface <code><a href="../../../javax/servlet/http/HttpServletResponse.html" title="interface in javax.servlet.http">HttpServletResponse</a></code></dd>
+<dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - Header name to look up</dd><dt><span class="strong">Since:</span></dt>
+ <dd>Servlet 3.0</dd></dl>
+</li>
+</ul>
+<a name="getHeaderNames()">
+<!-- -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>getHeaderNames</h4>
+<pre>public java.util.Collection<java.lang.String> getHeaderNames()</pre>
+<div class="block">Return an Iterable of all the header names set for this response.
+ <p>
+ The default implementation is to call
+ <a href="../../../javax/servlet/http/HttpServletResponse.html#getHeaderNames()"><code>HttpServletResponse.getHeaderNames()</code></a>
+ on the wrapper <a href="../../../javax/servlet/http/HttpServletResponse.html" title="interface in javax.servlet.http"><code>HttpServletResponse</code></a>.</div>
+<dl>
+<dt><strong>Specified by:</strong></dt>
+<dd><code><a href="../../../javax/servlet/http/HttpServletResponse.html#getHeaderNames()">getHeaderNames</a></code> in interface <code><a href="../../../javax/servlet/http/HttpServletResponse.html" title="interface in javax.servlet.http">HttpServletResponse</a></code></dd>
+<dt><span class="strong">Since:</span></dt>
+ <dd>Servlet 3.0</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/HttpServletResponse.html" title="interface in javax.servlet.http"><span class="strong">Prev Class</span></a></li>
+<li><a href="../../../javax/servlet/http/HttpSession.html" title="interface in javax.servlet.http"><span class="strong">Next Class</span></a></li>
+</ul>
+<ul class="navList">
+<li><a href="../../../index.html?javax/servlet/http/HttpServletResponseWrapper.html" target="_top">Frames</a></li>
+<li><a href="HttpServletResponseWrapper.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>Field | </li>
+<li><a href="#constructor_summary">Constr</a> | </li>
+<li><a href="#method_summary">Method</a></li>
+</ul>
+<ul class="subNavList">
+<li>Detail: </li>
+<li>Field | </li>
+<li><a href="#constructor_detail">Constr</a> | </li>
+<li><a href="#method_detail">Method</a></li>
+</ul>
+</div>
+<a 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/HttpServletResponseWrapper.html
------------------------------------------------------------------------------
svn:eol-style = native
Added: tomcat/site/trunk/docs/tomcat-8.0-doc/servletapi/javax/servlet/http/HttpSession.html
URL: http://svn.apache.org/viewvc/tomcat/site/trunk/docs/tomcat-8.0-doc/servletapi/javax/servlet/http/HttpSession.html?rev=1510665&view=auto
==============================================================================
--- tomcat/site/trunk/docs/tomcat-8.0-doc/servletapi/javax/servlet/http/HttpSession.html (added)
+++ tomcat/site/trunk/docs/tomcat-8.0-doc/servletapi/javax/servlet/http/HttpSession.html Mon Aug 5 19:10:09 2013
@@ -0,0 +1,633 @@
+<!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>HttpSession (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="HttpSession (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/HttpServletResponseWrapper.html" title="class in javax.servlet.http"><span class="strong">Prev Class</span></a></li>
+<li><a href="../../../javax/servlet/http/HttpSessionActivationListener.html" title="interface in javax.servlet.http"><span class="strong">Next Class</span></a></li>
+</ul>
+<ul class="navList">
+<li><a href="../../../index.html?javax/servlet/http/HttpSession.html" target="_top">Frames</a></li>
+<li><a href="HttpSession.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>Field | </li>
+<li>Constr | </li>
+<li><a href="#method_summary">Method</a></li>
+</ul>
+<ul class="subNavList">
+<li>Detail: </li>
+<li>Field | </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 HttpSession" class="title">Interface HttpSession</h2>
+</div>
+<div class="contentContainer">
+<div class="description">
+<ul class="blockList">
+<li class="blockList">
+<hr>
+<br>
+<pre>public interface <span class="strong">HttpSession</span></pre>
+<div class="block">Provides a way to identify a user across more than one page request or visit
+ to a Web site and to store information about that user.
+ <p>
+ The servlet container uses this interface to create a session between an HTTP
+ client and an HTTP server. The session persists for a specified time period,
+ across more than one connection or page request from the user. A session
+ usually corresponds to one user, who may visit a site many times. The server
+ can maintain a session in many ways such as using cookies or rewriting URLs.
+ <p>
+ This interface allows servlets to
+ <ul>
+ <li>View and manipulate information about a session, such as the session
+ identifier, creation time, and last accessed time
+ <li>Bind objects to sessions, allowing user information to persist across
+ multiple user connections
+ </ul>
+ <p>
+ When an application stores an object in or removes an object from a session,
+ the session checks whether the object implements
+ <a href="../../../javax/servlet/http/HttpSessionBindingListener.html" title="interface in javax.servlet.http"><code>HttpSessionBindingListener</code></a>. If it does, the servlet notifies the
+ object that it has been bound to or unbound from the session. Notifications
+ are sent after the binding methods complete. For session that are invalidated
+ or expire, notifications are sent after the session has been invalidated or
+ expired.
+ <p>
+ When container migrates a session between VMs in a distributed container
+ setting, all session attributes implementing the
+ <a href="../../../javax/servlet/http/HttpSessionActivationListener.html" title="interface in javax.servlet.http"><code>HttpSessionActivationListener</code></a> interface are notified.
+ <p>
+ A servlet should be able to handle cases in which the client does not choose
+ to join a session, such as when cookies are intentionally turned off. Until
+ the client joins the session, <code>isNew</code> returns <code>true</code>.
+ If the client chooses not to join the session, <code>getSession</code> will
+ return a different session on each request, and <code>isNew</code> will
+ always return <code>true</code>.
+ <p>
+ Session information is scoped only to the current web application (
+ <code>ServletContext</code>), so information stored in one context will not
+ be directly visible in another.</div>
+<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../javax/servlet/http/HttpSessionBindingListener.html" title="interface in javax.servlet.http"><code>HttpSessionBindingListener</code></a></dd></dl>
+</li>
+</ul>
+</div>
+<div class="summary">
+<ul class="blockList">
+<li class="blockList">
+<!-- ========== 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>java.lang.Object</code></td>
+<td class="colLast"><code><strong><a href="../../../javax/servlet/http/HttpSession.html#getAttribute(java.lang.String)">getAttribute</a></strong>(java.lang.String name)</code>
+<div class="block">Returns the object bound with the specified name in this session, or
+ <code>null</code> if no object is bound under the name.</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/HttpSession.html#getAttributeNames()">getAttributeNames</a></strong>()</code>
+<div class="block">Returns an <code>Enumeration</code> of <code>String</code> objects
+ containing the names of all the objects bound to this session.</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>long</code></td>
+<td class="colLast"><code><strong><a href="../../../javax/servlet/http/HttpSession.html#getCreationTime()">getCreationTime</a></strong>()</code>
+<div class="block">Returns the time when this session was created, measured in milliseconds
+ since midnight January 1, 1970 GMT.</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/HttpSession.html#getId()">getId</a></strong>()</code>
+<div class="block">Returns a string containing the unique identifier assigned to this
+ session.</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>long</code></td>
+<td class="colLast"><code><strong><a href="../../../javax/servlet/http/HttpSession.html#getLastAccessedTime()">getLastAccessedTime</a></strong>()</code>
+<div class="block">Returns the last time the client sent a request associated with this
+ session, as the number of milliseconds since midnight January 1, 1970
+ GMT, and marked by the time the container received the request.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>int</code></td>
+<td class="colLast"><code><strong><a href="../../../javax/servlet/http/HttpSession.html#getMaxInactiveInterval()">getMaxInactiveInterval</a></strong>()</code>
+<div class="block">Returns the maximum time interval, in seconds, that the servlet container
+ will keep this session open between client accesses.</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code><a href="../../../javax/servlet/ServletContext.html" title="interface in javax.servlet">ServletContext</a></code></td>
+<td class="colLast"><code><strong><a href="../../../javax/servlet/http/HttpSession.html#getServletContext()">getServletContext</a></strong>()</code>
+<div class="block">Returns the ServletContext to which this session belongs.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code><a href="../../../javax/servlet/http/HttpSessionContext.html" title="interface in javax.servlet.http">HttpSessionContext</a></code></td>
+<td class="colLast"><code><strong><a href="../../../javax/servlet/http/HttpSession.html#getSessionContext()">getSessionContext</a></strong>()</code>
+<div class="block"><strong>Deprecated.</strong>
+<div class="block"><i>As of Version 2.1, this method is deprecated and has no
+ replacement. It will be removed in a future version of the
+ Java Servlet API.</i></div>
+</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>java.lang.Object</code></td>
+<td class="colLast"><code><strong><a href="../../../javax/servlet/http/HttpSession.html#getValue(java.lang.String)">getValue</a></strong>(java.lang.String name)</code>
+<div class="block"><strong>Deprecated.</strong>
+<div class="block"><i>As of Version 2.2, this method is replaced by
+ <a href="../../../javax/servlet/http/HttpSession.html#getAttribute(java.lang.String)"><code>getAttribute(java.lang.String)</code></a>.</i></div>
+</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/HttpSession.html#getValueNames()">getValueNames</a></strong>()</code>
+<div class="block"><strong>Deprecated.</strong>
+<div class="block"><i>As of Version 2.2, this method is replaced by
+ <a href="../../../javax/servlet/http/HttpSession.html#getAttributeNames()"><code>getAttributeNames()</code></a></i></div>
+</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><strong><a href="../../../javax/servlet/http/HttpSession.html#invalidate()">invalidate</a></strong>()</code>
+<div class="block">Invalidates this session then unbinds any objects bound to it.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>boolean</code></td>
+<td class="colLast"><code><strong><a href="../../../javax/servlet/http/HttpSession.html#isNew()">isNew</a></strong>()</code>
+<div class="block">Returns <code>true</code> if the client does not yet know about the
+ session or if the client chooses not to join the session.</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><strong><a href="../../../javax/servlet/http/HttpSession.html#putValue(java.lang.String, java.lang.Object)">putValue</a></strong>(java.lang.String name,
+ java.lang.Object value)</code>
+<div class="block"><strong>Deprecated.</strong>
+<div class="block"><i>As of Version 2.2, this method is replaced by
+ <a href="../../../javax/servlet/http/HttpSession.html#setAttribute(java.lang.String, java.lang.Object)"><code>setAttribute(java.lang.String, java.lang.Object)</code></a></i></div>
+</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><strong><a href="../../../javax/servlet/http/HttpSession.html#removeAttribute(java.lang.String)">removeAttribute</a></strong>(java.lang.String name)</code>
+<div class="block">Removes the object bound with the specified name from this session.</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><strong><a href="../../../javax/servlet/http/HttpSession.html#removeValue(java.lang.String)">removeValue</a></strong>(java.lang.String name)</code>
+<div class="block"><strong>Deprecated.</strong>
+<div class="block"><i>As of Version 2.2, this method is replaced by
+ <a href="../../../javax/servlet/http/HttpSession.html#removeAttribute(java.lang.String)"><code>removeAttribute(java.lang.String)</code></a></i></div>
+</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><strong><a href="../../../javax/servlet/http/HttpSession.html#setAttribute(java.lang.String, java.lang.Object)">setAttribute</a></strong>(java.lang.String name,
+ java.lang.Object value)</code>
+<div class="block">Binds an object to this session, using the name specified.</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><strong><a href="../../../javax/servlet/http/HttpSession.html#setMaxInactiveInterval(int)">setMaxInactiveInterval</a></strong>(int interval)</code>
+<div class="block">Specifies the time, in seconds, between client requests before the
+ servlet container will invalidate this session.</div>
+</td>
+</tr>
+</table>
+</li>
+</ul>
+</li>
+</ul>
+</div>
+<div class="details">
+<ul class="blockList">
+<li class="blockList">
+<!-- ============ METHOD DETAIL ========== -->
+<ul class="blockList">
+<li class="blockList"><a name="method_detail">
+<!-- -->
+</a>
+<h3>Method Detail</h3>
+<a name="getCreationTime()">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getCreationTime</h4>
+<pre>long getCreationTime()</pre>
+<div class="block">Returns the time when this session was created, measured in milliseconds
+ since midnight January 1, 1970 GMT.</div>
+<dl><dt><span class="strong">Returns:</span></dt><dd>a <code>long</code> specifying when this session was created,
+ expressed in milliseconds since 1/1/1970 GMT</dd>
+<dt><span class="strong">Throws:</span></dt>
+<dd><code>java.lang.IllegalStateException</code> - if this method is called on an invalidated session</dd></dl>
+</li>
+</ul>
+<a name="getId()">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getId</h4>
+<pre>java.lang.String getId()</pre>
+<div class="block">Returns a string containing the unique identifier assigned to this
+ session. The identifier is assigned by the servlet container and is
+ implementation dependent.</div>
+<dl><dt><span class="strong">Returns:</span></dt><dd>a string specifying the identifier assigned to this session</dd>
+<dt><span class="strong">Throws:</span></dt>
+<dd><code>java.lang.IllegalStateException</code> - if this method is called on an invalidated session</dd></dl>
+</li>
+</ul>
+<a name="getLastAccessedTime()">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getLastAccessedTime</h4>
+<pre>long getLastAccessedTime()</pre>
+<div class="block">Returns the last time the client sent a request associated with this
+ session, as the number of milliseconds since midnight January 1, 1970
+ GMT, and marked by the time the container received the request.
+ <p>
+ Actions that your application takes, such as getting or setting a value
+ associated with the session, do not affect the access time.</div>
+<dl><dt><span class="strong">Returns:</span></dt><dd>a <code>long</code> representing the last time the client sent a
+ request associated with this session, expressed in milliseconds
+ since 1/1/1970 GMT</dd>
+<dt><span class="strong">Throws:</span></dt>
+<dd><code>java.lang.IllegalStateException</code> - if this method is called on an invalidated session</dd></dl>
+</li>
+</ul>
+<a name="getServletContext()">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getServletContext</h4>
+<pre><a href="../../../javax/servlet/ServletContext.html" title="interface in javax.servlet">ServletContext</a> getServletContext()</pre>
+<div class="block">Returns the ServletContext to which this session belongs.</div>
+<dl><dt><span class="strong">Returns:</span></dt><dd>The ServletContext object for the web application</dd><dt><span class="strong">Since:</span></dt>
+ <dd>2.3</dd></dl>
+</li>
+</ul>
+<a name="setMaxInactiveInterval(int)">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>setMaxInactiveInterval</h4>
+<pre>void setMaxInactiveInterval(int interval)</pre>
+<div class="block">Specifies the time, in seconds, between client requests before the
+ servlet container will invalidate this session. A zero or negative time
+ indicates that the session should never timeout.</div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>interval</code> - An integer specifying the number of seconds</dd></dl>
+</li>
+</ul>
+<a name="getMaxInactiveInterval()">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getMaxInactiveInterval</h4>
+<pre>int getMaxInactiveInterval()</pre>
+<div class="block">Returns the maximum time interval, in seconds, that the servlet container
+ will keep this session open between client accesses. After this interval,
+ the servlet container will invalidate the session. The maximum time
+ interval can be set with the <code>setMaxInactiveInterval</code> method.
+ A zero or negative time indicates that the session should never timeout.</div>
+<dl><dt><span class="strong">Returns:</span></dt><dd>an integer specifying the number of seconds this session remains
+ open between client requests</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../javax/servlet/http/HttpSession.html#setMaxInactiveInterval(int)"><code>setMaxInactiveInterval(int)</code></a></dd></dl>
+</li>
+</ul>
+<a name="getSessionContext()">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getSessionContext</h4>
+<pre><a href="../../../javax/servlet/http/HttpSessionContext.html" title="interface in javax.servlet.http">HttpSessionContext</a> getSessionContext()</pre>
+<div class="block"><span class="strong">Deprecated.</span> <i>As of Version 2.1, this method is deprecated and has no
+ replacement. It will be removed in a future version of the
+ Java Servlet API.</i></div>
+</li>
+</ul>
+<a name="getAttribute(java.lang.String)">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getAttribute</h4>
+<pre>java.lang.Object getAttribute(java.lang.String name)</pre>
+<div class="block">Returns the object bound with the specified name in this session, or
+ <code>null</code> if no object is bound under the name.</div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - a string specifying the name of the object</dd>
+<dt><span class="strong">Returns:</span></dt><dd>the object with the specified name</dd>
+<dt><span class="strong">Throws:</span></dt>
+<dd><code>java.lang.IllegalStateException</code> - if this method is called on an invalidated session</dd></dl>
+</li>
+</ul>
+<a name="getValue(java.lang.String)">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getValue</h4>
+<pre>java.lang.Object getValue(java.lang.String name)</pre>
+<div class="block"><span class="strong">Deprecated.</span> <i>As of Version 2.2, this method is replaced by
+ <a href="../../../javax/servlet/http/HttpSession.html#getAttribute(java.lang.String)"><code>getAttribute(java.lang.String)</code></a>.</i></div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - a string specifying the name of the object</dd>
+<dt><span class="strong">Returns:</span></dt><dd>the object with the specified name</dd>
+<dt><span class="strong">Throws:</span></dt>
+<dd><code>java.lang.IllegalStateException</code> - if this method is called on an invalidated session</dd></dl>
+</li>
+</ul>
+<a name="getAttributeNames()">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getAttributeNames</h4>
+<pre>java.util.Enumeration<java.lang.String> getAttributeNames()</pre>
+<div class="block">Returns an <code>Enumeration</code> of <code>String</code> objects
+ containing the names of all the objects bound to this session.</div>
+<dl><dt><span class="strong">Returns:</span></dt><dd>an <code>Enumeration</code> of <code>String</code> objects
+ specifying the names of all the objects bound to this session</dd>
+<dt><span class="strong">Throws:</span></dt>
+<dd><code>java.lang.IllegalStateException</code> - if this method is called on an invalidated session</dd></dl>
+</li>
+</ul>
+<a name="getValueNames()">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getValueNames</h4>
+<pre>java.lang.String[] getValueNames()</pre>
+<div class="block"><span class="strong">Deprecated.</span> <i>As of Version 2.2, this method is replaced by
+ <a href="../../../javax/servlet/http/HttpSession.html#getAttributeNames()"><code>getAttributeNames()</code></a></i></div>
+<dl><dt><span class="strong">Returns:</span></dt><dd>an array of <code>String</code> objects specifying the names of
+ all the objects bound to this session</dd>
+<dt><span class="strong">Throws:</span></dt>
+<dd><code>java.lang.IllegalStateException</code> - if this method is called on an invalidated session</dd></dl>
+</li>
+</ul>
+<a name="setAttribute(java.lang.String, java.lang.Object)">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>setAttribute</h4>
+<pre>void setAttribute(java.lang.String name,
+ java.lang.Object value)</pre>
+<div class="block">Binds an object to this session, using the name specified. If an object
+ of the same name is already bound to the session, the object is replaced.
+ <p>
+ After this method executes, and if the new object implements
+ <code>HttpSessionBindingListener</code>, the container calls
+ <code>HttpSessionBindingListener.valueBound</code>. The container then
+ notifies any <code>HttpSessionAttributeListener</code>s in the web
+ application.
+ <p>
+ If an object was already bound to this session of this name that
+ implements <code>HttpSessionBindingListener</code>, its
+ <code>HttpSessionBindingListener.valueUnbound</code> method is called.
+ <p>
+ If the value passed in is null, this has the same effect as calling
+ <code>removeAttribute()</code>.</div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - the name to which the object is bound; cannot be null</dd><dd><code>value</code> - the object to be bound</dd>
+<dt><span class="strong">Throws:</span></dt>
+<dd><code>java.lang.IllegalStateException</code> - if this method is called on an invalidated session</dd></dl>
+</li>
+</ul>
+<a name="putValue(java.lang.String, java.lang.Object)">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>putValue</h4>
+<pre>void putValue(java.lang.String name,
+ java.lang.Object value)</pre>
+<div class="block"><span class="strong">Deprecated.</span> <i>As of Version 2.2, this method is replaced by
+ <a href="../../../javax/servlet/http/HttpSession.html#setAttribute(java.lang.String, java.lang.Object)"><code>setAttribute(java.lang.String, java.lang.Object)</code></a></i></div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - the name to which the object is bound; cannot be null</dd><dd><code>value</code> - the object to be bound; cannot be null</dd>
+<dt><span class="strong">Throws:</span></dt>
+<dd><code>java.lang.IllegalStateException</code> - if this method is called on an invalidated session</dd></dl>
+</li>
+</ul>
+<a name="removeAttribute(java.lang.String)">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>removeAttribute</h4>
+<pre>void removeAttribute(java.lang.String name)</pre>
+<div class="block">Removes the object bound with the specified name from this session. If
+ the session does not have an object bound with the specified name, this
+ method does nothing.
+ <p>
+ After this method executes, and if the object implements
+ <code>HttpSessionBindingListener</code>, the container calls
+ <code>HttpSessionBindingListener.valueUnbound</code>. The container then
+ notifies any <code>HttpSessionAttributeListener</code>s in the web
+ application.</div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - the name of the object to remove from this session</dd>
+<dt><span class="strong">Throws:</span></dt>
+<dd><code>java.lang.IllegalStateException</code> - if this method is called on an invalidated session</dd></dl>
+</li>
+</ul>
+<a name="removeValue(java.lang.String)">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>removeValue</h4>
+<pre>void removeValue(java.lang.String name)</pre>
+<div class="block"><span class="strong">Deprecated.</span> <i>As of Version 2.2, this method is replaced by
+ <a href="../../../javax/servlet/http/HttpSession.html#removeAttribute(java.lang.String)"><code>removeAttribute(java.lang.String)</code></a></i></div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - the name of the object to remove from this session</dd>
+<dt><span class="strong">Throws:</span></dt>
+<dd><code>java.lang.IllegalStateException</code> - if this method is called on an invalidated session</dd></dl>
+</li>
+</ul>
+<a name="invalidate()">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>invalidate</h4>
+<pre>void invalidate()</pre>
+<div class="block">Invalidates this session then unbinds any objects bound to it.</div>
+<dl><dt><span class="strong">Throws:</span></dt>
+<dd><code>java.lang.IllegalStateException</code> - if this method is called on an already invalidated session</dd></dl>
+</li>
+</ul>
+<a name="isNew()">
+<!-- -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>isNew</h4>
+<pre>boolean isNew()</pre>
+<div class="block">Returns <code>true</code> if the client does not yet know about the
+ session or if the client chooses not to join the session. For example, if
+ the server used only cookie-based sessions, and the client had disabled
+ the use of cookies, then a session would be new on each request.</div>
+<dl><dt><span class="strong">Returns:</span></dt><dd><code>true</code> if the server has created a session, but the
+ client has not yet joined</dd>
+<dt><span class="strong">Throws:</span></dt>
+<dd><code>java.lang.IllegalStateException</code> - if this method is called on an already invalidated session</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/HttpServletResponseWrapper.html" title="class in javax.servlet.http"><span class="strong">Prev Class</span></a></li>
+<li><a href="../../../javax/servlet/http/HttpSessionActivationListener.html" title="interface in javax.servlet.http"><span class="strong">Next Class</span></a></li>
+</ul>
+<ul class="navList">
+<li><a href="../../../index.html?javax/servlet/http/HttpSession.html" target="_top">Frames</a></li>
+<li><a href="HttpSession.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>Field | </li>
+<li>Constr | </li>
+<li><a href="#method_summary">Method</a></li>
+</ul>
+<ul class="subNavList">
+<li>Detail: </li>
+<li>Field | </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/HttpSession.html
------------------------------------------------------------------------------
svn:eol-style = native
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@tomcat.apache.org
For additional commands, e-mail: dev-help@tomcat.apache.org