ApplicationPidFileWriter (Spring Boot Docs 2.2.1.RELEASE API)

java.lang.ObjectSE
- org.springframework.boot.context.ApplicationPidFileWriter

実装済みのインターフェース一覧:
EventListenerSE, org.springframework.context.ApplicationListener<SpringApplicationEvent>, org.springframework.core.Ordered
```
public class ApplicationPidFileWriter
extends ObjectSE
implements org.springframework.context.ApplicationListener<SpringApplicationEvent>, org.springframework.core.Ordered
```
アプリケーション PID をファイルに保存する ApplicationListener。このアプリケーションリスナーは JVM ごとに 1 回だけトリガーされ、ファイル名は実行時に "PIDFILE" （または "pidfile" ）という名前のシステムプロパティまたは環境変数を使用するか、Spring Environment の spring.pid.file プロパティを使用してオーバーライドできます。
PID ファイルを作成できない場合、例外は報告されません。この動作は、true をシステムプロパティまたは PID_FAIL_ON_WRITE_ERROR （または "pid_fail_on_write_error" ）という名前の環境変数、または Spring Environment の spring.pid.fail-on-write-error プロパティに割り当てることで変更できます。
メモ: Spring Environment へのアクセスは、triggerEventType が ApplicationEnvironmentPreparedEvent、ApplicationReadyEvent、ApplicationPreparedEvent に設定されている場合にのみ可能です。
導入:
2.0.0
作成者:
Jakub Kubrynski, Dave Syer, Phillip Webb, Tomasz Przybyla, Madhura Bhave

フィールド概要
- インターフェース org.springframework.core.Ordered から継承されたフィールド
  HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

コンストラクター概要

コンストラクター
コンストラクターと説明
`ApplicationPidFileWriter()` ファイル名 "application.pid" を使用して、新しい `ApplicationPidFileWriter` インスタンスを作成します。
`ApplicationPidFileWriter(FileSE file)` 指定されたファイルで新しい `ApplicationPidFileWriter` インスタンスを作成します。
`ApplicationPidFileWriter(StringSE filename)` 指定したファイル名で新しい `ApplicationPidFileWriter` インスタンスを作成します。

方法の概要

すべてのメソッド静的メソッドインスタンスメソッド具象メソッド
修飾子と型	メソッドと説明
`int`	`getOrder()`
`void`	`onApplicationEvent(SpringApplicationEvent event)`
`protected static void`	`reset()` 作成したフラグをテスト用にリセットします。
`void`	`setOrder(int order)`
`void`	`setTriggerEventType(ClassSE<? extends SpringApplicationEvent> triggerEventType)` PID ファイルの書き込みをトリガーするアプリケーションイベントの型を設定します。

クラス java.lang.ObjectSE から継承されたメソッド
cloneSE, equalsSE, finalizeSE, getClassSE, hashCodeSE, notifySE, notifyAllSE, toStringSE, waitSE, waitSE, waitSE

- コンストラクターの詳細
  - ApplicationPidFileWriter
```
public ApplicationPidFileWriter()
```
    ファイル名 "application.pid" を使用して、新しい ApplicationPidFileWriter インスタンスを作成します。
  - ApplicationPidFileWriter
```
public ApplicationPidFileWriter(StringSE filename)
```
    指定したファイル名で新しい ApplicationPidFileWriter インスタンスを作成します。
    パラメーター:
    filename - pid を含むファイルの名前
  - ApplicationPidFileWriter
```
public ApplicationPidFileWriter(FileSE file)
```
    指定されたファイルで新しい ApplicationPidFileWriter インスタンスを作成します。
    パラメーター:
    file - pid を含むファイル
- メソッドの詳細
  - setTriggerEventType
```
public void setTriggerEventType(ClassSE<? extends SpringApplicationEvent> triggerEventType)
```
    PID ファイルの書き込みをトリガーするアプリケーションイベントの型を設定します。デフォルトは ApplicationPreparedEvent です。注: ApplicationStartingEvent を使用して書き込みをトリガーする場合、Spring Environment で PID ファイル名を指定することはできません。
    パラメーター:
    triggerEventType - トリガーイベント型
  - onApplicationEvent
```
public void onApplicationEvent(SpringApplicationEvent event)
```
    次で指定:
    インターフェース org.springframework.context.ApplicationListener<SpringApplicationEvent> 内の onApplicationEvent
  - setOrder
```
public void setOrder(int order)
```
  - getOrder
```
public int getOrder()
```
    次で指定:
    インターフェース org.springframework.core.Ordered 内の getOrder
  - reset
```
protected static void reset()
```
    作成したフラグをテスト用にリセットします。

クラス ApplicationPidFileWriter

フィールド概要

インターフェース org.springframework.core.Ordered から継承されたフィールド

コンストラクター概要

方法の概要

クラス java.lang.ObjectSE から継承されたメソッド

コンストラクターの詳細

ApplicationPidFileWriter

ApplicationPidFileWriter

ApplicationPidFileWriter

メソッドの詳細

setTriggerEventType

onApplicationEvent

setOrder

getOrder

reset