nablarch.fw.launcher.logging

クラス LauncherLogFormatter

java.lang.Object

nablarch.fw.launcher.logging.LauncherLogFormatter

@Published(tag="architect")
public class LauncherLogFormatter
extends java.lang.Object

Mainで出力するログメッセージをフォーマットするクラス。

ネストされたクラスのサマリー

ネストされたクラス

修飾子とタイプ	クラスと説明
protected static class	LauncherLogFormatter.CommandLineArguments コマンドライン引数を取得する。
protected static class	LauncherLogFormatter.CommandLineOptions コマンドラインオプションを取得する。
protected static class	LauncherLogFormatter.ExecuteTime 実行時間を取得する。
protected static class	LauncherLogFormatter.ExitCode 終了コードを取得する。
protected static class	LauncherLogFormatter.LauncherLogContext バッチ実行ログコンテキスト

フィールドのサマリー

フィールド

修飾子とタイプ	フィールドと説明
static java.lang.String	PROPS_PREFIX プロパティ名のプレフィックス

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

コンストラクタ

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

メソッドのサマリー

修飾子とタイプ	メソッドと説明
protected java.lang.String	getEndLogFormat() 終了ログのフォーマットを取得する。
protected java.util.Map<java.lang.String,LogItem<LauncherLogFormatter.LauncherLogContext>>	getEndLogItems() 終了ログ用のログ出力項目を生成する。
java.lang.String	getEndLogMsg(int exitCode, long executeTime) 終了ログを生成する。
protected java.lang.String	getStartLogFormat() 開始ログのフォーマットを取得する。
protected java.util.Map<java.lang.String,LogItem<LauncherLogFormatter.LauncherLogContext>>	getStartLogItems() 開始ログ用のログ出力項目を生成する。
java.lang.String	getStartLogMsg(CommandLine commandLine) 開始ログを生成する。

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

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

フィールドの詳細

PROPS_PREFIX

public static final java.lang.String PROPS_PREFIX

プロパティ名のプレフィックス

関連項目:

定数フィールド値

コンストラクタの詳細

LauncherLogFormatter

public LauncherLogFormatter()

メソッドの詳細

getStartLogMsg

public java.lang.String getStartLogMsg(CommandLine commandLine)

開始ログを生成する。

getStartLogFormat()から取得したログフォーマットに従いログメッセージ生成を行う。

パラメータ:

commandLine - コマンドラインオブジェクト

戻り値:

生成した開始ログ

getEndLogMsg

public java.lang.String getEndLogMsg(int exitCode,
                                     long executeTime)

終了ログを生成する。

getEndLogFormat()から取得したログフォーマットに従いログメッセージの生成を行う。

パラメータ:

exitCode - 終了コード

executeTime - 処理時間

戻り値:

生成した終了ログ

getStartLogFormat

protected java.lang.String getStartLogFormat()

開始ログのフォーマットを取得する。

設定ファイル(nablarch.core.log.app.AppLogUtil#getProps())にログフォーマットが指定されている場合は、そのフォーマットを返却する。 設定されていない場合には、デフォルトのフォーマットを使用する。

デフォルトのフォーマットは、以下の設定例のようにフォーマット定義を行うことにより変更可能

 
 launcherLogFormatter.startFormat = @@@@ BEGIN @@@@\n\tcommandLineArguments = [$commandLineArguments$]
 
 

戻り値:

開始ログのフォーマット

getStartLogItems

protected java.util.Map<java.lang.String,LogItem<LauncherLogFormatter.LauncherLogContext>> getStartLogItems()

開始ログ用のログ出力項目を生成する。

戻り値:

生成したログ出力項目

getEndLogItems

protected java.util.Map<java.lang.String,LogItem<LauncherLogFormatter.LauncherLogContext>> getEndLogItems()

終了ログ用のログ出力項目を生成する。

戻り値:

生成したログ出力項目

getEndLogFormat

protected java.lang.String getEndLogFormat()

終了ログのフォーマットを取得する。

設定ファイル(nablarch.core.log.app.AppLogUtil#getProps())にログフォーマットが指定されている場合は、 そのフォーマットを返却する。 設定されていない場合には、デフォルトのフォーマットを使用する。

デフォルトのフォーマットは、以下の設定例のようにフォーマット定義を行うことにより変更可能

 
 launcherLogFormatter.endFormat = @@@@ END @@@@ execute time(ms) = [$executeTime$], exit code = [$exitCode$]
 
 

戻り値:

開始ログのフォーマット