|
||||||||||
前のクラス 次のクラス | フレームあり フレームなし | |||||||||
概要: 入れ子 | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド |
java.lang.Objectjp.co.fujitsu.reffi.client.nexaweb.logconsumer.LogConsumerAdapter
jp.co.fujitsu.reffi.client.nexaweb.logconsumer.FileLogConsumer
public class FileLogConsumer
[概 要]
クライアントログイベントをハンドリングしてローカルファイルに書き込むクラスです。[詳 細]
logイベント受信時にファイルにログメッセージ内容を書き込みます。jp.co.fujitsu.reffi.client.nexaweb.controller.BaseController#initialize()
を参照して下さい。
[備 考]
このLogConsumerはローカルファイルにアクセスする為、アプレット起動時はデジタル署名が必要です。
[環 境] JDK 6.0 Update 11
Copyright (c) 2008-2009 FUJITSU Japan All rights reserved.
コンストラクタの概要 | |
---|---|
FileLogConsumer()
|
メソッドの概要 | |
---|---|
protected void |
closeWriter()
[概 要] ログファイルへの書き込みストリームを閉じます。 |
protected OutputStreamWriter |
createWriter(File logFile)
[概 要] ログファイルへの書き込みストリームを生成します。 |
String |
getDirectoryPath()
[概 要] ログファイルが格納されるディレクトリパスを取得します。 |
String |
getEncoding()
[概 要] ログ出力キャラセットを取得します。 |
int |
getMaxBackupIndex()
[概 要] サイズローテーション後のバックアップ最大数を取得します。 |
int |
getMaxFileExist()
[概 要] ディレクトリ内に存在するログファイル上限を取得します。 |
long |
getMaxFileSize()
[概 要] 一ログファイルの最大サイズを取得します。 |
String |
getPrefix()
[概 要] ログファイル名の接頭文字を取得します。 |
String |
getSuffix()
[概 要] ログファイル名の拡張子を取得します。 |
Writer |
getWriter()
[概 要] ログファイルへの書き込みストリームを取得します。 |
void |
init(Object obj)
[概 要] このLogConsumerを初期化します。 |
void |
log(LogEvent evt)
[概 要] ログイベント受信ハンドラです。 |
protected String |
logFileName()
[概 要] ログファイル名を生成します。 |
protected String |
logFilePath()
[概 要] 生成されるログファイルのフルパスを取得します。 |
protected void |
rotateByMaxExist()
[概 要] ディレクトリ内のログファイルが指定最大数を超えた場合、古いログファイルを消去します。 |
protected void |
rotateBySize(File logFile)
[概 要] 指定最大byteを超えた書き込み対象ログファイルのバックアップをとります。 |
void |
setDirectoryPath(String directoryPath)
[概 要] ログファイルが格納されるディレクトリ名を設定します。 |
void |
setEncoding(String encoding)
[概 要] ログ出力キャラセットを設定します。 |
void |
setMaxBackupIndex(int maxBackupIndex)
[概 要] サイズローテーション後のバックアップ最大数を設定します。 |
void |
setMaxFileExist(int maxFileExist)
[概 要] ディレクトリ内に存在するログファイル上限を設定します。 |
void |
setMaxFileSize(long maxFileSize)
[概 要] 一ログファイルの最大サイズを設定します。 |
void |
setPrefix(String prefix)
[概 要] ログファイル名の接頭文字を設定します。 |
void |
setSuffix(String suffix)
[概 要] ログファイル名の拡張子を設定します。 |
void |
setWriter(Writer writer)
[概 要] ログファイルへの書き込みストリームを設定します。 |
クラス jp.co.fujitsu.reffi.client.nexaweb.logconsumer.LogConsumerAdapter から継承されたメソッド |
---|
createLogString, destroy, getDateFormat, getDateTime, getHeader, getLevelString, setDateFormat |
クラス java.lang.Object から継承されたメソッド |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
コンストラクタの詳細 |
---|
public FileLogConsumer()
メソッドの詳細 |
---|
public String getDirectoryPath()
[概 要]
ログファイルが格納されるディレクトリパスを取得します。[詳 細]
directoryPathフィールドを返却します。[備 考]
public void setDirectoryPath(String directoryPath)
[概 要]
ログファイルが格納されるディレクトリ名を設定します。[詳 細]
directoryPathフィールドに引数directoryPathを設定します。[備 考]
directoryPath
- ログファイルが格納されるディレクトリパスpublic int getMaxFileExist()
[概 要]
ディレクトリ内に存在するログファイル上限を取得します。[詳 細]
maxFileExistフィールドを返却します。[備 考]
public void setMaxFileExist(int maxFileExist)
[概 要]
ディレクトリ内に存在するログファイル上限を設定します。[詳 細]
maxFileExistフィールドを引数maxFileExistで設定します。[備 考]
maxFileExist
- ディレクトリ内に存在するログファイル上限public long getMaxFileSize()
[概 要]
一ログファイルの最大サイズを取得します。[詳 細]
maxFileSizeフィールドを返却します。[備 考]
public void setMaxFileSize(long maxFileSize)
[概 要]
一ログファイルの最大サイズを設定します。[詳 細]
maxFileSizeフィールドに引数maxFileSizeを設定します。[備 考]
maxFileSize
- 一ログファイルの最大サイズpublic int getMaxBackupIndex()
[概 要]
サイズローテーション後のバックアップ最大数を取得します。[詳 細]
maxBackupIndexフィールドを返却します。[備 考]
public void setMaxBackupIndex(int maxBackupIndex)
[概 要]
サイズローテーション後のバックアップ最大数を設定します。[詳 細]
maxBackupIndexフィールドに引数maxBackupIndexを設定します。[備 考]
maxBackupIndex
- サイズローテーション後のバックアップ最大数public String getPrefix()
[概 要]
ログファイル名の接頭文字を取得します。[詳 細]
prefixフィールドを返却します。[備 考]
public void setPrefix(String prefix)
[概 要]
ログファイル名の接頭文字を設定します。[詳 細]
prefixフィールドに引数prefixを設定します。[備 考]
prefix
- ログファイル名の接頭文字public String getSuffix()
[概 要]
ログファイル名の拡張子を取得します。[詳 細]
suffixフィールドを返却します。[備 考]
public void setSuffix(String suffix)
[概 要]
ログファイル名の拡張子を設定します。[詳 細]
suffixフィールドに引数suffixを設定します。[備 考]
suffix
- ログファイル名の拡張子public String getEncoding()
[概 要]
ログ出力キャラセットを取得します。[詳 細]
encodingフィールドを返却します。[備 考]
public void setEncoding(String encoding)
[概 要]
ログ出力キャラセットを設定します。[詳 細]
encodingフィールドに引数encodingを設定します。[備 考]
encoding
- ログ出力キャラセットpublic Writer getWriter()
[概 要]
ログファイルへの書き込みストリームを取得します。[詳 細]
writerフィールドを返却します。[備 考]
public void setWriter(Writer writer)
[概 要]
ログファイルへの書き込みストリームを設定します。[詳 細]
writerフィールドを引数writerで設定します。[備 考]
writer
- ログファイルへの書き込みストリームpublic void init(Object obj)
[概 要]
このLogConsumerを初期化します。[詳 細]
ClientConfig初期化オブジェクトから以下を取得してフィールドに設定します。[備 考]
Properties以外のobjは初期化パラメータとして認識されません。
LogConsumer
内の init
LogConsumerAdapter
内の init
obj
- 初期化パラメータpublic void log(LogEvent evt)
[概 要]
ログイベント受信ハンドラです。[詳 細]
LogConsumer#log(LogEvent)を実装します。 初期化された設定情報を元にファイルにログを追記、ローテーションします。[備 考]
evt
- Logクラスが発行したログイベントprotected void rotateBySize(File logFile) throws IOException
[概 要]
指定最大byteを超えた書き込み対象ログファイルのバックアップをとります。[詳 細]
getMaxBackupIndex()の返却値が0以上の場合、ファイル名に.1を付与します。[備 考]
getMaxBackupIndex()の返却値が0の場合はサイズバックアップは行われません。
logFile
- 書き込み中のログファイルインスタンス
IOException
protected void rotateByMaxExist()
[概 要]
ディレクトリ内のログファイルが指定最大数を超えた場合、古いログファイルを消去します。[詳 細]
getDirectoryPath()で求められるディレクトリから全ログファイルを取得、 ファイル数を求めます。[備 考]
protected OutputStreamWriter createWriter(File logFile) throws IOException
[概 要]
ログファイルへの書き込みストリームを生成します。[詳 細]
引数logFileへのOutputStreamWriterを、getEncoding()
エンコーディング
で作成、返却します。
[備 考]
logFile
- 書き込み対象にするログファイル
IOException
protected void closeWriter() throws IOException
[概 要]
ログファイルへの書き込みストリームを閉じます。[詳 細]
getWriter()がnullでは無い場合、getWriter().close()をコールします。[備 考]
IOException
protected String logFileName()
[概 要]
ログファイル名を生成します。[詳 細]
「プレフィックス + YYYYMMDD + サフィックス」のパターンでファイル名を生成します。[備 考]
プレフィックスとサフィックスを変更する場合はjp.co.fujitsu.reffi.client.nexaweb.controller.BaseController#initialize()
を参照して下さい。
protected String logFilePath()
[概 要]
生成されるログファイルのフルパスを取得します。[詳 細]
System.getProperties("user.home") / 指定されたディレクトリ名 / ログファイル名[備 考]
ディレクトリ名を変更する場合はjp.co.fujitsu.reffi.client.nexaweb.controller.BaseController#initialize()
を参照して下さい。
|
||||||||||
前のクラス 次のクラス | フレームあり フレームなし | |||||||||
概要: 入れ子 | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド |