Apache Tomcat Connectors - リファレンスガイド

このファイルは行ベースのフォーマットです。継続文字はないため、各ルールは1行で定義する必要があります。各ルールはURIパターンとワーカー名のペアで構成され、等号'='で結合されます。

/myapp=myworker

文字'#'以降のすべてのテキストは無視され、コメントとして使用できます。URIパターンとワーカー名の前後の空白はトリムされます。以下の定義はすべて同等です

# This is a white space example
/myapp=myworker
  /myapp=myworker
/myapp  =  myworker

URIパターン内では、3つの特殊文字 '*', '?' および '|' を使用できます。文字 '*' は、URI内の任意の数の文字に一致するワイルドカードであり、'?' は正確に1文字に一致します。各URIパターンは文字 '/'、または '*'、または '?' で始まる必要があり、オプションで修飾子 '!' と '-' の任意の組み合わせがプレフィックスとして付与されます（次節参照）。

# Mapping the URI /myapp1 and everything under /myapp1/:
/myapp1=myworker-a
/myapp1/*=myworker-a
# Mapping all URI which end with a common suffix:
*.jsp=myworker
*.do=myworker

# Mapping the URI /myapp1 and everything under /myapp1/:
/myapp1|/*=myworker-a

除外ルールは、Tomcatにリクエストを転送するURIルールからの除外を定義することを可能にします。除外ルールが一致する場合、リクエストは転送されません。これは通常、Webサーバーが静的コンテンツを提供するために使用されます。ルールが除外ルールであるのは、それに '!' がサフィックスとして付加されている場合です。

# Mapping the URI /myapp and everything under /myapp/:
/myapp|/*=myworker
# Exclude the subdirectory static:
!/myapp/static|/*=myworker
# Exclude some suffixes:
!*.html=myworker

# Mapping the webapps /myapp1 and /myapp2:
/myapp1|/*=myworker1
/myapp2|/*=myworker2
# Exclude the all subdirectories static for all workers:
!/*/static|/*=*
# Exclude some suffixes for all workers:
!*.html=*

ルールの無効化は、Webサーバーがさまざまなソースからのルールをマージし、以前に定義されたルールを無効にしたい場合に機能します。uriworkermapファイルは動的にリロードされるため、これを使用して一時的にリクエスト転送を無効にできます。ルールは、それに '-' がサフィックスとして付加されている場合に無効になります。

# We are not in maintenance.
# The maintenance rule got defined somewhere else.
-/*=maintenance

最も制限的なURIパターンが最初に適用されます。より正確には、URIパターンはパターン内の'/'文字の数でソートされ（最も多いものが最初）、数が同じルールは文字列の長さでソートされます（最も長いものが最初）。

両方の区別がそれでも不十分な場合、ルールの定義元が考慮されます。uriworkermap.propertiesで定義されたルールは、JkMount（Apache HTTP Serverの場合）によって定義されたルールや、workers.properties内でmount属性を使用して定義されたルールよりも優先されます。

すべての無効なルールは無視されます。除外ルールは、すべての通常のルールが適用された後に適用されます。

以下の設定競合については、定義された動作がありません: 同じ定義元で文字通り同じURIパターンを使用し、異なるワーカーターゲットを持つ場合。

ルール拡張は、任意のルールに付加できる追加属性です。それらはルールの末尾に追加され、各拡張はセミコロンで区切られます。

# This is an extension example,
# setting a reply_timeout of 1 minute
# only for this mapping.
/myapp=myworker;reply_timeout=60000
#
# This is an example using multiple extensions
/myapp=myloadbalancer;reply_timeout=60000;stopped=member1

拡張reply_timeoutは、単一のマッピングルールに対する応答タイムアウトを設定します。

# Setting a reply_timeout of 1 minute
# only for this mapping.
/myapp=myworker;reply_timeout=60000

拡張sticky_ignoreは、単一のマッピングルールに対するセッションのスティッキー性を無効にします。

# Disable session stickyness
# only for this mapping.
/myapp/loginform.jsp=myworker;sticky_ignore=1

この拡張機能はバージョン1.2.33から利用可能です。

拡張statelessは、セッションベースのロードバランシングを使用している場合にのみ役立ちます。この場合、通常、セッションIDを伴わないリクエストは新しいセッションとしてカウントされます。マッピングルールにstateless拡張をマークすると、そのマッピングルールに一致するリクエストは、セッションIDを伴わない場合でも、新しいセッションとしてカウントされなくなります。

# Don't let static content trash our session balancing
/myapp/static/*=myworker;stateless=1

拡張active、disabled、およびstoppedは、ロードバランサーのマッピングルールで使用して、ロードバランサーの選択されたメンバーを特別な有効化状態に設定できます。

# Stop forwarding only for member1 of loadbalancer
/myapp=myloadbalancer;stopped=member1

# Stop forwarding for member01 and member02 of loadbalancer
# Disable forwarding for member21 and member22 of loadbalancer
/myapp=myloadbalancer;stopped=member01,member02;disabled=member21,member22

拡張fail_on_statusは、あらゆるルールで使用できます。

# Send 503 instead of 404 and 500,
# and if we get a 503 also set the worker to error
/myapp=myworker;fail_on_status=-404,-500,503

拡張use_server_errorsは、バックエンド（例: Tomcat）のエラーページではなく、Webサーバーにエラーページを送信させることを可能にします。これは、カスタマイズされたエラーページを送信したいが、それらがすべてのWebアプリケーションの一部ではない場合に役立ちます。それらはWebサーバーに配置できます。

use_server_errorsの値は正の数です。バックエンドに送信されたリクエストがuse_server_errors以上のHTTPステータスコードを返した場合、そのステータスコードに対するWebサーバーのエラーページがクライアントに応答として送信されます。

# Use web server error page for all errors
/myapp=myworker;use_server_errors=400
# Use web server error page only for technical errors
/myotherapp=myworker;use_server_errors=500

拡張機能

• session_cookie
• session_path
• set_session_cookie
• session_cookie_path

Microsoft IISでISAPIリダイレクターを使用する場合、URIパターンに仮想ホスト情報をプレフィックスとして付加することで、個々のルールを特定の仮想ホストに制限できます。ルールとしては、URLがホスト名でプレフィックスされている必要があります。

# Use www.foo.org as virtual host
/www.foo.org/myapp/*=myworker
# Use www.bar.org as virtual host
/www.bar.org/myapp/*=myworker
# Normal mapping
/mysecondapp/*=myworker

/mysecondapp/* は存在するすべての仮想ホストにマッピングされることに注意してください。特定の仮想ホストへのマッピングを防ぐ必要がある場合は、除外ルールを使用する必要があります。

# Make sure the myapp is accessible by all virtual hosts
/myapp/*=myworker
# Disable mapping myapp for www.foo.org virtual host
!/www.foo.org/myapp/*=myworker

Apache HTTP Serverでは、仮想ホストごとに個別のuriworkermapファイルを定義できます。JkMountFileディレクティブは、メインサーバーおよび各仮想ホストで使用できます。仮想ホストがJkMountfileを使用せず、JkMountCopyが'On'に設定されている場合、メインサーバーからJkMountFileを継承します。すべての仮想ホストがメインサーバーからマウントを継承するようにしたい場合は、メインサーバーでJkMountCopyを'All'に設定できます。