対応バージョン :	3.3.0
対応エディション :
対応プラットフォーム :

Java Service Wrapperには、幅広いビルトインやユーザー定義イベントに反応する他、 Eメール経由でシステム管理者へ通知する機能があります。

イベント・プロパティ：

イベントに利用するプロパティは、下記の「イベント・コンフィギュレーション・プロパティ」セクションをご覧ください。

イベントの種類：

ビルトインやカスタム・イベントの完全なリストは、下記の「イベントの種類」セクションをご覧ください。

イベント・メール（イベントに応じたメール通知機能）：

Wrapperログの一部を添付したり、カスタマイズされたメッセージを添えて、Eメールが送信されます。 これでシステム管理者がさらなるアクションが必要かどうか判断するのに役立ちます。 詳しくは下記の「イベント・メール（イベントに応じたメール通知機能）」セクションをご覧ください。

イベント・コマンド（イベントに応じたコマンド実行）：

外部スクリプトを含むシステム・コマンドをイベントに応じて実行することも可能です。 これはシステム・クリーンアップや通知を送信したり、自動処理するアクションを起こすなどに便利です。 詳しくは下記の「イベント・コマンド（イベントに応じたコマンド実行）」セクションをご覧ください。

このセクションはプロパティの完全なリストで、 イベントに応じたWrapperの動作方法の設定やコントロールに利用します。

イベント全般プロパティ：

• wrapper.event.<event_name>.loglevel (3.3.6)(Pro)
• wrapper.event.<event_name>.message (3.3.6)(Pro)
• wrapper.event.<event_name>.set_environment (3.3.0 (Deprecated as of 3.3.6))(Pro)

イベント・メール（イベントに応じたメール通知機能）プロパティ：

メール通知の基本設定：

• wrapper.event.<event_name>.email (3.3.0)(Pro)

メールシステム設定：

• wrapper.event.<event_name>.email.client.host (3.3.2)(Pro)
• wrapper.event.<event_name>.email.smtp.host (3.3.0)(Pro)
• wrapper.event.<event_name>.email.smtp.port (3.3.0)(Pro)
• wrapper.event.<event_name>.email.smtp.auth.type (3.5.3)(Pro)
• wrapper.event.<event_name>.email.smtp.auth.userid (3.5.3)(Pro)
• wrapper.event.<event_name>.email.smtp.auth.password (3.5.3)(Pro)
• wrapper.event.<event_name>.email.receive.timeout (3.3.2)(Pro)
• wrapper.event.<event_name>.email.send.timeout (3.3.2)(Pro)
• wrapper.event.<event_name>.email.debug (3.3.0)(Pro)

メール本体設定：

• wrapper.event.<event_name>.email.from (3.3.0)(Pro)
• wrapper.event.<event_name>.email.recipient (3.3.0)(Pro)
• wrapper.event.<event_name>.email.subject (3.3.0)(Pro)
• wrapper.event.<event_name>.email.body (3.3.0)(Pro)
• wrapper.event.<event_name>.email.attach_log (3.4.0)(Pro)
• wrapper.event.default.email.lines (3.4.0)(Pro)
• wrapper.event.default.email.maillog.format (3.4.0)(Pro)
• wrapper.event.default.email.maillog.loglevel (3.4.0)(Pro)

イベント・コマンド（イベントに応じたコマンド実行）プロパティ：

• wrapper.event.<event_name>.command.argv.<n> (3.3.0)(Pro)
• wrapper.event.<event_name>.command.block (3.4.1)(Pro)
• wrapper.event.<event_name>.command.block.action (3.4.1)(Pro)
• wrapper.event.<event_name>.command.block.timeout (3.3.0)(Pro)
• wrapper.event.<event_name>.command.loglevel (3.3.0)(Pro)
• wrapper.event.<event_name>.command.on_exit.<n> (3.3.0)(Pro)

Wrapperは、メール通知を送ったり、場合によっては、 様々なイベントに反応して外部コマンドを実行したりします。 下記のリストでは、それぞれ定義されたイベントについて説明しています：

• ［wrapper_start］ - Wrapperプロセスが最初にスタートする時に発生するイベントです。 このイベントは、最初のJVMを起動する前に必要な初期化をするために使われます。

  例えば、メール通知の場合なら、システムが単に再起動されたことを指摘するために使われます。

• ［jvm_prelaunch］ - 新しいJVMが起動しようとする時にはいつでも発生するイベントです。 このイベントは、各JVMを起動する前に必要な初期化をするために使われます。

• ［jvm_start］ - 新しいJVMが起動した直後で、そのアプリケーションのスタートが確立する前に、発生するイベントです。

• ［jvm_started］ - JVM内のWrapperコードが、Wrapperプロセスに、新しいアプリケーションが起動して稼働状態に入ったことを 一旦、知らせるときに発生するイベントです。

  もし インテグレーション方法３（WrapperListener）を使っていない場合には、 ユーザー・アプリケーションが実際にスタートが確立する前に このイベントが発生するかもしれませんので注意してください。 ユーザー・アプリケーションの状況次第ですが、 方法１（WrapperSimpleApp） や 方法２（WrapperStartStopApp） の両者とも、アプリケーションの起動確立を通知する前に、 アプリケーションが完全にスタートが完了するまで待機するようにWrapperの設定を変更することができます。 さらに詳しくは、各インテグレーション方法の詳細で「上級者向け」セクションをご覧ください。

• ［jvm_deadlock］ (ver. 3.5.0から) - デッドロック・チェック機能により、 JVM内部でスレッド・デッドロックが検知されると、いつでも発生するイベントです。

• ［jvm_stop］ - JVMがシャットダウンされそうになる時にいつでも発生するイベントです。 このイベントは、JVM がクラッシュした時に発生しますが、そのJVMプロセスが過ぎた後に発生します。

  もし、何かの理由で、システムがクラッシュしたり、パワーが低減した場合、このイベントは決して発生しません。

• ［jvm_stopped］ - 何かの理由で、JVMがシャットダウンした後に発生するイベントです。 このイベントは、クリーンアップ作業をするために使われます。

  もし、何かの理由で、システムがクラッシュしたり、パワーが低減した場合、このイベントは決して発生しません。

• ［jvm_restart］ - WrapperがJVMを再起動しようとする時に発生するイベントです。

• ［jvm_failed_invocation］ - JVMが結果として再起動になる、ある状況から退出した時に発生するイベントですが、 JVMが動作している総時間が ［wrapper.successful_invocation_time］ プロパティで設定した値より下回る場合です。

• ［jvm_max_failed_invocations］ - JVMが結果として再起動になる、ある状況から退出した時に発生するイベントですが、 起動の失敗（［jvm_failed_invocation］イベント）をカウントし、 連続して失敗した「起動の試み（invocation）」の総数が、 ［wrapper.max_failed_invocations］ プロパティで設定した値より上回る場合です。

• ［jvm_kill］ - 「凍結していると思われるJVMを強制終了する必要がある」とWrapperが判断すると、発生するイベントです。 このイベントは、JVMプロセスを強制終了する前に発生します。 このイベントでは［jvm_stop］イベントが常に先行し、その後、 ［jvm_killed］イベント、および ［jvm_stopped］イベントが続きます。 このイベントでコマンド実行時に遅延が必要な場合は、 ［wrapper.jvm_kill.delay］プロパティ を参照してください。

• ［jvm_killed］ - 凍結していると思われるJVMをWrapperが強制終了したとき、発生するイベントです。 このイベントの後に、常に［jvm_stopped］イベントが続きます。

• ［jvm_unexpected_exit］ - 例えば、クラッシュして落ちたときなど、予想外の理由で、JVMプロセスが消えた時に発生するイベントです。 このイベントの後に常に［jvm_stop］イベント および［jvm_stopped］イベントが続きます。

• ［wrapper_stop］ - Wrapperプロセスがシャットダウンしている時に、最後に発生するイベントです。 このイベントは、最後のJVMがシャットダウンした後に必要なクリーンアップ作業をするために使われます。

  このイベントは、Wrapperが通常どおりにシャットダウンする時だけに発生するイベントであることに注意してください。 もし、何かの理由で、システムがクラッシュしたり、パワーが低減した場合、このイベントは決して発生しません。

• ［wrapper_pause］ (ver. 3.5.0から) - Wrapperがポーズ（一時停止）する時にいつでも発生するイベントです。 ポーズ（一時停止）した時のWrapper動作については設定次第ですが、 停止されるJVMについてのイベントも、同様に発生します。

  詳しくは［wrapper.pausable］ ［wrapper.pausable.stop_jvm］プロパティをご覧ください。

• ［wrapper_resume］ (ver. 3.5.0から) - Wrapperがレジューム（再開）する時にいつでも発生するイベントです。 ポーズ（一時停止）した時のWrapper動作については設定次第ですが、 開始されるJVMについてのイベントも、同様に発生します。

  詳しくは［wrapper.pausable］ ［wrapper.pausable.stop_jvm］プロパティをご覧ください。

• ［user_<n>］ (ver. 3.5.0から) - あるアクションに応じて、ユーザー定義イベントが発生します。 イベント名の「<n>」コンポーネント部には、「１ - 32767」の範囲でインテージャー（整数値）が入ります。

  ユーザー定義イベントが発生するよう設定できるアクションには、次のものが含まれます： ［wrapper.filter.action.<n>］、 ［wrapper.timer.<n>.action］、 ［wrapper.check.deadlock.action］、 ［wrapper.event.<event_name>.command.block.action］

Wrapperでは、各イベントの種類に反応して、メール通知を送ることができます。 使い方などのさらに詳しくは、各プロパティの説明を個別にご覧ください。

# Common Event Email settings.
#wrapper.event.default.email.debug=TRUE
wrapper.event.default.email.smtp.host=smtp.mycompany.com
wrapper.event.default.email.smtp.port=25
wrapper.event.default.email.subject=[%WRAPPER_HOSTNAME%:%WRAPPER_NAME%:%WRAPPER_EVENT_NAME%] Event Notification
wrapper.event.default.email.from=myapp-noreply@mycompany.com
wrapper.event.default.email.recipient=myapp-admin@mycompany.com

# Event specific settings.
wrapper.event.jvm_restart.email=TRUE
wrapper.event.jvm_restart.email.body=The JVM was restarted.\n\nPlease check on its status.\n

このプロパティは、［wrapper.event.<x>.email*］形式で、 プロパティ名の「<x>」コンポーネント部には、 「default」（デフォルト）のキーワードか、あるいは、 上記で定義された「イベントの種類の１つ」を設定します。

プロパティに何もイベント名が特別には定義されていない時はいつでも、デフォルト値が適用されます。 全てのイベント・メールに対して一般的な値を設定するのに便利です。

Wrapperは、各イベントの種類に反応して外部コマンドを実行することができます。 使い方などのさらに詳しくは、各プロパティの説明を個別にご覧ください。

Wrapperに様々な指示を出すことができます。 例えば、コマンドを実行させたり、そのコマンドが完了するまでブロック（一時停止）したり、 あるいは、そのコマンドが完了する待機時間の最大時間を設定したり、など。 もし待機時間がタイムアウトになっても、そのコマンドはそのまま動作を継続します。

現在のところ、Wrapperは、外部コマンドの出力をログ化する機能を提供していません。

wrapper.event.jvm_prelaunch.command.argv.1=/usr/bin/mycleanup
wrapper.event.jvm_prelaunch.command.argv.2=parameter1

wrapper.event.jvm_prelaunch.command.argv.1=/usr/bin/mycleanup
wrapper.event.jvm_prelaunch.command.argv.2=parameter1
wrapper.event.jvm_prelaunch.command.block=TRUE

wrapper.event.jvm_prelaunch.command.argv.1=/usr/bin/mycleanup
wrapper.event.jvm_prelaunch.command.argv.2=parameter1
wrapper.event.jvm_prelaunch.command.block=TRUE
wrapper.event.jvm_prelaunch.command.block.timeout=5

このプロパティは、［wrapper.event.<x>.command.*］形式で、 プロパティ名の「<x>」コンポーネント部には、 上記で定義された「イベントの種類の１つ」を設定します。