Return-Path: X-Original-To: apmail-tomcat-dev-archive@www.apache.org Delivered-To: apmail-tomcat-dev-archive@www.apache.org Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by minotaur.apache.org (Postfix) with SMTP id 6FBED743D for ; Sat, 22 Oct 2011 21:27:12 +0000 (UTC) Received: (qmail 94219 invoked by uid 500); 22 Oct 2011 21:27:11 -0000 Delivered-To: apmail-tomcat-dev-archive@tomcat.apache.org Received: (qmail 94163 invoked by uid 500); 22 Oct 2011 21:27:11 -0000 Mailing-List: contact dev-help@tomcat.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: "Tomcat Developers List" Delivered-To: mailing list dev@tomcat.apache.org Received: (qmail 94154 invoked by uid 99); 22 Oct 2011 21:27:11 -0000 Received: from nike.apache.org (HELO nike.apache.org) (192.87.106.230) by apache.org (qpsmtpd/0.29) with ESMTP; Sat, 22 Oct 2011 21:27:11 +0000 X-ASF-Spam-Status: No, hits=-2000.0 required=5.0 tests=ALL_TRUSTED X-Spam-Check-By: apache.org Received: from [140.211.11.4] (HELO eris.apache.org) (140.211.11.4) by apache.org (qpsmtpd/0.29) with ESMTP; Sat, 22 Oct 2011 21:26:56 +0000 Received: from eris.apache.org (localhost [127.0.0.1]) by eris.apache.org (Postfix) with ESMTP id E38D423888CD for ; Sat, 22 Oct 2011 21:26:33 +0000 (UTC) Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit Subject: svn commit: r1187809 [3/5] - in /tomcat/trunk/webapps: ROOT/ ROOT/WEB-INF/ docs/ docs/WEB-INF/ docs/api/ docs/appdev/ docs/appdev/sample/ docs/appdev/sample/src/mypackage/ docs/architecture/ docs/architecture/startup/ docs/config/ docs/elapi/ docs/imag... Date: Sat, 22 Oct 2011 21:26:25 -0000 To: dev@tomcat.apache.org From: markt@apache.org X-Mailer: svnmailer-1.0.8-patched Message-Id: <20111022212633.E38D423888CD@eris.apache.org> X-Virus-Checked: Checked by ClamAV on apache.org Modified: tomcat/trunk/webapps/docs/config/project.xml URL: http://svn.apache.org/viewvc/tomcat/trunk/webapps/docs/config/project.xml?rev=1187809&r1=1187808&r2=1187809&view=diff ============================================================================== --- tomcat/trunk/webapps/docs/config/project.xml (original) +++ tomcat/trunk/webapps/docs/config/project.xml Sat Oct 22 21:26:20 2011 @@ -24,7 +24,7 @@ The Apache Tomcat Servlet/JSP Container - + @@ -59,7 +59,7 @@ - + @@ -68,7 +68,7 @@ - + Modified: tomcat/trunk/webapps/docs/config/realm.xml URL: http://svn.apache.org/viewvc/tomcat/trunk/webapps/docs/config/realm.xml?rev=1187809&r1=1187808&r2=1187809&view=diff ============================================================================== --- tomcat/trunk/webapps/docs/config/realm.xml (original) +++ tomcat/trunk/webapps/docs/config/realm.xml Sat Oct 22 21:26:20 2011 @@ -50,8 +50,8 @@ containers, unless explicitly overridden.

For more in-depth information about container managed security in web - applications, as well as more information on configuring and using the - standard realm component implementations, please see the + applications, as well as more information on configuring and using the + standard realm component implementations, please see the Container-Managed Security Guide.

@@ -140,7 +140,7 @@ to encode user passwords stored in the database. If not specified, user passwords are assumed to be stored in clear-text.

- +

The charset for encoding digests. If not specified, the platform default will be used.

@@ -245,12 +245,12 @@
-

When the realm is nested inside a Context element, this allows the +

When the realm is nested inside a Context element, this allows the realm to use a DataSource defined for the Context rather than a global - DataSource. If not specified, the default is false: use a + DataSource. If not specified, the default is false: use a global DataSource.

- +

Name of the column, in the "user roles" table, which contains a role name assigned to the corresponding user.

@@ -736,17 +736,17 @@

The name of the application as configured in your login configuration - file + file (JAAS LoginConfig).

-

A comma-separated list of the names of the classes that you have made +

A comma-separated list of the names of the classes that you have made for your user Principals.

-

A comma-separated list of the names of the classes that you have made +

A comma-separated list of the names of the classes that you have made for your role Principals.

@@ -801,10 +801,10 @@ 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.

- +

To ensure correct operation, there is a reasonable degree of synchronization in this Realm.

- +

This Realm does not require modification to the underlying Realms or the associated user storage mechanisms. It achieves this by recording all failed logins, including those for users that do not exist. To prevent a DOS by @@ -866,7 +866,7 @@ <Realm> elements may be nested inside it.

Other Realm Implementations

- +

No other Realm implementation supports nested components.

Modified: tomcat/trunk/webapps/docs/config/resources.xml URL: http://svn.apache.org/viewvc/tomcat/trunk/webapps/docs/config/resources.xml?rev=1187809&r1=1187808&r2=1187809&view=diff ============================================================================== --- tomcat/trunk/webapps/docs/config/resources.xml (original) +++ tomcat/trunk/webapps/docs/config/resources.xml Sat Oct 22 21:26:20 2011 @@ -36,7 +36,7 @@

The Resources element represents the web - application static resources, from which classes will be loaded, + application static resources, from which classes will be loaded, HTML, JSP and the other static files will be served. This allows the webapp to reside on various mediums other than the filesystem, like compressed in a WAR file, in a JDBC database, or in a more advanced versioning @@ -48,14 +48,14 @@ access, access through the ServletContext interface, or native access through the DirectoryContext interface.

-

Note: Running a webapp with non-filesystem based - Resources implementations is only possible when the webapp does not +

Note: Running a webapp with non-filesystem based + Resources implementations is only possible when the webapp does not rely on direct filesystem access to its own resources, and uses the methods in the ServletContext interface to access them.

-

A Resources element MAY be nested inside a - Context component. If it is not included, - a default filesystem based Resources will be created automatically, +

A Resources element MAY be nested inside a + Context component. If it is not included, + a default filesystem based Resources will be created automatically, which is sufficient for most requirements.

@@ -73,10 +73,10 @@

Java class name of the implementation to use. This class must implement the javax.naming.directory.DirContext interface. - It is recommended for optimal functionality and performance, - but not mandatory, that the class extend + It is recommended for optimal functionality and performance, + but not mandatory, that the class extend org.apache.naming.resources.BaseDirContext, as well as - use the special object types provided in the + use the special object types provided in the org.apache.naming.resources for returned objects. If not specified, the standard value (defined below) will be used.

@@ -89,7 +89,7 @@

The standard implementation of Resources is - org.apache.naming.resources.FileDirContext, and + org.apache.naming.resources.FileDirContext, and is configured by its parent Context element.

Modified: tomcat/trunk/webapps/docs/config/server.xml URL: http://svn.apache.org/viewvc/tomcat/trunk/webapps/docs/config/server.xml?rev=1187809&r1=1187808&r2=1187809&view=diff ============================================================================== --- tomcat/trunk/webapps/docs/config/server.xml (original) +++ tomcat/trunk/webapps/docs/config/server.xml Sat Oct 22 21:26:20 2011 @@ -104,9 +104,9 @@

The following components may be nested inside a Server element:

Modified: tomcat/trunk/webapps/docs/config/systemprops.xml URL: http://svn.apache.org/viewvc/tomcat/trunk/webapps/docs/config/systemprops.xml?rev=1187809&r1=1187808&r2=1187809&view=diff ============================================================================== --- tomcat/trunk/webapps/docs/config/systemprops.xml (original) +++ tomcat/trunk/webapps/docs/config/systemprops.xml Sat Oct 22 21:26:20 2011 @@ -40,15 +40,15 @@
-

Set this to a fully qualified name of a class that implements +

Set this to a fully qualified name of a class that implements org.apache.tomcat.util.IntrospectionUtils.PropertySource. Required to have a public constructor with no arguments.

Use this to add a property source, that will be invoked when ${parameter} denoted parameters are found in the XML files that Tomcat parses.

- -
+ +
@@ -336,7 +336,7 @@ true, the default of this setting will be true, else the default value will be false.

- +

If this is true Tomcat will allow '=' @@ -406,12 +406,12 @@ -

An alternative name for the single sign on session cookie. Defaults to JSESSIONIDSSO.

- +

If this is true, every request that is associated with a session will cause the session's last accessed time to be updated @@ -420,7 +420,7 @@ true, the default of this setting will be true, else the default value will be false.

- +

If this is true, Tomcat will track the number of active @@ -454,9 +454,9 @@

If no logging configuration file is specified and no logging configuration class is specified using the java.util.logging.config.class and java.util.logging.config.file - properties the default logging framework org.apache.juli will use the default - java.util.logging.SimpleFormatter for all console output. - To simply override the console output formatter, one can use the described property. Example: + properties the default logging framework org.apache.juli will use the default + java.util.logging.SimpleFormatter for all console output. + To simply override the console output formatter, one can use the described property. Example: -Dorg.apache.juli.formatter=org.apache.juli.OneLineFormatter

@@ -473,7 +473,7 @@ -

The max number of log records that the async logger will keep in memory. When this limit is reached and a new record is being logged by the +

The max number of log records that the async logger will keep in memory. When this limit is reached and a new record is being logged by the JULI framework the system will take an action based on the org.apache.juli.AsyncOverflowDropType setting.

The default value is 10000 records. This number represents the global number of records, not on a per handler basis. @@ -571,13 +571,13 @@

If true, use a shared selector for servlet write/read.

If not specified, the default value of true will be used.

- +

If true, the server will exit if an exception happens during the server initialization phase.

If not specified, the default value of false will be used.

- +
Modified: tomcat/trunk/webapps/docs/config/valve.xml URL: http://svn.apache.org/viewvc/tomcat/trunk/webapps/docs/config/valve.xml?rev=1187809&r1=1187808&r2=1187809&view=diff ============================================================================== --- tomcat/trunk/webapps/docs/config/valve.xml (original) +++ tomcat/trunk/webapps/docs/config/valve.xml Sat Oct 22 21:26:20 2011 @@ -69,7 +69,7 @@

Some requests may be handled by Tomcat before they are passed to a container. These include redirects from /foo to /foo/ and the rejection of invalid requests. Where Tomcat can identify the Context that - would have handled the request, the request/response will be logged in the + would have handled the request, the request/response will be logged in the AccessLog(s) associated Context, Host and Engine. Where Tomcat cannot identify the Context that would have handled the request, e.g. in cases @@ -141,7 +141,7 @@ attributes (typically set by the RemoteIpValve and similar) that should be used to override the values returned by the request for remote address, remote host, server port and protocol. If the attributes are - not set, or this attribute is set to false then the values + not set, or this attribute is set to false then the values from the request will be used. If not set, the default value of false will be used.

@@ -208,7 +208,7 @@

Flag to determine if logging will be buffered. - If set to false, then access logging will be written after each + If set to false, then access logging will be written after each request. Default value: true

@@ -353,7 +353,7 @@ attributes (typically set by the RemoteIpValve and similar) that should be used to override the values returned by the request for remote address, remote host, server port and protocol. If the attributes are - not set, or this attribute is set to false then the values + not set, or this attribute is set to false then the values from the request will be used. If not set, the default value of false will be used.

@@ -417,7 +417,7 @@

Flag to determine if logging will be buffered. - If set to false, then access logging will be written after each + If set to false, then access logging will be written after each request. Default value: true

@@ -650,19 +650,19 @@ -

Default false. Flag to determine whether each request needs to be +

Default false. Flag to determine whether each request needs to be reauthenticated to the security Realm. If "true", this Valve uses cached security credentials (username and password) to - reauthenticate to the Realm each request associated - with an SSO session. If "false", the Valve can itself authenticate - requests based on the presence of a valid SSO cookie, without + reauthenticate to the Realm each request associated + with an SSO session. If "false", the Valve can itself authenticate + requests based on the presence of a valid SSO cookie, without rechecking with the Realm.

- +

Sets the host domain to be used for sso cookies.

- + @@ -944,7 +944,7 @@ from the request. If not set, the encoding of the request body will be used.

- +

Java class name of the implementation to use. This MUST be set to org.apache.catalina.authenticator.FormAuthenticator.

@@ -959,7 +959,7 @@ workaround for browser caching issues. If not set, the default value of true will be used.

- +

Controls the behavior of the FORM authentication process if the process is misused, for example by directly requesting the login page @@ -1219,7 +1219,7 @@

- +

Tomcat port of mod_remoteip, this valve replaces the apparent client remote IP address and hostname for @@ -1227,14 +1227,14 @@ via a request headers (e.g. "X-Forwarded-For").

Another feature of this valve is to replace the apparent scheme - (http/https), server port and request.secure with the scheme presented - by a proxy or a load balancer via a request header + (http/https), server port and request.secure with the scheme presented + by a proxy or a load balancer via a request header (e.g. "X-Forwarded-Proto").

- +

This Valve may be used at the Engine, Host or Context level as required. Normally, this Valve would be used at the Engine level.

- +

If used in conjunction with Remote Address/Host valves then this valve should be defined first to ensure that the correct client IP address is presented to the Remote Address/Host valves.

@@ -1312,19 +1312,19 @@ -

Value returned by ServletRequest.getServerPort() - when the protocolHeader indicates http +

Value returned by ServletRequest.getServerPort() + when the protocolHeader indicates http protocol and no portHeader is present. If not specified, the default of 80 is used.

-

Value returned by ServletRequest.getServerPort() - when the protocolHeader indicates https +

Value returned by ServletRequest.getServerPort() + when the protocolHeader indicates https protocol and no portHeader is present. If not specified, the default of 443 is used.

- +

If true, the value returned by ServletRequest.getLocalPort() and @@ -1342,17 +1342,17 @@

- +

Web crawlers can trigger the creation of many thousands of sessions as they crawl a site which may result in significant memory consumption. This Valve ensures that crawlers are associated with a single session - just like normal users - regardless of whether or not they provide a session token with their requests.

- +

This Valve may be used at the Engine, Host or Context level as required. Normally, this Valve would be used at the Engine level.

- +

If used in conjunction with Remote IP valve then the Remote IP valve should be defined before this valve to ensure that the correct client IP address is presented to this valve.

@@ -1397,13 +1397,13 @@
- -

This valve allows to detect requests that take a long time to process, which might + +

This valve allows to detect requests that take a long time to process, which might indicate that the thread that is processing it is stuck.

-

When such a request is detected, the current stack trace of its thread is written +

When such a request is detected, the current stack trace of its thread is written to tomcat log with a WARN level.

-

The IDs of the stuck threads are available through JMX in the - stuckThreadIds attribute. The JVM Thread MBean can then be used to +

The IDs of the stuck threads are available through JMX in the + stuckThreadIds attribute. The JVM Thread MBean can then be used to retrieve other information about each stuck thread (name, stack trace...).

@@ -1422,10 +1422,10 @@ -

Minimum duration in seconds after which a thread is considered stuck. +

Minimum duration in seconds after which a thread is considered stuck. Default is 600 seconds. If set to 0, the detection is disabled.

Note: since the detection is done in the background thread of the Container - (Engine, Host or Context) declaring this Valve, the threshold should be higher + (Engine, Host or Context) declaring this Valve, the threshold should be higher than the backgroundProcessorDelay of this Container.

Modified: tomcat/trunk/webapps/docs/connectors.xml URL: http://svn.apache.org/viewvc/tomcat/trunk/webapps/docs/connectors.xml?rev=1187809&r1=1187808&r2=1187809&view=diff ============================================================================== --- tomcat/trunk/webapps/docs/connectors.xml (original) +++ tomcat/trunk/webapps/docs/connectors.xml Sat Oct 22 21:26:20 2011 @@ -48,26 +48,26 @@ connector features the lowest latency an

For clustering, a HTTP load balancer with support for web sessions stickiness must be installed to direct the traffic to the Tomcat servers. Tomcat supports mod_proxy -(on Apache HTTP Server 2.x, and included by default in Apache HTTP Server 2.2) as the load balancer. -It should be noted that the performance of HTTP proxying is usually lower than the +(on Apache HTTP Server 2.x, and included by default in Apache HTTP Server 2.2) as the load balancer. +It should be noted that the performance of HTTP proxying is usually lower than the performance of AJP, so AJP clustering is often preferable.

-

When using a single server, the performance when using a native webserver in +

When using a single server, the performance when using a native webserver in front of the Tomcat instance is most of the time significantly worse than a standalone Tomcat with its default HTTP connector, even if a large part of the web -application is made of static files. If integration with the native webserver is -needed for any reason, an AJP connector will provide faster performance than -proxied HTTP. AJP clustering is the most efficient from the Tomcat perspective. +application is made of static files. If integration with the native webserver is +needed for any reason, an AJP connector will provide faster performance than +proxied HTTP. AJP clustering is the most efficient from the Tomcat perspective. It is otherwise functionally equivalent to HTTP clustering.

The native connectors supported with this Tomcat release are:

  • JK 1.2.x with any of the supported servers
  • -
  • mod_proxy on Apache HTTP Server 2.x (included by default in Apache HTTP Server 2.2), +
  • mod_proxy on Apache HTTP Server 2.x (included by default in Apache HTTP Server 2.2), with AJP enabled

Modified: tomcat/trunk/webapps/docs/default-servlet.xml URL: http://svn.apache.org/viewvc/tomcat/trunk/webapps/docs/default-servlet.xml?rev=1187809&r1=1187808&r2=1187809&view=diff ============================================================================== --- tomcat/trunk/webapps/docs/default-servlet.xml (original) +++ tomcat/trunk/webapps/docs/default-servlet.xml Sat Oct 22 21:26:20 2011 @@ -175,8 +175,8 @@ The DefaultServlet allows the following sendfileSize - If the connector used supports sendfile, this represents the minimal - file size in KB for which sendfile will be used. Use a negative value + If the connector used supports sendfile, this represents the minimal + file size in KB for which sendfile will be used. Use a negative value to always disable sendfile. [48] Modified: tomcat/trunk/webapps/docs/deployer-howto.xml URL: http://svn.apache.org/viewvc/tomcat/trunk/webapps/docs/deployer-howto.xml?rev=1187809&r1=1187808&r2=1187809&view=diff ============================================================================== --- tomcat/trunk/webapps/docs/deployer-howto.xml (original) +++ tomcat/trunk/webapps/docs/deployer-howto.xml Sat Oct 22 21:26:20 2011 @@ -36,8 +36,8 @@

Deployment is the term used for the process of installing a web - application (either a 3rd party WAR or your own custom web application) - into the Tomcat server. + application (either a 3rd party WAR or your own custom web application) + into the Tomcat server.

Web application deployment may be accomplished in a number of ways @@ -45,7 +45,7 @@

  • Statically; the web application is setup before Tomcat is started
  • - Dynamically; in conjunction with the Tomcat Manager web application or + Dynamically; in conjunction with the Tomcat Manager web application or manipulating already deployed web applications
@@ -58,20 +58,20 @@ web application resource (WAR) files.

- +

There is no installation required for static deployment of web applications as this is provided out of the box by Tomcat. Nor is any - installation required for deployment functions with the Tomcat Manager, - although some configuration is required as detailed in the + installation required for deployment functions with the Tomcat Manager, + although some configuration is required as detailed in the Tomcat Manager manual. An installation is however required if you wish - to use the Tomcat Client Deployer (TCD). -

+ to use the Tomcat Client Deployer (TCD). +

- The TCD is not packaged with the Tomcat core - distribution, and must therefore be downloaded separately from - the Downloads area. The download is usually labelled + The TCD is not packaged with the Tomcat core + distribution, and must therefore be downloaded separately from + the Downloads area. The download is usually labelled apache-tomcat-7.0.x-deployer.

@@ -92,25 +92,25 @@ Tomcat Client Deployer

- +

In talking about deployment of web applications, the concept of a - Context is required to be understood. A Context is what Tomcat + Context is required to be understood. A Context is what Tomcat calls a web application.

In order to configure a Context within Tomcat a Context Descriptor is required. A Context Descriptor is simply an XML file that contains - Tomcat related configuration for a Context, e.g naming resources or + Tomcat related configuration for a Context, e.g naming resources or session manager configuration. In earlier versions of Tomcat the content of a Context Descriptor configuration was often stored within Tomcat's primary configuration file server.xml but this is now discouraged (although it currently still works).

-

- Context Descriptors not only help Tomcat to know how to configure - Contexts but other tools such as the Tomcat Manager and TCD often use +

+ Context Descriptors not only help Tomcat to know how to configure + Contexts but other tools such as the Tomcat Manager and TCD often use these Context Descriptors to perform their roles properly.

@@ -123,16 +123,16 @@

Files in (1) are named [webappname].xml but files in (2) are named context.xml. If a Context Descriptor is not provided for a Context, - Tomcat configures the Context using default values. + Tomcat configures the Context using default values.

- +

- If you are not interested in using the Tomcat Manager, or TCD, - then you'll need to deploy your web applications + If you are not interested in using the Tomcat Manager, or TCD, + then you'll need to deploy your web applications statically to Tomcat, followed by a Tomcat startup. The location you - deploy web applications to for this type of deployment is called the + deploy web applications to for this type of deployment is called the appBase which is specified per Host. You either copy a so-called exploded web application, i.e non-compressed, to this location, or a compressed web application resource .WAR file. @@ -140,7 +140,7 @@

The web applications present in the location specified by the Host's (default Host is "localhost") appBase attribute (default - appBase is "$CATALINA_BASE/webapps") will be deployed on Tomcat startup + appBase is "$CATALINA_BASE/webapps") will be deployed on Tomcat startup only if the Host's deployOnStartup attribute is "true".

@@ -151,31 +151,31 @@

  • Any Context Descriptors will be deployed first.
  • Exploded web applications not referenced by any Context - Descriptor will then be deployed. If they have an associated - .WAR file in the appBase and it is newer than the exploded web application, - the exploded directory will be removed and the webapp will be + Descriptor will then be deployed. If they have an associated + .WAR file in the appBase and it is newer than the exploded web application, + the exploded directory will be removed and the webapp will be redeployed from the .WAR
  • .WAR files will be deployed
  • - Note again that for each deployed web application, a + Note again that for each deployed web application, a Context Descriptor will be created unless one exists already.

    - +

    It is possible to deploy web applications to a running Tomcat server.

    - If the Host autoDeploy attribute is "true", the Host will + If the Host autoDeploy attribute is "true", the Host will attempt to deploy and update web applications dynamically, as needed, - for example if a new .WAR is dropped into the appBase. - For this to work, the Host needs to have background processing + for example if a new .WAR is dropped into the appBase. + For this to work, the Host needs to have background processing enabled which is the default configuration.

    - +

    autoDeploy set to "true" and a running Tomcat allows for:

    @@ -187,11 +187,11 @@
  • Re-deployment of a web application which has already been deployed from - a .WAR when the new .WAR is provided. In this case the exploded - web application is removed, and the .WAR is expanded again. - Note that the explosion will not occur if the Host is configured + a .WAR when the new .WAR is provided. In this case the exploded + web application is removed, and the .WAR is expanded again. + Note that the explosion will not occur if the Host is configured so that .WARs are not exploded with a unpackWARs - attribute set to "false", in which case the web application + attribute set to "false", in which case the web application will be simply redeployed as a compressed archive.
  • @@ -205,14 +205,14 @@
  • Re-deployment of a web application if a Context Descriptor file (with a filename corresponding to the Context path of the previously deployed - web application) is added to the + web application) is added to the $CATALINA_BASE/conf/[enginename]/[hostname]/ directory.
  • Undeployment of a web application if its document base (docBase) - is deleted. Note that on Windows, this assumes that anti-locking - features (see Context configuration) are enabled, otherwise it is not + is deleted. Note that on Windows, this assumes that anti-locking + features (see Context configuration) are enabled, otherwise it is not possible to delete the resources of a running web application.
  • @@ -221,23 +221,23 @@ case loaded classes will be tracked for changes.

    - +

    - The Tomcat Manager is covered in its own manual page. + The Tomcat Manager is covered in its own manual page.

    - +

    - Finally, deployment of web application may be achieved using the - Tomcat Client Deployer. This is a package which can be used to - validate, compile, compress to .WAR, and deploy web applications to - production or development Tomcat servers. It should be noted that this feature + Finally, deployment of web application may be achieved using the + Tomcat Client Deployer. This is a package which can be used to + validate, compile, compress to .WAR, and deploy web applications to + production or development Tomcat servers. It should be noted that this feature uses the Tomcat Manager and as such the target Tomcat server should be running.

    - +

    It is assumed the user will be familiar with Apache Ant for using the TCD. Apache Ant is a scripted build tool. The TCD comes pre-packaged with a @@ -246,37 +246,37 @@ with using the operating system command shell and configuring environment variables).

    - +

    - The TCD includes Ant tasks, the Jasper page compiler for JSP compilation + The TCD includes Ant tasks, the Jasper page compiler for JSP compilation before deployment, as well as a task which validates the web application Context Descriptor. The validator task (class org.apache.catalina.ant.ValidatorTask) allows only one parameter: the base path of an exploded web application.

    - +

    The TCD uses an exploded web application as input (see the list of the - properties used below). A web application that is programmatically - deployed with the deployer may include a Context Descriptor in + properties used below). A web application that is programmatically + deployed with the deployer may include a Context Descriptor in /META-INF/context.xml.

    - +

    The TCD includes a ready-to-use Ant script, with the following targets:

    • - compile (default): Compile and validate the web + compile (default): Compile and validate the web application. This can be used standalone, and does not need a running Tomcat server. The compiled application will only run on the associated Tomcat 7.0.x server release, and is not guaranteed to work on another Tomcat release, as the code generated by Jasper depends on its runtime component. It should also be noted that this target will also compile - automatically any Java source file located in the + automatically any Java source file located in the /WEB-INF/classes folder of the web application.
    • - deploy: Deploy a web application (compiled or not) to + deploy: Deploy a web application (compiled or not) to a Tomcat server.
    • undeploy: Undeploy a web application
    • @@ -284,42 +284,42 @@
    • reload: Reload web application
    • stop: Stop web application
    - +

    In order for the deployment to be configured, create a file called deployer.properties in the TCD installation directory root. In this file, add the following name=value pairs per line:

    - +

    - Additionally, you will need to ensure that a user has been + Additionally, you will need to ensure that a user has been setup for the target Tomcat Manager (which TCD uses) otherwise the TCD will not authenticate with the Tomcat Manager and the deployment will - fail. To do this, see the Tomcat Manager page. + fail. To do this, see the Tomcat Manager page.

    - +
    @@ -143,16 +143,16 @@ attribute to "true").

    -

    Tomcat maintains a separate namespace of global resources for the -entire server. These are configured in the +

    Tomcat maintains a separate namespace of global resources for the +entire server. These are configured in the -<GlobalNamingResources> element of -$CATALINA_BASE/conf/server.xml. You may expose these resources to -web applications by using a +<GlobalNamingResources> element of +$CATALINA_BASE/conf/server.xml. You may expose these resources to +web applications by using a <ResourceLink> to include it in the per-web-application context.

    -

    If a resource has been defined using a +

    If a resource has been defined using a <ResourceLink>, it is not necessary for that resource to be defined in /WEB-INF/web.xml. However, it is recommended to keep the entry in /WEB-INF/web.xml @@ -376,7 +376,7 @@ writer.println("foo = " + bean.getFoo()

    The pathname attribute can be absolute or relative. If relative, it is relative to $CATALINA_BASE.

    - +

    The readonly attribute is optional and defaults to true if not supplied. If the XML is writeable then it will be written to when Tomcat starts. WARNING: When the file is @@ -513,7 +513,7 @@ Transport.send(message);

    5. Restart Tomcat

    - +

    For the additional JAR to be visible to Tomcat, it is necessary for the Tomcat instance to be restarted.

    Modified: tomcat/trunk/webapps/docs/jspapi/index.html URL: http://svn.apache.org/viewvc/tomcat/trunk/webapps/docs/jspapi/index.html?rev=1187809&r1=1187808&r2=1187809&view=diff ============================================================================== --- tomcat/trunk/webapps/docs/jspapi/index.html (original) +++ tomcat/trunk/webapps/docs/jspapi/index.html Sat Oct 22 21:26:20 2011 @@ -23,10 +23,10 @@ -The JSP Javadoc is not installed by default. Download and install +The JSP Javadoc is not installed by default. Download and install the "fulldocs" package to get it. -You can also access the javadoc online in the Tomcat +You can also access the javadoc online in the Tomcat documentation bundle. Modified: tomcat/trunk/webapps/docs/logging.xml URL: http://svn.apache.org/viewvc/tomcat/trunk/webapps/docs/logging.xml?rev=1187809&r1=1187808&r2=1187809&view=diff ============================================================================== --- tomcat/trunk/webapps/docs/logging.xml (original) +++ tomcat/trunk/webapps/docs/logging.xml Sat Oct 22 21:26:20 2011 @@ -343,7 +343,7 @@ org.apache.catalina.core.ContainerBase.[ #org.apache.catalina.util.LifecycleBase.level = FINE

    - +

    Example logging.properties for the servlet-examples web application to be placed in WEB-INF/classes inside the web application: @@ -420,7 +420,7 @@ java.util.logging.ConsoleHandler.formatt

      -
    1. Create a file called log4j.properties with the +
    2. Create a file called log4j.properties with the following content and save it into $CATALINA_BASE/lib
    @@ -473,7 +473,7 @@ log4j.logger.org.apache.catalina.core.Co INFO, HOST-MANAGER
      -
    1. Download Log4J +
    2. Download Log4J (v1.2 or later).
    3. Download or build tomcat-juli.jar and @@ -529,10 +529,10 @@ log4j.logger.org.apache.catalina.core.Co

      - You can (and should) be more picky about which packages to include + You can (and should) be more picky about which packages to include in the logging. Tomcat defines loggers by Engine and Host names. For example, for a more detailed Catalina localhost log, add this to the - end of the log4j.properties above. Note that there are known issues with + end of the log4j.properties above. Note that there are known issues with using this naming convention (with square brackets) in log4j XML based configuration files, so we recommend you use a properties file as described until a future version of log4j allows this convention. @@ -550,12 +550,12 @@ log4j.logger.org.apache.catalina.session

      - Your web applications should certainly use their own log4j configuration. + Your web applications should certainly use their own log4j configuration. This is valid with the above configuration. You would place a similar log4j.properties file in your web application's WEB-INF/classes directory, and log4jx.y.z.jar into WEB-INF/lib. Then specify your package level logging. This is a basic setup of log4j which does *not* require - Commons-Logging, and you should consult the + Commons-Logging, and you should consult the log4j documentation for more options. This page is intended only as a bootstrapping guide. Modified: tomcat/trunk/webapps/docs/manager-howto.xml URL: http://svn.apache.org/viewvc/tomcat/trunk/webapps/docs/manager-howto.xml?rev=1187809&r1=1187808&r2=1187809&view=diff ============================================================================== --- tomcat/trunk/webapps/docs/manager-howto.xml (original) +++ tomcat/trunk/webapps/docs/manager-howto.xml Sat Oct 22 21:26:20 2011 @@ -172,7 +172,7 @@ an example of restricting access to the

      The HTML interface is protected against CSRF but the text and JMX interfaces are not. To maintain the CSRF protection:

      - +
      • users with the manager-gui role should not be granted either the manager-script or manager-jmx roles.
      • @@ -258,8 +258,8 @@ name or the war file name without the .w application can later be undeployed (and the corresponding application directory removed) by use of the /undeploy command.

        -

        The .WAR file may include Tomcat specific deployment configuration, by -including a Context configuration XML file in +

        The .WAR file may include Tomcat specific deployment configuration, by +including a Context configuration XML file in /META-INF/context.xml.

        URL parameters include:

        @@ -759,13 +759,13 @@ error message. Possible causes for prob http://localhost:8080/manager/text/undeploy?path=/examples -

        WARNING - This command will delete any web -application artifacts that exist within appBase directory +

        WARNING - This command will delete any web +application artifacts that exist within appBase directory (typically "webapps") for this virtual host. -This will delete the the application .WAR, if present, -the application directory resulting either from a deploy in unpacked form +This will delete the the application .WAR, if present, +the application directory resulting either from a deploy in unpacked form or from .WAR expansion as well as the XML Context definition from -$CATALINA_BASE/conf/[enginename]/[hostname]/ directory. +$CATALINA_BASE/conf/[enginename]/[hostname]/ directory. If you simply want to take an application out of service, you should use the /stop command instead.

        @@ -845,29 +845,29 @@ has been reloaded several times, it may

        If the command does not succeed, the response will start with FAIL and include an error message.

        - +

        From this link , you can view information about the server.

        -

        First, you have the server and JVM version number, JVM provider, OS name +

        First, you have the server and JVM version number, JVM provider, OS name and number followed by the architecture type.

        -

        Second, there is several information about the memory usage of the JVM +

        Second, there is several information about the memory usage of the JVM (available, total and max memory).

        -

        Then, there is information about the Tomcat AJP and HTTP connectors. +

        Then, there is information about the Tomcat AJP and HTTP connectors. The same information is available for both of them :

          -
        • Threads information : Max threads, min and max spare threads, +

        • Threads information : Max threads, min and max spare threads, current thread count and current thread busy.

        • -
        • Request information : Max processing time and processing time, +

        • Request information : Max processing time and processing time, request and error count, bytes received and sent.

        • -
        • A table showing Stage, Time, Bytes Sent, Bytes Receive, Client, - VHost and Request. All existing threads are listed in the table. +

        • A table showing Stage, Time, Bytes Sent, Bytes Receive, Client, + VHost and Request. All existing threads are listed in the table. Here is the list of the possible thread stages :

          • "Parse and Prepare Request" : The request headers are @@ -993,8 +993,8 @@ property, and specify it from the comman

            Using Ant version 1.6.2 or later, -the Catalina tasks offer the option to capture their output in -properties or external files. They support directly the following subset of the +the Catalina tasks offer the option to capture their output in +properties or external files. They support directly the following subset of the <redirector> type attributes:

            @@ -1091,10 +1091,10 @@ any wrong or missing command attribute w

            They also support the embedded <redirector> element in which you can specify -its full set of attributes, but input, inputstring and +its full set of attributes, but input, inputstring and inputencoding that, even if accepted, are not used because they have no meaning in this context. -Refer to ant manual for details on +Refer to ant manual for details on <redirector> element attributes.

            @@ -1125,17 +1125,17 @@ can be used: path="${mgr.context.path}" war="${mgr.war.file}"/> </target> - + <target name="context.status"> <property name="running" value="${mgr.context.path}:running"/> <property name="stopped" value="${mgr.context.path}:stopped"/> - + <list url="${mgr.url}" outputproperty="ctx.status" username="${mgr.username}" password="${mgr.password}"> </list> - + <condition property="context.running"> <contains string="${ctx.status}" substring="${running}"/> </condition> Modified: tomcat/trunk/webapps/docs/maven-jars.xml URL: http://svn.apache.org/viewvc/tomcat/trunk/webapps/docs/maven-jars.xml?rev=1187809&r1=1187808&r2=1187809&view=diff ============================================================================== --- tomcat/trunk/webapps/docs/maven-jars.xml (original) +++ tomcat/trunk/webapps/docs/maven-jars.xml Sat Oct 22 21:26:20 2011 @@ -35,10 +35,10 @@
            - Tomcat snapshots are located in the + Tomcat snapshots are located in the Apache Snapshot Repository. The official URL is http://people.apache.org/repo/m2-snapshot-repository/org/apache/tomcat/ - Snapshots are done periodically, not on a regular basis, but when changes happen and the Tomcat team deems a new snapshot might + Snapshots are done periodically, not on a regular basis, but when changes happen and the Tomcat team deems a new snapshot might useful. --------------------------------------------------------------------- To unsubscribe, e-mail: dev-unsubscribe@tomcat.apache.org For additional commands, e-mail: dev-help@tomcat.apache.org