Blame - webapps/docs/default-servlet.html - portal_platform/tomcat-cms

Cheng Tang

2014-04-27 16:37:18 +0800

<html><head><META http-equiv="Content-Type" content="text/html; charset=iso-8859-1"><title>Apache Tomcat 7 (7.0.42) - Default Servlet Reference</title><meta name="author" content="Tim Funk"><style type="text/css" media="print">

2

.noPrint {display: none;}

3

td#mainBody {width: 100%;}

4

</style><style type="text/css">

5

code {background-color:rgb(224,255,255);padding:0 0.1em;}

6

code.attributeName, code.propertyName {background-color:transparent;}

7

</style><style type="text/css">

8

.wrapped-source code { display: block; background-color: transparent; }

9

.wrapped-source div { margin: 0 0 0 1.25em; }

10

.wrapped-source p { margin: 0 0 0 1.25em; text-indent: -1.25em; }

11

</style><style type="text/css">

12

p.notice {

13

border: 1px solid rgb(255, 0, 0);

14

background-color: rgb(238, 238, 238);

15

color: rgb(0, 51, 102);

16

padding: 0.5em;

17

margin: 1em 2em 1em 1em;

18

}

19

</style></head><body bgcolor="#ffffff" text="#000000" link="#525D76" alink="#525D76" vlink="#525D76"><table border="0" width="100%" cellspacing="0"><tr><td><a href="http://tomcat.apache.org/"><img src="./images/tomcat.gif" align="right" alt="

20

The Apache Tomcat Servlet/JSP Container

21

" border="0"></a></td><td><h1><font face="arial,helvetica,sanserif">Apache Tomcat 7</font></h1><font face="arial,helvetica,sanserif">Version 7.0.42, Jul 2 2013</font></td><td><a href="http://www.apache.org/"><img src="./images/asf-logo.gif" align="right" alt="Apache Logo" border="0"></a></td></tr></table><table border="0" width="100%" cellspacing="4"><tr><td colspan="2"><hr noshade size="1"></td></tr><tr><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</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-descriptor-howto.html">16) MBean Descriptor</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="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><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>

22

<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>

23

</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>

24

The default servlet is the servlet which serves static resources as well

25

as serves the directory listings (if directory listings are enabled).

26

27

</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>

28

It is declared globally in <i>$CATALINA_BASE/conf/web.xml</i>.

29

By default here is it's declaration:

30

31

32

<servlet-name>default</servlet-name>

33

<servlet-class>

34

org.apache.catalina.servlets.DefaultServlet

35

</servlet-class>

36

<init-param>

37

<param-name>debug</param-name>

38

<param-value>0</param-value>

39

</init-param>

40

<init-param>

41

<param-name>listings</param-name>

42

<param-value>false</param-value>

43

</init-param>

44

<load-on-startup>1</load-on-startup>

</servlet>

...

<servlet-mapping>

<servlet-name>default</servlet-name>

51

<url-pattern>/</url-pattern>

52

</servlet-mapping>

53

54

</pre></td><td bgcolor="#023264" width="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr><tr><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" height="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr></table></div>

55

56

So by default, the default servlet is loaded at webapp startup and

57

directory listings are disabled and debugging is turned off.

58

</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>

59

The DefaultServlet allows the following initParamters:

<tr>

<th valign="top">debug</th>

64

65

Debugging level. It is not very useful unless you are a tomcat

66

developer. As

67

of this writing, useful values are 0, 1, 11, 1000. [0]

</td>

</tr>

<tr>

<th valign="top">listings</th>

72

73

If no welcome file is present, can a directory listing be

74

shown?

75

value may be <b>true</b> or <b>false</b> [false]

76

<br>

77

Welcome files are part of the servlet api.

78

<br>

79

<b>WARNING:</b> Listings of directories containing many entries are

80

expensive. Multiple requests for large directory listings can consume

81

significant proportions of server resources.

</td>

</tr>

<tr>

<th valign="top">readmeFile</th>

86

87

If a directory listing is presented, a readme file may also

88

be presented with the listing. This file is inserted as is

89

so it may contain HTML.

</td>

</tr>

<tr>

<th valign="top">globalXsltFile</th>

94

95

If you wish to customize your directory listing, you

96

can use an XSL transformation. This value is an absolute

97

file name which be used for all directory listings.

98

This can be overridden per context and/or per directory. See

99

<strong>contextXsltFile</strong> and <strong>localXsltFile</strong>

100

below. The format of the xml is shown below.

</td>

</tr>

<tr>

<th valign="top">contextXsltFile</th>

105

106

You may also customize your directory listing by context by

107

configuring <code>contextXsltFile</code>. This should be a context

108

relative path (e.g.: <code>/path/to/context.xslt</code>). This

109

overrides <code>globalXsltFile</code>. If this value is present but a

110

file does not exist, then <code>globalXsltFile</code> will be used. If

111

<code>globalXsltFile</code> does not exist, then the default

112

directory listing will be shown.

</td>

</tr>

<tr>

<th valign="top">localXsltFile</th>

117

118

You may also customize your directory listing by directory by

119

configuring <code>localXsltFile</code>. This should be a relative

120

file name in the directory where the listing will take place.

121

This overrides <code>globalXsltFile</code> and

122

<code>contextXsltFile</code>. If this value is present but a file

123

does not exist, then <code>contextXsltFile</code> will be used. If

124

<code>contextXsltFile</code> does not exist, then

125

<code>globalXsltFile</code> will be used. If

126

<code>globalXsltFile</code> does not exist, then the default

127

directory listing will be shown.

</td>

</tr>

<tr>

<th valign="top">input</th>

132

133

Input buffer size (in bytes) when reading

134

resources to be served. [2048]

</td>

</tr>

<tr>

<th valign="top">output</th>

139

140

Output buffer size (in bytes) when writing

141

resources to be served. [2048]

</td>

</tr>

<tr>

<th valign="top">readonly</th>

146

147

Is this context "read only", so HTTP commands like PUT and

148

DELETE are rejected? [true]

</td>

</tr>

<tr>

<th valign="top">fileEncoding</th>

153

154

File encoding to be used when reading static resources.

[platform default]

</td>

</tr>

<tr>

<th valign="top">sendfileSize</th>

160

161

If the connector used supports sendfile, this represents the minimal

162

file size in KB for which sendfile will be used. Use a negative value

163

to always disable sendfile. [48]

</td>

</tr>

<tr>

<th valign="top">useAcceptRanges</th>

168

169

If true, the Accept-Ranges header will be set when appropriate for the

response. [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>

176

<p>You can override DefaultServlet with you own implementation and use that

177

in your web.xml declaration. If you

178

can understand what was just said, we will assume you can read the code

179

to DefaultServlet servlet and make the appropriate adjustments. (If not,

180

then that method isn't for you)

181

</p>

182

<p>

183

You can use either <code>localXsltFile</code> or

184

<code>globalXsltFile</code> and DefaultServlet will create

185

an xml document and run it through an xsl transformation based

186

on the values provided in <code>localXsltFile</code> and

187

<code>globalXsltFile</code>. <code>localXsltFile</code> is first

188

checked, followed by <code>globalXsltFile</code>, then default

189

behaviors takes place.

</p>

<p>

Format:

fileName1

</entry>

fileName2

</entry>

...

</entries>

</listing>

</pre></td><td bgcolor="#023264" width="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr><tr><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" height="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr></table></div>

208

<ul>

209

<li>size will be missing if <code>type='dir'</code></li>

210

<li>Readme is a CDATA entry</li>

211

</ul>

212

</p>

213

The following is a sample xsl file which mimics the default tomcat behavior:

214

215

<?xml version="1.0"?>

216

217

<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform"

218

version="1.0">

219

220

<xsl:output method="xhtml" encoding="iso-8859-1" indent="no"/>

221

222

<xsl:template match="listing">

<html>

<head>

<title>

Sample Directory Listing For

227

<xsl:value-of select="@directory"/>

228

</title>

229

<style>

230

h1{color : white;background-color : #0086b2;}

231

h3{color : white;background-color : #0086b2;}

232

body{font-family : sans-serif,Arial,Tahoma;

233

color : black;background-color : white;}

234

b{color : white;background-color : #0086b2;}

235

a{color : black;} HR{color : #0086b2;}

</style>

</head>

<body>

<h1>Sample Directory Listing For

240

<xsl:value-of select="@directory"/>

241

</h1>

242

243

<table cellspacing="0"

width="100%"

cellpadding="5"

align="center">

<tr>

<th align="left">Filename</th>

249

250

<th align="right">Last Modified</th>

251

</tr>

252

<xsl:apply-templates select="entries"/>

253

</table>

254

<xsl:apply-templates select="readme"/>

255

256

<h3>Apache Tomcat/7.0</h3>

</body>

</html>

</xsl:template>

<xsl:template match="entries">

263

<xsl:apply-templates select="entry"/>

264

</xsl:template>

265

266

<xsl:template match="readme">

</xsl:template>

<xsl:template match="entry">

272

<tr>

273

274

<xsl:variable name="urlPath" select="@urlPath"/>

</a>

</td>

</td>

</td>

</tr>

</xsl:template>

</xsl:stylesheet>

</pre></td><td bgcolor="#023264" width="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr><tr><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" height="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" width="1" height="1"><img src="./images/void.gif" alt="" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr></table></div>

290

291

</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>

292

Use web.xml in each individual webapp. See the security section of the

293

Servlet specification.

294

295

</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

296

on improving documentation for Apache Tomcat.<br><br>

297

If you have trouble and need help, read

298

<a href="http://tomcat.apache.org/findhelp.html">Find Help</a> page

299

and ask your question on the tomcat-users

300

<a href="http://tomcat.apache.org/lists.html">mailing list</a>.

301

Do not ask such questions here. This is not a Q&A section.<br><br>

302

The Apache Comments System is explained <a href="/tomcat-7.0-doc/comments.html">here</a>.

303

Comments may be removed by our moderators if they are either

304

implemented or considered invalid/off-topic.</p><script type="text/javascript"><![CDATA[//><!--

305

var comments_shortname = 'tomcat';

306

var comments_identifier = 'http://tomcat.apache.org/tomcat-7.0-doc/default-servlet.html';

307

(function(w, d) {

308

if (w.location.hostname.toLowerCase() == "tomcat.apache.org") {

309

d.write('<div id="comments_thread"><\/div>');

310

var s = d.createElement('script');

311

s.type = 'text/javascript';

312

s.async = true;

313

s.src = 'https://comments.apache.org/show_comments.lua?site=' + comments_shortname + '&page=' + comments_identifier;

314

(d.getElementsByTagName('head')[0] || d.getElementsByTagName('body')[0]).appendChild(s);

315

}

316

else {

317

d.write('<div id="comments_thread"><strong>Comments are disabled for this page at the moment.<\/strong><\/div>');

318

}

319

})(window, document);

320

//--><!]]></script></blockquote></td></tr></table></td></tr><tr><td colspan="2"><hr noshade size="1"></td></tr><tr><td colspan="2"><div align="center"><font color="#525D76" size="-1"><em>

321

322

</em></font></div></td></tr></table></body></html>