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 [7/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/RequestDispatcher.html
URL: http://svn.apache.org/viewvc/tomcat/site/trunk/docs/tomcat-8.0-doc/servletapi/javax/servlet/RequestDispatcher.html?rev=1510665&view=auto
==============================================================================
--- tomcat/site/trunk/docs/tomcat-8.0-doc/servletapi/javax/servlet/RequestDispatcher.html (added)
+++ tomcat/site/trunk/docs/tomcat-8.0-doc/servletapi/javax/servlet/RequestDispatcher.html Mon Aug 5 19:10:09 2013
@@ -0,0 +1,722 @@
+<!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:51 BST 2013 -->
+<title>RequestDispatcher (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="RequestDispatcher (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/Registration.Dynamic.html" title="interface in javax.servlet"><span class="strong">Prev Class</span></a></li>
+<li><a href="../../javax/servlet/Servlet.html" title="interface in javax.servlet"><span class="strong">Next Class</span></a></li>
+</ul>
+<ul class="navList">
+<li><a href="../../index.html?javax/servlet/RequestDispatcher.html" target="_top">Frames</a></li>
+<li><a href="RequestDispatcher.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</div>
+<h2 title="Interface RequestDispatcher" class="title">Interface RequestDispatcher</h2>
+</div>
+<div class="contentContainer">
+<div class="description">
+<ul class="blockList">
+<li class="blockList">
+<hr>
+<br>
+<pre>public interface <span class="strong">RequestDispatcher</span></pre>
+<div class="block">Defines an object that receives requests from the client and sends them to
+ any resource (such as a servlet, HTML file, or JSP file) on the server. The
+ servlet container creates the <code>RequestDispatcher</code> object, which is
+ used as a wrapper around a server resource located at a particular path or
+ given by a particular name.
+
+ <p>
+ This interface is intended to wrap servlets, but a servlet container can
+ create <code>RequestDispatcher</code> objects to wrap any type of resource.</div>
+<dl><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/ServletContext.html#getRequestDispatcher(java.lang.String)"><code>ServletContext.getRequestDispatcher(java.lang.String)</code></a>,
+<a href="../../javax/servlet/ServletContext.html#getNamedDispatcher(java.lang.String)"><code>ServletContext.getNamedDispatcher(java.lang.String)</code></a>,
+<a href="../../javax/servlet/ServletRequest.html#getRequestDispatcher(java.lang.String)"><code>ServletRequest.getRequestDispatcher(java.lang.String)</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>
+<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/RequestDispatcher.html#ERROR_EXCEPTION">ERROR_EXCEPTION</a></strong></code>
+<div class="block">The name of the request attribute that should be set by the container
+ when custom error-handling servlet or JSP page is invoked.</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/RequestDispatcher.html#ERROR_EXCEPTION_TYPE">ERROR_EXCEPTION_TYPE</a></strong></code>
+<div class="block">The name of the request attribute that should be set by the container
+ when custom error-handling servlet or JSP page is invoked.</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/RequestDispatcher.html#ERROR_MESSAGE">ERROR_MESSAGE</a></strong></code>
+<div class="block">The name of the request attribute that should be set by the container
+ when custom error-handling servlet or JSP page is invoked.</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/RequestDispatcher.html#ERROR_REQUEST_URI">ERROR_REQUEST_URI</a></strong></code>
+<div class="block">The name of the request attribute that should be set by the container
+ when custom error-handling servlet or JSP page is invoked.</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/RequestDispatcher.html#ERROR_SERVLET_NAME">ERROR_SERVLET_NAME</a></strong></code>
+<div class="block">The name of the request attribute that should be set by the container
+ when custom error-handling servlet or JSP page is invoked.</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/RequestDispatcher.html#ERROR_STATUS_CODE">ERROR_STATUS_CODE</a></strong></code>
+<div class="block">The name of the request attribute that should be set by the container
+ when custom error-handling servlet or JSP page is invoked.</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/RequestDispatcher.html#FORWARD_CONTEXT_PATH">FORWARD_CONTEXT_PATH</a></strong></code>
+<div class="block">The name of the request attribute that should be set by the container
+ when the <a href="../../javax/servlet/RequestDispatcher.html#forward(javax.servlet.ServletRequest, javax.servlet.ServletResponse)"><code>forward(ServletRequest, ServletResponse)</code></a> method is
+ called.</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/RequestDispatcher.html#FORWARD_PATH_INFO">FORWARD_PATH_INFO</a></strong></code>
+<div class="block">The name of the request attribute that should be set by the container
+ when the <a href="../../javax/servlet/RequestDispatcher.html#forward(javax.servlet.ServletRequest, javax.servlet.ServletResponse)"><code>forward(ServletRequest, ServletResponse)</code></a> method is
+ called.</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/RequestDispatcher.html#FORWARD_QUERY_STRING">FORWARD_QUERY_STRING</a></strong></code>
+<div class="block">The name of the request attribute that should be set by the container
+ when the <a href="../../javax/servlet/RequestDispatcher.html#forward(javax.servlet.ServletRequest, javax.servlet.ServletResponse)"><code>forward(ServletRequest, ServletResponse)</code></a> method is
+ called.</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/RequestDispatcher.html#FORWARD_REQUEST_URI">FORWARD_REQUEST_URI</a></strong></code>
+<div class="block">The name of the request attribute that should be set by the container
+ when the <a href="../../javax/servlet/RequestDispatcher.html#forward(javax.servlet.ServletRequest, javax.servlet.ServletResponse)"><code>forward(ServletRequest, ServletResponse)</code></a> method is
+ called.</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/RequestDispatcher.html#FORWARD_SERVLET_PATH">FORWARD_SERVLET_PATH</a></strong></code>
+<div class="block">The name of the request attribute that should be set by the container
+ when the <a href="../../javax/servlet/RequestDispatcher.html#forward(javax.servlet.ServletRequest, javax.servlet.ServletResponse)"><code>forward(ServletRequest, ServletResponse)</code></a> method is
+ called.</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/RequestDispatcher.html#INCLUDE_CONTEXT_PATH">INCLUDE_CONTEXT_PATH</a></strong></code>
+<div class="block">The name of the request attribute that should be set by the container
+ when the <a href="../../javax/servlet/RequestDispatcher.html#include(javax.servlet.ServletRequest, javax.servlet.ServletResponse)"><code>include(ServletRequest, ServletResponse)</code></a> method is
+ called on the <code>RequestDispatcher</code> obtained by a path and not by a
+ name.</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/RequestDispatcher.html#INCLUDE_PATH_INFO">INCLUDE_PATH_INFO</a></strong></code>
+<div class="block">The name of the request attribute that should be set by the container
+ when the <a href="../../javax/servlet/RequestDispatcher.html#include(javax.servlet.ServletRequest, javax.servlet.ServletResponse)"><code>include(ServletRequest, ServletResponse)</code></a> method is
+ called on the <code>RequestDispatcher</code> obtained by a path and not by a
+ name.</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/RequestDispatcher.html#INCLUDE_QUERY_STRING">INCLUDE_QUERY_STRING</a></strong></code>
+<div class="block">The name of the request attribute that should be set by the container
+ when the <a href="../../javax/servlet/RequestDispatcher.html#include(javax.servlet.ServletRequest, javax.servlet.ServletResponse)"><code>include(ServletRequest, ServletResponse)</code></a> method is
+ called on the <code>RequestDispatcher</code> obtained by a path and not by a
+ name.</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/RequestDispatcher.html#INCLUDE_REQUEST_URI">INCLUDE_REQUEST_URI</a></strong></code>
+<div class="block">The name of the request attribute that should be set by the container
+ when the <a href="../../javax/servlet/RequestDispatcher.html#include(javax.servlet.ServletRequest, javax.servlet.ServletResponse)"><code>include(ServletRequest, ServletResponse)</code></a> method is
+ called on the <code>RequestDispatcher</code> obtained by a path and not by a
+ name.</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/RequestDispatcher.html#INCLUDE_SERVLET_PATH">INCLUDE_SERVLET_PATH</a></strong></code>
+<div class="block">The name of the request attribute that should be set by the container
+ when the <a href="../../javax/servlet/RequestDispatcher.html#include(javax.servlet.ServletRequest, javax.servlet.ServletResponse)"><code>include(ServletRequest, ServletResponse)</code></a> method is
+ called on the <code>RequestDispatcher</code> obtained by a path and not by a
+ name.</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/RequestDispatcher.html#forward(javax.servlet.ServletRequest, javax.servlet.ServletResponse)">forward</a></strong>(<a href="../../javax/servlet/ServletRequest.html" title="interface in javax.servlet">ServletRequest</a> request,
+ <a href="../../javax/servlet/ServletResponse.html" title="interface in javax.servlet">ServletResponse</a> response)</code>
+<div class="block">Forwards a request from a servlet to another resource (servlet, JSP file,
+ or HTML file) on the server.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><strong><a href="../../javax/servlet/RequestDispatcher.html#include(javax.servlet.ServletRequest, javax.servlet.ServletResponse)">include</a></strong>(<a href="../../javax/servlet/ServletRequest.html" title="interface in javax.servlet">ServletRequest</a> request,
+ <a href="../../javax/servlet/ServletResponse.html" title="interface in javax.servlet">ServletResponse</a> response)</code>
+<div class="block">Includes the content of a resource (servlet, JSP page, HTML file) in the
+ response.</div>
+</td>
+</tr>
+</table>
+</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="FORWARD_REQUEST_URI">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>FORWARD_REQUEST_URI</h4>
+<pre>static final java.lang.String FORWARD_REQUEST_URI</pre>
+<div class="block">The name of the request attribute that should be set by the container
+ when the <a href="../../javax/servlet/RequestDispatcher.html#forward(javax.servlet.ServletRequest, javax.servlet.ServletResponse)"><code>forward(ServletRequest, ServletResponse)</code></a> method is
+ called. It provides the original value of a path-related property of the
+ request. See the chapter "Forwarded Request Parameters" in the Servlet
+ Specification for details.</div>
+<dl><dt><span class="strong">Since:</span></dt>
+ <dd>Servlet 3.0</dd>
+<dt><span class="strong">See Also:</span></dt><dd><a href="../../constant-values.html#javax.servlet.RequestDispatcher.FORWARD_REQUEST_URI">Constant Field Values</a></dd></dl>
+</li>
+</ul>
+<a name="FORWARD_CONTEXT_PATH">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>FORWARD_CONTEXT_PATH</h4>
+<pre>static final java.lang.String FORWARD_CONTEXT_PATH</pre>
+<div class="block">The name of the request attribute that should be set by the container
+ when the <a href="../../javax/servlet/RequestDispatcher.html#forward(javax.servlet.ServletRequest, javax.servlet.ServletResponse)"><code>forward(ServletRequest, ServletResponse)</code></a> method is
+ called. It provides the original value of a path-related property of the
+ request. See the chapter "Forwarded Request Parameters" in the Servlet
+ Specification for details.</div>
+<dl><dt><span class="strong">Since:</span></dt>
+ <dd>Servlet 3.0</dd>
+<dt><span class="strong">See Also:</span></dt><dd><a href="../../constant-values.html#javax.servlet.RequestDispatcher.FORWARD_CONTEXT_PATH">Constant Field Values</a></dd></dl>
+</li>
+</ul>
+<a name="FORWARD_PATH_INFO">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>FORWARD_PATH_INFO</h4>
+<pre>static final java.lang.String FORWARD_PATH_INFO</pre>
+<div class="block">The name of the request attribute that should be set by the container
+ when the <a href="../../javax/servlet/RequestDispatcher.html#forward(javax.servlet.ServletRequest, javax.servlet.ServletResponse)"><code>forward(ServletRequest, ServletResponse)</code></a> method is
+ called. It provides the original value of a path-related property of the
+ request. See the chapter "Forwarded Request Parameters" in the Servlet
+ Specification for details.</div>
+<dl><dt><span class="strong">Since:</span></dt>
+ <dd>Servlet 3.0</dd>
+<dt><span class="strong">See Also:</span></dt><dd><a href="../../constant-values.html#javax.servlet.RequestDispatcher.FORWARD_PATH_INFO">Constant Field Values</a></dd></dl>
+</li>
+</ul>
+<a name="FORWARD_SERVLET_PATH">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>FORWARD_SERVLET_PATH</h4>
+<pre>static final java.lang.String FORWARD_SERVLET_PATH</pre>
+<div class="block">The name of the request attribute that should be set by the container
+ when the <a href="../../javax/servlet/RequestDispatcher.html#forward(javax.servlet.ServletRequest, javax.servlet.ServletResponse)"><code>forward(ServletRequest, ServletResponse)</code></a> method is
+ called. It provides the original value of a path-related property of the
+ request. See the chapter "Forwarded Request Parameters" in the Servlet
+ Specification for details.</div>
+<dl><dt><span class="strong">Since:</span></dt>
+ <dd>Servlet 3.0</dd>
+<dt><span class="strong">See Also:</span></dt><dd><a href="../../constant-values.html#javax.servlet.RequestDispatcher.FORWARD_SERVLET_PATH">Constant Field Values</a></dd></dl>
+</li>
+</ul>
+<a name="FORWARD_QUERY_STRING">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>FORWARD_QUERY_STRING</h4>
+<pre>static final java.lang.String FORWARD_QUERY_STRING</pre>
+<div class="block">The name of the request attribute that should be set by the container
+ when the <a href="../../javax/servlet/RequestDispatcher.html#forward(javax.servlet.ServletRequest, javax.servlet.ServletResponse)"><code>forward(ServletRequest, ServletResponse)</code></a> method is
+ called. It provides the original value of a path-related property of the
+ request. See the chapter "Forwarded Request Parameters" in the Servlet
+ Specification for details.</div>
+<dl><dt><span class="strong">Since:</span></dt>
+ <dd>Servlet 3.0</dd>
+<dt><span class="strong">See Also:</span></dt><dd><a href="../../constant-values.html#javax.servlet.RequestDispatcher.FORWARD_QUERY_STRING">Constant Field Values</a></dd></dl>
+</li>
+</ul>
+<a name="INCLUDE_REQUEST_URI">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>INCLUDE_REQUEST_URI</h4>
+<pre>static final java.lang.String INCLUDE_REQUEST_URI</pre>
+<div class="block">The name of the request attribute that should be set by the container
+ when the <a href="../../javax/servlet/RequestDispatcher.html#include(javax.servlet.ServletRequest, javax.servlet.ServletResponse)"><code>include(ServletRequest, ServletResponse)</code></a> method is
+ called on the <code>RequestDispatcher</code> obtained by a path and not by a
+ name. It provides information on the path that was used to obtain the
+ <code>RequestDispatcher</code> instance for this include call. See the chapter
+ "Included Request Parameters" in the Servlet Specification for details.</div>
+<dl><dt><span class="strong">Since:</span></dt>
+ <dd>Servlet 3.0</dd>
+<dt><span class="strong">See Also:</span></dt><dd><a href="../../constant-values.html#javax.servlet.RequestDispatcher.INCLUDE_REQUEST_URI">Constant Field Values</a></dd></dl>
+</li>
+</ul>
+<a name="INCLUDE_CONTEXT_PATH">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>INCLUDE_CONTEXT_PATH</h4>
+<pre>static final java.lang.String INCLUDE_CONTEXT_PATH</pre>
+<div class="block">The name of the request attribute that should be set by the container
+ when the <a href="../../javax/servlet/RequestDispatcher.html#include(javax.servlet.ServletRequest, javax.servlet.ServletResponse)"><code>include(ServletRequest, ServletResponse)</code></a> method is
+ called on the <code>RequestDispatcher</code> obtained by a path and not by a
+ name. It provides information on the path that was used to obtain the
+ <code>RequestDispatcher</code> instance for this include call. See the chapter
+ "Included Request Parameters" in the Servlet Specification for details.</div>
+<dl><dt><span class="strong">Since:</span></dt>
+ <dd>Servlet 3.0</dd>
+<dt><span class="strong">See Also:</span></dt><dd><a href="../../constant-values.html#javax.servlet.RequestDispatcher.INCLUDE_CONTEXT_PATH">Constant Field Values</a></dd></dl>
+</li>
+</ul>
+<a name="INCLUDE_PATH_INFO">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>INCLUDE_PATH_INFO</h4>
+<pre>static final java.lang.String INCLUDE_PATH_INFO</pre>
+<div class="block">The name of the request attribute that should be set by the container
+ when the <a href="../../javax/servlet/RequestDispatcher.html#include(javax.servlet.ServletRequest, javax.servlet.ServletResponse)"><code>include(ServletRequest, ServletResponse)</code></a> method is
+ called on the <code>RequestDispatcher</code> obtained by a path and not by a
+ name. It provides information on the path that was used to obtain the
+ <code>RequestDispatcher</code> instance for this include call. See the chapter
+ "Included Request Parameters" in the Servlet Specification for details.</div>
+<dl><dt><span class="strong">Since:</span></dt>
+ <dd>Servlet 3.0</dd>
+<dt><span class="strong">See Also:</span></dt><dd><a href="../../constant-values.html#javax.servlet.RequestDispatcher.INCLUDE_PATH_INFO">Constant Field Values</a></dd></dl>
+</li>
+</ul>
+<a name="INCLUDE_SERVLET_PATH">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>INCLUDE_SERVLET_PATH</h4>
+<pre>static final java.lang.String INCLUDE_SERVLET_PATH</pre>
+<div class="block">The name of the request attribute that should be set by the container
+ when the <a href="../../javax/servlet/RequestDispatcher.html#include(javax.servlet.ServletRequest, javax.servlet.ServletResponse)"><code>include(ServletRequest, ServletResponse)</code></a> method is
+ called on the <code>RequestDispatcher</code> obtained by a path and not by a
+ name. It provides information on the path that was used to obtain the
+ <code>RequestDispatcher</code> instance for this include call. See the chapter
+ "Included Request Parameters" in the Servlet Specification for details.</div>
+<dl><dt><span class="strong">Since:</span></dt>
+ <dd>Servlet 3.0</dd>
+<dt><span class="strong">See Also:</span></dt><dd><a href="../../constant-values.html#javax.servlet.RequestDispatcher.INCLUDE_SERVLET_PATH">Constant Field Values</a></dd></dl>
+</li>
+</ul>
+<a name="INCLUDE_QUERY_STRING">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>INCLUDE_QUERY_STRING</h4>
+<pre>static final java.lang.String INCLUDE_QUERY_STRING</pre>
+<div class="block">The name of the request attribute that should be set by the container
+ when the <a href="../../javax/servlet/RequestDispatcher.html#include(javax.servlet.ServletRequest, javax.servlet.ServletResponse)"><code>include(ServletRequest, ServletResponse)</code></a> method is
+ called on the <code>RequestDispatcher</code> obtained by a path and not by a
+ name. It provides information on the path that was used to obtain the
+ <code>RequestDispatcher</code> instance for this include call. See the chapter
+ "Included Request Parameters" in the Servlet Specification for details.</div>
+<dl><dt><span class="strong">Since:</span></dt>
+ <dd>Servlet 3.0</dd>
+<dt><span class="strong">See Also:</span></dt><dd><a href="../../constant-values.html#javax.servlet.RequestDispatcher.INCLUDE_QUERY_STRING">Constant Field Values</a></dd></dl>
+</li>
+</ul>
+<a name="ERROR_EXCEPTION">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>ERROR_EXCEPTION</h4>
+<pre>static final java.lang.String ERROR_EXCEPTION</pre>
+<div class="block">The name of the request attribute that should be set by the container
+ when custom error-handling servlet or JSP page is invoked. The value of
+ the attribute is of type <code>java.lang.Throwable</code>. See the chapter
+ "Error Handling" in the Servlet Specification for details.</div>
+<dl><dt><span class="strong">Since:</span></dt>
+ <dd>Servlet 3.0</dd>
+<dt><span class="strong">See Also:</span></dt><dd><a href="../../constant-values.html#javax.servlet.RequestDispatcher.ERROR_EXCEPTION">Constant Field Values</a></dd></dl>
+</li>
+</ul>
+<a name="ERROR_EXCEPTION_TYPE">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>ERROR_EXCEPTION_TYPE</h4>
+<pre>static final java.lang.String ERROR_EXCEPTION_TYPE</pre>
+<div class="block">The name of the request attribute that should be set by the container
+ when custom error-handling servlet or JSP page is invoked. The value of
+ the attribute is of type <code>java.lang.Class</code>. See the chapter
+ "Error Handling" in the Servlet Specification for details.</div>
+<dl><dt><span class="strong">Since:</span></dt>
+ <dd>Servlet 3.0</dd>
+<dt><span class="strong">See Also:</span></dt><dd><a href="../../constant-values.html#javax.servlet.RequestDispatcher.ERROR_EXCEPTION_TYPE">Constant Field Values</a></dd></dl>
+</li>
+</ul>
+<a name="ERROR_MESSAGE">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>ERROR_MESSAGE</h4>
+<pre>static final java.lang.String ERROR_MESSAGE</pre>
+<div class="block">The name of the request attribute that should be set by the container
+ when custom error-handling servlet or JSP page is invoked. The value of
+ the attribute is of type <code>java.lang.String</code>. See the chapter
+ "Error Handling" in the Servlet Specification for details.</div>
+<dl><dt><span class="strong">Since:</span></dt>
+ <dd>Servlet 3.0</dd>
+<dt><span class="strong">See Also:</span></dt><dd><a href="../../constant-values.html#javax.servlet.RequestDispatcher.ERROR_MESSAGE">Constant Field Values</a></dd></dl>
+</li>
+</ul>
+<a name="ERROR_REQUEST_URI">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>ERROR_REQUEST_URI</h4>
+<pre>static final java.lang.String ERROR_REQUEST_URI</pre>
+<div class="block">The name of the request attribute that should be set by the container
+ when custom error-handling servlet or JSP page is invoked. The value of
+ the attribute is of type <code>java.lang.String</code>. See the chapter
+ "Error Handling" in the Servlet Specification for details.</div>
+<dl><dt><span class="strong">Since:</span></dt>
+ <dd>Servlet 3.0</dd>
+<dt><span class="strong">See Also:</span></dt><dd><a href="../../constant-values.html#javax.servlet.RequestDispatcher.ERROR_REQUEST_URI">Constant Field Values</a></dd></dl>
+</li>
+</ul>
+<a name="ERROR_SERVLET_NAME">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>ERROR_SERVLET_NAME</h4>
+<pre>static final java.lang.String ERROR_SERVLET_NAME</pre>
+<div class="block">The name of the request attribute that should be set by the container
+ when custom error-handling servlet or JSP page is invoked. The value of
+ the attribute is of type <code>java.lang.String</code>. See the chapter
+ "Error Handling" in the Servlet Specification for details.</div>
+<dl><dt><span class="strong">Since:</span></dt>
+ <dd>Servlet 3.0</dd>
+<dt><span class="strong">See Also:</span></dt><dd><a href="../../constant-values.html#javax.servlet.RequestDispatcher.ERROR_SERVLET_NAME">Constant Field Values</a></dd></dl>
+</li>
+</ul>
+<a name="ERROR_STATUS_CODE">
+<!-- -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>ERROR_STATUS_CODE</h4>
+<pre>static final java.lang.String ERROR_STATUS_CODE</pre>
+<div class="block">The name of the request attribute that should be set by the container
+ when custom error-handling servlet or JSP page is invoked. The value of
+ the attribute is of type <code>java.lang.Integer</code>. See the chapter
+ "Error Handling" in the Servlet Specification for details.</div>
+<dl><dt><span class="strong">Since:</span></dt>
+ <dd>Servlet 3.0</dd>
+<dt><span class="strong">See Also:</span></dt><dd><a href="../../constant-values.html#javax.servlet.RequestDispatcher.ERROR_STATUS_CODE">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="forward(javax.servlet.ServletRequest, javax.servlet.ServletResponse)">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>forward</h4>
+<pre>void forward(<a href="../../javax/servlet/ServletRequest.html" title="interface in javax.servlet">ServletRequest</a> request,
+ <a href="../../javax/servlet/ServletResponse.html" title="interface in javax.servlet">ServletResponse</a> response)
+ throws <a href="../../javax/servlet/ServletException.html" title="class in javax.servlet">ServletException</a>,
+ java.io.IOException</pre>
+<div class="block">Forwards a request from a servlet to another resource (servlet, JSP file,
+ or HTML file) on the server. This method allows one servlet to do
+ preliminary processing of a request and another resource to generate the
+ response.
+
+ <p>
+ For a <code>RequestDispatcher</code> obtained via
+ <code>getRequestDispatcher()</code>, the <code>ServletRequest</code>
+ object has its path elements and parameters adjusted to match the path of
+ the target resource.
+
+ <p>
+ <code>forward</code> should be called before the response has been
+ committed to the client (before response body output has been flushed).
+ If the response already has been committed, this method throws an
+ <code>IllegalStateException</code>. Uncommitted output in the response
+ buffer is automatically cleared before the forward.
+
+ <p>
+ The request and response parameters must be either the same objects as
+ were passed to the calling servlet's service method or be subclasses of
+ the <a href="../../javax/servlet/ServletRequestWrapper.html" title="class in javax.servlet"><code>ServletRequestWrapper</code></a> or <a href="../../javax/servlet/ServletResponseWrapper.html" title="class in javax.servlet"><code>ServletResponseWrapper</code></a>
+ classes that wrap them.</div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>request</code> - a <a href="../../javax/servlet/ServletRequest.html" title="interface in javax.servlet"><code>ServletRequest</code></a> object that represents the request
+ the client makes of the servlet</dd><dd><code>response</code> - a <a href="../../javax/servlet/ServletResponse.html" title="interface in javax.servlet"><code>ServletResponse</code></a> object that represents the response
+ the servlet returns to the client</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 the target resource throws this exception</dd>
+<dd><code>java.io.IOException</code> - if the target resource throws this exception</dd>
+<dd><code>java.lang.IllegalStateException</code> - if the response was already committed</dd></dl>
+</li>
+</ul>
+<a name="include(javax.servlet.ServletRequest, javax.servlet.ServletResponse)">
+<!-- -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>include</h4>
+<pre>void include(<a href="../../javax/servlet/ServletRequest.html" title="interface in javax.servlet">ServletRequest</a> request,
+ <a href="../../javax/servlet/ServletResponse.html" title="interface in javax.servlet">ServletResponse</a> response)
+ throws <a href="../../javax/servlet/ServletException.html" title="class in javax.servlet">ServletException</a>,
+ java.io.IOException</pre>
+<div class="block">Includes the content of a resource (servlet, JSP page, HTML file) in the
+ response. In essence, this method enables programmatic server-side
+ includes.
+
+ <p>
+ The <a href="../../javax/servlet/ServletResponse.html" title="interface in javax.servlet"><code>ServletResponse</code></a> object has its path elements and parameters
+ remain unchanged from the caller's. The included servlet cannot change
+ the response status code or set headers; any attempt to make a change is
+ ignored.
+
+ <p>
+ The request and response parameters must be either the same objects as
+ were passed to the calling servlet's service method or be subclasses of
+ the <a href="../../javax/servlet/ServletRequestWrapper.html" title="class in javax.servlet"><code>ServletRequestWrapper</code></a> or <a href="../../javax/servlet/ServletResponseWrapper.html" title="class in javax.servlet"><code>ServletResponseWrapper</code></a>
+ classes that wrap them.</div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>request</code> - a <a href="../../javax/servlet/ServletRequest.html" title="interface in javax.servlet"><code>ServletRequest</code></a> object that contains the client's
+ request</dd><dd><code>response</code> - a <a href="../../javax/servlet/ServletResponse.html" title="interface in javax.servlet"><code>ServletResponse</code></a> object that contains the servlet's
+ response</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 the included resource throws this exception</dd>
+<dd><code>java.io.IOException</code> - if the included resource throws this exception</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/Registration.Dynamic.html" title="interface in javax.servlet"><span class="strong">Prev Class</span></a></li>
+<li><a href="../../javax/servlet/Servlet.html" title="interface in javax.servlet"><span class="strong">Next Class</span></a></li>
+</ul>
+<ul class="navList">
+<li><a href="../../index.html?javax/servlet/RequestDispatcher.html" target="_top">Frames</a></li>
+<li><a href="RequestDispatcher.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/RequestDispatcher.html
------------------------------------------------------------------------------
svn:eol-style = native
Added: tomcat/site/trunk/docs/tomcat-8.0-doc/servletapi/javax/servlet/Servlet.html
URL: http://svn.apache.org/viewvc/tomcat/site/trunk/docs/tomcat-8.0-doc/servletapi/javax/servlet/Servlet.html?rev=1510665&view=auto
==============================================================================
--- tomcat/site/trunk/docs/tomcat-8.0-doc/servletapi/javax/servlet/Servlet.html (added)
+++ tomcat/site/trunk/docs/tomcat-8.0-doc/servletapi/javax/servlet/Servlet.html Mon Aug 5 19:10:09 2013
@@ -0,0 +1,396 @@
+<!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:51 BST 2013 -->
+<title>Servlet (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="Servlet (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/RequestDispatcher.html" title="interface in javax.servlet"><span class="strong">Prev Class</span></a></li>
+<li><a href="../../javax/servlet/ServletConfig.html" title="interface in javax.servlet"><span class="strong">Next Class</span></a></li>
+</ul>
+<ul class="navList">
+<li><a href="../../index.html?javax/servlet/Servlet.html" target="_top">Frames</a></li>
+<li><a href="Servlet.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</div>
+<h2 title="Interface Servlet" class="title">Interface Servlet</h2>
+</div>
+<div class="contentContainer">
+<div class="description">
+<ul class="blockList">
+<li class="blockList">
+<dl>
+<dt>All Known Implementing Classes:</dt>
+<dd><a href="../../javax/servlet/GenericServlet.html" title="class in javax.servlet">GenericServlet</a>, <a href="../../javax/servlet/http/HttpServlet.html" title="class in javax.servlet.http">HttpServlet</a></dd>
+</dl>
+<hr>
+<br>
+<pre>public interface <span class="strong">Servlet</span></pre>
+<div class="block">Defines methods that all servlets must implement.
+
+ <p>
+ A servlet is a small Java program that runs within a Web server. Servlets
+ receive and respond to requests from Web clients, usually across HTTP, the
+ HyperText Transfer Protocol.
+
+ <p>
+ To implement this interface, you can write a generic servlet that extends
+ <code>javax.servlet.GenericServlet</code> or an HTTP servlet that extends
+ <code>javax.servlet.http.HttpServlet</code>.
+
+ <p>
+ This interface defines methods to initialize a servlet, to service requests,
+ and to remove a servlet from the server. These are known as life-cycle
+ methods and are called in the following sequence:
+ <ol>
+ <li>The servlet is constructed, then initialized with the <code>init</code>
+ method.
+ <li>Any calls from clients to the <code>service</code> method are handled.
+ <li>The servlet is taken out of service, then destroyed with the
+ <code>destroy</code> method, then garbage collected and finalized.
+ </ol>
+
+ <p>
+ In addition to the life-cycle methods, this interface provides the
+ <code>getServletConfig</code> method, which the servlet can use to get any
+ startup information, and the <code>getServletInfo</code> method, which allows
+ the servlet to return basic information about itself, such as author,
+ version, and copyright.</div>
+<dl><dt><span class="strong">Version:</span></dt>
+ <dd>$Version$</dd>
+<dt><span class="strong">See Also:</span></dt><dd><a href="../../javax/servlet/GenericServlet.html" title="class in javax.servlet"><code>GenericServlet</code></a>,
+<a href="../../javax/servlet/http/HttpServlet.html" title="class in javax.servlet.http"><code>HttpServlet</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>void</code></td>
+<td class="colLast"><code><strong><a href="../../javax/servlet/Servlet.html#destroy()">destroy</a></strong>()</code>
+<div class="block">Called by the servlet container to indicate to a servlet that the servlet
+ is being taken out of service.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code><a href="../../javax/servlet/ServletConfig.html" title="interface in javax.servlet">ServletConfig</a></code></td>
+<td class="colLast"><code><strong><a href="../../javax/servlet/Servlet.html#getServletConfig()">getServletConfig</a></strong>()</code>
+<div class="block">Returns a <a href="../../javax/servlet/ServletConfig.html" title="interface in javax.servlet"><code>ServletConfig</code></a> object, which contains initialization and
+ startup parameters for this servlet.</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>java.lang.String</code></td>
+<td class="colLast"><code><strong><a href="../../javax/servlet/Servlet.html#getServletInfo()">getServletInfo</a></strong>()</code>
+<div class="block">Returns information about the servlet, such as author, version, and
+ copyright.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><strong><a href="../../javax/servlet/Servlet.html#init(javax.servlet.ServletConfig)">init</a></strong>(<a href="../../javax/servlet/ServletConfig.html" title="interface in javax.servlet">ServletConfig</a> config)</code>
+<div class="block">Called by the servlet container to indicate to a servlet that the servlet
+ is being placed into service.</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><strong><a href="../../javax/servlet/Servlet.html#service(javax.servlet.ServletRequest, javax.servlet.ServletResponse)">service</a></strong>(<a href="../../javax/servlet/ServletRequest.html" title="interface in javax.servlet">ServletRequest</a> req,
+ <a href="../../javax/servlet/ServletResponse.html" title="interface in javax.servlet">ServletResponse</a> res)</code>
+<div class="block">Called by the servlet container to allow the servlet to respond to a
+ request.</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="init(javax.servlet.ServletConfig)">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>init</h4>
+<pre>void init(<a href="../../javax/servlet/ServletConfig.html" title="interface in javax.servlet">ServletConfig</a> config)
+ throws <a href="../../javax/servlet/ServletException.html" title="class in javax.servlet">ServletException</a></pre>
+<div class="block">Called by the servlet container to indicate to a servlet that the servlet
+ is being placed into service.
+
+ <p>
+ The servlet container calls the <code>init</code> method exactly once
+ after instantiating the servlet. The <code>init</code> method must
+ complete successfully before the servlet can receive any requests.
+
+ <p>
+ The servlet container cannot place the servlet into service if the
+ <code>init</code> method
+ <ol>
+ <li>Throws a <code>ServletException</code>
+ <li>Does not return within a time period defined by the Web server
+ </ol></div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>config</code> - a <code>ServletConfig</code> object containing the servlet's
+ configuration and initialization parameters</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 an exception has occurred that interferes with the
+ servlet's normal operation</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../javax/servlet/UnavailableException.html" title="class in javax.servlet"><code>UnavailableException</code></a>,
+<a href="../../javax/servlet/Servlet.html#getServletConfig()"><code>getServletConfig()</code></a></dd></dl>
+</li>
+</ul>
+<a name="getServletConfig()">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getServletConfig</h4>
+<pre><a href="../../javax/servlet/ServletConfig.html" title="interface in javax.servlet">ServletConfig</a> getServletConfig()</pre>
+<div class="block">Returns a <a href="../../javax/servlet/ServletConfig.html" title="interface in javax.servlet"><code>ServletConfig</code></a> object, which contains initialization and
+ startup parameters for this servlet. The <code>ServletConfig</code>
+ object returned is the one passed to the <code>init</code> method.
+
+ <p>
+ Implementations of this interface are responsible for storing the
+ <code>ServletConfig</code> object so that this method can return it. The
+ <a href="../../javax/servlet/GenericServlet.html" title="class in javax.servlet"><code>GenericServlet</code></a> class, which implements this interface, already
+ does this.</div>
+<dl><dt><span class="strong">Returns:</span></dt><dd>the <code>ServletConfig</code> object that initializes this
+ servlet</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../javax/servlet/Servlet.html#init(javax.servlet.ServletConfig)"><code>init(javax.servlet.ServletConfig)</code></a></dd></dl>
+</li>
+</ul>
+<a name="service(javax.servlet.ServletRequest, javax.servlet.ServletResponse)">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>service</h4>
+<pre>void service(<a href="../../javax/servlet/ServletRequest.html" title="interface in javax.servlet">ServletRequest</a> req,
+ <a href="../../javax/servlet/ServletResponse.html" title="interface in javax.servlet">ServletResponse</a> res)
+ throws <a href="../../javax/servlet/ServletException.html" title="class in javax.servlet">ServletException</a>,
+ java.io.IOException</pre>
+<div class="block">Called by the servlet container to allow the servlet to respond to a
+ request.
+
+ <p>
+ This method is only called after the servlet's <code>init()</code> method
+ has completed successfully.
+
+ <p>
+ The status code of the response always should be set for a servlet that
+ throws or sends an error.
+
+
+ <p>
+ Servlets typically run inside multithreaded servlet containers that can
+ handle multiple requests concurrently. Developers must be aware to
+ synchronize access to any shared resources such as files, network
+ connections, and as well as the servlet's class and instance variables.
+ More information on multithreaded programming in Java is available in <a
+ href
+ ="http://java.sun.com/Series/Tutorial/java/threads/multithreaded.html">
+ the Java tutorial on multi-threaded programming</a>.</div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>req</code> - the <code>ServletRequest</code> object that contains the
+ client's request</dd><dd><code>res</code> - the <code>ServletResponse</code> object that contains the
+ servlet's response</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 an exception occurs that interferes with the servlet's
+ normal operation</dd>
+<dd><code>java.io.IOException</code> - if an input or output exception occurs</dd></dl>
+</li>
+</ul>
+<a name="getServletInfo()">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getServletInfo</h4>
+<pre>java.lang.String getServletInfo()</pre>
+<div class="block">Returns information about the servlet, such as author, version, and
+ copyright.
+
+ <p>
+ The string that this method returns should be plain text and not markup
+ of any kind (such as HTML, XML, etc.).</div>
+<dl><dt><span class="strong">Returns:</span></dt><dd>a <code>String</code> containing servlet information</dd></dl>
+</li>
+</ul>
+<a name="destroy()">
+<!-- -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>destroy</h4>
+<pre>void destroy()</pre>
+<div class="block">Called by the servlet container to indicate to a servlet that the servlet
+ is being taken out of service. This method is only called once all
+ threads within the servlet's <code>service</code> method have exited or
+ after a timeout period has passed. After the servlet container calls this
+ method, it will not call the <code>service</code> method again on this
+ servlet.
+
+ <p>
+ This method gives the servlet an opportunity to clean up any resources
+ that are being held (for example, memory, file handles, threads) and make
+ sure that any persistent state is synchronized with the servlet's current
+ state in memory.</div>
+</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/RequestDispatcher.html" title="interface in javax.servlet"><span class="strong">Prev Class</span></a></li>
+<li><a href="../../javax/servlet/ServletConfig.html" title="interface in javax.servlet"><span class="strong">Next Class</span></a></li>
+</ul>
+<ul class="navList">
+<li><a href="../../index.html?javax/servlet/Servlet.html" target="_top">Frames</a></li>
+<li><a href="Servlet.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/Servlet.html
------------------------------------------------------------------------------
svn:eol-style = native
Added: tomcat/site/trunk/docs/tomcat-8.0-doc/servletapi/javax/servlet/ServletConfig.html
URL: http://svn.apache.org/viewvc/tomcat/site/trunk/docs/tomcat-8.0-doc/servletapi/javax/servlet/ServletConfig.html?rev=1510665&view=auto
==============================================================================
--- tomcat/site/trunk/docs/tomcat-8.0-doc/servletapi/javax/servlet/ServletConfig.html (added)
+++ tomcat/site/trunk/docs/tomcat-8.0-doc/servletapi/javax/servlet/ServletConfig.html Mon Aug 5 19:10:09 2013
@@ -0,0 +1,286 @@
+<!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:51 BST 2013 -->
+<title>ServletConfig (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="ServletConfig (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/Servlet.html" title="interface in javax.servlet"><span class="strong">Prev Class</span></a></li>
+<li><a href="../../javax/servlet/ServletContainerInitializer.html" title="interface in javax.servlet"><span class="strong">Next Class</span></a></li>
+</ul>
+<ul class="navList">
+<li><a href="../../index.html?javax/servlet/ServletConfig.html" target="_top">Frames</a></li>
+<li><a href="ServletConfig.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</div>
+<h2 title="Interface ServletConfig" class="title">Interface ServletConfig</h2>
+</div>
+<div class="contentContainer">
+<div class="description">
+<ul class="blockList">
+<li class="blockList">
+<dl>
+<dt>All Known Implementing Classes:</dt>
+<dd><a href="../../javax/servlet/GenericServlet.html" title="class in javax.servlet">GenericServlet</a>, <a href="../../javax/servlet/http/HttpServlet.html" title="class in javax.servlet.http">HttpServlet</a></dd>
+</dl>
+<hr>
+<br>
+<pre>public interface <span class="strong">ServletConfig</span></pre>
+<div class="block">A servlet configuration object used by a servlet container to pass
+ information to a servlet during initialization.</div>
+</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.String</code></td>
+<td class="colLast"><code><strong><a href="../../javax/servlet/ServletConfig.html#getInitParameter(java.lang.String)">getInitParameter</a></strong>(java.lang.String name)</code>
+<div class="block">Returns a <code>String</code> containing the value of the named
+ initialization parameter, or <code>null</code> if the parameter does not
+ exist.</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/ServletConfig.html#getInitParameterNames()">getInitParameterNames</a></strong>()</code>
+<div class="block">Returns the names of the servlet's initialization parameters as an
+ <code>Enumeration</code> of <code>String</code> objects, or an empty
+ <code>Enumeration</code> if the servlet has no initialization parameters.</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/ServletConfig.html#getServletContext()">getServletContext</a></strong>()</code>
+<div class="block">Returns a reference to the <a href="../../javax/servlet/ServletContext.html" title="interface in javax.servlet"><code>ServletContext</code></a> in which the caller is
+ executing.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>java.lang.String</code></td>
+<td class="colLast"><code><strong><a href="../../javax/servlet/ServletConfig.html#getServletName()">getServletName</a></strong>()</code>
+<div class="block">Returns the name of this servlet instance.</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="getServletName()">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getServletName</h4>
+<pre>java.lang.String getServletName()</pre>
+<div class="block">Returns the name of this servlet instance. The name may be provided via
+ server administration, assigned in the web application deployment
+ descriptor, or for an unregistered (and thus unnamed) servlet instance it
+ will be the servlet's class name.</div>
+<dl><dt><span class="strong">Returns:</span></dt><dd>the name of the servlet instance</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 a reference to the <a href="../../javax/servlet/ServletContext.html" title="interface in javax.servlet"><code>ServletContext</code></a> in which the caller is
+ executing.</div>
+<dl><dt><span class="strong">Returns:</span></dt><dd>a <a href="../../javax/servlet/ServletContext.html" title="interface in javax.servlet"><code>ServletContext</code></a> object, used by the caller to interact
+ with its servlet container</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../javax/servlet/ServletContext.html" title="interface in javax.servlet"><code>ServletContext</code></a></dd></dl>
+</li>
+</ul>
+<a name="getInitParameter(java.lang.String)">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getInitParameter</h4>
+<pre>java.lang.String getInitParameter(java.lang.String name)</pre>
+<div class="block">Returns a <code>String</code> containing the value of the named
+ initialization parameter, or <code>null</code> if the parameter does not
+ exist.</div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - a <code>String</code> specifying the name of the
+ initialization parameter</dd>
+<dt><span class="strong">Returns:</span></dt><dd>a <code>String</code> containing the value of the initialization
+ parameter</dd></dl>
+</li>
+</ul>
+<a name="getInitParameterNames()">
+<!-- -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>getInitParameterNames</h4>
+<pre>java.util.Enumeration<java.lang.String> getInitParameterNames()</pre>
+<div class="block">Returns the names of the servlet's initialization parameters as an
+ <code>Enumeration</code> of <code>String</code> objects, or an empty
+ <code>Enumeration</code> if the servlet has no initialization parameters.</div>
+<dl><dt><span class="strong">Returns:</span></dt><dd>an <code>Enumeration</code> of <code>String</code> objects
+ containing the names of the servlet's initialization parameters</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/Servlet.html" title="interface in javax.servlet"><span class="strong">Prev Class</span></a></li>
+<li><a href="../../javax/servlet/ServletContainerInitializer.html" title="interface in javax.servlet"><span class="strong">Next Class</span></a></li>
+</ul>
+<ul class="navList">
+<li><a href="../../index.html?javax/servlet/ServletConfig.html" target="_top">Frames</a></li>
+<li><a href="ServletConfig.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/ServletConfig.html
------------------------------------------------------------------------------
svn:eol-style = native
Added: tomcat/site/trunk/docs/tomcat-8.0-doc/servletapi/javax/servlet/ServletContainerInitializer.html
URL: http://svn.apache.org/viewvc/tomcat/site/trunk/docs/tomcat-8.0-doc/servletapi/javax/servlet/ServletContainerInitializer.html?rev=1510665&view=auto
==============================================================================
--- tomcat/site/trunk/docs/tomcat-8.0-doc/servletapi/javax/servlet/ServletContainerInitializer.html (added)
+++ tomcat/site/trunk/docs/tomcat-8.0-doc/servletapi/javax/servlet/ServletContainerInitializer.html Mon Aug 5 19:10:09 2013
@@ -0,0 +1,237 @@
+<!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:51 BST 2013 -->
+<title>ServletContainerInitializer (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="ServletContainerInitializer (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/ServletConfig.html" title="interface in javax.servlet"><span class="strong">Prev Class</span></a></li>
+<li><a href="../../javax/servlet/ServletContext.html" title="interface in javax.servlet"><span class="strong">Next Class</span></a></li>
+</ul>
+<ul class="navList">
+<li><a href="../../index.html?javax/servlet/ServletContainerInitializer.html" target="_top">Frames</a></li>
+<li><a href="ServletContainerInitializer.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</div>
+<h2 title="Interface ServletContainerInitializer" class="title">Interface ServletContainerInitializer</h2>
+</div>
+<div class="contentContainer">
+<div class="description">
+<ul class="blockList">
+<li class="blockList">
+<hr>
+<br>
+<pre>public interface <span class="strong">ServletContainerInitializer</span></pre>
+<div class="block">ServletContainerInitializers (SCIs) are registered via an entry in the
+ file META-INF/services/javax.servlet.ServletContainerInitializer that must be
+ included in the JAR file that contains the SCI implementation.
+ <p>
+ SCI processing is performed regardless of the setting of metadata-complete.
+ SCI processing can be controlled per JAR file via fragment ordering. If an
+ absolute ordering is defined, the only those JARs included in the ordering
+ will be processed for SCIs. To disable SCI processing completely, an empty
+ absolute ordering may be defined.
+ <p>
+ SCIs register an interest in annotations (class, method or field) and/or
+ types via the <a href="../../javax/servlet/annotation/HandlesTypes.html" title="annotation in javax.servlet.annotation"><code>HandlesTypes</code></a> annotation which
+ is added to the class.</div>
+<dl><dt><span class="strong">Since:</span></dt>
+ <dd>Servlet 3.0</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>void</code></td>
+<td class="colLast"><code><strong><a href="../../javax/servlet/ServletContainerInitializer.html#onStartup(java.util.Set, javax.servlet.ServletContext)">onStartup</a></strong>(java.util.Set<java.lang.Class<?>> c,
+ <a href="../../javax/servlet/ServletContext.html" title="interface in javax.servlet">ServletContext</a> ctx)</code>
+<div class="block">Receives notification during startup of a web application of the classes
+ within the web application that matched the criteria defined via the
+ <a href="../../javax/servlet/annotation/HandlesTypes.html" title="annotation in javax.servlet.annotation"><code>HandlesTypes</code></a> annotation.</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="onStartup(java.util.Set, javax.servlet.ServletContext)">
+<!-- -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>onStartup</h4>
+<pre>void onStartup(java.util.Set<java.lang.Class<?>> c,
+ <a href="../../javax/servlet/ServletContext.html" title="interface in javax.servlet">ServletContext</a> ctx)
+ throws <a href="../../javax/servlet/ServletException.html" title="class in javax.servlet">ServletException</a></pre>
+<div class="block">Receives notification during startup of a web application of the classes
+ within the web application that matched the criteria defined via the
+ <a href="../../javax/servlet/annotation/HandlesTypes.html" title="annotation in javax.servlet.annotation"><code>HandlesTypes</code></a> annotation.</div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>c</code> - The (possibly null) set of classes that met the specified
+ criteria</dd><dd><code>ctx</code> - The ServletContext of the web application in which the
+ classes were discovered</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 an error occurs</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/ServletConfig.html" title="interface in javax.servlet"><span class="strong">Prev Class</span></a></li>
+<li><a href="../../javax/servlet/ServletContext.html" title="interface in javax.servlet"><span class="strong">Next Class</span></a></li>
+</ul>
+<ul class="navList">
+<li><a href="../../index.html?javax/servlet/ServletContainerInitializer.html" target="_top">Frames</a></li>
+<li><a href="ServletContainerInitializer.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/ServletContainerInitializer.html
------------------------------------------------------------------------------
svn:eol-style = native
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@tomcat.apache.org
For additional commands, e-mail: dev-help@tomcat.apache.org