001/*
002 * Copyright (c) 2009 The openGion Project.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *     http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
013 * either express or implied. See the License for the specific language
014 * governing permissions and limitations under the License.
015 */
016package org.opengion.fukurou.process;
017
018import java.io.PrintWriter ;
019
020/**
021 * LoggerProcess インターフェース は、AbstractProcess を実行する上で必要となる
022 * 各種パラメータを設定します。
023 * 特に、データベース接続を使用する場合は、このインターフェースを使用して、
024 * データベースコネクションを取得する必要があります。
025 *
026 * @version  4.0
027 * @author   Kazuhiko Hasegawa
028 * @since    JDK5.0,
029 */
030public interface LoggerProcess extends HybsProcess {
031        /**
032         * ログ出力用のPrintWriterを設定します。
033         * 通常は、引数の -logFile=XXXX で指定しますが、直接 PrintWriter を
034         * 渡す必要があるケース(JSPなどで使用するケース)で使用します。
035         * 引数より、こちらの設定のほうが、優先されます。
036         *
037         * @param       logging ログ出力用のPrintWriter
038         */
039        void setLoggingWriter( final PrintWriter logging ) ;
040
041        /**
042         * 画面表示用のPrintWriterを設定します。
043         * 通常は、引数の -dispFile=XXXX で指定しますが、直接 PrintWriter を
044         * 渡す必要があるケース(JSPなどで使用するケース)で使用します。
045         * 引数より、こちらの設定のほうが、優先されます。
046         *
047         * @param       display 画面表示用のPrintWriter
048         */
049        void setDisplayWriter( final PrintWriter display ) ;
050
051        /**
052         * エラーログにメッセージを表示します。
053         * ここに書き込まれたメッセージは、通常ログと、特殊ログの
054         * 両方に書き込まれます。
055         * 特殊ログとは、メール連絡等のことです。
056         *
057         * @param       msg     表示するメッセージ
058         * @param       th      例外オブジェクト
059         */
060        void errLog( final String msg,final Throwable th ) ;
061}