yoavs 2004/07/21 12:24:00
Modified:webapps/docs changelog.xml jndi-resources-howto.xml
webapps/docs/config globalresources.xml
Log:
Addressed Bugzilla 29584, cleaning up JNDI documentation.
Revision ChangesPath
1.73 +3 -0 jakarta-tomcat-catalina/webapps/docs/changelog.xml
Index: changelog.xml
===
RCS file: /home/cvs/jakarta-tomcat-catalina/webapps/docs/changelog.xml,v
retrieving revision 1.72
retrieving revision 1.73
diff -u -r1.72 -r1.73
--- changelog.xml 21 Jul 2004 18:11:05 - 1.72
+++ changelog.xml 21 Jul 2004 19:24:00 - 1.73
@@ -23,6 +23,9 @@
fix
bug30238/bug: Replaced isapi_redirector.dll isapi_redirect.dll in
installation script for consistency. (yoavs)
/fix
+ fix
+bug29584/bug: Enhanced and clarified JNDI documentation. (yoavs)
+ /fix
/changelog
/subsection
1.6 +57 -12jakarta-tomcat-catalina/webapps/docs/jndi-resources-howto.xml
Index: jndi-resources-howto.xml
===
RCS file: /home/cvs/jakarta-tomcat-catalina/webapps/docs/jndi-resources-howto.xml,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- jndi-resources-howto.xml 9 Aug 2003 18:59:22 - 1.5
+++ jndi-resources-howto.xml 21 Jul 2004 19:24:00 - 1.6
@@ -7,8 +7,9 @@
project;
properties
-author email=[EMAIL PROTECTED]Craig R. McClanahan/author
-titleJNDI Resources HOW-TO/title
+ author email=[EMAIL PROTECTED]Craig R. McClanahan/author
+ author email=[EMAIL PROTECTED]Yoav Shapira/author
+ titleJNDI Resources HOW-TO/title
/properties
body
@@ -17,10 +18,42 @@
section name=Introduction
pTomcat 5 provides a JNDI strongInitialContext/strong implementation
-instance to web applications running under it, in a manner that is compatible
-with those provided by a a href=http://java.sun.com/j2ee;Java2 Enterprise
-Edition/a application server. Entries in this codeInitialContext/code
-are configured in the code$CATALINA_HOME/conf/server.xml/code file, and
+instance for each web application running under it, in a manner that is
+compatible with those provided by a
+a href=http://java.sun.com/j2ee;Java2 Enterprise Edition/a application
+server.
+
+The J2EE standard provides a standard set of elements in
+the code/WEB-INF/web.xml/code file to reference resources; resources
+referenced in these elements must be defined in an application-server-specific
configuration.
+/p
+
+pFor Tomcat 5, these entries in per-web-application
+codeInitialContext/code are configured in the
+codestronglt;Contextgt;/strong/code or
+codestronglt;DefaultContextgt;/strong/code
+elements of the
+a href=config/server.htmlcodestronglt;Servergt;/strong/code/a
+element.
+
+The codestronglt;Contextgt;/strong/code element can be specified
+in either code$CATALINA_HOME/conf/server.xml/code or, preferably,
+the per-web-application context XML file.
+
+codestronglt;DefaultContextgt;/strong/code must be specified in
+code$CATALINA_HOME/conf/server.xml/code.
+/p
+
+pTomcat 5 maintains a separate namespace of global resources for the
+entire server. These are configured in the
+a href=config/globalresources.html
+codestronglt;GlobalNameingResourcesgt;/strong/code/a element of
+code$CATALINA_HOME/conf/server.xml/code. You may expose these resources to
+web applications by using
+codestronglt;ResourceLinkgt;/strong/code elements.
+/p
+
+pThe resources defined in these elements
may be referenced by the following elements in the web application deployment
descriptor (code/WEB-INF/web.xml/code) of your web application:/p
ul
@@ -39,10 +72,11 @@
pThe codeInitialContext/code is configured as a web application is
initially deployed, and is made available to web application components (for
-read-only access). All configured entries and resources will be placed in
+read-only access). All configured entries and resources are placed in
the codejava:comp/env/code portion of the JNDI namespace, so a typical
access to a resource - in this case, to a JDBC codeDataSource/code -
would look something like this:/p
+
source
// Obtain our environment naming context
Context initCtx = new InitialContext();
@@ -75,8 +109,9 @@
section name=Configuring JNDI Resources
pEach available JNDI Resource is configured based on inclusion of the
-following elements in the code$CATALINA_HOME/conf/server.xml/code
-file:/p
+following elements in the codestronglt;Contextgt;/strong/code or
+codestronglt;DefaultContextgt;/strong/code elements:/p
+
ul
lia href=config/context.html#Environment
