概要 | パッケージ | クラス | 階層ツリー | 非推奨 API | 索引 | ヘルプ
openGion 5.1.3.0
前のクラス 次のクラス | フレームあり フレームなし
概要: 入れ子 | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド

## 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=送信先アドレスをカンマ区切りで並べる
         [ -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 から継承されたフィールド
`CR, TAB`

コンストラクタの概要
`Process_Logger()` デフォルトコンストラクター。

メソッドの概要
`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, 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)

  プロセスの初期化を行います。初めに一度だけ、呼び出されます。 初期処理（ファイルオープン、ＤＢオープン等）に使用します。

  定義:
    インタフェース `HybsProcess` 内の `init`
  パラメータ:
    `paramProcess` - ParamProcess

### end

    public void end(boolean isOK)

  プロセスの終了を行います。最後に一度だけ、呼び出されます。 終了処理（ファイルクローズ、ＤＢクローズ等）に使用します。

  定義:
    インタフェース `HybsProcess` 内の `end`
  パラメータ:
    `isOK` - トータルで、OKだったかどうか(true:成功/false:失敗）

### logging

    public void logging(String msg)

  ログファイルにメッセージを表示します。

  定義:
    インタフェース `HybsProcess` 内の `logging`
  オーバーライド:
    クラス `AbstractProcess` 内の `logging`
  パラメータ:
    `msg` - String 表示するメッセージ

### println

    public void println(String msg)

  ディスプレイにメッセージを表示します。

  定義:
    インタフェース `HybsProcess` 内の `println`
  オーバーライド:
    クラス `AbstractProcess` 内の `println`
  パラメータ:
    `msg` - String 表示するメッセージ

### errLog

    public void errLog(String msg,
                       Throwable th)

  エラーログにメッセージを表示します。 ここに書き込まれたメッセージは、通常ログと、特殊ログの 両方に書き込まれます。 特殊ログとは、メール連絡等のことです。

  定義:
    インタフェース `LoggerProcess` 内の `errLog`
  パラメータ:
    `msg` - String 表示するメッセージ
    `th` - Throwable 例外オブジェクト

### setLoggingWriter

    public void setLoggingWriter(PrintWriter logWriter)

  ログ出力用のPrintWriterを設定します。 通常は、引数の -logFile=XXXX で指定しますが、直接 PrintWriter を 渡す必要があるケース（JSPなどで使用するケース）で使用します。 引数より、こちらの設定のほうが、優先されます。 ※ JspWriter を渡す場合の PrintWriter は、flushing および、close 処理を 行わない NonFlushPrintWriter を設定してください。

  定義:
    インタフェース `LoggerProcess` 内の `setLoggingWriter`
  パラメータ:
    `logWriter` - PrintWriter ログ出力用のPrintWriter

### setDisplayWriter

    public void setDisplayWriter(PrintWriter dispWriter)

  画面表示用のPrintWriterを設定します。 通常は、引数の -dispFile=XXXX で指定しますが、直接 PrintWriter を 渡す必要があるケース（JSPなどで使用するケース）で使用します。 引数より、こちらの設定のほうが、優先されます。 ※ JspWriter を渡す場合の PrintWriter は、flushing および、close 処理を 行わない NonFlushPrintWriter を設定してください。

  定義:
    インタフェース `LoggerProcess` 内の `setDisplayWriter`
  パラメータ:
    `dispWriter` - PrintWriter 画面表示用のPrintWriter

### report

    public String report()

  プロセスの処理結果のレポート表現を返します。 処理プログラム名、入力件数、出力件数などの情報です。 この文字列をそのまま、標準出力に出すことで、結果レポートと出来るような 形式で出してください。

  定義:
    インタフェース `HybsProcess` 内の `report`
  戻り値:
    処理結果のレポート

### usage

    public String usage()

  このクラスの使用方法を返します。

  定義:
    インタフェース `HybsProcess` 内の `usage`
  戻り値:
    String

### main

    public static void main(String[] args)

  このクラスは、main メソッドから実行できません。

  パラメータ:
    `args` - String[]

概要 | パッケージ | クラス | 階層ツリー | 非推奨 API | 索引 | ヘルプ
| openGion 5.1.3.0
前のクラス 次のクラス | フレームあり フレームなし
概要: 入れ子 | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド

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