Manager App HOW-TO

Introduction
はじめに
Configuring Manager Application Access
Managerアプリケーションへのアクセス設定
Supported Manager Commands
サポートされるManagerコマンド

Deploy A New Application Remotely
Deploy A New Application from a Local Path
List Currently Deployed and Installed Applications
Reload An Existing Application
List OS and JVM Properties
List Available Global JNDI Resources
List Available Security Roles
Session Statistics
Start an Existing Application
Stop an Existing Application
Undeploy an Existing Application

リモートへの新しいアプリケーションの配備
 ローカルパスからの新しいアプリケーションの配備
 配備・インストール済のアプリケーションの一覧表示
 既存のアプリケーションの再ロード
 OS・JVMのプロパティの一覧表示
 利用可能なJNDIリソースの一覧表示
 利用可能なセキュリティロールの一覧表示
 セッション統計
 既存のアプリケーションの起動
 既存のアプリケーションの停止
 既存のアプリケーションの配備解除

Executing Manager Commands With Ant
AntでのManagerコマンドの実行
Using the JMX Proxy Servlet
JMXプロキシサーブレットの使用

What is JMX Proxy Servlet?
Query command
Set command

JMXプロキシサーブレットとは
 クエリコマンド
 設定コマンド

In many production environments, it is very useful to have the capability 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 5 server configuration file.

コンテナ全体のシャットダウン・再起動をせずに、新しいWebアプリケーションを配備したり、既存のWebアプリケーションを配備解除したりする機能は、多くの本番環境でとても役立ちます。さらに、Tomcat 5 サーバ設定ファイルで reloadable を定義しなくても、既存のアプリケーションに再ロードを要求することも可能です。

To support these capabilities, Tomcat 5 includes a web application (installed by default on context path /manager) that supports the following functions:

こうした機能をサポートするために、Tomcat 5 には以下の機能をサポートする Webアプリケーションがあります (デフォルトではコンテキストパス /manager でインストールされています)。

Deploy a new web application, on a specified context path, from the uploaded contents of a WAR file.
Install a new web application, which can be anywhere on the server's disks.
List the currently deployed web applications, as well as the sessions that are currently active for those web apps.
Reload an existing web application, to reflect changes in the contents of /WEB-INF/classes or /WEB-INF/lib.
List the OS and JVM property values.
List the available global JNDI resources, for use in deployment tools that are preparing <ResourceLink> elements nested in a <Context> deployment description.
List the available security roles defined in the user database.
Remove an installed web application.
Start a stopped application (thus making it available again).
Stop an existing application (so that it becomes unavailable), but do not undeploy it.
Undeploy a deployed web application and delete its document base directory.

新しいWebアプリケーションを、指定したコンテキストパスで、 WARファイルをアップロードして配備します。
サーバのディスクから新しいWebアプリケーションをインストールします。サーバのディスクのどこにあってもかまいません。
配備済みのWebアプリケーションを、 Webアプリで現在アクティブなセッションとともに一覧表示します。
/WEB-INF/classes や /WEB-INF/lib の内容変更を反映するために、既存の Webアプリケーションを再ロードします。
OS や JVM のプロパティ値を一覧表示します。
利用可能なグローバル JNDI リソースを一覧表示します。これは <Context> 配備記述内で入れ子になっている <ResourceLink> 要素を準備する配備ツールで使用します。
ユーザデータベースで定義された、利用可能なセキュリティロールを一覧表示します。
インストール済みの Webアプリケーションを削除します。
停止したアプリケーションを起動 (そして再び利用可能に) します。
(利用不可にするために) 既存のアプリケーションを停止しますが、配備解除はしません。
配備済みのWebアプリケーションを配備解除し、ドキュメントベースのディレクトリを削除します。

There are two ways to configure the Manager web application Context:

Install the manager.xml context configuration file in the appBase for your Host.

Configure the Manager Context within the Host configuration in your Tomcat server.xml configuration. Here is an example:

<Context path="/manager" debug="0" privileged="true"
         docBase="/usr/local/kinetic/tomcat5/server/webapps/manager">
</Context>

Manager Webアプリケーションの Context 設定方法は2種類あります。

Host を示す appBase 上にある manager.xml コンテキスト設定ファイルをインストールします。

Tomcat server.xml ファイルの Host 設定内の Manager Context を設定します。以下に例を示します。

<Context path="/manager" debug="0" privileged="true"
         docBase="/usr/local/kinetic/tomcat5/server/webapps/manager">
</Context>

If you have Tomcat configured to support multiple virtual hosts (websites) you would need to configure a Manager for each.

複数の仮想ホスト (Webサイト) をサポートするように設定するなら、それぞれで Manager を設定する必要があります。

There are three ways to use the Manager web application.

As an application with a user interface you use in your browser. Here is an example URL where you can replace localhost with your website host name: http://localhost/manager/html/ .
A minimal version using HTTP requests only which is suitable for use by scripts setup by system administrators. Commands are given as part of the request URI, and responses are in the form of simple text that can be easily parsed and processed. See Supported Manager Commands for more information.
A convenient set of task definitions for the Ant (version 1.4 or later) build tool. See Executing Manager Commands With Ant for more information.

Manager Webアプリケーションの使用方法は3種類あります。

ユーザインタフェースとしてブラウザを使うアプリケーション。以下の URL で localhost を Webサイトのホスト名に置き換えて下さい： http://localhost/manager/html/
HTTPリクエストのみを使った最小版。システム管理者がスクリプトでセットアップするのに適しています。コマンドはリクエストURLの一部として送られ、レスポンスは簡単に解析・処理できるように単純テキスト形式となっています。詳しくはサポートされるManagerコマンドをご覧下さい。
Ant (バージョン1.4以降) ビルドツールで便利な一連のタスク定義。詳しくは AntでのManagerコマンドの実行をご覧下さい。

Future versions of Tomcat 5 will include administrative functionality that is presented in (at least) the following forms:

As web services, so that Tomcat administration can be easily integrated into remote and/or non-Java mnagement environments.
As a web application with a nice user interface (built on top of the web services processing layer) for easy Tomcat administration via a web browser.

Tomcat 5 の将来のバージョンでは (少なくとも) 以下の形式での管理機能が追加される予定です。

Webサービス。これを使うとリモートかつ/またはJava以外の管理環境と簡単に統合できます。
Webブラウザで Tomcat を簡単に管理するための、優れたユーザインタフェースを持つ Webサービス (Webサービス処理層の上に構築)。

mnagement→management

The description below uses the variable name $CATALINA_HOME to refer to the directory into which you have installed Tomcat 5, and is the base directory against which most relative paths are resolved. However, if you have configured Tomcat 5 for multiple instances by setting a CATALINA_BASE directory, you should use $CATALINA_BASE instead of $CATALINA_HOME for each of these references.

以下の記述で、変数名 $CATALINA_HOME は Tomcat 5 をインストールしたディレクトリを指し、これを基準にほとんどの相対パスを解決するディレクトリです。ただし、複数インスタンスで Tomcat 5 を設定した場合は、 $CATALINA_HOME の代わりに $CATALINA_BASE を使って下さい。

It would be quite unsafe to ship Tomcat with default settings that allowed anyone on the Internet to execute the Manager application on your server. Therefore, the Manager application is shipped with the requirement that anyone who attempts to use it must authenticate themselves, using a username and password that have the role manager associated with them. Further, there is no username in the default users file ($CATALINA_HOME/conf/tomcat-users.xml) that is assigned this role. Therefore, access to the Manager application is completely disabled by default.

Tomcat の出荷時のデフォルトの設定で、サーバの Manager アプリケーションをインターネット上の誰でも実行できるようになっていたら、まったく安全ではありません。そこで Tomcat 出荷時には、 Manager を使おうとする人は誰でも、関連する manager ロールを持ったユーザ名とパスワードを使った認証が必須となっています。さらに、デフォルトのユーザファイル ($CATALINA_HOME/conf/tomcat-users.xml) ではこのロールに関連するユーザ名はありません。したがって、Manager アプリケーションへのアクセスはデフォルトでは完全に無効となっています。

To enable access to the Manager web application, you must either create a new username/password combination and associate the role name manager with it, or add the manager role to some existing username/password combination. Exactly where this is done depends on which Realm implementation you are using:

Manager Web アプリケーションにアクセスできるようにするには、新規作成したユーザ名/パスワードをロール名 manager と関連づけるか、manager ロールに既存のユーザ名/パスワードを関連づけなければなりません。これを行なう具体的なやり方は、以下の Realm実装のうち、どれを使っているかによって違います。

MemoryRealm - If you have not customized your $CATALINA_HOME/conf/server.xml to select a different one, Tomcat 5 defaults to an XML-format file stored at $CATALINA_HOME/conf/tomcat-users.xml, which can be edited with any text editor. This file contains an XML <user> for each individual user, which might look something like this: <user name="craigmcc" password="secret" roles="standard,manager" /> which defines the username and password used by this individual to log on, and the role names he or she is associated with. You can add the manager role to the comma-delimited roles attribute for one or more existing users, and/or create new users with that assigned role.
JDBCRealm - Your user and role information is stored in a database accessed via JDBC. Add the manager role to one or more existing users, and/or create one or more new users with this role assigned, following the standard procedures for your environment.
JNDIRealm - Your user and role information is stored in a directory server accessed via LDAP. Add the manager role to one or more existing users, and/or create one or more new users with this role assigned, following the standard procedures for your environment.

MemoryRealm - 他のレルムを使うように $CATALINA_HOME/conf/server.xml をカスタマイズしていなければ、 Tomcat 5 はデフォルトでは $CATALINA_HOME/conf/tomcat-users.xml という XML 形式のファイルを使うようになっており、どんなテキストエディタでも編集可能です。このファイルにはユーザごとに <user> という XML が含まれており、以下のような感じになっています。 <user name="craigmcc" password="secret" roles="standard,manager" /> ここではログオンする人が使うユーザ名とパスワード、それにこの人が関連するロール名が定義されています。 manager ロールにコンマ区切りの roles 属性を追加することもできますし、割り当てたこのロールに対して新しいユーザを作成することもできます。またその両方を行なうことも可能です
JDBCRealm - ユーザとロールの情報を JDBC 経由でアクセスするデータベースに保存します。manager ロールを1人以上の既存ユーザに関連づけることもできますし、あなたの環境での標準手順にしたがって、割り当てたこのロールに対して1人以上の新しいユーザを作成することもできます。またその両方を行なうことも可能です。
JNDIRealm - ユーザとロールの情報を LDAP 経由でアクセスするディレクトリサーバに保存します。manager ロールを1人以上の既存ユーザに関連づけることもできますし、あなたの環境での標準手順にしたがって、割り当てたこのロールに対して1人以上の新しいユーザを作成することもできます。またその両方を行なうことも可能です。

The first time you attempt to issue one of the Manager commands described in the next section, you will be challenged to log on using BASIC authentication. The username and password you enter do not matter, as long as they identify a valid user in the users database who possesses the role manager.

次のセクションで記述する Managerコマンドのいずれかを最初に実行する際には、 BASIC認証を使ってログオンしようとします。 manager ロールを所有するユーザデータベース内の妥当なユーザと認証される限り、どのユーザ／パスワードを入力してもかまいません。

In addition to the password restrictions the manager web application could be restricted by the remote IP address or host by adding a RemoteAddrValve or RemoteHostValve. Here is an example of restricting access to the localhost by IP address:

<Context path="/manager" debug="0" privileged="true"
         docBase="/usr/local/kinetic/tomcat5/server/webapps/manager">
         <Valve className="org.apache.catalina.valves.RemoteAddrValve"
                allow="127.0.0.1"/>
</Context>

パスワードによる制限の他に、Manager Webアプリケーションでは RemoteAddrValve や RemoteHostValve を加えることでリモートIPアドレスやホストによる制限をかけられます。アクセスをローカルホストのIPアドレスに制限する例を示します。

<Context path="/manager" debug="0" privileged="true"
         docBase="/usr/local/kinetic/tomcat5/server/webapps/manager">
         <Valve className="org.apache.catalina.valves.RemoteAddrValve"
                allow="127.0.0.1"/>
</Context>

All commands that the Manager application knows how to process are specified in a single request URI like this:

Manager アプリケーションが実行可能なコマンドは全て、以下のような単独のリクエストURIで指定します。:

http://{host}:{port}/manager/{command}?{parameters}

where {host} and {port} represent the hostname and port number on which Tomcat is running, {command} represents the Manager command you wish to execute, and {parameters} represents the query parameters that are specific to that command. In the illustrations below, customize the host and port appropriately for your installation.

ここで {host} と {port} は Tomcat が動作するホスト名とポート番号を、{command} は実行したい Manager コマンドを、{parameters} はコマンド固有の問い合わせパラメータを示します。以下の例を実際に使う時は、インストールに合わせてホストやポートを変えてください。

Most commands accept one or more of the following query parameters:

ほどんどのコマンドでは以下の問い合わせパラメータを1個以上使えます。

path - The context path (including the leading slash) of the web application you are dealing with. To select the ROOT web application, specify a zero-length string. NOTE - It is not possible to perform administrative commands on the Manager application itself.
war - URL of a web application archive (WAR) file, pathname of a directory which contains the web application, or a Context configuration ".xml" file. You can use URLs in any of the following formats:
- file:/absolute/path/to/a/directory - The absolute path of a directory that contains the unpacked version of a web application. This directory will be attached to the context path you specify without any changes.
- file:/absolute/path/to/a/webapp.war - The absolute path of a web application archive (WAR) file. This is valid only for the /deploy command, and is the only acceptable format to that command.
- jar:file:/absolute/path/to/a/warfile.war!/ - The URL to a local web application archive (WAR) file. You can use any syntax that is valid for the JarURLConnection class for reference to an entire JAR file.
- file:/absolute/path/to/a/context.xml - The absolute path of a web application Context configuration ".xml" file which contains the Context configuration element.
- directory - The directory name for the web applciation context in the Host's application base directory.
- webapp.war - The name of a web application war file located in the Host's application base directory.

path - 対象の Webアプリケーションのコンテキストパス (先頭のスラッシュを含む)。ROOT Webアプリケーションの場合は、長さ0の文字列を指定します。注意 - Manager アプリケーション自身の管理コマンドは実行できません。
war - Webアプリケーションアーカイブ (WAR) ファイルのURL、 Webアプリケーションを含むディレクトリのパス名、コンテキスト設定 ".xml" ファイルのいずれか。以下のいずれかの形式で URL を指定できます。
- file:/absolute/path/to/a/directory - Web アプリケーションの展開したバージョンを含むディレクトリのパス。このディレクトリは特に変更することなく、指定したコンテキストパスに追加可能です。
- file:/absolute/path/to/a/webapp.war - Web アプリケーションアーカイブ (WAR) ファイルの絶対パス。 /deploy コマンドでのみ妥当で、このコマンドではこの形式のみサポートします。
- jar:file:/absolute/path/to/a/warfile.war!/ - ローカルの Webアプリケーションアーカイブ (WAR) ファイルの URL。 JAR ファイル全体を参照する JarURLConnection クラスで有効な構文はすべて使用可能です。
- file:/absolute/path/to/a/context.xml - コンテキスト設定要素を含む Webアプリケーションコンテキスト設定 ".xml" ファイルの絶対パス。
- directory - ホストのアプリケーション基準ディレクトリ内にある Webアプリケーションコンテキストのディレクトリ名。
- webapp.war - ホストのアプリケーション基準ディレクトリ内にある Webアプリケーションの WARファイル名。

Each command will return a response in text/plain format (i.e. plain ASCII with no HTML markup), making it easy for both humans and programs to read). The first line of the response wil begin with either OK or FAIL, indicating whether the requested command was successful or not. In the case of failure, the rest of the first line will contain a description of the problem that was encountered. Some commands include additional lines of information as described below.

各コマンドは人・プログラムのどちらでも読みやすいように、text/plain 形式 (HTMLマークアップなしの素のASCII) のレスポンスを返します。レスポンスの1行目は 成功 か 失敗 のどちらかで始まり、リクエストしたコマンドが成功したかどうかを示します。失敗した場合は、 1行目の残りの部分に起こった問題の説明が出力されます。コマンドによっては2行目以降に追加情報 (後述) を出力することもあります。

Internationalization Note - The Manager application looks up its message strings in resource bundles, so it is possible that the strings have been translated for your platform. The examples below show the English version of the messages.

国際化に関する注意 - Manager アプリケーションではリソースバンドル内のメッセージを検索するため、環境によっては文字列が外国語で表示される可能性があります。以下に示す例ではメッセージの日本語バージョンを示します。

原文では「英語バージョン」ですが、メッセージも翻訳しているので「日本語バージョン」と訳し変えています。 http://localhost:8080/manager/deploy?path=/foo

Upload the web application archive (WAR) file that is specified as the request data in this HTTP PUT request, install it into the appBase directory of our corresponding virtual host, and start it on the context path specified by the path request parameter. If no path is specified the directory name or the war file name without the .war extension is used as the path. The application can later be undeployed (and the corresponding application directory removed) by use of the /undeploy.

HTTP PUT リクエストのリクエストデータとして指定した Web アプリケーションアーカイブ (WAR) ファイルをアップロードし、当該仮想ホストの appBase にインストールし、path リクエストパラメータで指定したコンテキストパスで起動します。 path が指定されない場合は、ディレクトリ名または拡張子 (.war) を除いた WAR ファイル名がパスとして使用されます。/undeploy を使うと、このアプリケーションを後で配備解除 (さらに当該アプリケーションディレクトリを削除) できます。

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

.WAR ファイルには、/META-INF/context.xml というコンテキスト設定 XML ファイルの形で Tomcat 固有の配備設定を含めることができます。

URL parameters include:

update: When set to true, any existing update will be undeployed first. The default value is set to false.
tag: Specifying a tag name, this allows associating the deployed webapp with a version number. The application version can be later redeployed when needed using only the tag.
pause: Pause webapps so that incoming connections are not lost during an application update. This option is only used with the update parameter, and its default is false. Note that a large amount of request processors may be used if the amount of incoming requests is large.

URL パラメータは以下の通りです。

update: true と設定すると、同名のコンテキストがある場合に、先に配備解除を行ないます。デフォルト値は false に設定されています。
tag: タグ名を指定することで、配備した Web アプリケーションをバージョン番号と関連づけることができます。tag を使うだけで、アプリケーションのバージョンを後で変えることができます。
pause: アプリケーション更新の間に到着した接続が失われないように、 Web アプリケーションを一時停止します。このオプションは update パラメータが指定された場合にのみ使用可能で、デフォルト値は false です。到着リクエスト数が多い場合は、リクエスト処理量が大きくなるかもしれないのでご注意ください。

NOTE - This command is the logical opposite of the /undeploy command.

注意 - このコマンドは /undeploy コマンドの反対です

If installation and startup is successful, you will receive a response like this:

もしインストールと起動が成功すると、以下のようなレスポンスが返ってきます。

OK - Deployed application at context path /foo 成功 - コンテキストパス /foo でアプリケーションを配備しました

Otherwise, the response will start with FAIL and include an error message. Possible causes for problems include:

そうでなければ、レスポンスは 失敗 で始まるエラーメッセージとなります。問題の原因としては以下のものが考えられます。

Application already exists at path /foo

The context paths for all currently running web applications must be unique. Therefore, you must either remove or undeploy the existing web application using this context path, or choose a different context path for the new one. The update parameter may be specified as a parameter on the URL, with a value of true to avoid this error. In that case, an undeploy will be performed on an existing application before performing the deployment.
Encountered exception

An exception was encountered trying to start the new web application. Check the Tomcat 5 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.
Invalid context path was specified

The context path must start with a slash character, unless you are referencing the ROOT web application -- in which case the context path must be a zero-length string.
No context path was specified
The path parameter is required.

失敗 - アプリケーションは、既にパス /foo に存在します

現在実行中のWebアプリケーションのコンテキストパスは重複してはいけません。したがって、このコンテキストパスを使っている既存のアプリケーションを削除または配備解除するか、別のコンテキストパスにしなければなりません。このエラーを回避するには、URL へのパラメータとして update パラメータを true に指定するという方法もあります。その場合は、配備を行なう前に、既存のアプリケーションに対して配備解除が行なわれます。
失敗 - 例外が発生しました

新しい Webアプリケーションの起動の際に例外が発生しました。詳細については Tomcat 5 のログをチェックする必要がありますが、/WEB-INF/web.xml ファイルの解析での問題か、アプリケーションのイベントリスナーやフィルターの初期化の際にクラスがない可能性が考えられます。
失敗 - 無効なコンテキストパスが指定されました

コンテキストパスはスラッシュで始まらなければなりません。ROOT Webアプリケーションを参照する場合は例外で、この場合はコンテキストパスは長さ0の文字列になります。
コンテキストパスが指定されていません
path パラメータが必要です。

Install and start a new web application, attached to the specified context path (which must not be in use by any other web application). This command is the logical opposite of the /remove command.

(Web アプリケーションで使われていていない) path でコンテキストを指定して、新しい Web アプリケーションをインストール・起動します。このコマンドは /remove コマンドの反対です。

There are a number of different ways the install command can be used.

インストールコマンドの使い方は何通りもあります。

Install a version of a previously deployed webapp

以前に配備したバージョンの Webアプリのインストール

This can be used to deploy a previous version of a web applicaion, which has been deployed using the tag attribute. Note that the work directory for the manager webapp will contain the previously deployed WARs; removing it would make the deployment fail. http://localhost:8080/manager/deploy?path=/footoo&tag=footag

tag 属性を使って配備された以前のバージョンの Webアプリケーションを配備するのに使えます。 manager Webアプリの作業ディレクトリには、以前に配備した WARファイルが入っていますが、それを削除した場合には配備が失敗することにご注意ください。 http://localhost:8080/manager/deploy?path=/footoo&tag=footag

Install a Directory or WAR by URL

URLで指定したディレクトリまたは WARファイルのインストール

Install a web application directory or ".war" file located on the Tomcat server. If no path is specified, the directory name or the war file name without the ".war" extension is used as the path. The war parameter specifies a URL (including the file: scheme) for either a directory or a web application archive (WAR) file. The supported syntax for a URL referring to a WAR file is described on the Javadocs page for the java.net.JarURLConnection class. Use only URLs that refer to the entire WAR file.

Tomcat サーバ上にある Webアプリケーションディレクトリまたは ".war" ファイルをインストールします。path が指定されていない場合は、ディレクトリ名、または WARファイル名から拡張子「.war」をとったものがパスとして使われます。ディレクトリ名や Webアプリケーションアーカイブ (WAR) ファイルについては、 war パラメータで指定します。WARファイル参照 URL でサポートされている構文については、java.net.JarURLConnection クラスの Javadoc ページに記載されています。 WARファイル全体を参照する URL しか使えません。

In this example the web application located in the directory /path/to/foo on the Tomcat server is installed as the web application context named /footoo. http://localhost:8080/manager/deploy?path=/footoo&war=file:/path/to/foo

以下の例では Tomcat サーバの /path/to/foo ディレクトリにある Webアプリケーションを /footoo というコンテキストとしてインストールします。 http://localhost:8080/manager/deploy?path=/footoo&war=file:/path/to/foo

In this example the ".war" file /path/to/bar.war on the Tomcat server is installed as the web application context named /bar. Notice that there is no path parameter so the context path defaults to the name of the web application archive file without the ".war" extension. http://localhost:8080/manager/deploy?war=jar:file:/path/to/bar.war!/

以下の例では Tomcat サーバの /path/to/bar.war にある「.war」ファイルを、/bar というコンテキストの Web アプリケーションとしてインストールします。path パラメータがないので、コンテキストパスはデフォルト値である、Webアプリケーションアーカイブファイル名から拡張子「.war」を取ったものとなることにご注意ください。 http://localhost:8080/manager/deploy?war=jar:file:/path/to/bar.war!/

Install a Directory or War from the Host appBase

ホストの appBase 指定でのディレクトリや WAR ファイルのインストール

Install a web application directory or ".war" file located in your Host appBase directory. If no path is specified the directory name or the war file name without the ".war" extension is used as the path.

ホストの appBaseディレクトリ配下の Webアプリケーションのディレクトリまたは ".war"ファイルをインストールします。path が指定されていない場合は、ディレクトリ名、またはWARファイル名から拡張子".war"を省いた名前がパスとして使われます。

In this example the web application located in a sub directory named foo in the Host appBase directory of the Tomcat server is installed as the web application context named /foo. Notice that there is no path parameter so the context path defaults to the name of the web application directory. http://localhost:8080/manager/deploy?war=foo

以下の例では Tomcatサーバのホストの appBaseディレクトリの下の foo ディレクトリにある Webアプリケーションが /foo という Webアプリケーションコンテキストでインストールされます。 path パラメータが指定されていないので、コンテキストパスはデフォルトの Webアプリケーションのディレクトリ名となっていることに注意して下さい。 http://localhost:8080/manager/deploy?war=foo

In this example the ".war" file bar.war located in your Host appBase directory on the Tomcat server is installed as the web application context named /bartoo. http://localhost:8080/manager/deploy?path=/bartoo&war=bar.war

以下の例では Tomcatサーバのホストの appBaseディレクトリにある bar.war という".war"ファイルが /bartoo という Webアプリケーションコンテキストでインストールされます。 http://localhost:8080/manager/deploy?path=/bartoo&war=bar.war

Install using a Context configuration ".xml" file

コンテキスト設定".xml"ファイルを使ったインストール

If the Host deployXML flag is set to true you can install a web application using a Context configuration ".xml" file and an optional ".war" file or web application directory. The context path is not used when installing a web application using a context ".xml" configuration file.

ホストの deployXML フラグが true の場合、コンテキスト設定 ".xml"ファイルと、オプションで ".war"ファイルまたは Webアプリケーションディレクトリを使って Webアプリケーションをインストールできます。コンテキスト設定".xml"ファイルを使って Webアプリケーションをインストールする際にはコンテキストの path は使われません。

A Context configuration ".xml" file can contain valid XML for a web application Context just as if it were configured in your Tomcat server.xml configuration file. Here is an example: <Context path="/foobar" docBase="/path/to/application/foobar" debug="0">  <ResourceLink name="users" global="UserDatabase" type="org.apache.catalina.UserDatabase"/> </Context>

コンテキスト設定".xml"ファイルには、Tomcat の server.xml で設定するのと同じように妥当な XML を記述できます。以下に例を示します。 <Context path="/foobar" docBase="/path/to/application/foobar" debug="0">  <ResourceLink name="users" global="UserDatabase" type="org.apache.catalina.UserDatabase"/> </Context>

When the optional war parameter is set to the URL for a web application ".war" file or directory it overrides any docBase configured in the context configuration ".xml" file.

オプションですが、 URL に war パラメータで Webアプリケーションの".war"ファイルまたはディレクトリが指定された場合は、コンテキスト設定".xml"ファイルで設定された docBase はすべて上書きされます。

Here is an example of installing an application using a Context configuration ".xml" file. http://localhost:8080/manager/deploy?config=file:/path/context.xml

コンテキスト設定".xml" ファイルを使ってアプリケーションをインストールする例を示します。 http://localhost:8080/manager/deploy?config=file:/path/context.xml

Here is an example of installing an application using a Context configuration ".xml" file and a web application ".war" file located on the server. http://localhost:8080/manager/deploy?config=file:/path/context.xml&war=jar:file:/path/bar.war!/

サーバ上のコンテキスト設定".xml"ファイルと Webアプリケーション ".war"ファイルをインストールする例を示します。 http://localhost:8080/manager/deploy?config=file:/path/context.xml&war=jar:file:/path/bar.war!/

Installation Notes

インストールでの注意事項

If the Host is configured with unpackWARs=true and you install a war file, the war will be unpacked into a directory in your Host appBase directory.

unpackWARs=true という設定のホストで WARファイルをインストールすると、 WARファイルはホストの appBase ディレクトリに展開されます。

If the application war or directory is installed in your Host appBase directory and either the Host is configured with autoDeploy=true or liveDeploy=true, the Context path must match the directory name or war file name without the ".war" extension.

アプリケーションの WARファイルやディレクトリがホストの appBase ディレクトリに配備され、ホストで autoDeploy=true、liveDeploy=true のいずれかに設定されている場合、コンテキストパスはディレクトリ名か、 WARファイル名から拡張子".war"を省いた名前に合致しなければなりません。

For security when untrusted users can manage web applications, the Host deployXML flag can be set to false. This prevents untrusted users from installing web applications using a configuration XML file and also prevents them from installing application directories or ".war" files located outside of their Host appBase.

セキュリティ上の理由から、信頼されないユーザが Webアプリケーションを管理できる場合は、ホストの deployXML フラグは false になっています。これにより、信頼されないユーザは、設定 XML ファイルを使って Webアプリケーションをインストールできないだけでなく、ホストの appBase ディレクトリ配下にないアプリケーションディレクトリや ".war" ファイルのインストールができないようになっています。

Install Response

インストールに対するレスポンス

If installation and startup is successful, you will receive a response like this:

インストールと起動が成功すると、以下のようなレスポンスが返ってきます。

OK - Deployed application at context path /foo 成功 - コンテキストパス /foo にアプリケーションをインストールしました

Otherwise, the response will start with FAIL and include an error message. Possible causes for problems include:

そうでなければ、レスポンスは 失敗 で始まるエラーメッセージとなります。問題の原因としては以下のものが考えられます。

Application already exists at path /foo

The context paths for all currently running web applications must be unique. Therefore, you must either remove or undeploy the existing web application using this context path, or choose a different context path for the new one. The update parameter may be specified as a parameter on the URL, with a value of true to avoid this error. In that case, an undeploy will be performed on an existing application before performing the deployment.
Document base does not exist or is not a readable directory

The URL specified by the war parameter must identify a directory on this server that contains the "unpacked" version of a web application, or the absolute URL of a web application archive (WAR) file that contains this application. Correct the value specified by the war parameter.
Encountered exception

An exception was encountered trying to start the new web application. Check the Tomcat 5 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.
Invalid application URL was specified

The URL for the directory or web application that you specified was not valid. Such URLs must start with file:, and URLs for a WAR file must end in ".war".
Invalid context path was specified

The context path must start with a slash character, unless you are referencing the ROOT web application -- in which case the context path must be a "/" string.
Context path must match the directory or WAR file name:
If the application war or directory is installed in your Host appBase directory and either the Host is configured with autoDeploy=true or liveDeploy=true, the Context path must match the directory name or war file name without the ".war" extension.
Only web applications in the Host web application directory can be installed
If the Host deployXML flag is set to false this error will happen if an attempt is made to install a web application directory or ".war" file outside of the Host appBase directory.

アプリケーションは、既にパス /foo に存在します

現在動作している Webアプリケーションのコンテキストパスはすべて一意でなければなりません。したがって、このコンテキストパスを使っている既存の Webアプリケーションを配備解除するか、別のコンテキストパスにしなければなりません。URL で update パラメータに true を指定すれば、このエラーを回避できます。その場合、配備の前に既存のアプリケーションの配備解除が行なわれます。
ドキュメントベースが存在しない、又は読めないディレクトリです

war パラメータでで指定する URL は Webアプリケーションの「展開済み」バージョンを含んだこのサーバのディレクトリか、このアプリケーションを含む Webアプリケーションアーカイブ (WAR) ファイルの絶対 URL でなければなりません。war パラメータでに正しい値を指定してください。
例外が発生しました

Webアプリケーション起動時に例外が発生しました。詳細については Tomcat 5 のログをチェックする必要がありますが、/WEB-INF/web.xml 解析エラーや、アプリケーションイベントリスナやフィルタの初期化時にクラスが見つからなかった可能性もあります。
無効なアプリケーションのURLが指定されました

指定したディレクトリまたは Webアプリケーションの URL が妥当でありません。この URL は file: で始まらなければならず、 WARファイルの URL の場合、".war" で終わらなければなりません。
無効なコンテキストパスが指定されました

コンテキストパスはスラッシュ ("/") で始まらなければなりません。 ROOT Webアプリケーションを参照している場合は例外です -- この場合は、コンテキストパスは長さ0の文字列になります。
コンテキストパスはディレクトリ又はWARファイル名に一致しなければいけません:
ホストの appBase ディレクトリにアプリケーションの WARファイルやディレクトリが配備され、ホストで autoDeploy=true、 liveDeploy=true のどちらかの設定があった場合、コンテキストパスはディレクトリ名か、 WARファイル名から拡張子".war"を省いた名前に合致しなければなりません。
ホストWebアプリケーションディレクトリ中のWebアプリケーションだけがインストールできます
ホストの deployXML フラグが false になっていて、ホストの appBase ディレクトリ以外の場所に Webアプリケーションディレクトリや ".war" ファイルをインストールしようとするとこのエラーが発生します。

http://localhost:8080/manager/list

List the context paths, current status (running or stopped), and number of active sessions for all currently deployed and installed web applications. A typical response immediately after starting Tomcat might look like this:

現在配備・インストールされている Webアプリケーションすべてについて、コンテキストパスと現在のステータス (running または stopped)、アクティブなセッション数を一覧表示します。Tomcat 起動直後の場合、通常は以下のようなレスポンスを返します。

OK - Listed applications for virtual host localhost /webdav:running:0 /examples:running:0 /manager:running:0 /:running:0 成功 - バーチャルホスト localhost のアプリケーション一覧です /webdav:running:0 /examples:running:0 /manager:running:0 /:running:0 http://localhost:8080/manager/reload?path=/examples

Signal an existing application to shut itself down and reload. This can be useful when the web application context is not reloadable and you have updated classes or property files in the /WEB-INF/classes directory or when you have added or updated jar files in the /WEB-INF/lib directory.

既存のアプリケーションにシャットダウンと再ロードを指示します。 Webアプリケーションコンテキストが再ロード可能になっていなくて /WEB-INF/classes のクラスやプロパティファイルを更新した場合や、 /WEB-INF/lib ディレクトリの JARファイルを更新した場合に便利かもしれません。

NOTE: The /WEB-INF/web.xml web application configuration file is not reread on a reload. If you have made changes to your web.xml file you must stop then start the web application.

注意: /WEB-INF/web.xml の Webアプリケーション設定ファイルは再ロード時にチェックされず、以前の web.xml の設定が使われます。web.xml ファイルを変更した場合は、 Webアプリケーションを停止・起動しなければなりません

If this command succeeds, you will see a response like this:

このコマンドが成功すると、以下のようなレスポンスが返ってきます。

OK - Reloaded application at context path /examples OK - コンテキストパス /examples のアプリケーションを再ロードしました

Otherwise, the response will start with FAIL and include an error message. Possible causes for problems include:

そうでなければ、レスポンスは 失敗 で始まるエラーメッセージとなります。問題の原因としては以下のものが考えられます。

Encountered exception

An exception was encountered trying to restart the web application. Check the Tomcat 5 logs for the details.
Invalid context path was specified

The context path must start with a slash character, unless you are referencing the ROOT web application -- in which case the context path must be a zero-length string.
No context exists for path /foo

There is no deployed or installed application on the context path that you specified.
No context path was specified
The path parameter is required.
Reload not supported on WAR deployed at path /foo
Currently, application reloading (to pick up changes to the classes or web.xml file) is not supported when a web application is installed directly from a WAR file. It only works when the web application is installed from an unpacked directory. If you are using a WAR file, you should remove and then install the application again to pick up your changes.

例外が発生しました

Webアプリケーションの起動時に例外が発生しました。詳細については Tomcat 5 のログをチェックして下さい。
無効なコンテキストパスが指定されました

コンテキストパスはスラッシュ ("/") で始まらなければなりません。 ROOT Webアプリケーションを参照している場合は例外です -- この場合は、コンテキストパスは長さ0の文字列になります。
パス /foo のコンテキストが存在しません

指定したコンテキストのアプリケーションは配備されていません。
コンテキストパスが指定されていません
path パラメータが必要です。
パス /foo に配備されたWARファイルでは再ロードがサポートされていません
Webアプリケーションが WARファイルから直接インストールされた場合は、現在のところ、アプリケーションの再ロード (クラスや web.xml ファイルの変更の反映) はサポートされません。再ロードはアーカイブされていないディレクトリから Webアプリケーションがインストールされた場合のみ有効です。 WARファイルを使う場合、アプリケーションに変更を反映させるには、 配備解除 した上で再度 配備 しなければなりません。

http://localhost:8080/manager/serverinfo

Lists information about the Tomcat version, OS, and JVM properties.

Tomcat のバージョン、OS、JVM プロパティに関する情報を一覧表示します。

If an error occurs, the response will start with FAIL and include an error message. Possible causes for problems include:

エラーが発生した場合、レスポンスは失敗 で始まり、エラーメッセージが表示されます。問題の原因としては以下のものが考えられます。

Encountered exception

An exception was encountered trying to enumerate the system properties. Check the Tomcat 5 logs for the details.

例外が発生しました

Webアプリケーションの起動時に例外が発生しました。詳細については Tomcat 5 のログをチェックして下さい。

http://localhost:8080/manager/resources[?type=xxxxx]

List the global JNDI resources that are available for use in resource links for context configuration files. If you specify the type request parameter, the value must be the fully qualified Java class name of the resource type you are interested in (for example, you would specify javax.sql.DataSource to acquire the names of all available JDBC data sources). If you do not specify the type request parameter, resources of all types will be returned.

コンテキスト設定ファイルのリソースリンクで使用可能なグローバル JNDI リソースを一覧表示します。type リクエストパラメータを指定する場合、その値は使用したいリソースタイプの完全修飾 Java クラス名でなければなりません (例えば、使用可能なJDBC データソース名をすべて取得したい場合は、 javax.sql.DataSource と指定します)。type リクエストパラメータを指定しない場合は、すべてのリソースタイプが返されます。

Depending on whether the type request parameter is specfied or not, the first line of a normal response will be:

type リクエストパラメータが指定されていない場合、正常なレスポンスの1行目は以下のようになります。

  OK - Listed global resources of all types

  成功 - すべてのタイプのグローバルリソースを列挙しました

指定された場合は以下のようになります。

  OK - Listed global resources of type xxxxx

  成功 - タイプ xxxxx のグローバルリソースを列挙しました

followed by one line for each resource. Each line is composed of fields delimited by colon characters (":"), as follows:

続いて各リソースが1行ずつ表示されます。各行ではコロン (":") 区切りで以下の項目が表示されます

Global Resource Name - The name of this global JNDI resource, which would be used in the global attribute of a <ResourceLink> element.
Global Resource Type - The fully qualified Java class name of this global JNDI resource.

グローバルリソース名 - グローバル JNDI リソース名。 <ResourceLink> 要素の global 属性で使われます。
グローバルリソースタイプ - グローバル JNDI リソースの完全修飾 Java クラス名

If an error occurs, the response will start with FAIL and 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 5 logs for the details.
No global JNDI resources are available

The Tomcat server you are running has been configured without global JNDI resources.

例外が発生しました

Webアプリケーションの起動時に例外が発生しました。詳細については Tomcat 5 のログをチェックして下さい。
失敗 - グローバルなJNDIリソースが利用できません

この Tomcat サーバではグローバル JNDI リソースが使えないように設定されています。

http://localhost:8080/manager/roles

List the security role names (and corresponding descriptions) that are available in the org.apache.catalina.UserDatabase resource that is linked to the users resource reference in the web.xml file for the Manager web application. This would typically be used, for example, by a deployment tool that wanted to create <security-role-ref> elements to map security role names used in a web application to the role names actually defined within the container.

Manager Webアプリケーションの web.xml ファイルの users リソース参照にリンクした org.apache.catalina.UserDatabase リソースで使用可能なセキュリティロール名 (とその説明) を一覧表示します。例えば Webアプリケーションで使用されているセキュリティロール名と、コンテナで実際に定義されているロール名とを対応付ける <security-role-ref> 要素を作成する配備ツールで使えます。

By default, the users resource reference is pointed at the global UserDatabase resource. If you choose to utilize a different user database per virtual host, you should modify the <ResourceLink> element in the default manager.xml context configuration file to point at the global user database resource for this virtual host.

デフォルトでは、users リソース参照はグローバルな UserDatabase リソースを参照します。仮想ホストごとに別のユーザデータベースを使うことにする場合は、デフォルトの manager.xml コンテキスト設定ファイルの <ResourceLink> 要素を、この仮想ホスト用のグローバルなユーザデータベースのリソースを参照するように変更しなければなりません。

When this command is executed, the first line of the response will be:

このコマンドが実行された場合、レスポンスの1行目は以下のようになります。

When this command is executed, the first line of the response will be:

  OK - Listed security roles

  成功 - セキュリティロールを列挙しました

followed by one line for each security role. Each line is composed of fields delimited by colon characters (":") as follows:

続いて各セキュリティロールが1行ずつ表示されます。各行ではコロン (":") 区切りで以下の項目が表示されます

Security Role Name - A security role name that is known to Tomcat in the user database.
Description - Description of this security role (useful in creating user interfaces for selecting roles.

セキュリティロール名 - ユーザデータベースで Tomcat 認識しているセキュリティロール名。
説明 - このセキュリティロールの説明 (ロールを選択するユーザインタフェースを作成する場合に便利です)。

If an error occurs, the response will start with FAIL and include an error message. Possible causes for problems include:

エラーが発生した場合、レスポンスは失敗 で始まり、エラーメッセージが表示されます。問題の原因としては以下のものが考えられます。

Cannot resolve user database reference - A JNDI error prevented the successful lookup of the org.apache.catalina.UserDatabase resource. Check the Tomcat log files for a stack trace associated with this error.
No user database is available - You have not configured a resource reference for the users resource that points at an appropriate user database instance. Check your manager.xml file and ensure that you have created an appropriate <ResourceLink> or <ResourceParams> element for this resource.

失敗 - ユーザデータベース参照を解決できません - org.apache.catalina.UserDatabase リソースでの検索が失敗した場合の JNDI エラーです。Tomcat ログファイルで、このエラーに関連するスタックトレースをチェックして下さい。
失敗 - ユーザデータベースが利用できません - users リソース参照が正しいユーザデータベースのインスタンスを参照するように設定できていません。 manager.xml ファイルをチェックし、このリソースについて <ResourceLink> または <ResourceParams> 要素が正しいか確認して下さい。

http://localhost:8080/manager/sessions?path=/examples

Display the default session timeout for a web application, and the number of currently active sessions that fall within ten-minute ranges of their actual timeout times. For example, after restarting Tomcat and then executing one of the JSP samples in the /examples web app, you might get something like this:

Webアプリケーションのデフォルトのセッションタイムアウトと、現在アクティブなセッション数を実際のタイムアウト時間を基準に10分単位にグループ化して表示します。例えば、Tomcat を再起動し、/examples Webアプリの JSP サンプルの1つを実行した場合、以下のようになるでしょう。

OK - Session information for application at context path /examples Default maximum session inactive interval 30 minutes 30 - <40 minutes:1 sessions 成功 - コンテキストパス /examples のアプリケーションのセッション情報ですデフォルトの最大セッション停止間隔は30分です 30 - <40 分: 1 セッション http://localhost:8080/manager/start?path=/examples

Signal a stopped application to restart, and make itself available again. Stopping and starting is useful, for example, if the database required by your application becomes temporarily unavailable. It is usually better to stop the web application that relies on this database rather than letting users continuously encounter database exceptions.

停止したアプリケーションに再起動を指示し、再び使用可能にします。例えば、アプリケーションで必要なデータベースが一時的に使用不可になった場合、停止・起動ができると便利です。たいていの場合、このデータベースを使う Webアプリケーションを停止させた方が、ユーザに対してデータベース例外を表示し続けるよりは良いでしょう。

If this command succeeds, you will see a response like this:

このコマンドが成功すると、以下のようなレスポンスが返ってきます。

OK - Started application at context path /examples 成功 - コンテキストパス /examples でアプリケーションを起動しました

Otherwise, the response will start with FAIL and include an error message. Possible causes for problems include:

そうでなければ、レスポンスは 失敗 で始まるエラーメッセージとなります。問題の原因としては以下のものが考えられます。

Encountered exception

An exception was encountered trying to start the web application. Check the Tomcat 5 logs for the details.
Invalid context path was specified

The context path must start with a slash character, unless you are referencing the ROOT web application -- in which case the context path must be a zero-length string.
No context exists for path /foo

There is no deployed or installed application on the context path that you specified.
No context path was specified
The path parameter is required.

例外が発生しました

Webアプリケーションの起動時に例外が発生しました。詳細については Tomcat 5 のログをチェックして下さい。
無効なコンテキストパスが指定されました

コンテキストパスはスラッシュ ("/") で始まらなければなりません。 ROOT Webアプリケーションを参照している場合は例外です -- この場合は、コンテキストパスは長さ0の文字列になります。
パス /foo のコンテキストが存在しません

指定したコンテキストのアプリケーションは配備されていません。
コンテキストパスが指定されていません
path パラメータが必要です。

http://localhost:8080/manager/stop?path=/examples

Signal an existing application to make itself unavailable, but leave it deployed or installed. Any request that comes in while an application is stopped will see an HTTP error 404, and this application will show as "stopped" on a list applications command.

既存のアプリケーションを使用不可にするよう指示しますが、配備解除はしません。アプリケーションが停止している時に送られたリクエストの結果はすべて、 HTTPエラー404となり、このアプリケーションは「アプリケーション一覧」コマンドでは "stopped"と表示されます。

実際にブラウザで表示した場合、0バイトのレスポンスが返っているらしく、何も表示されません。

If this command succeeds, you will see a response like this:

OK - Stopped application at context path /examples

このコマンドが成功すると、以下のようなレスポンスが返ってきます。

成功 - コンテキストパス /examples でアプリケーションを停止しました

Otherwise, the response will start with FAIL and include an error message. Possible causes for problems include:

そうでなければ、レスポンスは 失敗 で始まるエラーメッセージとなります。問題の原因としては以下のものが考えられます。

Encountered exception

An exception was encountered trying to stop the web application. Check the Tomcat 5 logs for the details.
Invalid context path was specified

The context path must start with a slash character, unless you are referencing the ROOT web application -- in which case the context path must be a zero-length string.
No context exists for path /foo

There is no deployed or installed application on the context path that you specified.
No context path was specified
The path parameter is required.

例外が発生しました

Webアプリケーションの起動時に例外が発生しました。詳細については Tomcat 5 のログをチェックして下さい。
無効なコンテキストパスが指定されました

コンテキストパスはスラッシュ ("/") で始まらなければなりません。 ROOT Webアプリケーションを参照している場合は例外です -- この場合は、コンテキストパスは長さ0の文字列になります。
パス /foo のコンテキストが存在しません

指定したコンテキストのアプリケーションは配備されていません。
コンテキストパスが指定されていません
path パラメータが必要です。

http://localhost:8080/manager/undeploy?path=/examples

WARNING - This command will delete the contents of the web application directory if it exists within the appBase directory (typically "webapps") for this virtual host . This will also delete the source .WAR if expanding occurred, as well as the XML Context definition. If you simply want to take an application out of service, you should use the /stop command instead.

警告 - このコマンドによって、この仮想ホストの appBase ディレクトリ (通常は"webapps") 内に存在する Webアプリケーションディレクトリの中身や".war"ファイル、あるいはその両方が削除されます。 Webアプリケーションの一時的なワークディレクトリも削除されます。アプリケーションのサービスを休止したいだけなら、代わりに /stop コマンドを使うべきです。

Signal an existing application to gracefully shut itself down, and remove it from Tomcat (which also makes this context path available for reuse later). In addition, the document root directory is removed, if it exists in the appBase directory (typically "webapps") for this virtual host. This command is the logical opposite of the /deploy command.

既存のアプリケーションを緩やかに (gracefully) シャットダウンし、 Tomcat から削除するよう指示します (またこれによって、このコンテキストパスは後で再利用可能となります)。さらに、ドキュメントルートディレクトリが、この仮想ホストの appBase ディレクトリ (通常は"webapps") 内に存在する場合、そのディレクトリも削除されます。このコマンドは /deploy コマンドの反対です。

If this command succeeds, you will see a response like this:

このコマンドが成功すると、以下のようなレスポンスが返ってきます。

OK - Undeployed application at context path /examples 成功 - コンテキストパス /examples のアプリケーションを配備解除しました

Otherwise, the response will start with FAIL and include an error message. Possible causes for problems include:

そうでなければ、レスポンスは 失敗 で始まるエラーメッセージとなります。問題の原因としては以下のものが考えられます。

Encountered exception

An exception was encountered trying to undeploy the web application. Check the Tomcat 5 logs for the details.
Invalid context path was specified

The context path must start with a slash character, unless you are referencing the ROOT web application -- in which case the context path must be a zero-length string.
No context exists for path /foo

There is no deployed or installed application on the context path that you specified.
No context path was specified
The path parameter is required.

例外が発生しました

Webアプリケーションの起動時に例外が発生しました。詳細については Tomcat 5 のログをチェックして下さい。
無効なコンテキストパスが指定されました

コンテキストパスはスラッシュ ("/") で始まらなければなりません。 ROOT Webアプリケーションを参照している場合は例外です -- この場合は、コンテキストパスは長さ0の文字列になります。
パス /foo のコンテキストが存在しません

指定したコンテキストのアプリケーションは配備・インストールされていません。
コンテキストパスが指定されていません
path パラメータが必要です。

In addition to the ability to execute Manager commands via HTTP requests, as documented above, Tomcat 5 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:

ここまでで説明した HTTP リクエストによる Manager コマンド実行の他に、 Tomcat 5 ではビルドツールの Ant (バージョン1.4以降) 用の便利なタスク定義を用意しています。これらのコマンドを使うためには、以下のセットアップを行なわなければなりません。

Download the binary distribution of Ant from http://jakarta.apache.org/ant. 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 5 installation into Ant's library directory ($ANT_HOME/lib).
Add the $ANT_HOME/bin directory to your PATH environment variable.
Configure at least one username/password combination in your Tomcat user database that includes the manager role.

Ant のバイナリ配布を http://ant.apache.org/ からダウンロードします。バージョン1.4以降を使用しなければなりません。
適当なディレクトリに Ant 配布をインストールします (以下の説明では、このディレクトリを $ANT_HOME と記述します).
server/lib/catalina-ant.jar ファイルを Tomcat 5 のインストールディレクトリから Ant のライブラリディレクトリ ($ANT_HOME/lib) にコピーします。
PATH 環境変数に $ANT_HOME/bin を加えます。
Tomcat のユーザデータベースで manager ロールを持つ username/password の組み合わせを1種類以上設定します。

訳についてはAntのURLを最新化しました。

To use custom tasks within Ant, you must declare them first with a <taskdef> element. Therefore, your build.xml file might look something like this:

Ant でカスタムタスクを使うには、最初に <taskdef> 要素を宣言しなければなりません。したがって build.xml の内容は以下のような感じになるでしょう。

<project name="My Application" default="compile" basedir=".">

  <!-- Configure the directory into which the web application is built -->
  <property name="build"    value="${basedir}/build"/>

  <!-- Configure the context path for this application -->
  <property name="path"     value="/myapp"/>

  <!-- Configure properties to access the Manager application -->
  <property name="url"      value="http://localhost:8080/manager"/>
  <property name="username" value="myusername"/>
  <property name="password" value="mypassword"/>

  <!-- Configure the custom Ant tasks for the Manager application -->
  <taskdef name="deploy"    classname="org.apache.catalina.ant.DeployTask"/>
  <taskdef name="list"      classname="org.apache.catalina.ant.ListTask"/>
  <taskdef name="reload"    classname="org.apache.catalina.ant.ReloadTask"/>
  <taskdef name="resources" classname="org.apache.catalina.ant.ResourcesTask"/>
  <taskdef name="roles"     classname="org.apache.catalina.ant.RolesTask"/>
  <taskdef name="start"     classname="org.apache.catalina.ant.StartTask"/>
  <taskdef name="stop"      classname="org.apache.catalina.ant.StopTask"/>
  <taskdef name="undeploy"  classname="org.apache.catalina.ant.UndeployTask"/>

  <!-- Executable Targets -->
  <target name="compile" description="Compile web application">
    <!-- ... construct web application in ${build} subdirectory ... -->
  </target>

  <target name="deploy" description="Install web application"
          depends="compile">
    <deploy url="${url}" username="${username}" password="${password}"
            path="${path}" war="file://${build}"/>
  </target>

  <target name="reload" description="Reload web application"
          depends="compile">
    <reload  url="${url}" username="${username}" password="${password}"
            path="${path}"/>
  </target>

  <target name="undeploy" description="Remove web application">
    <remove url="${url}" username="${username}" password="${password}"
            path="${path}"/>
  </target>

</project>

<project name="My Application" default="compile" basedir=".">

  <!-- Webアプリケーションをビルドするディレクトリを設定します -->
  <property name="build"    value="${basedir}/build"/>

  <!-- このアプリケーションのコンテキストパスを設定します -->
  <property name="path"     value="/myapp"/>

  <!-- Manager アプリケーションにアクセスするプロパティを設定します -->
  <property name="url"      value="http://localhost:8080/manager"/>
  <property name="username" value="myusername"/>
  <property name="password" value="mypassword"/>

  <!-- Manager アプリケーション用のカスタム Ant タスクを設定します -->
  <taskdef name="deploy"    classname="org.apache.catalina.ant.DeployTask"/>
  <taskdef name="list"      classname="org.apache.catalina.ant.ListTask"/>
  <taskdef name="reload"    classname="org.apache.catalina.ant.ReloadTask"/>
  <taskdef name="resources" classname="org.apache.catalina.ant.ResourcesTask"/>
  <taskdef name="roles"     classname="org.apache.catalina.ant.RolesTask"/>
  <taskdef name="start"     classname="org.apache.catalina.ant.StartTask"/>
  <taskdef name="stop"      classname="org.apache.catalina.ant.StopTask"/>
  <taskdef name="undeploy"  classname="org.apache.catalina.ant.UndeployTask"/>

  <!-- 実行可能ターゲット -->
  <target name="compile" description="Webアプリケーションのコンパイル">
    <!-- ... ${build} サブディレクトリで Webアプリケーションを構築 ... -->
  </target>

  <target name="deploy" description="Webアプリケーションのインストール"
          depends="compile">
    <deploy url="${url}" username="${username}" password="${password}"
            path="${path}" war="file://${build}"/>
  </target>

  <target name="reload" description="Webアプリケーションのリロード"
          depends="compile">
    <reload  url="${url}" username="${username}" password="${password}"
            path="${path}"/>
  </target>

  <target name="undeploy" description="Webアプリケーションの削除">
    <remove url="${url}" username="${username}" password="${password}"
            path="${path}"/>
  </target>

</project>

Now, you can execute commands like ant deploy to deploy the applcation to a running instance of Tomcat, or ant reload to tell Tomcat to reload it. Note also that most of the interesting values in this build.xml file are defined as replaceable properties, so you can override their values from the command line. For example, you might consider it a security risk to include the real manager password in your build.xml file's source code. To avoid this, omit the password property, and specify it from the command line:

これで、Tomcatの実行中のインスタンスに対してアプリケーションを配備するのに ant deploy というコマンドを実行したり、Tomcat にリロードを指示するのに ant reload コマンドを実行できます。注意：この build.xml の重要な値のほとんどは置換可能なプロパティとして定義されています。したがって、これらの値はコマンドラインで上書きできます。例えば、 build.xml ファイルのソースコードに実際の manager ロールを持つユーザーのパスワードを記述するのは、セキュリティ上リスクがあると思うかもしれません。それを回避するには、password プロパティに値を指定せずに、コマンドラインで以下のように指定します。

real manager passwordあたりは補足して訳しました。

  ant -Dpassword=secret deploy

The JMX Proxy Servlet is a lightweight proxy to get and set the tomcat internals. (Or any class that has been exposed via an MBean) Its usage is not very user friendly but the UI is extremely help for integrating command line scripts for monitoring and changing the internals of tomcat. You can do two things with the proxy: get information and set information. For you to really understand the JMX Proxy Servlet, you should have a general understanding of JMX. If you don't know what JMX is, then prepare to be confused. JMXプロキシサーブレットは　Tomcat の内部変数の取得・設定を行なう軽量のプロキシです (MBean で公開しているクラスの取得・設定も可能です)。使い方はあまりわかりやすくありませんが、このユーザインタフェースは、コマンドラインのスクリプトで Tomcat の内部変数を監視・変更できるようにするのに極めて役立ちます。プロキシでは、情報の取得と設定ができます。 JMX プロキシサーブレットを正しく理解するためには、 JMX (Java Management Extensions) の概要を理解しておく必要があります。 JMX が何かご存知ない方はわかりにくいと思いますがご了承下さい。原文にはありませんがSunのJMXページへのリンクをつけておきました。 This takes the form: 以下のような形式となります。 http://webserver/manager/jmxproxy/?qry=STUFF Where STUFF is the JMX query you wish to perform. For example, here are some queries you might wish to run: ここで STUFF は実行したい JMX クエリ (問い合わせ) を指します。例えば、以下のようなクエリを実行できます。

qry=*%3Atype%3DRequestProcessor%2C* --> type=RequestProcessor which will locate all workers which can process requests and report their state.
qry=*%3Aj2eeType=Servlet%2c* --> j2eeType=Servlet which return all loaded servlets.
qry=Catalina%3Atype%3DEnvironment%2Cresourcetype%3DGlobal%2Cname%3DsimpleValue --> Catalina:type=Environment,resourcetype=Global,name=simpleValue which look for a specific MBean by the given name.

qry=*%3Atype%3DRequestProcessor%2C* --> type=RequestProcessor は、リクエスト処理可能なすべてのワーカを見つけ、状態を表示します。
qry=*%3Aj2eeType=Servlet%2c* --> j2eeType=Servlet は、ロードされたすべてサーブレットを表示します。
qry=Catalina%3Atype%3DEnvironment%2Cresourcetype%3DGlobal%2Cname%3DsimpleValue --> Catalina:type=Environment,resourcetype=Global,name=simpleValue は、指定した名前の MBean を検索します。

You'll need to experiment with this to really understand its capabilites. If you provide no qry parameter, then all of the MBeans will be displayed. We really recommend looking at the tomcat source code and understand the JMX spec to get a better understanding of all the queries you may run. こうしたクエリでできることを本当に理解するためには、実際に試してみる必要があります。 qry パラメータを指定しない場合、すべての MBean が表示されます。実際のところ、実行可能なクエリをすべて理解するには、 Tomcatのソースコードを読み、JMX 仕様を理解することをお薦めします。 Now that you can query an MBean, its time to muck with Tomcat's internals! The general form of the set command is : MBeanのクエリができるようになったら、こんどは Tomcat の内部変数を変えてみましょう。設定コマンドの通常の形式は以下の通りです。 http://webserver/manager/jmxproxy/?set=BEANNAME&att=MYATTRIBUTE&val=NEWVALUE So you need to provide 3 request parameters:

set: The full bean name
att: The attribute you wish to alter
val: The new value

したがって、以下の3種類のリクエストパラメータを指定する必要があります。

set: Beanのフルネーム
att: 変更したい属性
val: 変更後の値

If all goes ok, then it will say OK, otherwise an error message will be shown. For example, lets say we wish to turn up debugging on the fly for the ErrorReportValve. The following will set debugging to 10. すべてうまく行けば「成功」と出ますし、そうでなければエラーメッセージが出ます。例えば実行中にErrorReportValve のデバッグ詳細レベルを上げたいとします。以下のコマンドでデバッグ詳細レベルが10に設定されます。 http://localhost:8080/manager/jmxproxy/ ?set=Catalina%3Atype%3DValve%2Cname%3DErrorReportValve%2Chost%3Dlocalhost&att=debug&val=10 and my result is (YMMV): 実行結果は例えば以下のようになります (環境によって異なります)。 Result: ok Here is what I see if I pass in a bad value. Here is the URL I used, I try set debugging equal to 'cowbell': 次に誤った値を指定した場合の例を示します。デバッグ詳細レベルに「cowbell」と指定してみましょう。 http://localhost:8080/manager/jmxproxy/ ?set=Catalina%3Atype%3DValve%2Cname%3DErrorReportValve%2Chost%3Dlocalhost&att=debug&val=cowbell When I try that, my result is 実行結果は例えば以下のようになります。 Error: java.lang.NumberFormatException: For input string: "cowbell"