org.opengion.fukurou.process

## クラス Process_Logger

- java.lang.Object
- - org.opengion.fukurou.process.AbstractProcess
  - - org.opengion.fukurou.process.Process_Logger

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

      public class Process_Logger
      extends AbstractProcess
      implements LoggerProcess

       Process_Logger は、画面出力、ファイルログ、エラーメールを管理する、
       ロギング関係の LoggerProcess インターフェースの実装クラスです。

       MainProcess で使用されるログと、各種 Process で使用されるディスプレイを
       管理します。また、エラー発生時の、メール送信機能も、ここで用意します。

       引数文字列中にスペースを含む場合は、ダブルコーテーション("") で括って下さい。
       引数文字列の 『=』の前後には、スペースは挟めません。必ず、-key=value の様に
       繋げてください。

  形式サンプル:

         Process_Logger -logFile=ABC.txt -dispFile=System.out

           [ -logFile=ログ出力先指定  ] ： -logFile=[ファイル名/System.out/System.err] (初期値:null)
           [ -dispFile=画面出力先指定 ] ： -dispFile=[ファイル名/System.out/System.err](初期値:null)
           [ -host=メールサーバ       ] ： -host=メールサーバー
           [ -from=送信From           ] ： -from=送信元アドレス
           [ -to=受信To               ] ： -to=送信先アドレスをCSV形式で並べる
           [ -charset=ｷｬﾗｸﾀｾｯﾄ        ] ： -charset=メール送信時のキャラクタセット [ISO-2022-JP / Windows-31J]
           [ -subject=タイトル        ] ： -subject=タイトル
           [ -message=本文雛形        ] ： -message=本文雛形文章
           [ -msgFile=本文雛形ﾌｧｲﾙ    ] ： -msgFile=本文を格納しているファイルのアドレス
           [ -{@XXXX}=YYYY       ] ： メッセージ本文の {@XXXX} 文字列を、YYYY 文字列に変換します。

  バージョン
    4.0
  作成者
    Kazuhiko Hasegawa
  導入されたバージョン:
    JDK5.0,

- - ### フィールドのサマリー

    フィールド
    修飾子とタイプ | フィールドと説明
    --- | ---
    `static String` | `DEFAULT_CHARSET` メール送信時のデフォルトキャラクタセット "ISO-2022-JP"

    - ### クラスから継承されたフィールド org.opengion.fukurou.process.AbstractProcess

      `BUFFER_LARGE, BUFFER_MIDDLE, CR, TAB`

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

    コンストラクタ
    コンストラクタと説明
    `Process_Logger()` デフォルトコンストラクター。

  - ### メソッドのサマリー

    すべてのメソッド staticメソッド インスタンス・メソッド concreteメソッド
    修飾子とタイプ | メソッドと説明
    --- | ---
    `void` | `end(boolean isOK)` プロセスの終了を行います。
    `void` | `errLog(String msg, Throwable th)` エラーログにメッセージを表示します。
    `void` | `init(ParamProcess paramProcess)` プロセスの初期化を行います。
    `void` | `logging(String msg)` ログファイルにメッセージを表示します。
    `static void` | `main(String[] args)` このクラスは、main メソッドから実行できません。
    `void` | `println(String msg)` ディスプレイにメッセージを表示します。
    `String` | `report()` プロセスの処理結果のレポート表現を返します。
    `void` | `setDisplayWriter(PrintWriter dispWriter)` 画面表示用のPrintWriterを設定します。
    `void` | `setLoggingWriter(PrintWriter logWriter)` ログ出力用のPrintWriterを設定します。
    `String` | `usage()` このクラスの使用方法を返します。

    - ### クラスから継承されたメソッド org.opengion.fukurou.process.AbstractProcess

      `getArgument, putArgument, putArgument, setLoggerProcess, throwException, throwException, toString`

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

      `clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`

    - ### インタフェースから継承されたメソッド org.opengion.fukurou.process.HybsProcess

      `putArgument, putArgument, setLoggerProcess`

- - ### フィールドの詳細

    - #### DEFAULT_CHARSET

          public static final String DEFAULT_CHARSET

      メール送信時のデフォルトキャラクタセット "ISO-2022-JP"
      関連項目:
        定数フィールド値

  - ### コンストラクタの詳細

    - #### Process_Logger

          public Process_Logger()

      デフォルトコンストラクター。 このクラスは、動的作成されます。デフォルトコンストラクターで、 super クラスに対して、必要な初期化を行っておきます。

  - ### メソッドの詳細

    - #### init

          public void init(ParamProcess paramProcess)

      プロセスの初期化を行います。初めに一度だけ、呼び出されます。 初期処理(ファイルオープン、ＤＢオープン等)に使用します。
      定義:
        `init` インタフェース内 `HybsProcess`
      パラメータ:
        `paramProcess` - データベースの接続先情報などを持っているオブジェクト
      変更履歴:

        5.3.4.0 (2011/04/01) タイトル追加

    - #### end

          public void end(boolean isOK)

      プロセスの終了を行います。最後に一度だけ、呼び出されます。 終了処理(ファイルクローズ、ＤＢクローズ等)に使用します。
      定義:
        `end` インタフェース内 `HybsProcess`
      パラメータ:
        `isOK` - トータルで、OKだったかどうか[true:成功/false:失敗]

    - #### logging

          public void logging(String msg)

      ログファイルにメッセージを表示します。
      定義:
        `logging` インタフェース内 `HybsProcess`
      オーバーライド:
        `logging` クラス内 `AbstractProcess`
      パラメータ:
        `msg` - 表示するメッセージ
      変更履歴:

        6.3.1.1 (2015/07/10) JspWriter を使用する場合は、タグをエスケープする必要がある。

    - #### println

          public void println(String msg)

      ディスプレイにメッセージを表示します。
      定義:
        `println` インタフェース内 `HybsProcess`
      オーバーライド:
        `println` クラス内 `AbstractProcess`
      パラメータ:
        `msg` - 表示するメッセージ

    - #### errLog

          public void errLog(String msg,
                             Throwable th)

      エラーログにメッセージを表示します。 ここに書き込まれたメッセージは、通常ログと、特殊ログの 両方に書き込まれます。 特殊ログとは、メール連絡等のことです。
      定義:
        `errLog` インタフェース内 `LoggerProcess`
      パラメータ:
        `msg` - 表示するメッセージ
        `th` - Throwable例外オブジェクト
      変更履歴:

        6.3.1.1 (2015/07/10) JspWriter を使用する場合は、タグをエスケープする必要がある。
        6.4.2.0 (2016/01/29) ex.printStackTrace() を、ThrowUtil#ogStackTrace(Throwable) に置き換え。

    - #### setLoggingWriter

          public void setLoggingWriter(PrintWriter logWriter)

      ログ出力用のPrintWriterを設定します。 通常は、引数の -logFile=XXXX で指定しますが、直接 PrintWriter を 渡す必要があるケース(JSPなどで使用するケース)で使用します。 引数より、こちらの設定のほうが、優先されます。 ※ JspWriter を渡す場合の PrintWriter は、flushing および、close 処理を 行わない NonFlushPrintWriter を設定してください。 ※ 6.3.1.1 (2015/07/10) このメソッドは、JspWriter を設定する時のみ使用されるので、出力時には StringUtil#htmlFilter(String) を使って、タグをエスケープします。 そのための、フラグを用意します。
      定義:
        `setLoggingWriter` インタフェース内 `LoggerProcess`
      パラメータ:
        `logWriter` - ログ出力用のPrintWriter
      変更履歴:

        6.3.1.1 (2015/07/10) JspWriter を使用する場合は、タグをエスケープする必要がある。

    - #### setDisplayWriter

          public void setDisplayWriter(PrintWriter dispWriter)

      画面表示用のPrintWriterを設定します。 通常は、引数の -dispFile=XXXX で指定しますが、直接 PrintWriter を 渡す必要があるケース(JSPなどで使用するケース)で使用します。 引数より、こちらの設定のほうが、優先されます。 ※ JspWriter を渡す場合の PrintWriter は、flushing および、close 処理を 行わない NonFlushPrintWriter を設定してください。 ※ 6.3.1.1 (2015/07/10) このメソッドは、JspWriter を設定する時のみ使用されるので、出力時には StringUtil#htmlFilter(String) を使って、タグをエスケープします。 そのための、フラグを用意します。
      定義:
        `setDisplayWriter` インタフェース内 `LoggerProcess`
      パラメータ:
        `dispWriter` - 画面表示用のPrintWriter
      変更履歴:

        6.3.1.1 (2015/07/10) JspWriter を使用する場合は、タグをエスケープする必要がある。

    - #### report

          public String report()

      プロセスの処理結果のレポート表現を返します。 処理プログラム名、入力件数、出力件数などの情報です。 この文字列をそのまま、標準出力に出すことで、結果レポートと出来るような 形式で出してください。
      定義:
        `report` インタフェース内 `HybsProcess`
      戻り値:
        処理結果のレポート
      変更履歴:

        5.3.4.0 (2011/04/01) タイトル追加

      このメソッドは、nullを返しません

    - #### usage

          public String usage()

      このクラスの使用方法を返します。
      定義:
        `usage` インタフェース内 `HybsProcess`
      戻り値:
        このクラスの使用方法
      このメソッドは、nullを返しません

    - #### main

          public static void main(String[] args)

      このクラスは、main メソッドから実行できません。
      パラメータ:
        `args` - コマンド引数配列

Webアプリケーションフレームワーク openGion
Copyright (c) 2009 The openGion Project.