Tomcat的Server.xml文件详解

Tomcat是流行的JSP服务器，正如ASP中需要使用IIS一样，在编辑的JSp页面部署时需要一个服务器，Tomcat正是常用的首选服务器。网上下载的程序或者从别处拷贝的jsp工程，可以直接放在TOmcat主目录中Webapps目录中就可以运行，但我们不希望能放到任意的目录下都能通过浏览器进行访问吗？其实，很简单，打开Tomcat主目录中conf文件夹下Server.xml文件，在<host>标签中加入文件中加入如下代码即可：
<Context path="/myjsp" docBase="c:\myjsp" debug="0" reloadable="true" crossContext="true"></Context>
其中，path为我们要建立的虚拟目录，docBase为实际目录在硬盘上的位置。
当然，修改server.xml后需要重新启动Tomcat服务器，才能生效。
下面转自网上的关于Server.xml文件详解。
//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
port
指定一个端口，这个端口负责监听关闭tomcat的请求

shutdown
指定向端口发送的命令字符串

service
name
指定service的名字

Connector(表示客户端和service之间的连接)
port
指定服务器端要创建的端口号，并在这个端口监听来自客户端的请求

minProcessors
服务器启动时创建的处理请求的线程数

maxProcessors
最大可以创建的处理请求的线程数

enableLookups
如果为true，则可以通过调用request.getRemoteHost()进行DNS查询来得到远程客户端的实际主机名，若为false则不进行DNS查询，而是返回其ip地址

redirectPort
指定服务器正在处理http请求时收到了一个SSL传输请求后重定向的端口号

acceptCount
指定当所有可以使用的处理请求的线程数都被使用时，可以放到处理队列中的请求数，超过这个数的请求将不予处理

connectionTimeout
指定超时的时间数(以毫秒为单位)

Engine(表示指定service中的请求处理机，接收和处理来自Connector的请求)
defaultHost
指定缺省的处理请求的主机名，它至少与其中的一个host元素的name属性值是一样的

Context(表示一个web应用程序，通常为WAR文件，关于WAR的具体信息见servlet规范)
docBase
应用程序的路径或者是WAR文件存放的路径

path
表示此web应用程序的url的前缀，这样请求的url为http://localhost:8080/path/****

reloadable
这个属性非常重要，如果为true，则tomcat会自动检测应用程序的/WEB-INF/lib 和/WEB-INF/classes目录的变化，自动装载新的应用程序，我们可以在不重起tomcat的情况下改变应用程序

host(表示一个虚拟主机)
name
指定主机名

appBase
应用程序基本目录，即存放应用程序的目录

unpackWARs
如果为true，则tomcat会自动将WAR文件解压，否则不解压，直接从WAR文件中运行应用程序

Logger(表示日志，调试和错误信息)
className
指定logger使用的类名，此类必须实现org.apache.catalina.Logger 接口

prefix
指定log文件的前缀

suffix
指定log文件的后缀

timestamp
如果为true，则log文件名中要加入时间，如下例:localhost_log.2001-10-04.txt

Realm(表示存放用户名，密码及role的数据库)
className
指定Realm使用的类名，此类必须实现org.apache.catalina.Realm接口

Valve(功能与Logger差不多，其prefix和suffix属性解释和Logger 中的一样)
className
指定Valve使用的类名，如用org.apache.catalina.valves.AccessLogValve类可以记录应用程序的访问信息

directory
指定log文件存放的位置

pattern
有两个值，common方式记录远程主机名或ip地址，用户名，日期，第一行请求的字符串，HTTP响应代码，发送的字节数。combined方式比common方式记录的值更多



元素
它代表整个容器,是Tomcat实例的顶层元素.由org.apache.catalina.Server接口来定义.它包含一个元素.并且它不能做为任何元素的子元素.


1>className指定实现org.apache.catalina.Server接口的类.默认值为org.apache.catalina.core.StandardServer
2>port指定Tomcat监听shutdown命令端口.终止服务器运行时,必须在Tomcat服务器所在的机器上发出shutdown命令.该属性是必须的.
3>shutdown指定终止Tomcat服务器运行时,发给Tomcat服务器的shutdown监听端口的字符串.该属性必须设置


元素
该元素由org.apache.catalina.Service接口定义,它包含一个元素,以及一个或多个,这些Connector元素共享用同一个Engine元素



第一个处理所有直接由Tomcat服务器接收的web客户请求.
第二个处理所有由Apahce服务器转发过来的Web客户请求

1>className 指定实现org.apahce.catalina.Service接口的类.默认为org.apahce.catalina.core.StandardService
2>name定义Service的名字


元素
每个Service元素只能有一个Engine元素.元素处理在同一个中所有元素接收到的客户请求.由org.apahce.catalina.Engine接口定义.


1>className指定实现Engine接口的类,默认值为StandardEngine
2>defaultHost指定处理客户的默认主机名,在中的子元素中必须定义这一主机
3>name定义Engine的名字

在可以包含如下元素, , ,


元素
它由Host接口定义.一个Engine元素可以包含多个元素.每个的元素定义了一个虚拟主机.它包含了一个或多个Web应用.


1>className指定实现Host接口的类.默认值为StandardHost
2>appBase指定虚拟主机的目录,可以指定绝对目录,也可以指定相对于的相对目录.如果没有此项,默认为/webapps
3>autoDeploy如果此项设为true,表示Tomcat服务处于运行状态时,能够监测appBase下的文件,如果有新有web应用加入进来,会自运发布这个WEB应用
4>unpackWARs如果此项设置为true,表示把WEB应用的WAR文件先展开为开放目录结构后再运行.如果设为false将直接运行为WAR文件
5>alias指定主机别名,可以指定多个别名
6>deployOnStartup如果此项设为true,表示Tomcat服务器启动时会自动发布appBase目录下所有的Web应用.如果Web应用中的server.xml没有相应的元素,将采用Tomcat默认的Context
7>name定义虚拟主机的名字

在元素中可以包含如下子元素
, , ,


元素
它由Context接口定义.是使用最频繁的元素.每个可以包含多个元素.每个web应用有唯一
的一个相对应的Context代表web应用自身.servlet容器为第一个web应用创建一个
ServletContext对象.


1>className指定实现Context的类,默认为StandardContext类
2>path指定访问Web应用的URL入口,注意/myweb,而不是myweb了事
3>reloadable如果这个属性设为true, Tomcat服务器在运行状态下会监视在WEB-INF/classes和Web-INF/lib目录CLASS文件的改运.如果监视到有class文件被更新,服务器自重新加载Web应用
3>cookies指定是否通过Cookies来支持Session,默认值为true
4>useNaming指定是否支持JNDI,默认值为了true


在元素中可以包含如下元素
, , ,


Connector元素
由Connector接口定义.元素代表与客户程序实际交互的给件,它负责接收客户请求,以及向客户返回响应结果.



第一个Connector元素定义了一个HTTP Connector,它通过8080端口接收HTTP请求;第二个Connector元素定义了一个JD Connector,它通过8009端口接收由其它服务器转发过来的请求.

Connector元素共用属性
1>className指定实现Connector接口的类
2>enableLookups如果设为true,表示支持域名解析,可以把IP地址解析为主机名.WEB应用中调用request.getRemoteHost方法返回客户机主机名.默认值为true
3>redirectPort指定转发端口.如果当前端口只支持non-SSL请求,在需要安全通信的场命,将把客户请求转发至SSL的redirectPort端口
HttpConnector元素的属性
1>className实现Connector的类
2>port设定Tcp/IP端口,默认值为8080,如果把8080改成80,则只要输入http://localhost即可
因为TCP/IP的默认端口是80
3>address如果服务器有二个以上ip地址,此属性可以设定端口监听的ip地址.默认情况下,端口会监听服务器上所有的ip地址
4>bufferSize设定由端口创建的输入流的缓存大小.默认值为2048byte
5>protocol设定Http协议,默认值为HTTP/1.1
6>maxThreads设定在监听端口的线程的最大数目,这个值也决定了服务器可以同时响应客户请求的最大数目.默认值为200
7>acceptCount设定在监听端口队列的最大客户请求数量,默认值为10.如果队列已满,客户必须等待.
8>connectionTimeout定义建立客户连接超时的时间.如果为-1,表示不限制建立客户连接的时间
JkConnector的属性
1>className实现Connector的类
2>port设定AJP端口号
 
 
##########################################################################
 
附：server.xml：
 
Context元素代表一个web应用，运行在某个特定的虚拟主机上。如Servlet Specification 2.2或以后版本中描述的那样，每个web应用基于一个Web Application Archive(WAR)文件，或者是一个目录，包含WAR文件解压后的内容。有关Web Application Archive的更多信息，可以参考Servlet Specification和Tomcat 应用程序开发者指南。
通过将请求URI的最长可能前缀与每个Context的context路径进行匹配，Catalina选择相应的web 应用处理HTTP请求。一旦选定，根据web application deployment descriptor 文件中定义的servlet映射，Context会选择一个正确的servlet来处理进来的请求。servlet映射必须定义在该web应用目录层次结构中的/WEB-INF/web.xml中。

你可以在一个Host元素中嵌套任意多的Context元素。每个Context的路径必须是惟一的，由path属性定义。另外，你必须定义一个context路径长度为0的Context，这个Context称为该虚拟主机的缺省web应用，用来处理那些不能匹配任何Context的Context路径的请求。

除了在Host元素中嵌套Context元素以外，你也可以将它们存储在单个文件中（以.xml为后缀），放在$CATALINA_HOME/conf/[enginename]/[hostname]/目录下面。有关这方面的更多信息，参考应用的自动发布。这种方法允许动态重新配置web应用，因为如果修改了conf/server.xml，就必须重新启动Tomcat。

除了明确指定Context元素以外，还有其他几种技术可以自动生成Context元素。参考Automatic Application Deployment 和 User Web Applications

以下的描述使用变量$CATALINA_HOME来指Tomcat 5安装的目录。大多数的相对路径都是以该目录为基准。但是，通过设置CATALINA_BASE目录，可以运行多个Tomcat 5实例，这时你应该使用$CATALINA_BASE来作为目录基准，而不是使用$CATALINA_HOME。

属性
通用属性
所有Context的实现支持如下属性：
backgroundProcessorDelay 这个值代表在context及其子容器（包括所有的wrappers）上调用backgroundProcess方法的延时，以秒为单位。如果延时值非负，子容器不会被调用，也就是说子容器使用自己的处理线程。如果该值为正，会创建一个新的线程。在等待指定的时间以后，该线程在主机及其 子容器上调用backgroundProcess方法。context利用后台处理session过期，监测类的变化用于重新载入。如果没有指定，该属性的缺省值是－1，说明context依赖其所属的Host的后台处理。
className 实现的Java类名。该类必须实现org.apache.catalina.Context接口。如果没有指定，使用标准实现（在下面定义）。
cookies 如果想利用cookies来传递session identifier（需要客户端支持cookies），设为ture。否则为false，这种情况下只能依靠URL Rewriting传递session identifier。



crossContext 如果想在应用内调用ServletContext.getContext()来返回在该虚拟主机上运行的其他web application的request dispatcher,设为true。在安全性很重要的环境中，设为false，使得getContext()总是返回null。缺省值为false。

docBase 该web应用的文档基准目录（Document Base，也称为Context Root），或者是WAR文件的路径。可以使用绝对路径，也可以使用相对于context所属的Host的appBase路径。



override 如果想利用该Context元素中的设置覆盖DefaultContext中相应的设置，设为true。缺省情况下使用DefaultContext中的设置。

privileged 设为true，允许context使用container servlets，比如manager servlet。



path web应用的context路径。catalina将每个URL的起始和context path进行比较，选择合适的web应用处理该请求。特定Host下的context path必须是惟一的。如果context path为空字符串（""），这个context是所属Host的缺省web应用,用来处理不能匹配任何context path的请求。



reloadable 如果希望Catalina监视/WEB-INF/classes/和/WEB-INF/lib下面的类是否发生变化，在发生变化的时候自动重载web application，设为true。这个特征在开发阶段很有用，但也大大增加了服务器的开销。因此，在发布以后，不推荐使用。但是，你可以使用Manager应用在必要的时候触发应用的重载。
wrapperClass org.apache.catalina.Wrapper实现类的名称，用于该Context管理的servlets。如果没有指定，使用标准的缺省值。

标准实现
Context的标准实现是org.apache.catalina.core.StandardContext.它还支持如下的附加属性：

属性 描述
debug 与这个Engine关联的Logger记录的调试信息的详细程度。数字越大，输出越详细。如果没有指定，缺省为0。



swallowOutput 如果该值为true，System.out和System.err的输出被重定向到web应用的logger。如果没有指定，缺省值为false

useNaming 如果希望Catalina为该web应用使能一个JNDI InitialContext对象，设为true。该InitialialContext符合J2EE平台的约定，缺省值为true。

workDir Context提供的临时目录的路径，用于servlet的临时读/写。利用javax.servlet.context.tempdir属性，servlet可以访问该目录。如果没有指定，使用$CATALINA_HOME/work下一个合适的目录。



嵌套组件
下列元素可以嵌套在Context元素中，但每个元素至多只能嵌套一次。

Loader－配置该web应用用来加载servlet和javabean的类加载器。正常情况下，使用缺省的类加载器就足够了；
Logger - 配置用来接收和处理所有日志消息的logger，包括调用ServletContext.log()函数记录的所有消息；
Manager -配置用于创建，销毁，维持HTTP session的session manager.正常情况下，使用缺省的session manager配置就足够了；
Realm - 配置Realm，该Realm的用户数据库以及相关的角色仅用于这个特定的web应用中。如果没有指定，该web应用使用所属的Host或Engine的Realm。
Resources - 配置用于访问与这个web应用相关联的静态资源。正常情况下，使用缺省的resource manager就足够了。

专有特征
访问日志
正常情况下，运行web服务器会生成访问日志。访问日志以标准格式为每个请求输出一行信息。Catalina包含一个可选的Valve实现，可以用标准格式生成日志,还可以使用任意定制的格式。

通过在Engine，Host或者Context中嵌套一个Valve元素，Catalina会为该容器处理的所有请求创建访问日志，如下所示：


<Context path="/examples" ...>
...
<Valve className="org.apache.catalina.valves.AccessLogValve"
prefix="localhost_access_log." suffix=".txt"
pattern="common"/>
...
</Context>



参考Access Log Valve，以获得更多配置属性的信息；

Context的自动配置
如果使用标准的Context实现，当Catalina启动，或者重载web应用的时候，如下的配置步骤会自动发生，不需要特殊的配置来使能这个特征。

如果没有定义自己的Loader元素，将会配置一个标准的web应用class loader；
如果没有定义自己的Manager元素，会配置一个标准的session manager；
如果没有定义自己的Resources元素，使用标准的resource manager。
在conf/web.xml中列出的web应用的属性会当做该web应用的缺省的属性。这被用于建立缺省的映射（比如将.jsp映射成对应的JSP servlet），以及其他的标准属性。
列举在/WEB-INF/web.xml资源中的属性被处理（如果资源存在）；
如果web应用指定了安全限制，并且可能需要对用户进行认证，Catalina会配置选定的Authenticator，该Authenticator实现了login方法。

Context参数
可以在Context中元素中嵌套<Parameter>元素，配置带有名称的值，这些值作为servletcontext初始化参数，对整个web应用可见。比如，你可以像这样创建初始化参数:


<Context ...>
...
<Parameter name="companyName" value="My Company, Incorporated"
override="false"/>
...
</Context>



这与在/WEB-INF/web.xml中包含如下元素相等：


<context-param>
<param-name>companyName</param-name>
<param-value>My Company, Incorporated</param-value>
</context-param>



区别是，前者不需要修改deployment descriptor来定制这个值。

<Parameter>元素的有效属性值如下：

属性 描述
description 关于该context初始化参数的文字描述（可选）

name









要创建的context初始化参数的名称

override 如果不希望/WEB-INF/web.xml中具有相同参数名称的<context-param>覆盖这里指定的值，设为false。缺省值为true。

value 调用ServletContext.getInitParameter()时，返回给应用的参数值。


环境条目
可以在Context中嵌套<Environment>元素，配置命名的值，这些值作为环境条目资源(Environment Entry Resource），对整个web应用可见。比如，可以按照如下方法创建一个环境条目：


<Context ...>
...
<Environment name="maxExemptions" value="10"
type="java.lang.Integer" override="false"/>
...
</Context>



这与在/WEB-INF/web.xml中包含如下元素是等价的：


<env-entry>
<env-entry-name>maxExemptions</param-name>
<env-entry-value>10</env-entry-value>
<env-entry-type>java.lang.Integer</env-entry-type>
</env-entry>



区别是，前者不需要修改deployment descriptor来定制这个值。

<Environment>元素的有效属性所如下：

属性 描述
description 环境条目的文字描述（可选）

name 环境条目的名称，相对于java:comp/env context。

override 如果不希望/WEB-INF/web.xml中具有相同名称的<env-entry>覆盖这里指定的值，设为false。缺省值为true。

type 环境条目的Java类名的全称.在/WEB-INF/web.xml中，<env-entry-type>必须是如下的值：java.lang.Boolean, java.lang.Byte, java.lang.Character, java.lang.Double, java.lang.Float, java.lang.Integer, java.lang.Long, java.lang.Short, or java.lang.String.

value 通过JNDI context请求时，返回给应用的参数值。这个值必须转换成type属性定义的Java类型




生命期Listeners
如果一个Java对象需要知道Context什么时候启动，什么时候停止，可以在这个对象中嵌套一个Listener元素。该Listener元素必须实现了org.apache.catalina.LifecycleListener接口，在发生对应的生命期事件的时候，通知该Listener。可以按照如下的格式配置这样的Listener：


<Context path="/examples" ...>
...
<Listener className="com.mycompany.mypackage.MyListener" ... >
...
</Context>



注意，一个listener可以具有任意多的附加属性。属性名与JavaBean的属性名相对应，使用标准的属性命名方法。

请求过滤器（Request Filters）
对每个发送到Engine，Host或者Context的请求，可以要求Catalina检查IP地址或主机名称。Catalina使用一系列配置好的“接受”或者“拒绝”过滤器对客户端的地址或者主机名进行检查，过滤器是按照正则表达式语法定义的，由Jakarta Regexp正则表达式库支持。不被接受的请求会返回一个HTTP“Forbidden”错误。下面是过滤器的定义。


<Context path="/examples" ...>
...
<Valve className="org.apache.catalina.valves.RemoteHostValve"
allow="*.mycompany.com,www.yourcompany.com"/>
<Valve className="org.apache.catalina.valves.RemoteAddrValve"
deny="192.168.1.*"/>
...
</Context>



资源定义（Resource Definitions）
可以在/WEB-INF/web.xml中定义资源的特性。使用JNDI查找<resource-ref>和<resource-env-ref>元素时，这些特性被返回。对同一资源名称，还必须定义资源参数（见下面“资源参数”小节），这些参数用来配置对象工厂（object factory）以及对象工厂的属性。

比如，你可以按照如下方式创建资源定义：


<Context ...>
...
<Resource name="jdbc/EmployeeDB" auth="Container"
type="javax.sql.DataSource"
description="Employees Database for HR Applications"/>
...
</Context>



这等价于在/WEB-INF/web.xml中包含如下元素：


<resource-ref>
<description>Employees Database for HR Applications</description>
<res-ref-name>jdbc/EmployeeDB</res-ref-name>
<res-ref-type>javax.sql.DataSource</res-ref-type>
<res-auth>Container</res-auth>
</resource-ref>



区别是，前者不需要修改deployment descriptor来定制这个值。

<Resource>元素的有效属性如下：

属性 描述
auth 指定时web应用代码本身sign on到对应的resource mananger，还是由container代表web应用sign on到resource manager。该属性的值必须是Application或者Container。如果在web application deployment descriptor中使用<resource-ref>，这个属性是必需的，如果使用<resource-env-ref>，这个属性是可选的。

description 资源的文字描述（可选）

name 资源的名称，相对于java:comp/env context

scope 指定通过这个resource manager得到的连接是否共享。该属性的值必须是Shareable或者Unshareable。缺省情况下，假定连接是共享的。
type 当web应用查找该资源的时候，返回的Java类名的全称。


资源参数
资源参数用来配置资源管理器（resource manager，或对象工厂,object factory）。在做JNDI查找时，资源管理器返回查找的对象。在资源可以被访问之前，对<Context>或<DefaultContext>元素的每个<Resource>元素，或者/WEB-INF/web.xml中定义的每个<resource-ref>或<resource-env-ref>元素，都必须定义资源参数。

资源参数是用名称定义的，使用的资源管理器（或者object factory）不同，参数名称的集合也不一样。这些参数名和工厂类的JavaBeans属性相对应。JNDI实现通过调用对应的JavaBeans属性设置函数来配置特定的工厂类，然后通过lookup()调用使得该实例可见。

一个JDBC数据源的资源参数可以按照如下方式定义：


<Context ...>
...
<ResourceParams name="jdbc/EmployeeDB">
<parameter>
<name>driverClassName</name>
<value>org.hsql.jdbcDriver</value>
</parameter>
<parameter>
<name>url</name>
</value>jdbc:HypersonicSQL:database</value>
</parameter>
<parameter>
<name>user</name>
<value>dbusername</value>
</parameter>
<parameter>
<name>password</name>
<value>dbpassword</value>
</parameter>
</ResourceParams>
...
</Context>



如果你需要为某个特定的资源类型指定工厂内的Java类名，在<ResourceParams>元素中嵌套一个叫做factory的<parameter>条目。

<Resourceparams>元素的有效属性如下：

属性 描述
name 配置的资源名称，相对于java:comp/env context。这个名称必须与$CATALINA_HOME/conf/server.xml中某个<Resource>元素定义的资源名称匹配，或者在/WEB-INF/web.xml中通过<resource-ref>或者<resource-env-ref>元素应用。


资源连接（Resource Links）
资源连接用于创建到全局JNDI资源的连接。在连接名称上进行JNDI查询会返回被连接的global 资源。
比如，你可以按照如下方法创建一个资源连接：


<Context ...>
...
<ResourceLink name="linkToGlobalResource"
global="simpleValue"
type="java.lang.Integer"
...
</Context>



<ResourceLink>元素的有效属性如下：

属性 描述
global 被连接的连接全局资源的名称



name 创建的资源连接的名称，相对于java:comp/env context

type 当web应用在该资源连接上进行查找时，返回的Java类名的全称