665 lines
53 KiB
HTML
665 lines
53 KiB
HTML
|
<html><head><META http-equiv="Content-Type" content="text/html; charset=iso-8859-1"><title>Apache Tomcat Configuration Reference - The Context Container</title><meta name="author" value="Craig R. McClanahan"><meta name="email" value="craigmcc@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 Context Container</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>Context</strong> element represents a <em>web
|
||
|
|
application</em>, which is run within a particular virtual host.
|
||
|
|
Each web application is based on a <em>Web Application Archive</em>
|
||
|
|
(WAR) file, or a corresponding directory containing the corresponding
|
||
|
|
unpacked contents, as described in the Servlet Specification (version
|
||
|
|
2.2 or later). For more information about web application archives,
|
||
|
|
you can download the
|
||
|
|
<a href="http://java.sun.com/products/servlet/download.html">Servlet
|
||
|
|
Specification</a>, and review the Tomcat
|
||
|
|
<a href="../../appdev/index.html">Application Developer's Guide</a>.</p>
|
||
|
|
|
||
|
|
<p>The web application used to process each HTTP request is selected
|
||
|
|
by Catalina based on matching the longest possible prefix of the
|
||
|
|
Request URI against the <em>context path</em> of each defined Context.
|
||
|
|
Once selected, that Context will select an appropriate servlet to
|
||
|
|
process the incoming request, according to the servlet mappings defined
|
||
|
|
in the <em>web application deployment descriptor</em> file (which MUST
|
||
|
|
be located at <code>/WEB-INF/web.xml</code> within the web app's
|
||
|
|
directory hierarchy).</p>
|
||
|
|
|
||
|
|
<p>You may define as many <strong>Context</strong> elements as you
|
||
|
|
wish. Each such Context MUST have a unique context path. In
|
||
|
|
addition, a Context must be present with a context path equal to
|
||
|
|
a zero-length string. This Context becomes the <em>default</em>
|
||
|
|
web application for this virtual host, and is used to process all
|
||
|
|
requests that do not match any other Context's context path.</p>
|
||
|
|
|
||
|
|
<p><b>For Tomcat 6, unlike Tomcat 4.x, it is NOT recommended to place
|
||
|
|
<Context> elements directly in the server.xml file.</b> This
|
||
|
|
is because it makes modifing the <strong>Context</strong> configuration
|
||
|
|
more invasive since the main <code>conf/server.xml</code> file cannot be
|
||
|
|
reloaded without restarting Tomcat.</p>
|
||
|
|
|
||
|
|
<p><strong>Context</strong> elements may be explicitly defined:
|
||
|
|
<ul>
|
||
|
|
<li>in the <code>$CATALINA_HOME/conf/context.xml</code> file:
|
||
|
|
the Context element information will be loaded by all webapps</li>
|
||
|
|
<li>in the
|
||
|
|
<code>$CATALINA_HOME/conf/[enginename]/[hostname]/context.xml.default</code>
|
||
|
|
file: the Context element information will be loaded by all webapps of that
|
||
|
|
host</li>
|
||
|
|
<li>in individual files (with a ".xml" extension) in the
|
||
|
|
<code>$CATALINA_HOME/conf/[enginename]/[hostname]/</code> directory.
|
||
|
|
The name of the file (less the .xml) extension will be used as the
|
||
|
|
context path. Multi-level context paths may be defined using #, e.g.
|
||
|
|
<code>context#path.xml</code>. The default web application may be defined
|
||
|
|
by using a file called <code>ROOT.xml</code>.</li>
|
||
|
|
<li>if the previous file was not found for this application, in an individual
|
||
|
|
file at <code>/META-INF/context.xml</code> inside the application files</li>
|
||
|
|
<li>inside a <a href="host.html">Host</a> element in the main
|
||
|
|
<code>conf/server.xml</code></li>
|
||
|
|
</ul>
|
||
|
|
</p>
|
||
|
|
|
||
|
|
<p>In addition to explicitly specified Context elements, there are
|
||
|
|
several techniques by which Context elements can be created automatically
|
||
|
|
for you. See <a href="host.html#Automatic Application Deployment">
|
||
|
|
Automatic Application Deployment</a> and
|
||
|
|
<a href="host.html#User Web Applications">User Web Applications</a>
|
||
|
|
for more information.</p>
|
||
|
|
|
||
|
|
<blockquote><em>
|
||
|
|
<p>The description below uses the variable name $CATALINA_HOME
|
||
|
|
to refer to the directory into which you have installed Tomcat 5,
|
||
|
|
and is the base directory against which most relative paths are
|
||
|
|
resolved. However, if you have configured Tomcat 5 for multiple
|
||
|
|
instances by setting a CATALINA_BASE directory, you should use
|
||
|
|
$CATALINA_BASE instead of $CATALINA_HOME for each of these
|
||
|
|
references.</p>
|
||
|
|
</em></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="Attributes"><strong>Attributes</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="Common Attributes"><strong>Common Attributes</strong></a></font></td></tr><tr><td><blockquote>
|
||
|
|
|
||
|
|
<p>All implementations of <strong>Context</strong>
|
||
|
|
support the following attributes:</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>backgroundProcessorDelay</code></td><td align="left" valign="center">
|
||
|
|
<p>This value represents the delay in seconds between the
|
||
|
|
invocation of the backgroundProcess method on this context and
|
||
|
|
its child containers, including all wrappers.
|
||
|
|
Child containers will not be invoked if their delay value is not
|
||
|
|
negative (which would mean they are using their own processing
|
||
|
|
thread). Setting this to a positive value will cause
|
||
|
|
a thread to be spawn. After waiting the specified amount of time,
|
||
|
|
the thread will invoke the backgroundProcess method on this host
|
||
|
|
and all its child containers. A context will use background
|
||
|
|
processing to perform session expiration and class monitoring for
|
||
|
|
reloading. If not specified, the default value for this attribute is
|
||
|
|
-1, which means the context will rely on the background processing
|
||
|
|
thread of its parent host.</p>
|
||
|
|
</td></tr><tr><td align="left" valign="center"><code>className</code></td><td align="left" valign="center">
|
||
|
|
<p>Java class name of the implementation to use. This class must
|
||
|
|
implement the <code>org.apache.catalina.Context</code> interface.
|
||
|
|
If not specified, the standard value (defined below) will be used.</p>
|
||
|
|
</td></tr><tr><td align="left" valign="center"><code>cookies</code></td><td align="left" valign="center">
|
||
|
|
<p>Set to <code>true</code> if you want cookies to be used for
|
||
|
|
session identifier communication if supported by the client (this
|
||
|
|
is the default). Set to <code>false</code> if you want to disable
|
||
|
|
the use of cookies for session identifier communication, and rely
|
||
|
|
only on URL rewriting by the application.</p>
|
||
|
|
</td></tr><tr><td align="left" valign="center"><code>crossContext</code></td><td align="left" valign="center">
|
||
|
|
<p>Set to <code>true</code> if you want calls within this application
|
||
|
|
to <code>ServletContext.getContext()</code> to successfully return a
|
||
|
|
request dispatcher for other web applications running on this virtual
|
||
|
|
host. Set to <code>false</code> (the default) in security
|
||
|
|
conscious environments, to make <code>getContext()</code> always
|
||
|
|
return <code>null</code>.</p>
|
||
|
|
</td></tr><tr><td align="left" valign="center"><strong><code>docBase</code></strong></td><td align="left" valign="center">
|
||
|
|
<p>The <em>Document Base</em> (also known as the <em>Context
|
||
|
|
Root</em>) directory for this web application, or the pathname
|
||
|
|
to the web application archive file (if this web application is
|
||
|
|
being executed directly from the WAR file). You may specify
|
||
|
|
an absolute pathname for this directory or WAR file, or a pathname
|
||
|
|
that is relative to the <code>appBase</code> directory of the
|
||
|
|
owning <a href="host.html">Host</a>.</p>
|
||
|
|
</td></tr><tr><td align="left" valign="center"><code>override</code></td><td align="left" valign="center">
|
||
|
|
<p>Set to <code>true</code> to have explicit settings in this
|
||
|
|
Context element override any corresponding settings in the
|
||
|
|
<a href="defaultcontext.html">DefaultContext</a> element associated
|
||
|
|
with our owning <a href="host.html">Host</a>. By default, settings
|
||
|
|
in the DefaultContext element will be used.</p>
|
||
|
|
<p>If a symbolic link is used for docBase then changes to the
|
||
|
|
symbolic link will only be effective after a Tomcat restart or
|
||
|
|
by undeploying and redeploying the conext. A context reload is not
|
||
|
|
sufficient.</p>
|
||
|
|
</td></tr><tr><td align="left" valign="center"><code>privileged</code></td><td align="left" valign="center">
|
||
|
|
<p>Set to <code>true</code> to allow this context to use container
|
||
|
|
servlets, like the manager servlet.</p>
|
||
|
|
</td></tr><tr><td align="left" valign="center"><code>path</code></td><td align="left" valign="center">
|
||
|
|
<p>The <em>context path</em> of this web application, which is
|
||
|
|
matched against the beginning of each request URI to select the
|
||
|
|
appropriate web application for processing. All of the context paths
|
||
|
|
within a particular <a href="host.html">Host</a> must be unique.
|
||
|
|
If you specify a context path of an empty string (""), you are
|
||
|
|
defining the <em>default</em> web application for this Host, which
|
||
|
|
will process all requests not assigned to other Contexts. The value of
|
||
|
|
this field must not be set except when statically defining a Context in
|
||
|
|
server.xml, as it will be inferred from the filenames used for either the
|
||
|
|
.xml context file or the docBase.</p>
|
||
|
|
</td></tr><tr><td align="left" valign="center"><code>reloadable</code></td><td align="left" valign="center">
|
||
|
|
<p>Set to <code>true</code> if you want Catalina to monitor classes in
|
||
|
|
<code>/WEB-INF/classes/</code> and <code>/WEB-INF/lib</code> for
|
||
|
|
changes, and automatically reload the web application if a change
|
||
|
|
is detected. This feature is very useful during application
|
||
|
|
development, but it requires significant runtime overhead and is
|
||
|
|
not recommended for use on deployed production applications. That's
|
||
|
|
why the default setting for this attribute is <i>false</i>. You
|
||
|
|
can use the <a href="../../manager-howto.html">Manager</a> web
|
||
|
|
application, however, to trigger reloads of deployed applications
|
||
|
|
on demand.</p>
|
||
|
|
</td></tr><tr><td align="left" valign="center"><code>wrapperClass</code></td><td align="left" valign="center">
|
||
|
|
<p>Java class name of the <code>org.apache.catalina.Wrapper</code>
|
||
|
|
implementation class that will be used for servlets managed by this
|
||
|
|
Context. If not specified, a standard default value will be used.</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="Standard Implementation"><strong>Standard Implementation</strong></a></font></td></tr><tr><td><blockquote>
|
||
|
|
|
||
|
|
<p>The standard implementation of <strong>Context</strong> is
|
||
|
|
<strong>org.apache.catalina.core.StandardContext</strong>.
|
||
|
|
It supports the following additional attributes (in addition to the
|
||
|
|
common attributes listed above):</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>allowLinking</code></td><td align="left" valign="center">
|
||
|
|
<p>If the value of this flag is <code>true</code>, symlinks will be
|
||
|
|
allowed inside the web application, pointing to resources outside the
|
||
|
|
web application base path. If not specified, the default value
|
||
|
|
of the flag is <code>false</code>.</p>
|
||
|
|
<p><b>NOTE: This flag MUST NOT be set to true on the Windows platform
|
||
|
|
(or any other OS which does not have a case sensitive filesystem),
|
||
|
|
as it will disable case sensitivity checks, allowing JSP source code
|
||
|
|
disclosure, among other security problems.</b></p>
|
||
|
|
</td></tr><tr><td align="left" valign="center"><code>antiJARLocking</code></td><td align="left" valign="center">
|
||
|
|
<p>If true, the Tomcat classloader will take extra measures to avoid
|
||
|
|
JAR file locking when resources are accessed inside JARs through URLs.
|
||
|
|
This will impact startup time of applications, but could prove to be useful
|
||
|
|
on platforms or configurations where file locking can occur.
|
||
|
|
If not specified, the default value is <code>false</code>.</p>
|
||
|
|
</td></tr><tr><td align="left" valign="center"><code>antiResourceLocking</code></td><td align="left" valign="center">
|
||
|
|
<p>If true, Tomcat will prevent any file locking.
|
||
|
|
This will significantly impact startup time of applications,
|
||
|
|
but allows full webapp hot deploy and undeploy on platforms
|
||
|
|
or configurations where file locking can occur.
|
||
|
|
If not specified, the default value is <code>false</code>.</p>
|
||
|
|
|
||
|
|
<p>Please note that setting this to <code>true</code> has some side effects,
|
||
|
|
including the disabling of JSP reloading in a running server: see
|
||
|
|
<a href="http://issues.apache.org/bugzilla/show_bug.cgi?id=37668">Bugzilla 37668</a>.
|
||
|
|
</p>
|
||
|
|
|
||
|
|
<p>
|
||
|
|
Please note that setting this flag to true in applications that are
|
||
|
|
outside the appBase for the Host (the <code>webapps</code> directory
|
||
|
|
by default) will cause the application to be
|
||
|
|
<strong>deleted</strong> on Tomcat shutdown. You probably don't want to
|
||
|
|
do this, so think twice before setting antiResourceLocking=true on a webapp
|
||
|
|
that's outside the appBase for its Host.
|
||
|
|
</p>
|
||
|
|
</td></tr><tr><td align="left" valign="center"><code>cacheMaxSize</code></td><td align="left" valign="center">
|
||
|
|
<p>Maximum size of the static resource cache in kilobytes.
|
||
|
|
If not specified, the default value is <code>10240</code>
|
||
|
|
(10 megabytes).</p>
|
||
|
|
</td></tr><tr><td align="left" valign="center"><code>cacheTTL</code></td><td align="left" valign="center">
|
||
|
|
<p>Amount of time in milliseconds between cache entries revalidation.
|
||
|
|
If not specified, the default value is <code>5000</code>
|
||
|
|
(5 seconds).</p>
|
||
|
|
</td></tr><tr><td align="left" valign="center"><code>cachingAllowed</code></td><td align="left" valign="center">
|
||
|
|
<p>If the value of this flag is <code>true</code>, the cache for static
|
||
|
|
resources will be used. If not specified, the default value
|
||
|
|
of the flag is <code>true</code>.</p>
|
||
|
|
</td></tr><tr><td align="left" valign="center"><code>caseSensitive</code></td><td align="left" valign="center">
|
||
|
|
<p>If the value of this flag is <code>true</code>, all case sensitivity
|
||
|
|
checks will be disabled. If not
|
||
|
|
specified, the default value of the flag is <code>true</code>.</p>
|
||
|
|
<p><b>NOTE: This flag MUST NOT be set to false on the Windows platform
|
||
|
|
(or any other OS which does not have a case sensitive filesystem),
|
||
|
|
as it will disable case sensitivity checks, allowing JSP source code
|
||
|
|
disclosure, among other security problems.</b></p>
|
||
|
|
</td></tr><tr><td align="left" valign="center"><code>processTlds</code></td><td align="left" valign="center">
|
||
|
|
<p>Whether the context should process TLDs on startup. The default
|
||
|
|
is true. The false setting is intended for special cases
|
||
|
|
that know in advance TLDs are not part of the webapp.</p>
|
||
|
|
</td></tr><tr><td align="left" valign="center"><code>swallowOutput</code></td><td align="left" valign="center">
|
||
|
|
<p>If the value of this flag is <code>true</code>, the bytes output to
|
||
|
|
System.out and System.err by the web application will be redirected to
|
||
|
|
the web application logger. If not specified, the default value
|
||
|
|
of the flag is <code>false</code>.</p>
|
||
|
|
</td></tr><tr><td align="left" valign="center"><code>tldNamespaceAware</code></td><td align="left" valign="center">
|
||
|
|
<p>If the value of this flag is <code>true</code>, the TLD files
|
||
|
|
XML validation will be namespace-aware. If you turn this flag on,
|
||
|
|
you should probably also turn <code>tldValidation</code> on. The
|
||
|
|
default value for this flag is <code>false</code>, and setting it
|
||
|
|
to true will incur a performance penalty.
|
||
|
|
</p>
|
||
|
|
</td></tr><tr><td align="left" valign="center"><code>tldValidation</code></td><td align="left" valign="center">
|
||
|
|
<p>If the value of this flag is <code>true</code>, the TLD files
|
||
|
|
will be XML validated on context startup. The default value for
|
||
|
|
this flag is <code>false</code>, and setting it to true will incur
|
||
|
|
a performance penalty.</p>
|
||
|
|
</td></tr><tr><td align="left" valign="center"><code>unloadDelay</code></td><td align="left" valign="center">
|
||
|
|
<p>Amount of ms that the container will wait for servlets to unload.
|
||
|
|
If not specified, the default value of the flag is <code>2000</code>
|
||
|
|
ms.</p>
|
||
|
|
</td></tr><tr><td align="left" valign="center"><code>unpackWAR</code></td><td align="left" valign="center">
|
||
|
|
<p>If true, Tomcat will unpack all compressed web applications before
|
||
|
|
running them.
|
||
|
|
If not specified, the default value is <code>true</code>.</p>
|
||
|
|
</td></tr><tr><td align="left" valign="center"><code>useNaming</code></td><td align="left" valign="center">
|
||
|
|
<p>Set to <code>true</code> (the default) to have Catalina enable a
|
||
|
|
JNDI <code>InitialContext</code> for this web application that is
|
||
|
|
compatible with Java2 Enterprise Edition (J2EE) platform
|
||
|
|
conventions.</p>
|
||
|
|
</td></tr><tr><td align="left" valign="center"><code>workDir</code></td><td align="left" valign="center">
|
||
|
|
<p>Pathname to a scratch directory to be provided by this Context
|
||
|
|
for temporary read-write use by servlets within the associated web
|
||
|
|
application. This directory will be made visible to servlets in the
|
||
|
|
web application by a servlet context attribute (of type
|
||
|
|
<code>java.io.File</code>) named
|
||
|
|
<code>javax.servlet.context.tempdir</code> as described in the
|
||
|
|
Servlet Specification. If not specified, a suitable directory
|
||
|
|
underneath <code>$CATALINA_HOME/work</code> will be provided.</p>
|
||
|
|
</td></tr></table>
|
||
|
|
|
||
|
|
</blockquote></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="Nested Components"><strong>Nested Components</strong></a></font></td></tr><tr><td><blockquote>
|
||
|
|
|
||
|
|
<p>You can nest at most one instance of the following utility components
|
||
|
|
by nesting a corresponding element inside your <strong>Context</strong>
|
||
|
|
element:</p>
|
||
|
|
<ul>
|
||
|
|
<li><a href="loader.html"><strong>Loader</strong></a> -
|
||
|
|
Configure the web application class loader that will be used to load
|
||
|
|
servlet and bean classes for this web application. Normally, the
|
||
|
|
default configuration of the class loader will be sufficient.</li>
|
||
|
|
<li><a href="manager.html"><strong>Manager</strong></a> -
|
||
|
|
Configure the session manager that will be used to create, destroy,
|
||
|
|
and persist HTTP sessions for this web application. Normally, the
|
||
|
|
default configuration of the session manager will be sufficient.</li>
|
||
|
|
<li><a href="realm.html"><strong>Realm</strong></a> -
|
||
|
|
Configure a realm that will allow its
|
||
|
|
database of users, and their associated roles, to be utilized solely
|
||
|
|
for this particular web application. If not specified, this web
|
||
|
|
application will utilize the Realm associated with the owning
|
||
|
|
<a href="host.html">Host</a> or <a href="engine.html">Engine</a>.</li>
|
||
|
|
<li><a href="resources.html"><strong>Resources</strong></a> -
|
||
|
|
Configure the resource manager that will be used to access the static
|
||
|
|
resources associated with this web application. Normally, the
|
||
|
|
default configuration of the resource manager will be sufficient.</li>
|
||
|
|
<li><strong>WatchedResource</strong> - The auto deployer will monitor the
|
||
|
|
specified static resource of the web application for updates, and will
|
||
|
|
reload the web application if is is updated. The content of this element
|
||
|
|
must be a string.</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="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="Logging"><strong>Logging</strong></a></font></td></tr><tr><td><blockquote>
|
||
|
|
|
||
|
|
<p>A context is associated with the
|
||
|
|
<code>org.apache.catalina.core.ContainerBase.[enginename].[hostname].[path]</code>
|
||
|
|
log category. Note that the brackets are actually part of the name, don't omit them.</p>
|
||
|
|
|
||
|
|
</blockquote></td></tr></table>
|
||
|
|
|
||
|
|
|
||
|
|
<table border="0" cellspacing="0" cellpadding="2"><tr><td bgcolor="#828DA6"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="Access Logs"><strong>Access Logs</strong></a></font></td></tr><tr><td><blockquote>
|
||
|
|
|
||
|
|
<p>When you run a web server, one of the output files normally generated
|
||
|
|
is an <em>access log</em>, which generates one line of information for
|
||
|
|
each request processed by the server, in a standard format. Catalina
|
||
|
|
includes an optional <a href="valve.html">Valve</a> implementation that
|
||
|
|
can create access logs in the same standard format created by web servers,
|
||
|
|
or in any number of custom formats.</p>
|
||
|
|
|
||
|
|
<p>You can ask Catalina to create an access log for all requests
|
||
|
|
processed by an <a href="engine.html">Engine</a>,
|
||
|
|
<a href="host.html">Host</a>, or <a href="context.html">Context</a>
|
||
|
|
by nesting a <a href="valve.html">Valve</a> element 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>
|
||
|
|
<Context path="/examples" ...>
|
||
|
|
...
|
||
|
|
<Valve className="org.apache.catalina.valves.AccessLogValve"
|
||
|
|
prefix="localhost_access_log." suffix=".txt"
|
||
|
|
pattern="common"/>
|
||
|
|
...
|
||
|
|
</Context>
|
||
|
|
</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>See <a href="valve.html#Access Log Valve">Access Log Valve</a>
|
||
|
|
for more information on the configuration attributes that are
|
||
|
|
supported.</p>
|
||
|
|
|
||
|
|
</blockquote></td></tr></table>
|
||
|
|
|
||
|
|
|
||
|
|
<table border="0" cellspacing="0" cellpadding="2"><tr><td bgcolor="#828DA6"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="Automatic Context Configuration"><strong>Automatic Context Configuration</strong></a></font></td></tr><tr><td><blockquote>
|
||
|
|
|
||
|
|
<p>If you use the standard <strong>Context</strong> implementation,
|
||
|
|
the following configuration steps occur automtically when Catalina
|
||
|
|
is started, or whenever this web application is reloaded. No special
|
||
|
|
configuration is required to enable this feature.</p>
|
||
|
|
|
||
|
|
<ul>
|
||
|
|
<li>If you have not declared your own <a href="loader.html">Loader</a>
|
||
|
|
element, a standard web application class loader will be configured.
|
||
|
|
</li>
|
||
|
|
<li>If you have not declared your own <a href="manager.html">Manager</a>
|
||
|
|
element, a standard session manager will be configured.</li>
|
||
|
|
<li>If you have not declared your own <a href="resources.html">Resources</a>
|
||
|
|
element, a standard resources manager will be configured.</li>
|
||
|
|
<li>The web application properties listed in <code>conf/web.xml</code>
|
||
|
|
will be processed as defaults for this web application. This is used
|
||
|
|
to establish default mappings (such as mapping the <code>*.jsp</code>
|
||
|
|
extension to the corresponding JSP servlet), and other standard
|
||
|
|
features that apply to all web applications.</li>
|
||
|
|
<li>The web application properties listed in the
|
||
|
|
<code>/WEB-INF/web.xml</code> resource for this web application
|
||
|
|
will be processed (if this resource exists).</li>
|
||
|
|
<li>If your web application has specified security constraints that might
|
||
|
|
require user authentication, an appropriate Authenticator that
|
||
|
|
implements the login method you have selected will be configured.</li>
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
</blockquote></td></tr></table>
|
||
|
|
|
||
|
|
|
||
|
|
<table border="0" cellspacing="0" cellpadding="2"><tr><td bgcolor="#828DA6"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="Context Parameters"><strong>Context Parameters</strong></a></font></td></tr><tr><td><blockquote>
|
||
|
|
|
||
|
|
<p>You can configure named values that will be made visible to the
|
||
|
|
web application as servlet context initialization parameters by nesting
|
||
|
|
<code><Parameter></code> elements inside this element. For
|
||
|
|
example, you can create an initialization parameter 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>
|
||
|
|
<Context ...>
|
||
|
|
...
|
||
|
|
<Parameter name="companyName" value="My Company, Incorporated"
|
||
|
|
override="false"/>
|
||
|
|
...
|
||
|
|
</Context>
|
||
|
|
</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>
|
||
|
|
<context-param>
|
||
|
|
<param-name>companyName</param-name>
|
||
|
|
<param-value>My Company, Incorporated</param-value>
|
||
|
|
</context-param>
|
||
|
|
</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 a <code><Parameter></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 context
|
||
|
|
initialization parameter.</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 context initialization parameter to be created.</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
|
||
|
|
a <code><context-param></code> for the same parameter 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>value</code></strong></td><td align="left" valign="center">
|
||
|
|
<p>The parameter value that will be presented to the application
|
||
|
|
when requested by calling
|
||
|
|
<code>ServletContext.getInitParameter()</code>.</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="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 the
|
||
|
|
web application 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>
|
||
|
|
<Context ...>
|
||
|
|
...
|
||
|
|
<Environment name="maxExemptions" value="10"
|
||
|
|
type="java.lang.Integer" override="false"/>
|
||
|
|
...
|
||
|
|
</Context>
|
||
|
|
</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</param-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="Lifecycle Listeners"><strong>Lifecycle Listeners</strong></a></font></td></tr><tr><td><blockquote>
|
||
|
|
|
||
|
|
<p>If you have implemented a Java object that needs to know when this
|
||
|
|
<strong>Context</strong> is started or stopped, you can declare it by
|
||
|
|
nesting a <strong>Listener</strong> element inside this element. The
|
||
|
|
class name you specify must implement the
|
||
|
|
<code>org.apache.catalina.LifecycleListener</code> interface, and
|
||
|
|
it will be notified about the occurrence of the coresponding
|
||
|
|
lifecycle events. Configuration of such a listener looks 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>
|
||
|
|
<Context path="/examples" ...>
|
||
|
|
...
|
||
|
|
<Listener className="com.mycompany.mypackage.MyListener" ... >
|
||
|
|
...
|
||
|
|
</Context>
|
||
|
|
</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>Note that a Listener can have any number of additional properties
|
||
|
|
that may be configured from this element. Attribute names are matched
|
||
|
|
to corresponding JavaBean property names using the standard property
|
||
|
|
method naming patterns.</p>
|
||
|
|
|
||
|
|
</blockquote></td></tr></table>
|
||
|
|
|
||
|
|
|
||
|
|
<table border="0" cellspacing="0" cellpadding="2"><tr><td bgcolor="#828DA6"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="Request Filters"><strong>Request Filters</strong></a></font></td></tr><tr><td><blockquote>
|
||
|
|
|
||
|
|
<p>You can ask Catalina to check the IP address, or host name, on every
|
||
|
|
incoming request directed to the surrounding
|
||
|
|
<a href="engine.html">Engine</a>, <a href="host.html">Host</a>, or
|
||
|
|
<a href="context.html">Context</a> element. The remote address or name
|
||
|
|
will be checked against a configured list of "accept" and/or "deny"
|
||
|
|
filters, which are defined using the Regular Expression syntax supported
|
||
|
|
by the <a href="http://jakarta.apache.org/regexp/">Jakarta Regexp</a>
|
||
|
|
regular expression library. Requests that come from locations that are
|
||
|
|
not accepted will be rejected with an HTTP "Forbidden" error.
|
||
|
|
Example filter declarations:</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>
|
||
|
|
<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>
|
||
|
|
</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>See <a href="valve.html#Remote Address Filter">Remote Address Filter</a>
|
||
|
|
and <a href="valve.html#Remote Host Filter">Remote Host Filter</a> for
|
||
|
|
more information about the configuration options that are supported.</p>
|
||
|
|
|
||
|
|
</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 the resource
|
||
|
|
to be returned for JNDI lookups of <code><resource-ref></code> and
|
||
|
|
<code><resource-env-ref></code> elements in the web application
|
||
|
|
deployment descriptor. You <strong>MUST</strong> also define
|
||
|
|
the needed resource parameters as attributes of the <code>Resource</code>
|
||
|
|
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>
|
||
|
|
<Context ...>
|
||
|
|
...
|
||
|
|
<Resource name="jdbc/EmployeeDB" auth="Container"
|
||
|
|
type="javax.sql.DataSource"
|
||
|
|
description="Employees Database for HR Applications"/>
|
||
|
|
...
|
||
|
|
</Context>
|
||
|
|
</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 attributes 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>This element is used to create a link to a global JNDI resource. Doing
|
||
|
|
a JNDI lookup on the link name will then return the linked global
|
||
|
|
resource.</p>
|
||
|
|
|
||
|
|
<p>For example, you can create a resource link 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>
|
||
|
|
<Context ...>
|
||
|
|
...
|
||
|
|
<ResourceLink name="linkToGlobalResource"
|
||
|
|
global="simpleValue"
|
||
|
|
type="java.lang.Integer"
|
||
|
|
...
|
||
|
|
</Context>
|
||
|
|
</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>The valid attributes for a <code><ResourceLink></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>global</code></strong></td><td align="left" valign="center">
|
||
|
|
<p>The name of the linked global resource in the
|
||
|
|
global JNDI context.</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 link to be created, relative to the
|
||
|
|
<code>java:comp/env</code> context.</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 link.</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="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>
|