DefaultContext组件

Introduction

DefaultContext元素代表Context元素的配置设置的一个子集,可以嵌套在Engine或者Host元素中,表示自动创建的Context的缺省配置属性。

在什么情况下,Catalina会自动创建Context?有关这方面的更多信息,参考应用自动发布和用户web应用。

属性
公共属性

所有DefaultContext的实现支持如下属性:

属性 描述
cookies

如果想利用cookies来传递session identifier(需要客户端支持cookies),设为ture。否则为false,这种情况下只能依靠URL Rewriting传递session identifier。

 

crossContext

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

reloadable

如果希望Catalina监视/WEB-INF/classes/和/WEB-INF/lib下面的类是否发生变化,在发生变化的时候自动重载web application,设为true。这个特征在开发阶段很有用,但也大大增加了服务器的开销。因此,在发布以后,不推荐使用。但是,你可以使用Manager应用在必要的时候触发应用的重载。

wrapperClass

org.apache.catalina.Wrapper实现类的名称,用于该Context管理的servlets。如果没有指定,使用标准的缺省值。

标准实现

 

 

 

DefaultContext的标准实现是org.apache.catalina.core.DefaultContext,它还支持如下的附加属性:

属性 描述
swallowOutput

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

useNaming

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

嵌套组件
专有特征
Contxt参数(Context Parameters

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

 

<DefaultContext ...>
                                    ...
                                    <Parameter name="companyName" value="My Company, Incorporated"
                                    override="false"/>
                                    ...
                                    </DefaultContext>
                                    
这与在/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应用可见。比如,可以按照如下方法创建一个环境条目:

 

<DefaultContext ...>
                                    ...
                                    <Environment name="maxExemptions" value="10"
                                    type="java.lang.Integer" override="false"/>
                                    ...
                                    </DefaultContext>
                                    
这与在/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>
                                    

but does not require modification of the deployment descriptor to customize 区别是,前者不需要修改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(Lifecycle Listeners

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

<DefaultContext  ...>
                                    ...
                                    <Listener className="com.mycompany.mypackage.MyListener" ... >
                                    ...
                                    </DefaultContext>
                                    

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

资源定义(Resource Definitions

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

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

 

<DefaultContext ...>
                                    ...
                                    <Resource name="jdbc/EmployeeDB" auth="Container"
                                    type="javax.sql.DataSource"
                                    description="Employees Database for HR Applications"/>
                                    ...
                                    </DefaultContext>
                                    
这等价于在/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 Parameters

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

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

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

 

<DefaultContext ...>
                                    ...
                                    <ResourceParams name="jdbc/EmployeeDB">
                                    <parameter>
                                    <name>driverClassName</name>
                                    <value>org.hsql.jdbcDriver</value>
                                    </parameter>
                                    <parameter>
                                    <name>driverName</name>
                                    </value>jdbc:HypersonicSQL:database</value>
                                    </parameter>
                                    <parameter>
                                    <name>user</name>
                                    <value>dbusername</value>
                                    </parameter>
                                    <parameter>
                                    <name>password</name>
                                    <value>dbpassword</value>
                                    </parameter>
                                    </ResourceParams>
                                    ...
                                    </DefaultContext>
                                    
如果你需要为某个特定的资源类型指定工厂内的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 资源。
比如,你可以按照如下方法创建一个资源连接:

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

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

属性 描述
global

被连接的连接全局资源的名称

name

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

type

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