インデックス

wrapper.java.statusfile プロパティ
対応バージョン :3.2.0
対応エディション :プロフェッショナル版スタンダード版コミュニティー版
対応プラットフォーム :WindowsMac OSXLinuxIBM AIXFreeBSDHP-UXSolarisIBM z/OSIBM z/Linux

警告

このプロパティの説明を読まずに、パラメータを変更することは絶対にしないで下さい。 設定を間違えると、期待どおりに動作せず、Wrapper の動作不良や不具合の原因となります。

このプロパティには、現在の Java ステータスを書き込むファイルを設定します。 このプロパティは、デフォルトで設定されません。

このプロパティは、ほとんどのアプリケーションに使いません。 しかしながら、Java プロセスの状態をモニタリング（監視）する必要がある外部アプリケーションに便利に使えることでしょう。

このプロパティを設定すると、Java プロセスの内部ステータスが変化した時はいつでも、 Java プロセスの最新のステータスを含むファイルが、指定された配置場所へ書き込まれます。 そのファイルは、Wrapper プロセスが起動されるときに作成され、プロセスが終了するとファイルが削除されます。

設定例： 
wrapper.java.statusfile=./myapp.java.status

注意

Wrapper は、ステータス（状況）が変わるたびに、このファイルを開き、書き込む必要があります。 Wrapper は、短時間であれば外部プロセスによってファイルをロックすることを許可します。 しかしながら、１秒間以上、ファイルのロックが解放されずに書き込めないと、 Wrapper は失敗としてログに警告メッセージを記録しますが、Wrapper の運用には影響ありません。

ステータス（状況）の表記：

このファイルの書き込み形式は、単一のトークン表記された一行のテキストファイルで、 現在の Java プロセスのステータス（状況）を示します。

可能な値は次のとおり：

  • [DOWN_CLEAN] ：

    Java プロセスは完全にダウンしています。 これは、Wrapper が最初に起動するとき、また同様に、 Java プロセスが終了していると確認した後のステート（状態）です。 Wrapper 自身がシャットダウンをする前に、ステートは常に「DOWN_CLEAN」を返さなければなりません。

  • [LAUNCH(DELAY)] ：

    Wrapper が新しい JVM の起動待ちです。 これは、Wrapper が新しい JVM プロセス起動を待機している時のステート（状態）です。 ［wrapper.startup.delay］ プロパティが設定されている場合でのスタートアップ時や、あるいは、 ［wrapper.restart.delay］ プロパティ値に「0 (ゼロ)」より大きい値を設定されている場合での再起動中に、 このステート（状態）が発生します。 もし、Wrapper 自身が JVM を起動できる状態であれば、ステートは、スタートアップ時に「LAUNCH」に 変更され、再起動時（２回目以降の起動）には「RESTART」へ変化します。 それ以外の場合は、「DOWN_CLEAN」に戻ります。

  • [RESTART] ：

    Wrapper は JVM 起動を試みています。 もし、Wrapper 自身が JVM を起動できる状態であれば、ステートは、「LAUNCH」へ変化します。 それ以外の場合は、「DOWN_CLEAN」に戻ります。

  • [LAUNCH] ：

    Wrapper が新しい JVM を起動する準備を整っています。 通常は、ステートが「STARTING」へ変化します。 もし、プロセスを起動してすぐにエラーが発生した場合、ステートは「DOWN_CLEAN」に戻ります。

  • [LAUNCHING] ：

    Wrapper は JVM 起動プロセス中ですが、 新しい Java プロセスの存在はまだ確認できていません。 Wrapper がこのステート（状態）のまま継続が許可されている経過時間は、 ［wrapper.startup.timeout］ プロパティでコントロールすることができます。 通常ではステートは「LAUNCHED」へ変化します。 タイムアウトが発生した場合、ステートは「KILLING」へ変化します。

  • [LAUNCHED] ：

    Wrapper が、Java プロセスの配置により Java プロセスが起動したことを確認しました。 このステート（状態）は、ほとんど即座に常に「STARTING」へ変化します。

  • [STARTING] ：

    Java プロセスが起動しました。 JVMの［WrapperManager］クラスが、Wrapper でバックエンドソケットを開き、 ユーザーの Java アプリケーションが開始したことを Wrapper へ通知するまで、あるいは、JVM がシャットダウンを開始するまで、 このステート（状態）が続きます。 Wrapper がこのステート（状態）のまま継続が許可されている経過時間は、 ［wrapper.startup.timeout］ プロパティでコントロールすることができます。 通常ではステートは「STARTED」へ変化します。 タイムアウトが発生した場合、ステートは「KILLING」に変化します。

  • [STARTED] ：

    JVM の［WrapperManager］クラスが、アプリケーションが立ち上がり動作していることを、 Wrapper へ通知しました。 JVM がシャットダウンを開始するまで、このステート（状態）が続きます。 一旦、このステート（状態）になると、Wrapperは、 ［wrapper.ping.interval］ プロパティで指定されいるインターバル（一定間隔）で、 ［WrapperManager］クラスに ping を送信します。 ［WrapperManager］クラスは、 ［wrapper.ping.timeout］ プロパティで指定されている時間以内に、応答しなければなりません。 通常では、JVM を停止するように要求されるまで、Wrapper はこのステート（状態）のままになり、 要求があると「STOP」へ変化します。 ping タイムアウトが発生した場合、ステートは「KILLING」に変化します。

  • [STOP] ：

    Wrapper は、JVM を停止するように要求された、或いは JVM を停止する必要があると判断しました。 JVM をキレイにシャットダウンするようにリクエストします。 ステートは、その時に「STOPPING」へ変化します。

  • [STOPPING] ：

    JVM は内部アプリケーションの停止を開始しました。 JVM の［WrapperManager］ クラスが、アプリケーションが停止したことを、 Wrapper へ通知するまで、このステート（状態）が続きます。 Wrapper がこのステート（状態）のまま継続が許可されている経過時間は、 ［wrapper.shutdown.timeout］ プロパティでコントロールすることができます。 タイムアウトが発生した場合、ステートは「KILLING」に変化します。

  • [STOPPED] ：

    JVM の［WrapperManager］ クラスが、アプリケーションが停止したことを、Wrapper へ通知しました。 Java プロセスが実際に終了するまで、このステート（状態）が続きます。 Wrapper がこのステート（状態）のまま継続が許可されている経過時間は、 ［wrapper.jvm_exit.timeout］ プロパティでコントロールすることができます。 通常ではステートは「DOWN_CHECK」へ変化します。 タイムアウトが発生した場合、ステートは「KILLING」に変化します。

  • [KILLING] ：

    Wrapper は、Java プロセスを強制終了する必要があると判断しました。 もし、［wrapper.request_thread_dump_on_failed_jvm_exit］プロパティが設定されていた場合、Wrapper が Java を終了する前に、Java がダンプを完了させるまで待機する必要がある。 この延長は、［wrapper.request_thread_dump_on_failed_jvm_exit.delay」で設定します。 ステートを完了すると、「KILL」へ変化します。

  • [KILL] ：

    Wrapper は、JVM を強制終了する準備を整えました。 リクエストを送信すると、ステートは「KILLED」へ変化します。

  • [KILLED] （ver. 3.5.18 から）：

    Java プロセスを強制終了するようにリクエストが送信されているが、Wrapper が Java プロセスが終了したことの確認を待っています。 Wrapper がこのステート（状態）のまま継続が許可されている経過時間は、 ［wrapper.jvm_terminate.timeout］ プロパティでコントロールすることができます。 Java プロセスが終了したことを確認できると、ステートは「DOWN_CHECK」へ変化します。

  • [DOWN_CHECK] ：

    Wrapper は、JVM プロセスがもう存在しないことを確認しました。 このステートは、プロフェッショナル版で「WrapperManager.exec」より作成されたチャイルド（子）プロセスをすべてクリーンアップするために使用されます。 全てのプロセスがクリーンアップされると、ステートは「DOWN_FLUSH」へ変化します。

  • [DOWN_FLUSH] ：

    Wrapper が JVM プロセスがもう存在しないことを確認しましたが、stdout と stderr パイプに、まだログ化されていない Java プロセス出力があります。 このステートは、続行する前にすべてのログ出力が書き込まれることを確認するために使用されます。 ログ出力完了後、ステートは「DOWN_CLEAN」へ変化されます。

注意

このプロパティは、 コンフィギュレーションのリロード（再読み込み） で、プロパティ値を有効にすることはできません。 変更したプロパティ値を有効にするためには、Wrapper を再起動してください。

wrapper.java.statusfile.group プロパティ
対応バージョン :3.5.38
対応エディション :プロフェッショナル版スタンダード版コミュニティー版
対応プラットフォーム :Windows (未対応)Mac OSXLinuxIBM AIXFreeBSDHP-UXSolarisIBM z/OSIBM z/Linux

このファイルに「グループ」を設定することができます。 詳しくは［wrapper.*.group］プロパティを参照ください。

設定例： 
wrapper.java.statusfile.group=jenkins

wrapper.java.statusfile.umask プロパティ
対応バージョン :3.2.0
対応エディション :プロフェッショナル版スタンダード版コミュニティー版
対応プラットフォーム :WindowsMac OSXLinuxIBM AIXFreeBSDHP-UXSolarisIBM z/OSIBM z/Linux

このファイルに「umask」を設定することができます。 詳しくは［wrapper.*.umask］プロパティを参照ください。

設定例： 
wrapper.java.statusfile.umask=0022

参照： PID、ID、ステータスファイル
  • [ wrapper.anchorfile ] (3.1.1)

    スタートアップ時に作成されたアンカーファイルのパスを指定します。

  • [ wrapper.java.pidfile ] (3.0.5)

    Java プロセス ID を書き込むファイルのパスを設定します。

  • [ wrapper.java.idfile ] (3.2.0)

    Wrapper が生成した現在の Java ID を書き込むファイルのパスを設定します。

  • [ wrapper.java.statusfile ] (3.2.0)

    JVM の現在のステータスを書き込むファイルのパスを指定します。

  • [ wrapper.pidfile ] (Usage changed in 3.0.5)

    Wrapper プロセスの PID を書き込むファイルのパスを指定します。

  • [ wrapper.lockfile ] (3.2.0)

    Wrapper プロセス ID を含むロックファイルを設定します。

  • [ wrapper.statusfile ] (3.2.0)

    現在の Wrapper ステータスを書き込むファイルのパスを設定します。

  • [ wrapper.*.group ] (3.5.38)

    Wrapper が特定のファイルを作成するときに割り当てるグループを指定します。

  • [ wrapper.*.umask ] (3.2.0)

    Wrapper によって作成された特定のファイルに対するパーミッション（アクセス権限）を指定します。