Apache Tomcat 10

ほとんどのコマンドは、次のクエリパラメータの1つ以上を受け入れます。

• path - 対象のウェブアプリケーションのコンテキストパス（先頭のスラッシュを含む）。ROOTウェブアプリケーションを選択するには、「/」を指定します。
  注記：マネージャアプリケーション自体に対して管理コマンドを実行することはできません。
  注記：pathパラメータが明示的に指定されていない場合、pathとversionは、configパラメータから、またはconfigパラメータが存在しない場合はwarパラメータから、標準のコンテキスト命名ルールを使用して導出されます。
• version - 並列展開機能で使用されるこのウェブアプリケーションのバージョン。並列展開を使用する場合は、pathが必要な場所でpathに加えてversionを指定する必要があり、一意でなければならないのはpathだけではありません、pathとversionの組み合わせです。
  注記：pathが明示的に指定されていない場合、versionパラメータは無視されます。
• war - ウェブアプリケーションアーカイブ（WAR）ファイルのURL、またはウェブアプリケーションを含むディレクトリのパス名、またはコンテキスト設定「.xml」ファイル。次のいずれかの形式のURLを使用できます。
  • file:/absolute/path/to/a/directory - 展開済みのウェブアプリケーションを含むディレクトリの絶対パス。このディレクトリは、変更を加えることなく、指定したコンテキストパスにアタッチされます。
  • file:/absolute/path/to/a/webapp.war - ウェブアプリケーションアーカイブ（WAR）ファイルの絶対パス。これは/deployコマンドの場合にのみ有効であり、そのコマンドで許容される唯一の形式です。
  • file:/absolute/path/to/a/context.xml - コンテキスト設定要素を含むウェブアプリケーションコンテキスト設定「.xml」ファイルの絶対パス。
  • directory - ホストのアプリケーションベースディレクトリ内のウェブアプリケーションコンテキストのディレクトリ名。
  • webapp.war - ホストのアプリケーションベースディレクトリにあるウェブアプリケーションwarファイルの名前。

各コマンドはtext/plain形式（つまり、HTMLマークアップのないプレーンASCII）で応答を返します。これにより、人間とプログラムの両方で読みやすくなります。応答の最初の行はOKまたはFAILで始まり、要求されたコマンドが成功したかどうかを示します。失敗した場合、最初の行の残りの部分には発生した問題の説明が含まれます。以下のように、追加の情報を含むコマンドもあります。

国際化に関する注記 - マネージャアプリケーションはメッセージ文字列をリソースバンドルで検索するため、プラットフォームに合わせて文字列が翻訳されている可能性があります。以下の例は、メッセージの英語バージョンを示しています。

http://localhost:8080/manager/text/deploy?path=/foo

このHTTP PUTリクエストで要求データとして指定されたウェブアプリケーションアーカイブ（WAR）ファイルのアップロードを行い、対応する仮想ホストのappBaseディレクトリにインストールして起動し、指定されたパスからappBaseに追加されたWARファイルの名前を導出します。アプリケーションは後で/undeployコマンドを使用してアンデプロイ（および対応するWARファイルの削除）できます。

このコマンドはHTTP PUTリクエストによって実行されます。

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

URLパラメータには以下が含まれます。

• update：trueに設定すると、既存の更新は最初にアンデプロイされます。デフォルト値はfalseに設定されています。
• tag：タグ名を指定すると、展開されたウェブアプリをタグまたはラベルに関連付けることができます。ウェブアプリケーションがアンデプロイされた場合、後で必要に応じてタグのみを使用して再デプロイできます。
• config：コンテキスト設定「.xml」ファイルのURL。形式はfile:/absolute/path/to/a/context.xmlです。これは、コンテキスト設定要素を含むウェブアプリケーションコンテキスト設定「.xml」ファイルの絶対パスである必要があります。

注記 - このコマンドは/undeployコマンドの論理的な反対です。

インストールと起動が成功すると、次のような応答を受け取ります。

OK - Deployed application at context path /foo

それ以外の場合は、応答はFAILで始まり、エラーメッセージが含まれます。問題の考えられる原因には以下が含まれます。

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

  現在実行中のすべてのウェブアプリケーションのコンテキストパスは一意である必要があります。そのため、このコンテキストパスを使用して既存のウェブアプリケーションをアンデプロイするか、新しいアプリケーションに別のコンテキストパスを選択する必要があります。このエラーを回避するには、URLのパラメータとしてupdateパラメータをtrueの値で指定できます。その場合、展開を実行する前に既存のアプリケーションに対してアンデプロイが実行されます。

• 例外が発生しました。

  新しいウェブアプリケーションの起動中に例外が発生しました。詳細についてはTomcatログを確認してください。考えられる原因としては、/WEB-INF/web.xmlファイルの解析の問題、またはアプリケーションイベントリスナーとフィルタの初期化時に発生したクラスの欠落などがあります。

新しいウェブアプリケーションを展開して起動します。指定されたコンテキストpath（他のウェブアプリケーションで使用されていないもの）にアタッチされます。このコマンドは/undeployコマンドの論理的な反対です。

このコマンドはHTTP GETリクエストによって実行されます。展開コマンドを使用できる方法はいくつかあります。

http://localhost:8080/manager/text/deploy?path=/footoo&tag=footag

http://localhost:8080/manager/text/deploy?path=/footoo&war=file:/path/to/foo

http://localhost:8080/manager/text/deploy?war=file:/path/to/bar.war

http://localhost:8080/manager/text/deploy?war=foo

http://localhost:8080/manager/text/deploy?war=bar.war

<Context path="/foobar" docBase="/path/to/application/foobar">
</Context>

http://localhost:8080/manager/text/deploy?config=file:/path/context.xml

http://localhost:8080/manager/text/deploy
 ?config=file:/path/context.xml&war=file:/path/bar.war

OK - Deployed application at context path /foo

http://localhost:8080/manager/text/list

現在展開されているすべてのウェブアプリケーションのコンテキストパス、現在の状態（runningまたはstopped）、アクティブなセッションの数を一覧表示します。Tomcatの起動直後の典型的な応答は次のようになります。

OK - Listed applications for virtual host localhost
/webdav:running:0:webdav
/examples:running:0:examples
/manager:running:0:manager
/:running:0:ROOT
/test:running:0:test##2
/test:running:0:test##1

http://localhost:8080/manager/text/reload?path=/examples

既存のアプリケーションにシャットダウンして再ロードするようシグナルを送信します。これは、ウェブアプリケーションコンテキストが再ロード可能ではなく、/WEB-INF/classesディレクトリにクラスまたはプロパティファイルを更新した場合、または/WEB-INF/libディレクトリにjarファイルを追加または更新した場合に役立ちます。

このコマンドが成功すると、次のような応答が表示されます。

OK - Reloaded application at context path /examples

それ以外の場合は、応答はFAILで始まり、エラーメッセージが含まれます。問題の考えられる原因には以下が含まれます。

• 例外が発生しました。

  ウェブアプリケーションの再起動中に例外が発生しました。詳細についてはTomcatログを確認してください。

• 無効なコンテキストパスが指定されました。

  コンテキストパスはスラッシュ文字で始まる必要があります。ROOTウェブアプリケーションを参照するには「/」を使用します。

• パス/fooにコンテキストが存在しません。

  指定されたコンテキストパスにデプロイされたアプリケーションはありません。

• コンテキストパスが指定されていません。

  path パラメータが必要です。

• /foo パスにWAR形式でデプロイされたアプリケーションではリロードがサポートされていません。

  現在、WARファイルから直接Webアプリケーションをデプロイした場合、アプリケーションのリロード（クラスまたはweb.xmlファイルの変更を反映）はサポートされていません。Webアプリケーションは展開されたディレクトリからデプロイされた場合のみ機能します。WARファイルを使用している場合は、変更を反映するために、アプリケーションをundeployしてからdeployするか、updateパラメータを指定してdeployし直してください。

http://localhost:8080/manager/text/serverinfo

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

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

• 例外が発生しました。

  システムプロパティを列挙しようとした際に例外が発生しました。詳細については、Tomcatログを確認してください。

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

コンテキスト設定ファイルのリソースリンクで使用できるグローバルJNDIリソースを一覧表示します。typeリクエストパラメータを指定する場合は、対象となるリソースタイプの完全修飾Javaクラス名を指定する必要があります（例：すべての使用可能なJDBCデータソースの名前を取得するには、javax.sql.DataSourceを指定します）。typeリクエストパラメータを指定しない場合は、すべてのタイプの資源が返されます。

typeリクエストパラメータが指定されているかどうかに応じて、正常なレスポンスの最初の行は次のようになります。

OK - Listed global resources of all types

または

OK - Listed global resources of type xxxxx

その後、リソースごとに1行続きます。各行は、コロン文字（":"）で区切られたフィールドで構成されます。以下のとおりです。

• グローバルリソース名 - これは、<ResourceLink>要素のglobal属性で使用される、このグローバルJNDIリソースの名前です。
• グローバルリソースタイプ - このグローバルJNDIリソースの完全修飾Javaクラス名です。

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

• 例外が発生しました。

  グローバルJNDIリソースを列挙しようとした際に例外が発生しました。詳細については、Tomcatログを確認してください。

• 使用可能なグローバルJNDIリソースはありません。

  実行中のTomcatサーバーは、グローバルJNDIリソースなしで設定されています。

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

Webアプリケーションのデフォルトのセッションタイムアウトと、実際のタイムアウト時間から1分単位の範囲に分類される現在アクティブなセッションの数を表示します。たとえば、Tomcatを再起動してから/examples WebアプリのJSPサンプルの1つを実行すると、次のような結果が得られる場合があります。

OK - Session information for application at context path /examples
Default maximum session inactive interval 30 minutes
<1 minutes: 1 sessions
1 - <2 minutes: 1 sessions

http://localhost:8080/manager/text/expire?path=/examples&idle=num

セッション統計（上記の/sessionsコマンドと同様）を表示し、num分以上アイドル状態のセッションを期限切れにします。すべてのセッションを期限切れにするには、&idle=0を使用します。

OK - Session information for application at context path /examples
Default maximum session inactive interval 30 minutes
1 - <2 minutes: 1 sessions
3 - <4 minutes: 1 sessions
>0 minutes: 2 sessions were expired

実際、/sessionsと/expireは同じコマンドの同義語です。違いはidleパラメータの存在にあります。

http://localhost:8080/manager/text/start?path=/examples

停止したアプリケーションに再起動を指示し、再び使用可能にします。停止と起動は、たとえば、アプリケーションに必要なデータベースが一時的に使用できなくなった場合に役立ちます。ユーザーがデータベース例外を連続して発生させるよりも、このデータベースに依存するWebアプリケーションを停止する方が通常は適切です。

このコマンドが成功すると、次のような応答が表示されます。

OK - Started application at context path /examples

それ以外の場合は、応答はFAILで始まり、エラーメッセージが含まれます。問題の考えられる原因には以下が含まれます。

• 例外が発生しました。

  Webアプリケーションの起動中に例外が発生しました。詳細については、Tomcatログを確認してください。

• 無効なコンテキストパスが指定されました。

  コンテキストパスはスラッシュ文字で始まる必要があります。ROOTウェブアプリケーションを参照するには「/」を使用します。

• パス/fooにコンテキストが存在しません。

  指定されたコンテキストパスにデプロイされたアプリケーションはありません。

• コンテキストパスが指定されていません。

  path パラメータが必要です。

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

既存のアプリケーションに使用不可を指示しますが、デプロイされたままにします。アプリケーションが停止している間に受信されたリクエストはすべてHTTPエラー404が表示され、このアプリケーションはアプリケーション一覧コマンドに「停止済み」として表示されます。

このコマンドが成功すると、次のような応答が表示されます。

OK - Stopped application at context path /examples

それ以外の場合は、応答はFAILで始まり、エラーメッセージが含まれます。問題の考えられる原因には以下が含まれます。

• 例外が発生しました。

  Webアプリケーションの停止中に例外が発生しました。詳細については、Tomcatログを確認してください。

• 無効なコンテキストパスが指定されました。

  コンテキストパスはスラッシュ文字で始まる必要があります。ROOTウェブアプリケーションを参照するには「/」を使用します。

• パス/fooにコンテキストが存在しません。

  指定されたコンテキストパスにデプロイされたアプリケーションはありません。

• コンテキストパスが指定されていません pathパラメータが必要です。

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

警告 - このコマンドは、この仮想ホストのappBaseディレクトリ（通常は「webapps」）内にあるWebアプリケーションアーティファクトをすべて削除します。これにより、存在する場合はアプリケーションの.WARファイル、展開形式でのデプロイまたは.WAR展開からのアプリケーションディレクトリ、および$CATALINA_BASE/conf/[enginename]/[hostname]/ディレクトリからのXMLコンテキスト定義が削除されます。アプリケーションを単に使用不可にしたい場合は、代わりに/stopコマンドを使用してください。

既存のアプリケーションに正常なシャットダウンを指示し、Tomcatから削除します（これにより、このコンテキストパスを後で再利用できるようになります）。さらに、この仮想ホストのappBaseディレクトリ（通常は「webapps」）に存在する場合は、ドキュメントルートディレクトリも削除されます。このコマンドは/deployコマンドの論理的な反対です。

このコマンドが成功すると、次のような応答が表示されます。

OK - Undeployed application at context path /examples

それ以外の場合は、応答はFAILで始まり、エラーメッセージが含まれます。問題の考えられる原因には以下が含まれます。

• 例外が発生しました。

  Webアプリケーションのアンデプロイ中に例外が発生しました。詳細については、Tomcatログを確認してください。

• 無効なコンテキストパスが指定されました。

  コンテキストパスはスラッシュ文字で始まる必要があります。ROOTウェブアプリケーションを参照するには「/」を使用します。

• /fooという名前のコンテキストが存在しません。

  指定された名前のデプロイ済みアプリケーションはありません。

• コンテキストパスが指定されていません pathパラメータが必要です。

http://localhost:8080/manager/text/findleaks[?statusLine=[true|false]]

find leaks診断は、完全なガベージコレクションをトリガーします。本番システムでは、非常に注意して使用する必要があります。

find leaks診断は、停止、リロード、またはアンデプロイされたときにメモリリークを引き起こしたWebアプリケーションを特定しようとします。結果は常にプロファイラで確認する必要があります。この診断では、StandardHost実装によって提供される追加機能を使用します。StandardHostを拡張しないカスタムホストを使用している場合は機能しません。

Javaコードから明示的に完全なガベージコレクションをトリガーすることは、信頼性が低いことが文書化されています。さらに、使用するJVMによっては、-XX:+DisableExplicitGCのように、明示的なGCトリガーを無効にするオプションがあります。診断が正常に完全なGCを実行したことを確認するには、GCログ、JConsoleなどのツールを使用して確認する必要があります。

このコマンドが成功すると、次のような応答が表示されます。

/leaking-webapp

レスポンスにステータス行を含める場合は、値をtrueとしてリクエストにstatusLineクエリパラメータを含めてください。

停止、リロード、またはアンデプロイされたWebアプリケーションのコンテキストパスで、以前の実行からのクラスがメモリにまだロードされているためメモリリークが発生しているものが、新しい行に一覧表示されます。アプリケーションが複数回リロードされている場合は、複数回一覧表示される場合があります。

コマンドが成功しなかった場合は、レスポンスはFAILで始まり、エラーメッセージが含まれます。

http://localhost:8080/manager/text/sslConnectorCiphers

SSL Connector/Ciphers診断は、現在各コネクタに対して設定されているSSL/TLS暗号を一覧表示します。

レスポンスは次のようになります。

OK - Connector / SSL Cipher information
Connector[HTTP/1.1-8080]
  SSL is not enabled for this connector
Connector[HTTP/1.1-8443]
  TLS_ECDH_RSA_WITH_3DES_EDE_CBC_SHA
  TLS_DHE_RSA_WITH_AES_128_CBC_SHA
  TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
  TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
  ...

http://localhost:8080/manager/text/sslConnectorCerts

SSL Connector/Certs診断は、現在各仮想ホストに対して設定されている証明書チェーンを一覧表示します。

レスポンスは次のようになります。

OK - Connector / Certificate Chain information
Connector[HTTP/1.1-8080]
SSL is not enabled for this connector
Connector[HTTP/1.1-8443]-_default_-RSA
[
[
  Version: V3
  Subject: CN=localhost, OU=Apache Tomcat PMC, O=The Apache Software Foundation, L=Wakefield, ST=MA, C=US
  Signature Algorithm: SHA256withRSA, OID = 1.2.840.113549.1.1.11
  ...

http://localhost:8080/manager/text/sslConnectorTrustedCerts

SSL Connector/Certs診断は、現在各仮想ホストに対して設定されている信頼された証明書を一覧表示します。

レスポンスは次のようになります。

OK - Connector / Trusted Certificate information
Connector[HTTP/1.1-8080]
SSL is not enabled for this connector
Connector[HTTP/1.1-8443]-_default_
[
[
  Version: V3
  Subject: CN=Apache Tomcat Test CA, OU=Apache Tomcat PMC, O=The Apache Software Foundation, L=Wakefield, ST=MA, C=US
  ...

http://localhost:8080/manager/text/sslReload?tlsHostName=name

TLS設定ファイル（証明書ファイルとキーファイル）をリロードします（これにより、server.xmlの再解析はトリガーされません）。すべてのホストのファイルをリロードするには、tlsHostNameパラメータを指定しないでください。

OK - Reloaded TLS configuration for [_default_]

http://localhost:8080/manager/text/threaddump

JVMスレッドダンプを書き込みます。

レスポンスは次のようになります。

OK - JVM thread dump
2014-12-08 07:24:40.080
Full thread dump Java HotSpot(TM) Client VM (25.25-b02 mixed mode):

"http-nio-8080-exec-2" Id=26 cpu=46800300 ns usr=46800300 ns blocked 0 for -1 ms waited 0 for -1 ms
   java.lang.Thread.State: RUNNABLE
        locks java.util.concurrent.ThreadPoolExecutor$Worker@1738ad4
        at sun.management.ThreadImpl.dumpThreads0(Native Method)
        at sun.management.ThreadImpl.dumpAllThreads(ThreadImpl.java:446)
        at org.apache.tomcat.util.Diagnostics.getThreadDump(Diagnostics.java:440)
        at org.apache.tomcat.util.Diagnostics.getThreadDump(Diagnostics.java:409)
        at org.apache.catalina.manager.ManagerServlet.threadDump(ManagerServlet.java:557)
        at org.apache.catalina.manager.ManagerServlet.doGet(ManagerServlet.java:371)
        at jakarta.servlet.http.HttpServlet.service(HttpServlet.java:618)
        at jakarta.servlet.http.HttpServlet.service(HttpServlet.java:725)
...

http://localhost:8080/manager/text/vminfo

Java仮想マシンに関する診断情報を書き込みます。

レスポンスは次のようになります。

OK - VM info
2014-12-08 07:27:32.578
Runtime information:
  vmName: Java HotSpot(TM) Client VM
  vmVersion: 25.25-b02
  vmVendor: Oracle Corporation
  specName: Java Virtual Machine Specification
  specVersion: 1.8
  specVendor: Oracle Corporation
  managementSpecVersion: 1.2
  name: ...
  startTime: 1418012458849
  uptime: 393855
  isBootClassPathSupported: true

OS information:
...

http://localhost:8080/manager/text/save

パラメータを指定せずに指定すると、このコマンドはサーバーの現在の設定をserver.xmlに保存します。必要に応じて、既存のファイルはバックアップとして名前が変更されます。

デプロイされたWebアプリケーションのパスと一致するpathパラメータを指定すると、そのWebアプリケーションの設定が、現在のホストのxmlBase内の適切な名前のcontext.xmlファイルに保存されます。

このコマンドを使用するには、StoreConfig MBeanが存在する必要があります。通常、これはStoreConfigLifecycleListenerを使用して設定されます。

コマンドが成功しなかった場合は、レスポンスはFAILで始まり、エラーメッセージが含まれます。

形式は次のとおりです。

http://webserver/manager/jmxproxy/?qry=STUFF

ここで、STUFFは実行するJMXクエリです。たとえば、実行したいクエリをいくつか示します。

• qry=*%3Atype%3DRequestProcessor%2C* --> type=RequestProcessor リクエストを処理できるすべてのワーカーを探し、その状態を報告します。
• qry=*%3Aj2eeType%3DServlet%2c* --> j2eeType=Servlet ロードされているすべてのサーブレットを返します。
• qry=Catalina%3Atype%3DEnvironment%2Cresourcetype%3DGlobal%2Cname%3DsimpleValue --> Catalina:type=Environment,resourcetype=Global,name=simpleValue 指定された名前で特定のMBeanを検索します。

その機能を本当に理解するには、実験する必要があります。qryパラメータを指定しない場合、すべてのMBeanが表示されます。Tomcatのソースコードを確認し、JMX仕様を理解して、実行できるすべてのクエリをよりよく理解することをお勧めします。

JMXProxyServlet は、特定の MBean の属性の値を取得するために使用できる "get" コマンドもサポートしています。get コマンドの一般的な形式は次のとおりです。

http://webserver/manager/jmxproxy/?get=BEANNAME&att=MYATTRIBUTE&key=MYKEY

次のパラメータを指定する必要があります。

1. get: 完全な Bean 名
2. att: 取得する属性
3. key: （オプション）CompositeData MBean 属性へのキー

すべてが正常に実行された場合は「OK」と表示され、そうでない場合はエラーメッセージが表示されます。たとえば、現在のヒープメモリデータを取得したいとします。

http://webserver/manager/jmxproxy/?get=java.lang:type=Memory&att=HeapMemoryUsage

または、「used」キーのみを取得する場合

http://webserver/manager/jmxproxy/
 ?get=java.lang:type=Memory&att=HeapMemoryUsage&key=used

MBean をクエリできるようになったので、Tomcat の内部を操作してみましょう！set コマンドの一般的な形式は次のとおりです。

http://webserver/manager/jmxproxy/?set=BEANNAME&att=MYATTRIBUTE&val=NEWVALUE

そのため、3 つのリクエストパラメータを指定する必要があります。

1. set: 完全な Bean 名
2. att: 変更する属性
3. val: 新しい値

すべてが正常に実行された場合は「OK」と表示され、そうでない場合はエラーメッセージが表示されます。たとえば、ErrorReportValve のデバッグをオンザフライで有効にしたいとします。次のコマンドはデバッグを 10 に設定します。

http://localhost:8080/manager/jmxproxy/
 ?set=Catalina%3Atype%3DValve%2Cname%3DErrorReportValve%2Chost%3Dlocalhost
 &att=debug&val=10

そして、私の結果は次のとおりです（結果は異なる場合があります）。

Result: ok

不正な値を渡した場合の結果を示します。私が使用した URL は次のとおりです。デバッグを 'cow' に設定しようとしました。

http://localhost:8080/manager/jmxproxy/
 ?set=Catalina%3Atype%3DValve%2Cname%3DErrorReportValve%2Chost%3Dlocalhost
 &att=debug&val=cow

それを試みると、結果は次のようになります。

Error: java.lang.NumberFormatException: For input string: "cow"

invoke コマンドを使用すると、MBean でメソッドを呼び出すことができます。コマンドの一般的な形式は次のとおりです。

http://webserver/manager/jmxproxy/
 ?invoke=BEANNAME&op=METHODNAME&ps=COMMASEPARATEDPARAMETERS

たとえば、**Service** の findConnectors() メソッドを呼び出すには、次のようにします。

http://localhost:8080/manager/jmxproxy/
 ?invoke=Catalina%3Atype%3DService&op=findConnectors&ps=

*Ant* バージョン **1.6.2** 以降では、Catalina タスクは、その出力をプロパティまたは外部ファイルにキャプチャするオプションを提供します。次の <redirector> タイプ属性のサブセットを直接サポートします。

追加でいくつかの属性を指定することもできます。

それらは、そのすべての属性を指定できる埋め込み <redirector> 要素もサポートしますが、input、inputstring、inputencoding は、受け入れられていても使用されません。これは、このコンテキストでは意味がないためです。<redirector> 要素属性の詳細については、Ant マニュアル を参照してください。

この出力リダイレクションサポートの使用方法を示す build ファイルの抜粋を次に示します。

    <target name="manager.deploy"
        depends="context.status"
        if="context.notInstalled">
        <deploy url="${mgr.url}"
            username="${mgr.username}"
            password="${mgr.password}"
            path="${mgr.context.path}"
            config="${mgr.context.descriptor}"/>
    </target>

    <target name="manager.deploy.war"
        depends="context.status"
        if="context.deployable">
        <deploy url="${mgr.url}"
            username="${mgr.username}"
            password="${mgr.password}"
            update="${mgr.update}"
            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>
        <condition property="context.stopped">
            <contains string="${ctx.status}" substring="${stopped}"/>
        </condition>
        <condition property="context.notInstalled">
            <and>
                <isfalse value="${context.running}"/>
                <isfalse value="${context.stopped}"/>
            </and>
        </condition>
        <condition property="context.deployable">
            <or>
                <istrue value="${context.notInstalled}"/>
                <and>
                    <istrue value="${context.running}"/>
                    <istrue value="${mgr.update}"/>
                </and>
                <and>
                    <istrue value="${context.stopped}"/>
                    <istrue value="${mgr.update}"/>
                </and>
            </or>
        </condition>
        <condition property="context.undeployable">
            <or>
                <istrue value="${context.running}"/>
                <istrue value="${context.stopped}"/>
            </or>
        </condition>
    </target>

警告：あまり意味がなく、常に悪いアイデアですが、Catalina タスクを複数回呼び出すと、Ant タスクの依存関係チェーンの設定が不適切なため、意図していなくても同じ Ant 実行でタスクが複数回呼び出される可能性があります。タスクからの出力をキャプチャする場合は、注意が必要です。予期しない結果につながる可能性があります。

• プロパティにキャプチャする場合、Ant プロパティは不変であり、一度設定されると変更できないため、最初の呼び出しからの出力のみが含まれます。
• ファイルにキャプチャする場合、append="true" 属性を使用していない限り、各実行で上書きされ、最後の呼び出しからの出力のみが含まれます。その場合は、各タスク呼び出しの出力がファイルに追加されます。