FileLogWriter (Nablarch-API)

java.lang.Object
- nablarch.core.log.basic.LogWriterSupport
- - nablarch.core.log.basic.FileLogWriter

すべての実装されたインタフェース:

LogWriter

直系の既知のサブクラス:

SynchronousFileLogWriter
```
public class FileLogWriter
extends LogWriterSupport
```
ファイルにログを書き込むクラス。

FileLogWriterクラスの特徴を下記に示す。
- ログフォーマッタを設定で指定できる。
- ログファイルが指定サイズに達したら、出力ファイルを自動で切り替える。
- 初期処理と終了処理、ログファイルの切り替え時に、書き込み先のログファイルにINFOレベルでメッセージを出力する。
本クラスでは、ファイルへのログ書き込みにBufferedOutputStreamを使用する。
出力バッファのサイズは設定で変更できる。
書き込み処理では、書き込み後にすぐにフラッシュし、書き込んだ内容をファイルに反映する。

プロパティファイルの記述ルールを下記に示す。

filePath
書き込み先のファイルパス。必須。

encoding
書き込み時に使用する文字エンコーディング。オプション。
指定しなければシステムプロパティ(file.encoding)から取得した文字エンコーディング。
outputBufferSize
出力バッファのサイズ。オプション。
単位はキロバイト。1000バイトを1キロバイトと換算する。１以上を指定する。指定しなければ8KB。
maxFileSize
書き込み先ファイルの最大サイズ。オプション。
単位はキロバイト。1000バイトを1キロバイトと換算する。指定しなければ自動切替なし。
指定値が解析可能な整数値(Long.parseLong)でない場合は自動切替なし。
指定値が０以下の場合は自動切替なし。
古いログファイル名は、<通常のファイル名>.yyyyMMddHHmmssSSS.old。
本クラスでは、初期処理と終了処理、ログファイルの切り替え時に、書き込み先のログファイルにINFOレベルでメッセージを出力する。

コンストラクタのサマリー

コンストラクタ
コンストラクタと説明

FileLogWriter()

コンストラクタ
コンストラクタと説明
`FileLogWriter()`

メソッドのサマリー

すべてのメソッドインスタンス・メソッド concreteメソッド
修飾子とタイプ	メソッドと説明
`protected java.lang.String`	`getSettings()` 設定情報を取得する。
`protected void`	`onInitialize(ObjectSettings settings)` 初期処理を行う。
`protected void`	`onTerminate()` 終了処理を行う。
`protected void`	`onWrite(java.lang.String formattedMessage)` フォーマット済みのログを出力先に書き込む。

クラスから継承されたメソッド nablarch.core.log.basic.LogWriterSupport
createLogFormatter, getFormatter, getName, initialize, needsToWrite, terminate, write

クラスから継承されたメソッド java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- コンストラクタの詳細
  - FileLogWriter
```
public FileLogWriter()
```
- メソッドの詳細
  - onInitialize
```
protected void onInitialize(ObjectSettings settings)
```
    初期処理を行う。
    ログの出力先に応じたリソースの確保などを実装する。
    デフォルト実装では何もしない。
    プロパティファイルで指定された設定情報を取得し、ファイルへの書き込みを行う出力ストリームを初期化する。
    初期処理完了後、INFOレベルで設定情報を出力する。
    
    オーバーライド:
    
    onInitialize クラス内 LogWriterSupport
    
    パラメータ:
    
    settings - LogWriterの設定内容
  - getSettings
```
protected java.lang.String getSettings()
```
    設定情報を取得する。
    
    設定情報のフォーマットを下記に示す。
    
    WRITER NAME = [<LogWriterの名称>]
    WRITER CLASS = [<LogWriterのクラス名>]
    FORMATTER CLASS = [<LogFormatterのクラス名>]
    LEVEL = [<ログの出力制御の基準とするLogLevel>] FILE PATH = [<書き込み先のファイルパス>]
    ENCODING = [<書き込み時に使用する文字エンコーディング>]
    OUTPUT BUFFER SIZE = [<出力バッファのサイズ>]
    FILE AUTO CHANGE = [<ログファイルを自動で切り替えるか否か。>]
    MAX FILE SIZE = [<書き込み先ファイルの最大サイズ>]
    CURRENT FILE SIZE = [<書き込み先ファイルの現在のサイズ>]
    
    オーバーライド:
    
    getSettings クラス内 LogWriterSupport
    
    戻り値:
    
    設定情報
    
    関連項目:
    
    LogWriterSupport.getSettings()
  - onTerminate
```
protected void onTerminate()
```
    終了処理を行う。
    ログの出力先に応じて確保しているリソースの解放などを実装する。
    デフォルト実装では何もしない。
    
    終了処理の前に、INFOレベルで終了メッセージを出力する。
    ファイルへの書き込みを行う出力ストリームをクローズする。
    
    オーバーライド:
    
    onTerminate クラス内 LogWriterSupport
  - onWrite
```
protected void onWrite(java.lang.String formattedMessage)
```
    フォーマット済みのログを出力先に書き込む。
    
    設定情報に基づきログをファイルに書き込む。
    書き込み後にすぐにフラッシュし、書き込んだ内容をファイルに反映する。
    
    IO例外が発生した場合は、IO例外をラップしてIllegalStateExceptionを送出する。
    
    定義:
    
    onWrite クラス内 LogWriterSupport
    
    パラメータ:
    
    formattedMessage - フォーマット済みのログ

クラス FileLogWriter

コンストラクタのサマリー

メソッドのサマリー

クラスから継承されたメソッド nablarch.core.log.basic.LogWriterSupport

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

コンストラクタの詳細

FileLogWriter

メソッドの詳細

onInitialize

getSettings

onTerminate

onWrite