| <html><head><META http-equiv="Content-Type" content="text/html; charset=iso-8859-1"><title>Apache Tomcat 7 (7.0.77) - Default Servlet Reference</title><meta name="author" content="Tim Funk"><style type="text/css" media="print"> | |
| .noPrint {display: none;} | |
| td#mainBody {width: 100%;} | |
| </style><style type="text/css"> | |
| code {background-color:rgb(224,255,255);padding:0 0.1em;} | |
| code.attributeName, code.propertyName {background-color:transparent;} | |
| table { | |
| border-collapse: collapse; | |
| text-align: left; | |
| } | |
| table *:not(table) { | |
| /* Prevent border-collapsing for table child elements like <div> */ | |
| border-collapse: separate; | |
| } | |
| th { | |
| text-align: left; | |
| } | |
| div.codeBox pre code, code.attributeName, code.propertyName, code.noHighlight, .noHighlight code { | |
| background-color: transparent; | |
| } | |
| div.codeBox { | |
| overflow: auto; | |
| margin: 1em 0; | |
| } | |
| div.codeBox pre { | |
| margin: 0; | |
| padding: 4px; | |
| border: 1px solid #999; | |
| border-radius: 5px; | |
| background-color: #eff8ff; | |
| display: table; /* To prevent <pre>s from taking the complete available width. */ | |
| /* | |
| When it is officially supported, use the following CSS instead of display: table | |
| to prevent big <pre>s from exceeding the browser window: | |
| max-width: available; | |
| width: min-content; | |
| */ | |
| } | |
| div.codeBox pre.wrap { | |
| white-space: pre-wrap; | |
| } | |
| table.defaultTable tr, table.detail-table tr { | |
| border: 1px solid #CCC; | |
| } | |
| table.defaultTable tr:nth-child(even), table.detail-table tr:nth-child(even) { | |
| background-color: #FAFBFF; | |
| } | |
| table.defaultTable tr:nth-child(odd), table.detail-table tr:nth-child(odd) { | |
| background-color: #EEEFFF; | |
| } | |
| table.defaultTable th, table.detail-table th { | |
| background-color: #88b; | |
| color: #fff; | |
| } | |
| table.defaultTable th, table.defaultTable td, table.detail-table th, table.detail-table td { | |
| padding: 5px 8px; | |
| } | |
| p.notice { | |
| border: 1px solid rgb(255, 0, 0); | |
| background-color: rgb(238, 238, 238); | |
| color: rgb(0, 51, 102); | |
| padding: 0.5em; | |
| margin: 1em 2em 1em 1em; | |
| } | |
| </style></head><body bgcolor="#ffffff" text="#000000" link="#525D76" alink="#525D76" vlink="#525D76"><table border="0" width="100%" cellspacing="0"><!--PAGE HEADER--><tr><td><!--PROJECT LOGO--><a href="http://tomcat.apache.org/"><img src="./images/tomcat.gif" align="right" alt=" | |
| The Apache Tomcat Servlet/JSP Container | |
| " border="0"></a></td><td><h1><font face="arial,helvetica,sanserif">Apache Tomcat 7</font></h1><font face="arial,helvetica,sanserif">Version 7.0.77, Mar 28 2017</font></td><td><!--APACHE LOGO--><a href="http://www.apache.org/"><img src="./images/asf-logo.svg" align="right" alt="Apache Logo" border="0" style="width: 266px;height: 83px;"></a></td></tr></table><table border="0" width="100%" cellspacing="4"><!--HEADER SEPARATOR--><tr><td colspan="2"><hr noshade size="1"></td></tr><tr><!--LEFT SIDE NAVIGATION--><td width="20%" valign="top" nowrap class="noPrint"><p><strong>Links</strong></p><ul><li><a href="index.html">Docs Home</a></li><li><a href="http://wiki.apache.org/tomcat/FAQ">FAQ</a></li><li><a href="#comments_section">User Comments</a></li></ul><p><strong>User Guide</strong></p><ul><li><a href="introduction.html">1) Introduction</a></li><li><a href="setup.html">2) Setup</a></li><li><a href="appdev/index.html">3) First webapp</a></li><li><a href="deployer-howto.html">4) Deployer</a></li><li><a href="manager-howto.html">5) Manager</a></li><li><a href="realm-howto.html">6) Realms and AAA</a></li><li><a href="security-manager-howto.html">7) Security Manager</a></li><li><a href="jndi-resources-howto.html">8) JNDI Resources</a></li><li><a href="jndi-datasource-examples-howto.html">9) JDBC DataSources</a></li><li><a href="class-loader-howto.html">10) Classloading</a></li><li><a href="jasper-howto.html">11) JSPs</a></li><li><a href="ssl-howto.html">12) SSL/TLS</a></li><li><a href="ssi-howto.html">13) SSI</a></li><li><a href="cgi-howto.html">14) CGI</a></li><li><a href="proxy-howto.html">15) Proxy Support</a></li><li><a href="mbeans-descriptors-howto.html">16) MBeans Descriptors</a></li><li><a href="default-servlet.html">17) Default Servlet</a></li><li><a href="cluster-howto.html">18) Clustering</a></li><li><a href="balancer-howto.html">19) Load Balancer</a></li><li><a href="connectors.html">20) Connectors</a></li><li><a href="monitoring.html">21) Monitoring and Management</a></li><li><a href="logging.html">22) Logging</a></li><li><a href="apr.html">23) APR/Native</a></li><li><a href="virtual-hosting-howto.html">24) Virtual Hosting</a></li><li><a href="aio.html">25) Advanced IO</a></li><li><a href="extras.html">26) Additional Components</a></li><li><a href="maven-jars.html">27) Mavenized</a></li><li><a href="security-howto.html">28) Security Considerations</a></li><li><a href="windows-service-howto.html">29) Windows Service</a></li><li><a href="windows-auth-howto.html">30) Windows Authentication</a></li><li><a href="jdbc-pool.html">31) Tomcat's JDBC Pool</a></li><li><a href="web-socket-howto.html">32) WebSocket</a></li></ul><p><strong>Reference</strong></p><ul><li><a href="RELEASE-NOTES.txt">Release Notes</a></li><li><a href="config/index.html">Configuration</a></li><li><a href="api/index.html">Tomcat Javadocs</a></li><li><a href="servletapi/index.html">Servlet Javadocs</a></li><li><a href="jspapi/index.html">JSP 2.2 Javadocs</a></li><li><a href="elapi/index.html">EL 2.2 Javadocs</a></li><li><a href="websocketapi/index.html">WebSocket 1.1 Javadocs</a></li><li><a href="http://tomcat.apache.org/connectors-doc/">JK 1.2 Documentation</a></li></ul><p><strong>Apache Tomcat Development</strong></p><ul><li><a href="building.html">Building</a></li><li><a href="changelog.html">Changelog</a></li><li><a href="http://wiki.apache.org/tomcat/TomcatVersions">Status</a></li><li><a href="developers.html">Developers</a></li><li><a href="architecture/index.html">Architecture</a></li><li><a href="funcspecs/index.html">Functional Specs.</a></li><li><a href="tribes/introduction.html">Tribes</a></li></ul></td><!--RIGHT SIDE MAIN BODY--><td width="80%" valign="top" align="left" id="mainBody"><h1>Default Servlet Reference</h1><table border="0" cellspacing="0" cellpadding="2"><tr><td bgcolor="#525D76"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="Table of Contents"><!--()--></a><a name="Table_of_Contents"><strong>Table of Contents</strong></a></font></td></tr><tr><td><blockquote> | |
| <ul><li><a href="#what">What is the DefaultServlet</a></li><li><a href="#where">Where is it declared?</a></li><li><a href="#change">What can I change?</a></li><li><a href="#dir">How do I customize directory listings?</a></li><li><a href="#secure">How do I secure directory listings?</a></li></ul> | |
| </blockquote></td></tr></table><table border="0" cellspacing="0" cellpadding="2"><tr><td bgcolor="#525D76"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="what"><strong>What is the DefaultServlet</strong></a></font></td></tr><tr><td><blockquote> | |
| <p> | |
| The default servlet is the servlet which serves static resources as well | |
| as serves the directory listings (if directory listings are enabled). | |
| </p> | |
| </blockquote></td></tr></table><table border="0" cellspacing="0" cellpadding="2"><tr><td bgcolor="#525D76"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="where"><strong>Where is it declared?</strong></a></font></td></tr><tr><td><blockquote> | |
| <p> | |
| It is declared globally in <i>$CATALINA_BASE/conf/web.xml</i>. | |
| By default here is it's declaration: | |
| </p> | |
| <div class="codeBox"><pre><code> <servlet> | |
| <servlet-name>default</servlet-name> | |
| <servlet-class> | |
| org.apache.catalina.servlets.DefaultServlet | |
| </servlet-class> | |
| <init-param> | |
| <param-name>debug</param-name> | |
| <param-value>0</param-value> | |
| </init-param> | |
| <init-param> | |
| <param-name>listings</param-name> | |
| <param-value>false</param-value> | |
| </init-param> | |
| <load-on-startup>1</load-on-startup> | |
| </servlet> | |
| ... | |
| <servlet-mapping> | |
| <servlet-name>default</servlet-name> | |
| <url-pattern>/</url-pattern> | |
| </servlet-mapping></code></pre></div> | |
| So by default, the default servlet is loaded at webapp startup and | |
| directory listings are disabled and debugging is turned off. | |
| </blockquote></td></tr></table><table border="0" cellspacing="0" cellpadding="2"><tr><td bgcolor="#525D76"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="change"><strong>What can I change?</strong></a></font></td></tr><tr><td><blockquote> | |
| <p> | |
| The DefaultServlet allows the following initParamters: | |
| </p> | |
| <table border="1" cellpadding="5"><tr><th width="15%" bgcolor="#023264"><font color="#ffffff">Property</font></th><th width="85%" bgcolor="#023264"><font color="#ffffff">Description</font></th></tr><tr><td align="left" valign="center"><code class="propertyName">debug</code></td><td align="left" valign="center"> | |
| Debugging level. It is not very useful unless you are a tomcat | |
| developer. As | |
| of this writing, useful values are 0, 1, 11, 1000. [0] | |
| </td></tr><tr><td align="left" valign="center"><code class="propertyName">listings</code></td><td align="left" valign="center"> | |
| If no welcome file is present, can a directory listing be | |
| shown? | |
| value may be <b>true</b> or <b>false</b> [false] | |
| <br> | |
| Welcome files are part of the servlet api. | |
| <br> | |
| <b>WARNING:</b> Listings of directories containing many entries are | |
| expensive. Multiple requests for large directory listings can consume | |
| significant proportions of server resources. | |
| </td></tr><tr><td align="left" valign="center"><code class="propertyName">readmeFile</code></td><td align="left" valign="center"> | |
| If a directory listing is presented, a readme file may also | |
| be presented with the listing. This file is inserted as is | |
| so it may contain HTML. | |
| </td></tr><tr><td align="left" valign="center"><code class="propertyName">globalXsltFile</code></td><td align="left" valign="center"> | |
| If you wish to customize your directory listing, you | |
| can use an XSL transformation. This value is a relative file name (to | |
| either $CATALINA_BASE/conf/ or $CATALINA_HOME/conf/) which will be used | |
| for all directory listings. This can be overridden per context and/or | |
| per directory. See <strong>contextXsltFile</strong> and | |
| <strong>localXsltFile</strong> below. The format of the xml is shown | |
| below. | |
| </td></tr><tr><td align="left" valign="center"><code class="propertyName">contextXsltFile</code></td><td align="left" valign="center"> | |
| You may also customize your directory listing by context by | |
| configuring <code>contextXsltFile</code>. This must be a context | |
| relative path (e.g.: <code>/path/to/context.xslt</code>) to a file with | |
| a <code>.xsl</code> or <code>.xslt</code> extension. This overrides | |
| <code>globalXsltFile</code>. If this value is present but a file does | |
| not exist, then <code>globalXsltFile</code> will be used. If | |
| <code>globalXsltFile</code> does not exist, then the default | |
| directory listing will be shown. | |
| </td></tr><tr><td align="left" valign="center"><code class="propertyName">localXsltFile</code></td><td align="left" valign="center"> | |
| You may also customize your directory listing by directory by | |
| configuring <code>localXsltFile</code>. This must be a file in the | |
| directory where the listing will take place to with a | |
| <code>.xsl</code> or <code>.xslt</code> extension. This overrides | |
| <code>globalXsltFile</code> and <code>contextXsltFile</code>. If this | |
| value is present but a file does not exist, then | |
| <code>contextXsltFile</code> will be used. If | |
| <code>contextXsltFile</code> does not exist, then | |
| <code>globalXsltFile</code> will be used. If | |
| <code>globalXsltFile</code> does not exist, then the default | |
| directory listing will be shown. | |
| </td></tr><tr><td align="left" valign="center"><code class="propertyName">input</code></td><td align="left" valign="center"> | |
| Input buffer size (in bytes) when reading | |
| resources to be served. [2048] | |
| </td></tr><tr><td align="left" valign="center"><code class="propertyName">output</code></td><td align="left" valign="center"> | |
| Output buffer size (in bytes) when writing | |
| resources to be served. [2048] | |
| </td></tr><tr><td align="left" valign="center"><code class="propertyName">readonly</code></td><td align="left" valign="center"> | |
| Is this context "read only", so HTTP commands like PUT and | |
| DELETE are rejected? [true] | |
| </td></tr><tr><td align="left" valign="center"><code class="propertyName">fileEncoding</code></td><td align="left" valign="center"> | |
| File encoding to be used when reading static resources. | |
| [platform default] | |
| </td></tr><tr><td align="left" valign="center"><code class="propertyName">sendfileSize</code></td><td align="left" valign="center"> | |
| If the connector used supports sendfile, this represents the minimal | |
| file size in KB for which sendfile will be used. Use a negative value | |
| to always disable sendfile. [48] | |
| </td></tr><tr><td align="left" valign="center"><code class="propertyName">useAcceptRanges</code></td><td align="left" valign="center"> | |
| If true, the Accept-Ranges header will be set when appropriate for the | |
| response. [true] | |
| </td></tr><tr><td align="left" valign="center"><code class="propertyName">showServerInfo</code></td><td align="left" valign="center"> | |
| Should server information be presented in the response sent to clients | |
| when directory listing is enabled. [true] | |
| </td></tr></table> | |
| </blockquote></td></tr></table><table border="0" cellspacing="0" cellpadding="2"><tr><td bgcolor="#525D76"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="dir"><strong>How do I customize directory listings?</strong></a></font></td></tr><tr><td><blockquote> | |
| <p>You can override DefaultServlet with you own implementation and use that | |
| in your web.xml declaration. If you | |
| can understand what was just said, we will assume you can read the code | |
| to DefaultServlet servlet and make the appropriate adjustments. (If not, | |
| then that method isn't for you) | |
| </p> | |
| <p> | |
| You can use either <code>localXsltFile</code> or | |
| <code>globalXsltFile</code> and DefaultServlet will create | |
| an xml document and run it through an xsl transformation based | |
| on the values provided in <code>localXsltFile</code> and | |
| <code>globalXsltFile</code>. <code>localXsltFile</code> is first | |
| checked, followed by <code>globalXsltFile</code>, then default | |
| behaviors takes place. | |
| </p> | |
| <p> | |
| Format: | |
| </p> | |
| <div class="codeBox"><pre><code> <listing> | |
| <entries> | |
| <entry type='file|dir' urlPath='aPath' size='###' date='gmt date'> | |
| fileName1 | |
| </entry> | |
| <entry type='file|dir' urlPath='aPath' size='###' date='gmt date'> | |
| fileName2 | |
| </entry> | |
| ... | |
| </entries> | |
| <readme></readme> | |
| </listing></code></pre></div> | |
| <ul> | |
| <li>size will be missing if <code>type='dir'</code></li> | |
| <li>Readme is a CDATA entry</li> | |
| </ul> | |
| <p> | |
| The following is a sample xsl file which mimics the default tomcat behavior: | |
| </p> | |
| <div class="codeBox"><pre><code><?xml version="1.0" encoding="UTF-8"?> | |
| <xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" | |
| version="3.0"> | |
| <xsl:output method="html" html-version="5.0" | |
| encoding="UTF-8" indent="no" | |
| doctype-system="about:legacy-compat"/> | |
| <xsl:template match="listing"> | |
| <html> | |
| <head> | |
| <title> | |
| Sample Directory Listing For | |
| <xsl:value-of select="@directory"/> | |
| </title> | |
| <style> | |
| h1 {color : white;background-color : #0086b2;} | |
| h3 {color : white;background-color : #0086b2;} | |
| body {font-family : sans-serif,Arial,Tahoma; | |
| color : black;background-color : white;} | |
| b {color : white;background-color : #0086b2;} | |
| a {color : black;} HR{color : #0086b2;} | |
| table td { padding: 5px; } | |
| </style> | |
| </head> | |
| <body> | |
| <h1>Sample Directory Listing For | |
| <xsl:value-of select="@directory"/> | |
| </h1> | |
| <hr style="height: 1px;" /> | |
| <table style="width: 100%;"> | |
| <tr> | |
| <th style="text-align: left;">Filename</th> | |
| <th style="text-align: center;">Size</th> | |
| <th style="text-align: right;">Last Modified</th> | |
| </tr> | |
| <xsl:apply-templates select="entries"/> | |
| </table> | |
| <xsl:apply-templates select="readme"/> | |
| <hr style="height: 1px;" /> | |
| <h3>Apache Tomcat/8.0</h3> | |
| </body> | |
| </html> | |
| </xsl:template> | |
| <xsl:template match="entries"> | |
| <xsl:apply-templates select="entry"/> | |
| </xsl:template> | |
| <xsl:template match="readme"> | |
| <hr style="height: 1px;" /> | |
| <pre><xsl:apply-templates/></pre> | |
| </xsl:template> | |
| <xsl:template match="entry"> | |
| <tr> | |
| <td style="text-align: left;"> | |
| <xsl:variable name="urlPath" select="@urlPath"/> | |
| <a href="{$urlPath}"> | |
| <pre><xsl:apply-templates/></pre> | |
| </a> | |
| </td> | |
| <td style="text-align: right;"> | |
| <pre><xsl:value-of select="@size"/></pre> | |
| </td> | |
| <td style="text-align: right;"> | |
| <pre><xsl:value-of select="@date"/></pre> | |
| </td> | |
| </tr> | |
| </xsl:template> | |
| </xsl:stylesheet></code></pre></div> | |
| </blockquote></td></tr></table><table border="0" cellspacing="0" cellpadding="2"><tr><td bgcolor="#525D76"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="secure"><strong>How do I secure directory listings?</strong></a></font></td></tr><tr><td><blockquote> | |
| Use web.xml in each individual webapp. See the security section of the | |
| Servlet specification. | |
| </blockquote></td></tr></table></td></tr><tr class="noPrint"><td width="20%" valign="top" nowrap class="noPrint"></td><td width="80%" valign="top" align="left"><table border="0" cellspacing="0" cellpadding="2"><tr><td bgcolor="#525D76"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="comments_section" id="comments_section"><strong>Comments</strong></a></font></td></tr><tr><td><blockquote><p class="notice"><strong>Notice: </strong>This comments section collects your suggestions | |
| on improving documentation for Apache Tomcat.<br><br> | |
| If you have trouble and need help, read | |
| <a href="http://tomcat.apache.org/findhelp.html">Find Help</a> page | |
| and ask your question on the tomcat-users | |
| <a href="http://tomcat.apache.org/lists.html">mailing list</a>. | |
| Do not ask such questions here. This is not a Q&A section.<br><br> | |
| The Apache Comments System is explained <a href="./comments.html">here</a>. | |
| Comments may be removed by our moderators if they are either | |
| implemented or considered invalid/off-topic.</p><script type="text/javascript"><!--//--><![CDATA[//><!-- | |
| var comments_shortname = 'tomcat'; | |
| var comments_identifier = 'http://tomcat.apache.org/tomcat-7.0-doc/default-servlet.html'; | |
| (function(w, d) { | |
| if (w.location.hostname.toLowerCase() == "tomcat.apache.org") { | |
| d.write('<div id="comments_thread"><\/div>'); | |
| var s = d.createElement('script'); | |
| s.type = 'text/javascript'; | |
| s.async = true; | |
| s.src = 'https://comments.apache.org/show_comments.lua?site=' + comments_shortname + '&page=' + comments_identifier; | |
| (d.getElementsByTagName('head')[0] || d.getElementsByTagName('body')[0]).appendChild(s); | |
| } | |
| else { | |
| d.write('<div id="comments_thread"><strong>Comments are disabled for this page at the moment.<\/strong><\/div>'); | |
| } | |
| })(window, document); | |
| //--><!]]></script></blockquote></td></tr></table></td></tr><!--FOOTER SEPARATOR--><tr><td colspan="2"><hr noshade size="1"></td></tr><!--PAGE FOOTER--><tr><td colspan="2"><div align="center"><font color="#525D76" size="-1"><em> | |
| Copyright © 1999-2017, Apache Software Foundation | |
| </em></font></div></td></tr></table></body></html> |