nablarch.fw.launcher.logging

Class LauncherLogFormatter

java.lang.Object

nablarch.fw.launcher.logging.LauncherLogFormatter

Direct Known Subclasses:

LauncherJsonLogFormatter

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

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	LauncherLogFormatter.CommandLineArguments コマンドライン引数を取得する。 コマンドライン引数は、CommandLine.getArgs()から取得する。
protected static class	LauncherLogFormatter.CommandLineOptions コマンドラインオプションを取得する。 コマンドラインオプションは、CommandLine.getParamMap() から取得した値。
protected static class	LauncherLogFormatter.ExecuteTime 実行時間を取得する。
protected static class	LauncherLogFormatter.ExitCode 終了コードを取得する。
protected static class	LauncherLogFormatter.LauncherLogContext バッチ実行ログコンテキスト

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	PROPS_PREFIX プロパティ名のプレフィックス

Constructor Summary

Constructors

Constructor and Description
LauncherLogFormatter()

Method Summary

Modifier and Type	Method and Description
protected java.lang.String	getEndLogFormat() 終了ログのフォーマットを取得する。 設定ファイル(nablarch.core.log.app.AppLogUtil#getProps())にログフォーマットが指定されている場合は、 そのフォーマットを返却する。 設定されていない場合には、デフォルトのフォーマットを使用する。 デフォルトのフォーマットは、以下の設定例のようにフォーマット定義を行うことにより変更可能
protected java.util.Map<java.lang.String,LogItem<LauncherLogFormatter.LauncherLogContext>>	getEndLogItems() 終了ログ用のログ出力項目を生成する。
java.lang.String	getEndLogMsg(int exitCode, long executeTime) 終了ログを生成する。 getEndLogFormat()から取得したログフォーマットに従いログメッセージの生成を行う。
protected java.lang.String	getStartLogFormat() 開始ログのフォーマットを取得する。 設定ファイル(nablarch.core.log.app.AppLogUtil#getProps())にログフォーマットが指定されている場合は、そのフォーマットを返却する。 設定されていない場合には、デフォルトのフォーマットを使用する。 デフォルトのフォーマットは、以下の設定例のようにフォーマット定義を行うことにより変更可能
protected java.util.Map<java.lang.String,LogItem<LauncherLogFormatter.LauncherLogContext>>	getStartLogItems() 開始ログ用のログ出力項目を生成する。
java.lang.String	getStartLogMsg(CommandLine commandLine) 開始ログを生成する。 getStartLogFormat()から取得したログフォーマットに従いログメッセージ生成を行う。

Methods inherited from class java.lang.Object

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

Field Detail

PROPS_PREFIX

public static final java.lang.String PROPS_PREFIX

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

See Also:

Constant Field Values

Constructor Detail

LauncherLogFormatter

public LauncherLogFormatter()

Method Detail

getStartLogMsg

public java.lang.String getStartLogMsg(CommandLine commandLine)

開始ログを生成する。

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

Parameters:

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

Returns:

生成した開始ログ

getEndLogMsg

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

終了ログを生成する。

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

Parameters:

exitCode - 終了コード

executeTime - 処理時間

Returns:

生成した終了ログ

getStartLogFormat

protected java.lang.String getStartLogFormat()

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

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

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

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

Returns:

開始ログのフォーマット

getStartLogItems

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

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

Returns:

生成したログ出力項目

getEndLogItems

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

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

Returns:

生成したログ出力項目

getEndLogFormat

protected java.lang.String getEndLogFormat()

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

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

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

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

Returns:

開始ログのフォーマット