From: kkolinko
Date: Tue, 2 Mar 2010 09:04:59 +0000 (+0000)
Subject: Do not mention Tomcat version unless necessary.
X-Git-Url: https://git.internetallee.de/?a=commitdiff_plain;h=0b9339e429643bd5211304b37220c00f785a151e;p=tomcat7.0
Do not mention Tomcat version unless necessary.
Especially, do not mention Tomcat 6 in Tomcat 7 docs.
git-svn-id: https://svn.apache.org/repos/asf/tomcat/trunk@917924 13f79535-47bb-0310-9956-ffa450edef68
---
diff --git a/webapps/docs/appdev/deployment.xml b/webapps/docs/appdev/deployment.xml
index f7753089e..6fc56e946 100644
--- a/webapps/docs/appdev/deployment.xml
+++ b/webapps/docs/appdev/deployment.xml
@@ -118,19 +118,19 @@ API Specification, version 2.3, which you should consult for more details.
-
Like most servlet containers, Tomcat 6 also supports mechanisms to install
+
Like most servlet containers, Tomcat also supports mechanisms to install
library JAR files (or unpacked classes) once, and make them visible to all
installed web applications (without having to be included inside the web
application itself. The details of how Tomcat locates and shares such
classes are described in the
Class Loader HOW-TO documentation.
-The location commonly used within a Tomcat 6 installation for shared code is
+The location commonly used within a Tomcat installation for shared code is
$CATALINA_HOME/lib. JAR files placed here are visible both to
web applications and internal Tomcat code. This is a good place to put JDBC
drivers that are required for both your application or internal Tomcat use
(such as for a JDBCRealm).
-
Out of the box, a standard Tomcat 6 installation includes a variety
+
Out of the box, a standard Tomcat installation includes a variety
of pre-installed shared library files, including:
The Servlet 3.0 and JSP 2.1 APIs that are fundamental
@@ -162,7 +162,7 @@ included element.
NOTE - The Servlet Specification includes a Document
Type Descriptor (DTD) for the web application deployment descriptor, and
-Tomcat 6 enforces the rules defined here when processing your application's
+Tomcat enforces the rules defined here when processing your application's
/WEB-INF/web.xml file. In particular, you must
enter your descriptor elements (such as <filter>,
<servlet>, and <servlet-mapping> in
@@ -183,19 +183,19 @@ information on the Context element.
-
+
The description below uses the variable name $CATALINA_BASE to refer the
base directory against which most relative paths are resolved. If you have
- not configured Tomcat 6 for multiple instances by setting a CATALINA_BASE
+ not configured Tomcat for multiple instances by setting a CATALINA_BASE
directory, then $CATALINA_BASE will be set to the value of $CATALINA_HOME,
- the directory into which you have installed Tomcat 6.
+ the directory into which you have installed Tomcat.
In order to be executed, a web application must be deployed on
a servlet container. This is true even during development.
-We will describe using Tomcat 6 to provide the execution environment.
+We will describe using Tomcat to provide the execution environment.
A web application can be deployed in Tomcat by one of the following
approaches:
@@ -219,18 +219,18 @@ approaches:
directory that Tomcat created, and then restart Tomcat, in order to reflect
your changes.
-
Use the Tomcat 6 "Manager" web application to deploy and undeploy
- web applications. Tomcat 6 includes a web application, deployed
+
Use the Tomcat "Manager" web application to deploy and undeploy
+ web applications. Tomcat includes a web application, deployed
by default on context path /manager, that allows you to
deploy and undeploy applications on a running Tomcat server without
restarting it. See the administrator documentation (TODO: hyperlink)
for more information on using the Manager web application.
-
Use "Manager" Ant Tasks In Your Build Script. Tomcat 6
+
Use "Manager" Ant Tasks In Your Build Script. Tomcat
includes a set of custom task definitions for the Ant
build tool that allow you to automate the execution of commands to the
"Manager" web application. These tasks are used in the Tomcat deployer.
-
Use the Tomcat Deployer. Tomcat 6 includes a packaged tool
+
Use the Tomcat Deployer. Tomcat includes a packaged tool
bundling the Ant tasks, and can be used to automatically precompile JSPs
which are part of the web application before deployment to the server.
In order to use Tomcat 6 for developing web applications, you must first
+
In order to use Tomcat for developing web applications, you must first
install it (and the software it depends on). The required steps are outlined
in the following subsections.
@@ -53,12 +53,12 @@ are available at
Binary downloads of the Tomcat server are available from
http://tomcat.apache.org/download-60.cgi.
This manual assumes you are using the most recent release
-of Tomcat 6. Detailed instructions for downloading and installing
-Tomcat 6 are available here.
+of Tomcat 7. Detailed instructions for downloading and installing
+Tomcat are available here.
In the remainder of this manual, example shell scripts assume that you have
set an environment variable CATALINA_HOME that contains the
-pathname to the directory in which Tomcat 6 has been installed. Optionally, if
+pathname to the directory in which Tomcat has been installed. Optionally, if
Tomcat has been configured for multiple instances, each instance will have its
own CATALINA_BASE configured.
diff --git a/webapps/docs/appdev/processes.xml b/webapps/docs/appdev/processes.xml
index 0cd1b7758..2c6622833 100644
--- a/webapps/docs/appdev/processes.xml
+++ b/webapps/docs/appdev/processes.xml
@@ -127,7 +127,7 @@ file named build.properties in your project's top-level
directory. The supported properties are listed in the comments inside
the sample build.xml script. At a minimum, you will generally
need to define the catalina.home property defining where
-Tomcat 6 is installed, and the manager application username and password.
+Tomcat is installed, and the manager application username and password.
You might end up with something like this:
# Context path to install this application on
@@ -245,7 +245,7 @@ quickest way to do that is to use the custom Ant tasks that are included in
the sample build.xml script. Using these commands might follow
a pattern like this:
-
Start Tomcat 6 if needed. If Tomcat 6 is not already running,
+
Start Tomcat if needed. If Tomcat is not already running,
you will need to start it in the usual way.
Compile your application. Use the ant compile
diff --git a/webapps/docs/appdev/source.xml b/webapps/docs/appdev/source.xml
index 6280adb0c..d3323d7a0 100644
--- a/webapps/docs/appdev/source.xml
+++ b/webapps/docs/appdev/source.xml
@@ -35,9 +35,9 @@
The description below uses the variable name $CATALINA_BASE to refer the
base directory against which most relative paths are resolved. If you have
- not configured Tomcat 6 for multiple instances by setting a CATALINA_BASE
+ not configured Tomcat for multiple instances by setting a CATALINA_BASE
directory, then $CATALINA_BASE will be set to the value of $CATALINA_HOME,
- the directory into which you have installed Tomcat 6.
+ the directory into which you have installed Tomcat.
A key recommendation of this manual is to separate the directory
@@ -102,7 +102,7 @@ created on a temporary basis:
build/ - When you execute a default build
(ant), this directory will contain an exact image
of the files in the web application archive for this application.
- Tomcat 6 allows you to deploy an application in an unpacked
+ Tomcat allows you to deploy an application in an unpacked
directory like this, either by copying it to the
$CATALINA_BASE/webapps directory, or by installing
it via the "Manager" web application. The latter approach is very
@@ -152,7 +152,7 @@ build is performed.
"standard" build properties stored in the developer's home directory.
In many cases, your development system administrator will have already
- installed the required JAR files into Tomcat 6's lib directory.
+ installed the required JAR files into the lib directory of Tomcat.
If this has been done, you need
to take no actions at all - the example build.xml file
automatically constructs a compile classpath that includes these files.
@@ -290,22 +290,22 @@ provided:
For interactive development and testing of your web application using
-Tomcat 6, the following additional targets are defined:
+Tomcat, the following additional targets are defined:
-
install - Tell the currently running Tomcat 6 to make
+
install - Tell the currently running Tomcat to make
the application you are developing immediately available for execution
- and testing. This action does not require Tomcat 6 to be restarted, but
+ and testing. This action does not require Tomcat to be restarted, but
it is also not remembered after Tomcat is restarted the next time.
reload - Once the application is installed, you can
continue to make changes and recompile using the compile
- target. Tomcat 6 will automatically recognize changes made to JSP pages,
+ target. Tomcat will automatically recognize changes made to JSP pages,
but not to servlet or JavaBean classes - this command will tell Tomcat
to restart the currently installed application so that such changes are
recognized.
remove - When you have completed your development and
- testing activities, you can optionally tell Tomcat 6 to remove this
+ testing activities, you can optionally tell Tomcat to remove this
application from service.
Like many server applications, Tomcat 6 installs a variety of class loaders
+
Like many server applications, Tomcat installs a variety of class loaders
(that is, classes that implement java.lang.ClassLoader) to allow
different portions of the container, and the web applications running on the
container, to have access to different repositories of available classes and
@@ -48,7 +48,7 @@ class loader(s) cannot find the requested class or resource. The model for
web application class loaders differs slightly from this, as discussed below,
but the main principles are the same.
-
When Tomcat 6 is started, it creates a set of class loaders that are
+
When Tomcat is started, it creates a set of class loaders that are
organized into the following parent-child relationships, where the parent
class loader is above the child class loader:
@@ -70,7 +70,7 @@ the following section.
-
As indicated in the diagram above, Tomcat 6 creates the following class
+
As indicated in the diagram above, Tomcat creates the following class
loaders as it is initialized:
Bootstrap - This class loader contains the basic runtime
@@ -82,14 +82,14 @@ loaders as it is initialized:
System - This class loader is normally initialized from
the contents of the CLASSPATH environment variable. All such
classes are visible to both Tomcat internal classes, and to web
- applications. However, the standard Tomcat 6 startup scripts
+ applications. However, the standard Tomcat startup scripts
($CATALINA_HOME/bin/catalina.sh or
%CATALINA_HOME%\bin\catalina.bat) totally ignore the contents
of the CLASSPATH environment variable itself, and instead
build the System class loader from the following repositories:
$CATALINA_HOME/bin/bootstrap.jar - Contains the main() method
- that is used to initialize the Tomcat 6 server, and the class loader
+ that is used to initialize the Tomcat server, and the class loader
implementation classes it depends on.
$CATALINA_HOME/bin/tomcat-juli.jar - Package renamed Commons
logging API, and java.util.logging LogManager.
@@ -104,7 +104,7 @@ loaders as it is initialized:
annotations-api.jar - JEE annotations classes.
catalina.jar - Implementation of the Catalina servlet
- container portion of Tomcat 6.
+ container portion of Tomcat.
catalina-ant.jar - Tomcat Catalina Ant tasks.
catalina-ha.jar - High availability package.
catalina-tribes.jar - Group communication package.
@@ -123,7 +123,7 @@ loaders as it is initialized:
of messages is needed.
WebappX - A class loader is created for each web
- application that is deployed in a single Tomcat 6 instance. All unpacked
+ application that is deployed in a single Tomcat instance. All unpacked
classes and resources in the /WEB-INF/classes directory of
your web application archive, plus classes and resources in JAR files
under the /WEB-INF/lib directory of your web application
@@ -143,7 +143,7 @@ the XML parser components in J2SE 1.4+), the J2SE 1.4 endorsed feature can be
used.
Last, any JAR containing servlet API classes will be ignored by the
classloader.
-All other class loaders in Tomcat 6 follow the usual delegation pattern.
+All other class loaders in Tomcat follow the usual delegation pattern.
Therefore, from the perspective of a web application, class or resource
loading looks in the following repositories, in this order:
diff --git a/webapps/docs/cluster-howto.xml b/webapps/docs/cluster-howto.xml
index d84ecf685..2a778d6a1 100644
--- a/webapps/docs/cluster-howto.xml
+++ b/webapps/docs/cluster-howto.xml
@@ -136,7 +136,7 @@ should be completed:
Using session persistence, and saving the session to a shared file system (PersistenceManager + FileStore)
Using session persistence, and saving the session to a shared database (PersistenceManager + JDBCStore)
-
Using in-memory-replication, using the SimpleTcpCluster that ships with Tomcat 6 (lib/catalina-tribes.jar + lib/catalina-ha.jar)
+
Using in-memory-replication, using the SimpleTcpCluster that ships with Tomcat (lib/catalina-tribes.jar + lib/catalina-ha.jar)
In this release of session replication, Tomcat can perform an all-to-all replication of session state using the DeltaManager or
@@ -309,7 +309,7 @@ should be completed:
This is a template for the manager configuration that will be used if no manager is defined in the <Context>
element. In Tomcat 5.x each webapp marked distributable had to use the same manager, this is no longer the case
- since Tomcat 6 you can define a manager class for each webapp, so that you can mix managers in your cluster.
+ since Tomcat you can define a manager class for each webapp, so that you can mix managers in your cluster.
Obviously the managers on one node's application has to correspond with the same manager on the same application on the other node.
If no manager has been specified for the webapp, and the webapp is marked <distributable/> Tomcat will take this manager configuration
and create a manager instance cloning this configuration.
diff --git a/webapps/docs/config/ajp.xml b/webapps/docs/config/ajp.xml
index f90eca4b1..f037fe3de 100644
--- a/webapps/docs/config/ajp.xml
+++ b/webapps/docs/config/ajp.xml
@@ -37,7 +37,7 @@
The AJP Connector element represents a
Connector component that communicates with a web
connector via the AJP protocol. This is used for cases
- where you wish to invisibly integrate Tomcat 6 into an existing (or new)
+ where you wish to invisibly integrate Tomcat into an existing (or new)
Apache installation, and you want Apache to handle the static content
contained in the web application, and/or utilize Apache's SSL
processing.
The description below uses the variable name $CATALINA_BASE to refer the
base directory against which most relative paths are resolved. If you have
- not configured Tomcat 6 for multiple instances by setting a CATALINA_BASE
+ not configured Tomcat for multiple instances by setting a CATALINA_BASE
directory, then $CATALINA_BASE will be set to the value of $CATALINA_HOME,
- the directory into which you have installed Tomcat 6.
+ the directory into which you have installed Tomcat.
The Context element represents a web
@@ -67,7 +67,8 @@
web application for this virtual host, and is used to process all
requests that do not match any other Context's context path.
-
For Tomcat 6, unlike Tomcat 4.x, it is NOT recommended to place
+
For the current versions of Tomcat, unlike Tomcat 4.x,
+ it is NOT recommended to place
<Context> elements directly in the server.xml file. This
is because it makes modifying the Context configuration
more invasive since the main conf/server.xml file cannot be
diff --git a/webapps/docs/config/engine.xml b/webapps/docs/config/engine.xml
index 0ac3cee59..b44a1b816 100644
--- a/webapps/docs/config/engine.xml
+++ b/webapps/docs/config/engine.xml
@@ -86,9 +86,9 @@
Identifier which must be used in load balancing scenarios to enable
session affinity. The identifier, which must be unique across all
- Tomcat 6 servers which participate in the cluster, will be appended to
+ Tomcat servers which participate in the cluster, will be appended to
the generated session identifier, therefore allowing the front end
- proxy to always forward a particular session to the same Tomcat 6
+ proxy to always forward a particular session to the same Tomcat
instance.
The description below uses the variable name $CATALINA_BASE to refer the
base directory against which most relative paths are resolved. If you have
- not configured Tomcat 6 for multiple instances by setting a CATALINA_BASE
+ not configured Tomcat for multiple instances by setting a CATALINA_BASE
directory, then $CATALINA_BASE will be set to the value of $CATALINA_HOME,
- the directory into which you have installed Tomcat 6.
+ the directory into which you have installed Tomcat.
This manual contains reference information about all of the configuration
directives that can be included in a conf/server.xml file to
-configure the behavior of the Tomcat 6 Servlet/JSP container. It does not
+configure the behavior of the Tomcat 7 Servlet/JSP container. It does not
attempt to describe which configuration directives should be used to perform
specific tasks - for that, see the various HOW-TO documents on the
main index page.
The description below uses the variable name $CATALINA_BASE to refer the
base directory against which most relative paths are resolved. If you have
- not configured Tomcat 6 for multiple instances by setting a CATALINA_BASE
+ not configured Tomcat for multiple instances by setting a CATALINA_BASE
directory, then $CATALINA_BASE will be set to the value of $CATALINA_HOME,
- the directory into which you have installed Tomcat 6.
+ the directory into which you have installed Tomcat.
The description below uses the variable name $CATALINA_BASE to refer the
base directory against which most relative paths are resolved. If you have
- not configured Tomcat 6 for multiple instances by setting a CATALINA_BASE
+ not configured Tomcat for multiple instances by setting a CATALINA_BASE
directory, then $CATALINA_BASE will be set to the value of $CATALINA_HOME,
- the directory into which you have installed Tomcat 6.
+ the directory into which you have installed Tomcat.
@@ -565,7 +565,7 @@
JAAS Realm (org.apache.catalina.realm.JAASRealm)
-
JAASRealm is an implementation of the Tomcat 6
+
JAASRealm is an implementation of the Tomcat
Realm interface that authenticates users through the Java
Authentication & Authorization Service (JAAS) framework which is now
provided as part of the standard J2SE API.
LockOutRealm is an implementation of the Tomcat 6
+
LockOutRealm is an implementation of the Tomcat
Realm interface that extends the CombinedRealm to provide lock
out functionality to provide a user lock out mechanism if there are too many
failed authentication attempts in a given period of time.
The description below uses the variable name $CATALINA_BASE to refer the
base directory against which most relative paths are resolved. If you have
- not configured Tomcat 6 for multiple instances by setting a CATALINA_BASE
+ not configured Tomcat for multiple instances by setting a CATALINA_BASE
directory, then $CATALINA_BASE will be set to the value of $CATALINA_HOME,
- the directory into which you have installed Tomcat 6.
+ the directory into which you have installed Tomcat.
- To down load the extras components open the Tomcat 6 download page and
- select browse from the Quick Navigation Links. The extras components can be
+ To download the extras components open the Tomcat download page and
+ select "browse" from the Quick Navigation Links. The extras components can be
found in bin/extras.
The purpose of this specification is to define high level requirements
for administrative applications that can be used to manage the operation
- of a running Tomcat 6 container. A variety of Access Methods
+ of a running Tomcat container. A variety of Access Methods
to the supported administrative functionality shall be supported, to
meet varying requirements:
@@ -102,7 +102,7 @@
To the maximum extent feasible, all administrative functions,
and the access methods that support them, shall run portably
- on all platforms where Tomcat 6 itself runs.
+ on all platforms where Tomcat itself runs.
In a default Tomcat distribution, all administrative capabilities
shall be disabled. It shall be necessary for a system
administrator to specifically enable the desired access methods
@@ -171,14 +171,17 @@
The availability of the following technologies can be assumed
for the implementation and operation of the various access methods
- and the corresponding administrative business logic:
+ and the corresponding administrative business logic:
+ FIXME - This list below is totally outdated, but nobody
+ cares about the administrative app anymore. It is removed and unsupported
+ since Tomcat 6.0.
This document defines the Supported Operations that may
be performed against the Administered
-Objects that are supported by Tomcat 6 administrative applications.
+Objects that are supported by Tomcat administrative applications.
Not all operations are required to be available through every administrative
application that is implemented. However, if a given operation is available,
it should operate consistently with the descriptions found here.
The purpose of the JDBCRealm implementation is to
- provide a mechanism by which Tomcat 6 can acquire information needed
+ provide a mechanism by which Tomcat can acquire information needed
to authenticate web application users, and define their security roles,
from a relational database accessed via JDBC APIs. For integration
with Catalina, the resulting class(es) must implement the
diff --git a/webapps/docs/funcspecs/fs-jndi-realm.xml b/webapps/docs/funcspecs/fs-jndi-realm.xml
index 2c9d86a26..016e71379 100644
--- a/webapps/docs/funcspecs/fs-jndi-realm.xml
+++ b/webapps/docs/funcspecs/fs-jndi-realm.xml
@@ -37,7 +37,7 @@
The purpose of the JNDIRealm implementation is to
- provide a mechanism by which Tomcat 6 can acquire information needed
+ provide a mechanism by which Tomcat can acquire information needed
to authenticate web application users, and define their security roles,
from a directory server or other service accessed via JNDI APIs. For
integration with Catalina, this class must implement the
diff --git a/webapps/docs/funcspecs/fs-memory-realm.xml b/webapps/docs/funcspecs/fs-memory-realm.xml
index 6d3e3a27e..7501130dd 100644
--- a/webapps/docs/funcspecs/fs-memory-realm.xml
+++ b/webapps/docs/funcspecs/fs-memory-realm.xml
@@ -37,10 +37,10 @@
The purpose of the MemoryRealm implementation is to
- provide a mechanism by which Tomcat 6 can acquire information needed
+ provide a mechanism by which Tomcat can acquire information needed
to authenticate web application users, and define their security roles,
from a simple text-based configuration file in XML format. This is
- intended to simplify the initial installation and operation of Tomcat 6,
+ intended to simplify the initial installation and operation of Tomcat,
without the complexity of configuring a database or directory server
based Realm. It is not intended for production use.
This documentation area includes functional specifications for
many features supported by the Catalina servlet container
-portion of Tomcat 6. In most cases, these features are not documented in the
+portion of Tomcat. In most cases, these features are not documented in the
underlying Servlet or JSP specifications, so a definition of the expected
correct behavior is important both to implementors of those features, and to
test writers trying to decide what to test.
@@ -43,14 +43,14 @@ test writers trying to decide what to test.
in the menu (to the left):
Administrative Apps - Overall requirements for supporting an
- ability to configure and operate a Tomcat 6 installation through tools,
+ ability to configure and operate a Tomcat installation through tools,
as well as detailed requirements for the tools themselves.
Internal Servlets - Requirements for Catalina features that are
implemented as internal, container-managed, servlets.
Realm Implementations - Requirements for the implementations of
the org.apache.catalina.Realm interface (providing access to
collections of users, passwords and roles) that are included in the
- standard Tomcat 6 distribution.
+ standard Tomcat distribution.
NOTE - In some cases, the contents of these functional specs has
diff --git a/webapps/docs/html-manager-howto.xml b/webapps/docs/html-manager-howto.xml
index d5853f118..4ccf7cce5 100644
--- a/webapps/docs/html-manager-howto.xml
+++ b/webapps/docs/html-manager-howto.xml
@@ -134,7 +134,7 @@ error message. Possible causes for problems include:
Encountered exception
An exception was encountered trying to start the web application.
- Check the Tomcat 6 logs for the details.
+ Check the Tomcat logs for the details.
Invalid context path was specified
@@ -174,7 +174,7 @@ error message. Possible causes for problems include:
Encountered exception
An exception was encountered trying to stop the web application.
- Check the Tomcat 6 logs for the details.
+ Check the Tomcat logs for the details.
Invalid context path was specified
@@ -222,7 +222,7 @@ error message. Possible causes for problems include:
Encountered exception
An exception was encountered trying to restart the web application.
- Check the Tomcat 6 logs for the details.
+ Check the Tomcat logs for the details.
Invalid context path was specified
@@ -511,7 +511,7 @@ error message. Possible causes for problems include:
Encountered exception
An exception was encountered trying to start the new web application.
- Check the Tomcat 6 logs for the details, but likely explanations include
+ Check the Tomcat logs for the details, but likely explanations include
problems parsing your /WEB-INF/web.xml file, or missing
classes encountered when initializing application event listeners and
filters.
diff --git a/webapps/docs/index.xml b/webapps/docs/index.xml
index c96c35b87..acaf17195 100644
--- a/webapps/docs/index.xml
+++ b/webapps/docs/index.xml
@@ -51,7 +51,7 @@ manual is described in more detail below.
The following documents will assist you in downloading, installing
-Apache Tomcat 6, and using many of the Apache Tomcat features.
+Apache Tomcat 7, and using many of the Apache Tomcat features.
Introduction - A
@@ -87,7 +87,7 @@ Apache Tomcat 6, and using many of the Apache Tomcat features.
- Configuring a JNDI DataSoure with a DB connection pool.
Examples for many popular databases.
Classloading
- - Information about class loading in Apache Tomcat 6, including where to place
+ - Information about class loading in Apache Tomcat, including where to place
your application classes so that they are visible.
JSPs
- Information about Jasper configuration, as well as the JSP compiler
@@ -101,7 +101,7 @@ Apache Tomcat 6, and using many of the Apache Tomcat features.
Proxy Support -
- Configuring Apache Tomcat 6 to run behind a proxy server (or a web server
+ Configuring Apache Tomcat to run behind a proxy server (or a web server
functioning as a proxy server).
MBean Descriptor -
Configuring MBean descriptors files for custom components.
@@ -135,7 +135,7 @@ Apache Tomcat 6, and using many of the Apache Tomcat features.
The following documents are aimed at System Administrators who
-are responsible for installing, configuring, and operating a Apache Tomcat 6 server.
+are responsible for installing, configuring, and operating an Apache Tomcat server.
Release notes
@@ -143,7 +143,7 @@ are responsible for installing, configuring, and operating a Apache Tomcat 6 ser
Apache Tomcat Server Configuration Reference
- Reference manual that documents all available elements and attributes
- that may be placed into a Apache Tomcat 6 conf/server.xml file.
+ that may be placed into the Apache Tomcat conf/server.xml file.
JK Documentation
- Complete documentation and HOWTOs on the JK native webserver connector,
@@ -165,7 +165,7 @@ are responsible for installing, configuring, and operating a Apache Tomcat 6 ser
the development of the Apache Tomcat project.
Building from Source -
- Details the steps necessary to download Apache Tomcat 6 source code (and the
+ Details the steps necessary to download Apache Tomcat source code (and the
other packages that it depends on), and build a binary distribution from
those sources.
@@ -180,7 +180,7 @@ the development of the Apache Tomcat project.
Functional Specifications
- Requirements specifications for features of the Catalina servlet
- container portion of Apache Tomcat 6.
+ container portion of Apache Tomcat.
Javadocs
- Javadoc API documentation for Apache Tomcat's internals.
Apache Tomcat Architecture
diff --git a/webapps/docs/introduction.xml b/webapps/docs/introduction.xml
index 4779b0880..ba1059db4 100644
--- a/webapps/docs/introduction.xml
+++ b/webapps/docs/introduction.xml
@@ -105,19 +105,19 @@ meaning that any change to the files necessitates a restart of the container.
written and easy to understand, we may have missed something. Provided
below are various web sites and mailing lists in case you get stuck.
-
As Tomcat 6 is a new release of Tomcat, keep in mind that some of the
-issues and solutions vary between the major versions of Tomcat (4.x versus
-5). As you search around the web, there will be some documentation that
-is not relevant to Tomcat 6, but 3.x, 4.x and 5.x. Doing 3.x or 4.x things to 6
-will probably not work in most cases as the server.xml files are very
-different.
+
As Tomcat 7 is a new release of Tomcat, keep in mind that some of the
+issues and solutions vary between the major versions of Tomcat (6.x versus
+7.x). As you search around the web, there will be some documentation that
+is not relevant to Tomcat 7, but 6.x, 5.x or earlier versions. Doing 3.x
+or 4.x things to 7 will probably not work in most cases as the server.xml
+files are very different.
Current document - most documents will list potential hangups. Be sure
to fully read the relevant documentation as it will save you much time
and effort. There's nothing like scouring the web only to find out that
the answer was right in front of you all along!
Tomcat 6 provides a JNDI InitialContext implementation
+
Tomcat provides a JNDI InitialContext implementation
instance for each web application running under it, in a manner that is
compatible with those provided by a
Java2 Enterprise Edition application
@@ -64,7 +64,7 @@ resources:
<resource-ref> - Resource reference,
which is typically to an object factory for resources such as a JDBC
DataSource, a JavaMail Session, or custom
- object factories configured into Tomcat 6.
+ object factories configured into Tomcat.
<resource-env-ref> - Resource
environment reference, a new variation of resource-ref
added in Servlet 2.4 that is simpler to configure for resources
@@ -140,7 +140,7 @@ attribute to "true").
-
Tomcat 6 maintains a separate namespace of global resources for the
+
Tomcat maintains a separate namespace of global resources for the
entire server. These are configured in the
<GlobalNameingResources> element of
@@ -185,7 +185,7 @@ conn.close();
-
Tomcat 6 includes a series of standard resource factories that can
+
Tomcat includes a series of standard resource factories that can
provide services to your web applications, but give you configuration
flexibility (via the
<Context> element)
@@ -196,7 +196,7 @@ conn.close();
See Adding Custom
Resource Factories for information about how to create, install,
configure, and use your own custom resource factory classes with
- Tomcat 6.
+ Tomcat.
NOTE - Of the standard resource factories, only the
"JDBC Data Source" and "User Transaction" factories are mandated to
@@ -400,7 +400,7 @@ writer.println("foo = " + bean.getFoo() + ", bar = " +
configuration details that the client application must be aware of
(including the name of the SMTP host to be used for message sending).
-
Tomcat 6 includes a standard resource factory that will create
+
Tomcat includes a standard resource factory that will create
javax.mail.Session session instances for you, already
configured to connect to an SMTP server.
In this way, the application is totally insulated from changes in the
@@ -532,7 +532,7 @@ Transport.send(message);
to support the functionality required by that application. The J2EE
Platform Specification requires J2EE Application Servers to make
available a DataSource implementation (that is, a connection
- pool for JDBC connections) for this purpose. Tomcat 6 offers exactly
+ pool for JDBC connections) for this purpose. Tomcat offers exactly
the same support, so that database-based applications you develop on
Tomcat using this service will run unchanged on any J2EE server.
@@ -689,7 +689,7 @@ conn.close();
If none of the standard resource factories meet your needs, you can write
- your own factory and integrate it into Tomcat 6, and then configure the use
+ your own factory and integrate it into Tomcat, and then configure the use
of this factory in the
<Context> element for
the web application. In the example below, we will create a factory that only
diff --git a/webapps/docs/manager-howto.xml b/webapps/docs/manager-howto.xml
index a455ec722..f71f07bca 100644
--- a/webapps/docs/manager-howto.xml
+++ b/webapps/docs/manager-howto.xml
@@ -73,10 +73,10 @@ Using the JMX Proxy Servlet
to deploy a new web application, or undeploy an existing one, without having
to shut down and restart the entire container. In addition, you can request
an existing application to reload itself, even if you have not declared it
-to be reloadable in the Tomcat 6 server
+to be reloadable in the Tomcat server
configuration file.
-
To support these capabilities, Tomcat 6 includes a web application
+
To support these capabilities, Tomcat includes a web application
(installed by default on context path /manager) that supports
the following functions:
@@ -139,9 +139,9 @@ With Ant for more information.
The description below uses the variable name $CATALINA_BASE to refer the
base directory against which most relative paths are resolved. If you have
- not configured Tomcat 6 for multiple instances by setting a CATALINA_BASE
+ not configured Tomcat for multiple instances by setting a CATALINA_BASE
directory, then $CATALINA_BASE will be set to the value of $CATALINA_HOME,
- the directory into which you have installed Tomcat 6.
+ the directory into which you have installed Tomcat.
It would be quite unsafe to ship Tomcat with default settings that allowed
@@ -163,7 +163,7 @@ depends on which Realm implementation you are using:
MemoryRealm - If you have not customized your
$CATALINA_BASE/conf/server.xml to select a different one,
- Tomcat 6 defaults to an XML-format file stored at
+ Tomcat defaults to an XML-format file stored at
$CATALINA_BASE/conf/tomcat-users.xml, which can be
edited with any text editor. This file contains an XML
<user> for each individual user, which might
@@ -322,7 +322,7 @@ error message. Possible causes for problems include:
Encountered exception
An exception was encountered trying to start the new web application.
- Check the Tomcat 6 logs for the details, but likely explanations include
+ Check the Tomcat logs for the details, but likely explanations include
problems parsing your /WEB-INF/web.xml file, or missing
classes encountered when initializing application event listeners and
filters.
@@ -495,7 +495,7 @@ error message. Possible causes for problems include:
Encountered exception
An exception was encountered trying to start the new web application.
- Check the Tomcat 6 logs for the details, but likely explanations include
+ Check the Tomcat logs for the details, but likely explanations include
problems parsing your /WEB-INF/web.xml file, or missing
classes encountered when initializing application event listeners and
filters.
@@ -578,7 +578,7 @@ error message. Possible causes for problems include:
Encountered exception
An exception was encountered trying to restart the web application.
- Check the Tomcat 6 logs for the details.
+ Check the Tomcat logs for the details.
Invalid context path was specified
@@ -622,7 +622,7 @@ include an error message. Possible causes for problems include:
Encountered exception
An exception was encountered trying to enumerate the system properties.
- Check the Tomcat 6 logs for the details.
+ Check the Tomcat logs for the details.
@@ -667,7 +667,7 @@ include an error message. Possible causes for problems include:
Encountered exception
An exception was encountered trying to enumerate the global JNDI
- resources. Check the Tomcat 6 logs for the details.
+ resources. Check the Tomcat logs for the details.
No global JNDI resources are available
@@ -776,7 +776,7 @@ error message. Possible causes for problems include:
Encountered exception
An exception was encountered trying to start the web application.
- Check the Tomcat 6 logs for the details.
+ Check the Tomcat logs for the details.
Invalid context path was specified
@@ -818,7 +818,7 @@ error message. Possible causes for problems include:
Encountered exception
An exception was encountered trying to stop the web application.
- Check the Tomcat 6 logs for the details.
+ Check the Tomcat logs for the details.
Invalid context path was specified
@@ -873,7 +873,7 @@ error message. Possible causes for problems include:
Encountered exception
An exception was encountered trying to undeploy the web application.
- Check the Tomcat 6 logs for the details.
+ Check the Tomcat logs for the details.
Invalid context path was specified
@@ -981,7 +981,7 @@ The same information is available for both of them :
In addition to the ability to execute Manager commands via HTTP requests,
-as documented above, Tomcat 6 includes a convenient set of Task definitions
+as documented above, Tomcat includes a convenient set of Task definitions
for the Ant (version 1.4 or later) build tool. In order to use these
commands, you must perform the following setup operations:
@@ -990,7 +990,7 @@ commands, you must perform the following setup operations:
You must use version 1.4 or later.
Install the Ant distribution in a convenient directory (called
ANT_HOME in the remainder of these instructions).
-
Copy the file server/lib/catalina-ant.jar from your Tomcat 6
+
Copy the file server/lib/catalina-ant.jar from your Tomcat
installation into Ant's library directory ($ANT_HOME/lib).
Add the $ANT_HOME/bin directory to your PATH
diff --git a/webapps/docs/mbeans-descriptor-howto.xml b/webapps/docs/mbeans-descriptor-howto.xml
index 6dc76b072..a6e5c82e7 100644
--- a/webapps/docs/mbeans-descriptor-howto.xml
+++ b/webapps/docs/mbeans-descriptor-howto.xml
@@ -31,7 +31,7 @@
-
Tomcat 6 uses JMX MBeans as the technology for implementing
+
Tomcat uses JMX MBeans as the technology for implementing
manageability of Tomcat.
The descriptions of JMX MBeans for Catalina are in the mbeans-descriptor.xml
diff --git a/webapps/docs/proxy-howto.xml b/webapps/docs/proxy-howto.xml
index bfd4bbb25..da33b1fcf 100644
--- a/webapps/docs/proxy-howto.xml
+++ b/webapps/docs/proxy-howto.xml
@@ -64,7 +64,7 @@ proxy configurations for several common cases.
Apache 1.3 supports an optional module (mod_proxy) that
configures the web server to act as a proxy server. This can be used to
-forward requests for a particular web application to a Tomcat 6 instance,
+forward requests for a particular web application to a Tomcat instance,
without having to configure a web connector such as mod_jk.
To accomplish this, you need to perform the following tasks:
Include two directives in your httpd.conf file for
- each web application that you wish to forward to Tomcat 6. For
+ each web application that you wish to forward to Tomcat. For
example, to forward an application at context path /myapp:
ProxyPass /myapp http://localhost:8081/myapp
ProxyPassReverse /myapp http://localhost:8081/myapp
which tells Apache to forward URLs of the form
- http://localhost/myapp/* to the Tomcat 6 connector
+ http://localhost/myapp/* to the Tomcat connector
listening on port 8081.
-
Configure your copy of Tomcat 6 to include a special
+
Configure your copy of Tomcat to include a special
<Connector> element, with appropriate
proxy settings, for example:
diff --git a/webapps/docs/realm-howto.xml b/webapps/docs/realm-howto.xml
index ea0c3095a..c5904ffb2 100644
--- a/webapps/docs/realm-howto.xml
+++ b/webapps/docs/realm-howto.xml
@@ -78,7 +78,7 @@ see the Servlet
Specification (Version 2.4), Section 12.
For information about utilizing the Single Sign On feature of
-Tomcat 6 (allowing a user to authenticate themselves once across the entire
+Tomcat (allowing a user to authenticate themselves once across the entire
set of web applications associated with a virtual host), see
here.
@@ -105,7 +105,7 @@ applications to declare their security requirements (in the
defining the interface between a servlet container and the associated user
and role information. In many cases, however, it is desirable to "connect"
a servlet container to some existing authentication database or mechanism
-that already exists in the production environment. Therefore, Tomcat 6
+that already exists in the production environment. Therefore, Tomcat
defines a Java interface (org.apache.catalina.Realm) that
can be implemented by "plug in" components to establish this connection.
Five standard plug-ins are provided, supporting connections to various
@@ -131,7 +131,7 @@ sources of authentication information:
It is also possible to write your own Realm implementation,
-and integrate it with Tomcat 6. To do so, you need to:
+and integrate it with Tomcat. To do so, you need to:
Implement org.apache.catalina.Realm,
Place your compiled realm in $CATALINA_HOME/lib,
@@ -259,7 +259,7 @@ corrupted in the return, the digest will be invalid.
-
The example application shipped with Tomcat 6 includes an area that is
+
The example application shipped with Tomcat includes an area that is
protected by a security constraint, utilizing form-based login. To access it,
point your browser at
http://localhost:8080/examples/jsp/security/protected/
@@ -272,7 +272,7 @@ and log on with one of the usernames and passwords described for the default
If you wish to use the Manager Application
-to deploy and undeploy applications in a running Tomcat 6 installation, you
+to deploy and undeploy applications in a running Tomcat installation, you
MUST add the "manager" role to at least one username in your selected Realm
implementation. This is because the manager web application itself uses a
security constraint that requires role "manager" to access ANY request URI
@@ -304,7 +304,7 @@ Tomcat administrator specifically assigns this role to one or more users.
Introduction
-
JDBCRealm is an implementation of the Tomcat 6
+
JDBCRealm is an implementation of the Tomcat
Realm interface that looks up users in a relational database
accessed via a JDBC driver. There is substantial configuration flexibility
that lets you adapt to existing table and column names, as long as your
@@ -348,7 +348,7 @@ database structure conforms to the following requirements:
Note that only JAR files are recognized!
Set up a <Realm> element, as described below, in your
$CATALINA_BASE/conf/server.xml file.
-
Restart Tomcat 6 if it is already running.
+
Restart Tomcat if it is already running.
Realm Element Attributes
@@ -393,7 +393,7 @@ described above, and accessed with username "dbuser" and password "dbpass":
JDBCRealm operates according to the following rules:
When a user attempts to access a protected resource for the first time,
- Tomcat 6 will call the authenticate() method of this
+ Tomcat will call the authenticate() method of this
Realm. Thus, any changes you have made to the database
directly (new users, changed passwords or roles, etc.) will be immediately
reflected.
@@ -417,7 +417,7 @@ described above, and accessed with username "dbuser" and password "dbpass":
Introduction
-
DataSourceRealm is an implementation of the Tomcat 6
+
DataSourceRealm is an implementation of the Tomcat
Realm interface that looks up users in a relational database
accessed via a JNDI named JDBC DataSource. There is substantial configuration
flexibility that lets you adapt to existing table and column names, as long
@@ -461,7 +461,7 @@ as your database structure conforms to the following requirements:
for information on how to configure a JNDI named JDBC DataSource.
Set up a <Realm> element, as described below, in your
$CATALINA_BASE/conf/server.xml file.
-
Restart Tomcat 6 if it is already running.
+
Restart Tomcat if it is already running.
Realm Element Attributes
@@ -504,7 +504,7 @@ name "java:/comp/env/jdbc/authority".
DataSourceRealm operates according to the following rules:
When a user attempts to access a protected resource for the first time,
- Tomcat 6 will call the authenticate() method of this
+ Tomcat will call the authenticate() method of this
Realm. Thus, any changes you have made to the database
directly (new users, changed passwords or roles, etc.) will be immediately
reflected.
@@ -528,7 +528,7 @@ name "java:/comp/env/jdbc/authority".
Introduction
-
JNDIRealm is an implementation of the Tomcat 6
+
JNDIRealm is an implementation of the Tomcat
Realm interface that looks up users in an LDAP directory
server accessed by a JNDI provider (typically, the standard LDAP
provider that is available with the JNDI API classes). The realm
@@ -709,7 +709,7 @@ the name of this attribute.
$CATALINA_HOME/lib directory.
Set up a <Realm> element, as described below, in your
$CATALINA_BASE/conf/server.xml file.
-
Restart Tomcat 6 if it is already running.
+
Restart Tomcat if it is already running.
Realm Element Attributes
@@ -889,7 +889,7 @@ authentication is usually to be preferred.
JNDIRealm operates according to the following rules:
When a user attempts to access a protected resource for the first time,
- Tomcat 6 will call the authenticate() method of this
+ Tomcat will call the authenticate() method of this
Realm. Thus, any changes you have made to the directory
(new users, changed passwords or roles, etc.) will be immediately
reflected.
@@ -913,7 +913,7 @@ authentication is usually to be preferred.
Introduction
-
UserDatabaseRealm is an implementation of the Tomcat 6
+
UserDatabaseRealm is an implementation of the Tomcat
Realm interface that uses a JNDI resource to store user
information. By default, the JNDI resource is backed by an XML file. It is not
designed for large-scale production use. At startup time, the UserDatabaseRealm
@@ -938,7 +938,7 @@ configuration documentation.
Example
-
The default installation of Tomcat 6 is configured with a UserDatabaseRealm
+
The default installation of Tomcat is configured with a UserDatabaseRealm
nested inside the <Engine> element, so that it applies
to all virtual hosts and web applications. The default contents of the
conf/tomcat-users.xml file is:
@@ -960,7 +960,7 @@ to all virtual hosts and web applications. The default contents of the
restarted. Changes may be made via the UserDatabase resource. Tomcat
provides MBeans that may be accessed via JMX for this purpose.
When a user attempts to access a protected resource for the first time,
- Tomcat 6 will call the authenticate() method of this
+ Tomcat will call the authenticate() method of this
Realm.
Once a user has been authenticated, the user (and his or her associated
roles) are cached within Tomcat for the duration of the user's login.
@@ -979,7 +979,7 @@ to all virtual hosts and web applications. The default contents of the
Introduction
MemoryRealm is a simple demonstration implementation of the
-Tomcat 6 Realm interface. It is not designed for production use.
+Tomcat Realm interface. It is not designed for production use.
At startup time, MemoryRealm loads information about all users, and their
corresponding roles, from an XML document (by default, this document is loaded
from $CATALINA_BASE/conf/tomcat-users.xml). Changes to the data
@@ -1018,7 +1018,7 @@ valid user, consisting of the following attributes:
this file will not be recognized until Tomcat is
restarted.
When a user attempts to access a protected resource for the first time,
- Tomcat 6 will call the authenticate() method of this
+ Tomcat will call the authenticate() method of this
Realm.
Once a user has been authenticated, the user (and his or her associated
roles) are cached within Tomcat for the duration of the user's login.
@@ -1089,7 +1089,7 @@ variable: JAVA_OPTS=$JAVA_OPTS -Djava.security.auth.login.config==$CATALIN
Configure your security-constraints in your web.xml for
the resources you want to protect
Configure the JAASRealm module in your server.xml
-
Restart Tomcat 6 if it is already running.
+
Restart Tomcat if it is already running.
Realm Element Attributes
To configure JAASRealm as for step 6 above, you create
@@ -1130,7 +1130,7 @@ and restarting the server, without any code changes to your application.
Additional Notes
When a user attempts to access a protected resource for
- the first time, Tomcat 6 will call the authenticate()
+ the first time, Tomcat will call the authenticate()
method of this Realm. Thus, any changes you have made in
the security mechanism directly (new users, changed passwords or
roles, etc.) will be immediately reflected.
@@ -1154,7 +1154,7 @@ and restarting the server, without any code changes to your application.
Introduction
-
CombinedRealm is an implementation of the Tomcat 6
+
CombinedRealm is an implementation of the Tomcat
Realm interface that authenticates users through one or more
sub-Realms.
@@ -1198,7 +1198,7 @@ UserDatabase Realm and a DataSource Realm.
Introduction
-
LockOutRealm is an implementation of the Tomcat 6
+
LockOutRealm is an implementation of the Tomcat
Realm interface that extends the CombinedRealm to provide lock
out functionality to provide a user lock out mechanism if there are too many
failed authentication attempts in a given period of time.
diff --git a/webapps/docs/security-manager-howto.xml b/webapps/docs/security-manager-howto.xml
index 1589227af..9ddaff291 100644
--- a/webapps/docs/security-manager-howto.xml
+++ b/webapps/docs/security-manager-howto.xml
@@ -53,7 +53,7 @@
system administrator can use to keep the server secure and reliable.
WARNING - A security audit
- have been conducted using the Tomcat 6 codebase. Most of the critical
+ have been conducted using the Tomcat codebase. Most of the critical
package have been protected and a new security package protection mechanism
has been implemented. Still, make sure that you are satisfied with your SecurityManager
configuration before allowing untrusted users to publish web applications,
@@ -69,7 +69,7 @@
by Tomcat will have. There are a number of Permission classes that are
a standard part of the JDK, and you can create your own Permission class
for use in your own web applications. Both techniques are used in
- Tomcat 6.
The description below uses the variable name $CATALINA_BASE to refer the
base directory against which most relative paths are resolved. If you have
- not configured Tomcat 6 for multiple instances by setting a CATALINA_BASE
+ not configured Tomcat for multiple instances by setting a CATALINA_BASE
directory, then $CATALINA_BASE will be set to the value of $CATALINA_HOME,
- the directory into which you have installed Tomcat 6.
+ the directory into which you have installed Tomcat.
-
To install and configure SSL support on Tomcat 6, you need to follow
+
To install and configure SSL support on Tomcat, you need to follow
these simple steps. For more information, read the rest of this HOW-TO.
Create a certificate keystore by executing the following command:
@@ -342,7 +342,7 @@ sources like "/dev/urandom" that will allow quicker starts of Tomcat.
The final step is to configure the Connector in the
$CATALINA_BASE/conf/server.xml file, where
$CATALINA_BASE represents the base directory for the
-Tomcat 6 instance. An example <Connector> element
+Tomcat instance. An example <Connector> element
for an SSL connector is included in the default server.xml
file installed with Tomcat. For JSSE, it should look something like this: