13.2.2　mod_jk.conf（HTTP Server用リダイレクタ動作定義ファイル）

(1)　形式

次のようにキーを指定します。

<キー名称> <値>

指定方法

• 改行までが値になります。

• #で始まる行はコメントとみなされます。

• キー名称と値は半角スペースで区切ります。また，値を複数指定する場合も半角スペースで区切ります。

• 指定する値がファイルパスでスペースを含む場合は，パス全体を""（ダブルクォーテーション）で囲む必要があります。

• コメントの記述方法，および記述できる文字の種類などの記述形式は，HTTP Serverの仕様に従います。

• キー名称の大文字小文字は区別しません。

ページの先頭へ

(2)　ファイルの格納先

• Windowsの場合

  <Application Serverのインストールディレクトリ>\CC\web\redirector\mod_jk.conf

• UNIXの場合

  /opt/Cosminexus/CC/web/redirector/mod_jk.conf

ページの先頭へ

(3)　機能

リダイレクタの動作を定義します。

ページの先頭へ

(4)　指定できるキー

• モジュール定義

  WebコンテナとHTTP Server間の通信を処理するためにライブラリを定義します。

  形式

  LoadModule jk_module <ライブラリ名>

  ライブラリ名を絶対パスで指定します。なお，複数指定はできません。

  指定例

  Windowsの場合

  LoadModule jk_module "<Application Serverのインストールディレクトリ>\CC\web\redirector\mod_jk.dll"

  UNIXの場合

  LoadModule jk_module /opt/Cosminexus/CC/web/redirector/mod_jk.so

  注意事項

  モジュール定義を指定するキーは，ほかのキーよりも前に記述する必要があります。

• マッピング定義

  HTTP ServerへのリクエストでどのURLパターンがWebコンテナに転送されるかを定義します。

  形式

  JkMount <URLパターン> <ワーカ名>

  workers.propertiesのworker.listで指定されているワーカのどれかを記述します。URLパターンとワーカ名の組み合わせを複数記述できます。このファイルに不正な値を設定した場合，動作は保証されません。また，先頭がスラッシュ（/）から始まらないURLパターンを指定した場合，リダイレクタ起動時にエラーメッセージがログに出力され，指定した内容は無視されます。

  拡張子の長さが0文字の拡張子指定のURLパターンを指定した場合（URLパターンの末尾が「/*.」の場合），メッセージKDJE41041-Wがログに出力され，指定した内容は無視されます。

  JkMountキーについては，「5.4　ラウンドロビン方式によるリクエストの振り分け」，および「5.5　POSTデータサイズでのリクエストの振り分け」を参照してください。

• リダイレクタ定義

  次に示すキーを指定できます。ただし，このキーに不正な値を指定した場合，動作は保証されません。

  なお，「関連情報」とは，指定したキーに関する情報の参照先です。マニュアル名称の「アプリケーションサーバ」を省略しています。

  キー名称	内容	デフォルト値	関連情報
  JkConnectTimeout	リクエスト送信時のWebコンテナに対するコネクション確立のタイムアウト値を，0〜3600の整数（単位：秒）で指定します。 数値以外の文字列や範囲外の数値を指定した場合は，メッセージを出力し，デフォルト値を使用します。 タイムアウト値に0，またはTCPの持つデータ送信の再送タイマより長い時間を設定した場合，TCPの持つタイムアウト値になります。その場合，不正なタイムアウト値が指定されたことを示すメッセージは出力されません。	30
  JkGatewayHost	ゲートウェイのホスト名またはIPアドレスを指定します。 Hostヘッダのないリクエストに対してwelcomeファイルなどへリダイレクトする場合，Locationヘッダに指定するURLのホスト名部分が指定値になります。	なし	「5.10　Webコンテナへのゲートウェイ情報の通知」
  JkGatewayHttpsScheme	クライアントからのリクエストのスキームがhttpsであり，かつSSLアクセラレータなどを介すことでWebサーバへのスキームがhttpとなる場合に，Onを指定します。 Onを指定した場合，Webサーバへのリクエストのスキームがhttpsであるとみなされます。Offを指定した場合，何も実行されません。	Off	「5.10　Webコンテナへのゲートウェイ情報の通知」
  JkGatewayPort	ゲートウェイのポート番号を指定します。Hostヘッダのないリクエストをwelcomeファイルなどにリダイレクトする場合，Locationヘッダに指定するURLのポート番号部分が指定値となります。 このパラメタを指定した場合は，必ずJkGatewayHostも指定してください。 JkGatewayHostを指定してこのパラメタを省略した場合，httpによるアクセスであれば80，httpsによるアクセスであれば443が使用されます。	なし	「5.10　Webコンテナへのゲートウェイ情報の通知」
  JkLogFileDir	ログファイルの出力先ディレクトリを指定します。Windowsの場合，相対パスまたは絶対パスで指定してください。UNIXの場合，絶対パスで指定してください。 相対パスで指定した場合： <Application Serverのインストールディレクトリ>\CC\web\redirector以下のディレクトリ名を指します。 絶対パスで指定した場合： 記述されたディレクトリ名を指します。 なお，出力先として指定したディレクトリのアクセス権にHTTP Serverの実行アカウントの書き込み権限を設定する必要があります※1。アクセス権を設定していない場合，ログファイルが出力されません。 JkLogFilePrefixとJkTraceLogFilePrefixに同じ値を指定した場合は，このキーにJkTraceLogFileDirとは異なる値を指定する必要があります。同じ値が指定された場合，リダイレクタは動作しません。	Windowsの場合 logs UNIXの場合 /opt/Cosminexus/CC/web/redirector/logs
  JkLogFileNum	リダイレクタ用ログファイルの最大数を指定します。この値を超えると古いログファイルは上書きされます。次の範囲の整数値を指定してください。 Windowsの場合 1≦JkLogFileNum≦16 UNIXの場合 1≦JkLogFileNum≦64	5
  JkLogFilePrefix	ログファイル名のプリフィックスです。実際のログファイル名は，指定値に<通番>.logが付加されたものとなります。 JkLogFileDirとJkTraceLogFileDirに同じ値を指定した場合は，このキーにJkTraceLogFilePrefixとは異なる値を指定する必要があります。同じ値が指定された場合，リダイレクタは動作しません。	hws_redirect
  JkLogFileSize	リダイレクタ用ログファイルの一つ当たりのサイズ（バイト）を指定します。次の範囲の整数値を指定してください。 Windowsの場合 4096≦JkLogFileSize≦2147483647 UNIXの場合 4096≦JkLogFileSize≦16777216	4194304
  JkLogLevel	リダイレクタ用ログファイルのメッセージログ，および保守用トレースログのログ出力レベルを指定します。指定するログレベルを一つだけ指定します。debug，info，error（デフォルト値），およびemergを指定できます。なお，emergは，Windowsの場合だけ指定できる値です。 これら以外の値を指定した場合は，errorが指定されたものとして動作します。	error
  JkModulePriority	HTTP Serverへリダイレクタ以外の外部モジュールを登録する場合に，ほかの外部モジュールに対するリダイレクタの実行順位を指定します。 指定できる値を次に示します。 -10〜30の整数 REALLY_FIRST（整数値の-10に対応） FIRST（整数値の0に対応） MIDDLE（整数値の10に対応） LAST（整数値の20に対応） REALLY_LAST（整数値の30に対応） 実行順位は指定する値が小さい程高くなります。	FIRST
  JkOptions	リクエストURLのURLデコードを行うかどうかを指定します。なお，このキーはUNIX用です。 ForwardURICompatUnparsed（デフォルト）： リクエストURLのURLデコードを行いません。 ForwardURICompat： リクエストURLのURLデコードを行います。 02-00ではURLデコードを行っていたため，URLデコードによって変換される文字列を含むURLを使用する場合，02-00と同様にURLデコードを行う必要があるときだけForwardURICompatを指定してください。	ForwardURICompatUnparsed
  JkPrfId	PRFデーモン起動時にPRF識別子に指定した文字列を指定します。	PRF_ID
  JkRequestRetryCount	リクエスト送信時のWebコンテナに対するコネクション確立，およびリクエスト送信のリトライ回数を，1〜16の整数（単位：回）で指定します。 リトライ回数には，初回のコネクション確立およびリクエスト送信処理も含まれます。 タイムアウトが発生した場合，リトライするケースは次のとおりです。 コネクション確立時にタイムアウトした場合 リクエストヘッダ送信時にタイムアウトした場合 上記処理以降の，リクエストボディの送信時にタイムアウトが発生した場合は，リトライは行いません。 リトライ回数に，範囲外の値や，整数値でない値などの異常値を設定した場合，デフォルト値が設定されます。	3
  JkSendTimeout	リクエスト送信のタイムアウト値を0〜3600の整数（単位：秒）で指定します。 数値以外の文字列や範囲外の数値を指定した場合は，メッセージを出力し，デフォルト値を使用します。 タイムアウト値に0，またはTCPの持つデータ送信の再送タイマより長い時間を設定した場合，TCPの持つタイムアウト値になります。その場合，不正なタイムアウト値が指定されたことを示すメッセージは出力されません。	100
  JkTraceLog	リダイレクタの保守用トレースログを出力するかどうかを指定します。出力する場合はOn（デフォルト値）を，出力しない場合はOffを指定します。	On
  JkTraceLogFileDir	保守用トレースログファイルの出力先ディレクトリを指定します。Windowsの場合，相対パスまたは絶対パスで指定してください。UNIXの場合，絶対パスで指定してください。 相対パスで記述した場合： <Application Serverのインストールディレクトリ>\CC\web\redirector以下のディレクトリ名を指します。 絶対パスで記述した場合： 記述されたディレクトリ名を指します。 JkLogFilePrefixとJkTraceLogFilePrefixに同じ値を指定した場合は，このキーにJkLogFileDirとは異なる値を指定する必要があります。同じ値が指定された場合，リダイレクタは動作しません。	Windowsの場合 logs UNIXの場合 /opt/Cosminexus/CC/web/redirector/logs
  JkTraceLogFileNum	保守用トレースログファイルの最大数を整数値で指定します。 Windowsの場合 1〜16 UNIXの場合 1〜64 この数を超えると古いログファイルは上書きされます。	4
  JkTraceLogFilePrefix	保守用トレースログファイル名のプリフィックスを指定します。実際のログファイル名は，このキーの指定値に<通番>.logが付加されたものとなります。 JkLogFileDirとJkTraceLogFileDirに同じ値を指定した場合は，このキーにJkLogFilePrefixとは異なる値を指定する必要があります。同じ値が指定された場合，リダイレクタは動作しません。	hws_rd_trace
  JkTraceLogFileSize	保守用トレースログファイルの一つ当たりのサイズを整数値（単位：バイト）で指定します。 Windowsの場合 4096〜2147483647 UNIXの場合 4096〜16777216	16777216
  JkTranslateBackcompat	05-05以前のバージョンの互換用のキーです。 HTTP ServerへのリクエストがWebコンテナに転送させるURLパターンであった場合，リダイレクタよりあとに実行されるモジュールのtranslate_handler関数がHTTP Serverから呼び出されるようにするかどうかを指定します。 Onを指定した場合，リダイレクタの次に実行されるモジュールのtranslate_handler関数が呼び出されます。 Offを指定した場合，リダイレクタよりあとに実行されるモジュールのtranslate_handler関数は呼び出されません。	Off
  JkWorkersFile	ワーカ定義ファイルのファイル名を指定します。Windowsの場合，相対パスまたは絶対パスで指定してください。UNIXの場合，絶対パスで指定してください。 相対パスで指定した場合： <Application Serverのインストールディレクトリ>\CC\web\redirector以下のファイル名を指します。 絶対パスで指定した場合： 記述されたファイル名を指します。	Windowsの場合 workers.properties UNIXの場合 /opt/Cosminexus/CC/web/redirector/workers.properties※2

  注

  複数のキーを指定した場合，最後に指定した値が有効になります。

  注※1　HTTP Serverと連携する場合

  新規インストール時には，デフォルトのログ出力先ディレクトリは存在しません。ディレクトリを作成してアクセス権を設定するか，一つ上のディレクトリredirectorにアクセス権を設定してください。

  また，リダイレクタのログ出力先ディレクトリを変更し，そのパスが途中までしか存在しない場合，存在する最下層のディレクトリに対してアクセス権を設定するか，指定したパスをすべて作成し，アクセス権を設定してください。

  注※2

  /opt/Cosminexus/CC/web/redirector/workers.propertiesが存在しない場合，HTTP Serverは起動しません。

ページの先頭へ

(5)　記述例

• Windowsの場合

  LoadModule jk_module "C:\Program Files\Hitachi\Cosminexus\CC\web\redirector\mod_jk.dll"※
   
  JkGatewayHost hostA
  JkGatewayHttpsScheme On
  JkGatewayPort 443
   
  JkLogLevel error
  JkLogFileSize 4194304
  JkLogFileNum 5
  JkLogFileDir logs
  JkLogFilePrefix hws_redirect
  JkPrfId prfid
  JkTraceLog On
  JkTraceLogFileSize 16777216
  JkTraceLogFileNum 4
  JkTraceLogFileDir logs
  JkTraceLogFilePrefix hws_rd_trace
  JkTranslateBackcompat Off
  JkWorkersFile workers.properties
   
  JkMount /examples/* worker1

  注※

  LoadModuleの指定は，ファイル上では1行で記述してください。

• UNIXの場合

  LoadModule jk_module /opt/Cosminexus/CC/web/redirector/mod_jk.so
  JkWorkersFile /opt/Cosminexus/CC/web/redirector/workers.properties
   
  JkLogLevel error
  JkLogFileSize 4194304
  JkLogFileNum 5
  JkLogFileDir /opt/Cosminexus/CC/web/redirector/logs
  JkLogFilePrefix hws_redirect
   
  JkTraceLog On
  JkTraceLogFileSize 16777216
  JkTraceLogFileNum 4
  JkTraceLogFileDir /opt/Cosminexus/CC/web/redirector/logs
  JkTraceLogFilePrefix hws_rd_trace
   
  JkMount /examples/* worker1

ページの先頭へ

(6)　注意事項

• Windowsの場合，リダイレクタのユーザ定義を変更するには，Webサーバを再起動する必要があります。変更した定義は，Webサーバを再起動したあとに反映されます。

• UNIXの場合，リダイレクタのユーザ定義を変更して，変更内容を反映させるには，次の操作が必要です。

ファイルサイズまたはファイル面数を変更する場合

1. Webサーバを停止します。

2. ログファイルおよびHNTRLibが使用する管理ファイルを，移動または削除します。

   ＜HNTRLibが使用する管理ファイル＞

   メッセージログファイルの場合：<JkLogFilePrefixの設定値>.mm

   保守用トレースログファイルの場合：<JkTraceLogFilePrefixの設定値>.mm

3. Webサーバを起動します。

なお，HNTRLibが使用する管理ファイルのデフォルトの格納場所は次のとおりです。

<Application Serverのインストールディレクトリ>/CC/web/redirector/logs/mmap

ファイルサイズまたはファイル面数を変更しない場合

Webサーバを再起動します。

ページの先頭へ