198 lines
19 KiB
HTML
198 lines
19 KiB
HTML
|
<html><head><META http-equiv="Content-Type" content="text/html; charset=iso-8859-1"><title>Apache Tomcat Configuration Reference - The GlobalNamingResources Component</title><meta name="author" value="Remy Maucherat"><meta name="email" value="remm@apache.org"><meta name="author" value="Yoav Shapira"><meta name="email" value="yoavs@apache.org"></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><font face="arial,helvetica,sanserif"><h1>Apache Tomcat 6.0</h1></font></td><td><!--APACHE LOGO--><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"><!--HEADER SEPARATOR--><tr><td colspan="2"><hr noshade="noshade" size="1"></td></tr><tr><!--RIGHT SIDE MAIN BODY--><td width="80%" valign="top" align="left"><table border="0" width="100%" cellspacing="4"><tr><td align="left" valign="top"><h1>Apache Tomcat Configuration Reference</h1><h2>The GlobalNamingResources Component</h2></td><td align="right" valign="top" nowrap="true"><img src="../../images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr></table><table border="0" cellspacing="0" cellpadding="2"><tr><td bgcolor="#525D76"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="Introduction"><strong>Introduction</strong></a></font></td></tr><tr><td><blockquote>
|
||
|
|
|
||
|
|
<p>The <strong>GlobalNamingResources</strong> element defines the global
|
||
|
|
JNDI resources for the <a href="server.html">Server</a>.</p>
|
||
|
|
|
||
|
|
<p>These resources are listed in the server's global JNDI resource context.
|
||
|
|
This context is distinct from the per-web-application JNDI contexts
|
||
|
|
described in
|
||
|
|
the <a href="../../jndi-resources-howto.html">JNDI Resources HOW-TO</a>.
|
||
|
|
The resources defined in this element are <strong>not</strong> visible in
|
||
|
|
the per-web-application contexts unless you explicitly link them with
|
||
|
|
<a href="context.html#Resource Links"><ResourceLink></a> elements.
|
||
|
|
</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="Attributes"><strong>Attributes</strong></a></font></td></tr><tr><td><blockquote>
|
||
|
|
|
||
|
|
</blockquote></td></tr></table><table border="0" cellspacing="0" cellpadding="2"><tr><td bgcolor="#525D76"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="Nested Components"><strong>Nested Components</strong></a></font></td></tr><tr><td><blockquote>
|
||
|
|
|
||
|
|
</blockquote></td></tr></table><table border="0" cellspacing="0" cellpadding="2"><tr><td bgcolor="#525D76"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="Special Features"><strong>Special Features</strong></a></font></td></tr><tr><td><blockquote>
|
||
|
|
|
||
|
|
|
||
|
|
<table border="0" cellspacing="0" cellpadding="2"><tr><td bgcolor="#828DA6"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="Environment Entries"><strong>Environment Entries</strong></a></font></td></tr><tr><td><blockquote>
|
||
|
|
|
||
|
|
<p>You can configure named values that will be made visible to all
|
||
|
|
web applications as environment entry resources by nesting
|
||
|
|
<code><Environment></code> entries inside this element. For
|
||
|
|
example, you can create an environment entry like this:</p>
|
||
|
|
<div align="left"><table cellspacing="4" cellpadding="0" border="0"><tr><td bgcolor="#023264" width="1" height="1"><img src="../../images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" height="1"><img src="../../images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" width="1" height="1"><img src="../../images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr><tr><td bgcolor="#023264" width="1"><img src="../../images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#ffffff" height="1"><pre>
|
||
|
|
<GlobalNamingResources ...>
|
||
|
|
...
|
||
|
|
<Environment name="maxExemptions" value="10"
|
||
|
|
type="java.lang.Integer" override="false"/>
|
||
|
|
...
|
||
|
|
</GlobalNamingResources>
|
||
|
|
</pre></td><td bgcolor="#023264" width="1"><img src="../../images/void.gif" 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" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" height="1"><img src="../../images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" width="1" height="1"><img src="../../images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr></table></div>
|
||
|
|
|
||
|
|
<p>This is equivalent to the inclusion of the following element in the
|
||
|
|
web application deployment descriptor (<code>/WEB-INF/web.xml</code>):
|
||
|
|
</p>
|
||
|
|
<div align="left"><table cellspacing="4" cellpadding="0" border="0"><tr><td bgcolor="#023264" width="1" height="1"><img src="../../images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" height="1"><img src="../../images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" width="1" height="1"><img src="../../images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr><tr><td bgcolor="#023264" width="1"><img src="../../images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#ffffff" height="1"><pre>
|
||
|
|
<env-entry>
|
||
|
|
<env-entry-name>maxExemptions</env-entry-name>
|
||
|
|
<env-entry-value>10</env-entry-value>
|
||
|
|
<env-entry-type>java.lang.Integer</env-entry-type>
|
||
|
|
</env-entry>
|
||
|
|
</pre></td><td bgcolor="#023264" width="1"><img src="../../images/void.gif" 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" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" height="1"><img src="../../images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" width="1" height="1"><img src="../../images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr></table></div>
|
||
|
|
<p>but does <em>not</em> require modification of the deployment descriptor
|
||
|
|
to customize this value.</p>
|
||
|
|
|
||
|
|
<p>The valid attributes for an <code><Environment></code> element
|
||
|
|
are as follows:</p>
|
||
|
|
|
||
|
|
<table border="1" cellpadding="5"><tr><th width="15%" bgcolor="#023264"><font color="#ffffff">Attribute</font></th><th width="85%" bgcolor="#023264"><font color="#ffffff">Description</font></th></tr><tr><td align="left" valign="center"><code>description</code></td><td align="left" valign="center">
|
||
|
|
<p>Optional, human-readable description of this environment entry.</p>
|
||
|
|
</td></tr><tr><td align="left" valign="center"><strong><code>name</code></strong></td><td align="left" valign="center">
|
||
|
|
<p>The name of the environment entry to be created, relative to the
|
||
|
|
<code>java:comp/env</code> context.</p>
|
||
|
|
</td></tr><tr><td align="left" valign="center"><code>override</code></td><td align="left" valign="center">
|
||
|
|
<p>Set this to <code>false</code> if you do <strong>not</strong> want
|
||
|
|
an <code><env-entry></code> for the same environment entry name,
|
||
|
|
found in the web application deployment descriptor, to override the
|
||
|
|
value specified here. By default, overrides are allowed.</p>
|
||
|
|
</td></tr><tr><td align="left" valign="center"><strong><code>type</code></strong></td><td align="left" valign="center">
|
||
|
|
<p>The fully qualified Java class name expected by the web application
|
||
|
|
for this environment entry. Must be one of the legal values for
|
||
|
|
<code><env-entry-type></code> in the web application deployment
|
||
|
|
descriptor: <code>java.lang.Boolean</code>,
|
||
|
|
<code>java.lang.Byte</code>, <code>java.lang.Character</code>,
|
||
|
|
<code>java.lang.Double</code>, <code>java.lang.Float</code>,
|
||
|
|
<code>java.lang.Integer</code>, <code>java.lang.Long</code>,
|
||
|
|
<code>java.lang.Short</code>, or <code>java.lang.String</code>.</p>
|
||
|
|
</td></tr><tr><td align="left" valign="center"><strong><code>value</code></strong></td><td align="left" valign="center">
|
||
|
|
<p>The parameter value that will be presented to the application
|
||
|
|
when requested from the JNDI context. This value must be convertable
|
||
|
|
to the Java type defined by the <code>type</code> attribute.</p>
|
||
|
|
</td></tr></table>
|
||
|
|
|
||
|
|
</blockquote></td></tr></table>
|
||
|
|
|
||
|
|
|
||
|
|
<table border="0" cellspacing="0" cellpadding="2"><tr><td bgcolor="#828DA6"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="Resource Definitions"><strong>Resource Definitions</strong></a></font></td></tr><tr><td><blockquote>
|
||
|
|
|
||
|
|
<p>You can declare the characteristics of resources
|
||
|
|
to be returned for JNDI lookups of <code><resource-ref></code> and
|
||
|
|
<code><resource-env-ref></code> elements in the web application
|
||
|
|
deployment descriptor by defining them in this element and then linking
|
||
|
|
them with <a href="context.html#Resource Links"><ResourceLink></a>
|
||
|
|
elements
|
||
|
|
in the <code><strong><Context></strong></code> element.
|
||
|
|
|
||
|
|
You <strong>MUST</strong> also define any other needed parameters using
|
||
|
|
attributes on the Resource element, to configure
|
||
|
|
the object factory to be used (if not known to Tomcat already), and
|
||
|
|
the properties used to configure that object factory.</p>
|
||
|
|
|
||
|
|
<p>For example, you can create a resource definition like this:</p>
|
||
|
|
<div align="left"><table cellspacing="4" cellpadding="0" border="0"><tr><td bgcolor="#023264" width="1" height="1"><img src="../../images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" height="1"><img src="../../images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" width="1" height="1"><img src="../../images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr><tr><td bgcolor="#023264" width="1"><img src="../../images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#ffffff" height="1"><pre>
|
||
|
|
<GlobalNamingResources ...>
|
||
|
|
...
|
||
|
|
<Resource name="jdbc/EmployeeDB" auth="Container"
|
||
|
|
type="javax.sql.DataSource"
|
||
|
|
description="Employees Database for HR Applications"/>
|
||
|
|
...
|
||
|
|
</GlobalNamingResources>
|
||
|
|
</pre></td><td bgcolor="#023264" width="1"><img src="../../images/void.gif" 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" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" height="1"><img src="../../images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" width="1" height="1"><img src="../../images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr></table></div>
|
||
|
|
|
||
|
|
<p>This is equivalent to the inclusion of the following element in the
|
||
|
|
web application deployment descriptor (<code>/WEB-INF/web.xml</code>):</p>
|
||
|
|
<div align="left"><table cellspacing="4" cellpadding="0" border="0"><tr><td bgcolor="#023264" width="1" height="1"><img src="../../images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" height="1"><img src="../../images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" width="1" height="1"><img src="../../images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr><tr><td bgcolor="#023264" width="1"><img src="../../images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#ffffff" height="1"><pre>
|
||
|
|
<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>
|
||
|
|
</pre></td><td bgcolor="#023264" width="1"><img src="../../images/void.gif" 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" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" height="1"><img src="../../images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" width="1" height="1"><img src="../../images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr></table></div>
|
||
|
|
|
||
|
|
<p>but does <em>not</em> require modification of the deployment
|
||
|
|
descriptor to customize this value.</p>
|
||
|
|
|
||
|
|
<p>The valid attriutes for a <code><Resource></code> element
|
||
|
|
are as follows:</p>
|
||
|
|
|
||
|
|
<table border="1" cellpadding="5"><tr><th width="15%" bgcolor="#023264"><font color="#ffffff">Attribute</font></th><th width="85%" bgcolor="#023264"><font color="#ffffff">Description</font></th></tr><tr><td align="left" valign="center"><code>auth</code></td><td align="left" valign="center">
|
||
|
|
<p>Specify whether the web Application code signs on to the
|
||
|
|
corresponding resource manager programatically, or whether the
|
||
|
|
Container will sign on to the resource manager on behalf of the
|
||
|
|
application. The value of this attribute must be
|
||
|
|
<code>Application</code> or <code>Container</code>. This
|
||
|
|
attribute is <strong>required</strong> if the web application
|
||
|
|
will use a <code><resource-ref></code> element in the web
|
||
|
|
application deployment descriptor, but is optional if the
|
||
|
|
application uses a <code><resource-env-ref></code> instead.</p>
|
||
|
|
</td></tr><tr><td align="left" valign="center"><code>description</code></td><td align="left" valign="center">
|
||
|
|
<p>Optional, human-readable description of this resource.</p>
|
||
|
|
</td></tr><tr><td align="left" valign="center"><strong><code>name</code></strong></td><td align="left" valign="center">
|
||
|
|
<p>The name of the resource to be created, relative to the
|
||
|
|
<code>java:comp/env</code> context.</p>
|
||
|
|
</td></tr><tr><td align="left" valign="center"><code>scope</code></td><td align="left" valign="center">
|
||
|
|
<p>Specify whether connections obtained through this resource
|
||
|
|
manager can be shared. The value of this attribute must be
|
||
|
|
<code>Shareable</code> or <code>Unshareable</code>. By default,
|
||
|
|
connections are assumed to be shareable.</p>
|
||
|
|
</td></tr><tr><td align="left" valign="center"><strong><code>type</code></strong></td><td align="left" valign="center">
|
||
|
|
<p>The fully qualified Java class name expected by the web
|
||
|
|
application when it performs a lookup for this resource.</p>
|
||
|
|
</td></tr></table>
|
||
|
|
|
||
|
|
|
||
|
|
</blockquote></td></tr></table>
|
||
|
|
|
||
|
|
<table border="0" cellspacing="0" cellpadding="2"><tr><td bgcolor="#828DA6"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="Resource Links"><strong>Resource Links</strong></a></font></td></tr><tr><td><blockquote>
|
||
|
|
<p>Use <a href="context.html#Resource Links"><ResourceLink></a>
|
||
|
|
elements to link resources from the global context into
|
||
|
|
per-web-application contexts. Here is an example of making a custom
|
||
|
|
factory available to all applications in the server, based on the example
|
||
|
|
definition in the
|
||
|
|
<a href="../../jndi-resource-howto.html#Generic JavaBean Resources">
|
||
|
|
JNDI Resource HOW-TO</a>:
|
||
|
|
</p>
|
||
|
|
|
||
|
|
<div align="left"><table cellspacing="4" cellpadding="0" border="0"><tr><td bgcolor="#023264" width="1" height="1"><img src="../../images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" height="1"><img src="../../images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" width="1" height="1"><img src="../../images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr><tr><td bgcolor="#023264" width="1"><img src="../../images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#ffffff" height="1"><pre>
|
||
|
|
|
||
|
|
<DefaultContext>
|
||
|
|
<ResourceLink
|
||
|
|
name="bean/MyBeanFactory"
|
||
|
|
global="bean/MyBeanFactory"
|
||
|
|
type="com.mycompany.MyBean"
|
||
|
|
/>
|
||
|
|
</DefaultContext>
|
||
|
|
|
||
|
|
</pre></td><td bgcolor="#023264" width="1"><img src="../../images/void.gif" 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" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" height="1"><img src="../../images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" width="1" height="1"><img src="../../images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr></table></div>
|
||
|
|
|
||
|
|
</blockquote></td></tr></table>
|
||
|
|
|
||
|
|
<table border="0" cellspacing="0" cellpadding="2"><tr><td bgcolor="#828DA6"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="Transaction"><strong>Transaction</strong></a></font></td></tr><tr><td><blockquote>
|
||
|
|
|
||
|
|
<p>You can declare the characteristics of the UserTransaction
|
||
|
|
to be returned for JNDI lookup for <code>java:comp/UserTransaction</code>.
|
||
|
|
You <strong>MUST</strong> define an object factory class to instantiate
|
||
|
|
this object as well as the needed resource parameters as attributes of the
|
||
|
|
<code>Transaction</code>
|
||
|
|
element, and the properties used to configure that object factory.</p>
|
||
|
|
|
||
|
|
<p>The valid attributes for the <code><Transaction></code> element
|
||
|
|
are as follows:</p>
|
||
|
|
|
||
|
|
<table border="1" cellpadding="5"><tr><th width="15%" bgcolor="#023264"><font color="#ffffff">Attribute</font></th><th width="85%" bgcolor="#023264"><font color="#ffffff">Description</font></th></tr><tr><td align="left" valign="center"><strong><code>factory</code></strong></td><td align="left" valign="center">
|
||
|
|
<p>The class name for the JNDI object factory.</p>
|
||
|
|
</td></tr></table>
|
||
|
|
|
||
|
|
</blockquote></td></tr></table>
|
||
|
|
|
||
|
|
</blockquote></td></tr></table></td></tr><!--FOOTER SEPARATOR--><tr><td colspan="2"><hr noshade="noshade" size="1"></td></tr><!--PAGE FOOTER--><tr><td colspan="2"><div align="center"><font color="#525D76" size="-1"><em>
|
||
|
|
Copyright © 1999-2006, Apache Software Foundation
|
||
|
|
</em></font></div></td></tr></table></body></html>
|