nablarch.core.log.app

Class FailureLogUtil

java.lang.Object

nablarch.core.log.app.FailureLogUtil

public final class FailureLogUtil
extends java.lang.Object

障害ログを出力するユーティリティクラス。

本ユーティリティを使用するには、app-log.propertiesの設定が必要である。
障害通知ログは"MONITOR"、障害解析ログは本クラス名(FQCN)をロガー名に使用する。
ログレベルは、ログ出力に使用したメソッドにより決まる。

Method Summary

Modifier and Type	Method and Description
static java.lang.String	getNotificationMessage(java.lang.Object data, java.lang.String failureCode, java.lang.Object... messageOptions) フォーマットされた障害通知ログのメッセージを取得する。
static java.lang.String	getNotificationMessage(java.lang.Throwable error, java.lang.Object data, java.lang.String failureCode, java.lang.Object[] messageOptions) フォーマットされた障害通知ログのメッセージを取得する。
static void	initialize() クラスローダに紐付くFailureLogFormatterを生成する。
static void	logError(java.lang.Object data, java.lang.String failureCode, java.lang.Object... messageOptions) ERRORレベルの障害通知ログと障害解析ログを出力する。
static void	logError(java.lang.Throwable error, java.lang.Object data, java.lang.String failureCode, java.lang.Object... messageOptions) ERRORレベルの障害通知ログと障害解析ログを出力する。
static void	logError(java.lang.Throwable error, java.lang.Object data, java.lang.String failureCode, java.lang.Object[] messageOptions, java.lang.Object[] logOptions) ERRORレベルの障害通知ログと障害解析ログを出力する。
static void	logFatal(java.lang.Object data, java.lang.String failureCode, java.lang.Object... messageOptions) FATALレベルの障害通知ログと障害解析ログを出力する。
static void	logFatal(java.lang.Throwable error, java.lang.Object data, java.lang.String failureCode, java.lang.Object... messageOptions) FATALレベルの障害通知ログと障害解析ログを出力する。
static void	logFatal(java.lang.Throwable error, java.lang.Object data, java.lang.String failureCode, java.lang.Object[] messageOptions, java.lang.Object[] logOptions) FATALレベルの障害通知ログと障害解析ログを出力する。
static void	logWarn(java.lang.Throwable error, java.lang.Object data, java.lang.String failureCode, java.lang.Object... messageOptions) WARNレベルの障害解析ログを出力する。 フレームワークにおいて複数例外発生時に障害ログとして出力できない例外をログ出力する場合に使用する。

Methods inherited from class java.lang.Object

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

Method Detail

initialize

public static void initialize()

クラスローダに紐付くFailureLogFormatterを生成する。

logFatal

@Published(tag="architect")
public static void logFatal(java.lang.Object data,
                                                        java.lang.String failureCode,
                                                        java.lang.Object... messageOptions)

FATALレベルの障害通知ログと障害解析ログを出力する。

Parameters:

data - 処理対象データ

failureCode - 障害コード

messageOptions - 障害コードからメッセージを取得する際に使用するオプション情報

logFatal

@Published(tag="architect")
public static void logFatal(java.lang.Throwable error,
                                                        java.lang.Object data,
                                                        java.lang.String failureCode,
                                                        java.lang.Object... messageOptions)

FATALレベルの障害通知ログと障害解析ログを出力する。

Parameters:

error - エラー情報

data - 処理対象データ

failureCode - 障害コード

messageOptions - 障害コードからメッセージを取得する際に使用するオプション情報

logFatal

@Published(tag="architect")
public static void logFatal(java.lang.Throwable error,
                                                        java.lang.Object data,
                                                        java.lang.String failureCode,
                                                        java.lang.Object[] messageOptions,
                                                        java.lang.Object[] logOptions)

FATALレベルの障害通知ログと障害解析ログを出力する。

Parameters:

error - エラー情報

data - 処理対象データ

failureCode - 障害コード

messageOptions - 障害コードからメッセージを取得する際に使用するオプション情報

logOptions - ログのオプション情報

logError

@Published(tag="architect")
public static void logError(java.lang.Object data,
                                                        java.lang.String failureCode,
                                                        java.lang.Object... messageOptions)

ERRORレベルの障害通知ログと障害解析ログを出力する。

Parameters:

data - 処理対象データ

failureCode - 障害コード

messageOptions - 障害コードからメッセージを取得する際に使用するオプション情報

logError

@Published(tag="architect")
public static void logError(java.lang.Throwable error,
                                                        java.lang.Object data,
                                                        java.lang.String failureCode,
                                                        java.lang.Object... messageOptions)

ERRORレベルの障害通知ログと障害解析ログを出力する。

Parameters:

error - エラー情報

data - 処理対象データ

failureCode - 障害コード

messageOptions - 障害コードからメッセージを取得する際に使用するオプション情報

logError

@Published(tag="architect")
public static void logError(java.lang.Throwable error,
                                                        java.lang.Object data,
                                                        java.lang.String failureCode,
                                                        java.lang.Object[] messageOptions,
                                                        java.lang.Object[] logOptions)

ERRORレベルの障害通知ログと障害解析ログを出力する。

Parameters:

error - エラー情報

data - 処理対象データ

failureCode - 障害コード

messageOptions - 障害コードからメッセージを取得する際に使用するオプション情報

logOptions - ログのオプション情報

logWarn

@Published(tag="architect")
public static void logWarn(java.lang.Throwable error,
                                                       java.lang.Object data,
                                                       java.lang.String failureCode,
                                                       java.lang.Object... messageOptions)

WARNレベルの障害解析ログを出力する。

フレームワークにおいて複数例外発生時に障害ログとして出力できない例外をログ出力する場合に使用する。

Parameters:

error - エラー情報

data - 処理対象データ

failureCode - 障害コード

messageOptions - 障害コードからメッセージを取得する際に使用するオプション情報

getNotificationMessage

public static java.lang.String getNotificationMessage(java.lang.Object data,
                                                      java.lang.String failureCode,
                                                      java.lang.Object... messageOptions)

フォーマットされた障害通知ログのメッセージを取得する。

Parameters:

data - 処理対象データ

failureCode - 障害コード

messageOptions - 障害コードからメッセージを取得する際に使用するオプション情報

Returns:

フォーマット済みのメッセージ

getNotificationMessage

public static java.lang.String getNotificationMessage(java.lang.Throwable error,
                                                      java.lang.Object data,
                                                      java.lang.String failureCode,
                                                      java.lang.Object[] messageOptions)

フォーマットされた障害通知ログのメッセージを取得する。

Parameters:

error - エラー情報

data - 処理対象データ

failureCode - 障害コード

messageOptions - 障害コードからメッセージを取得する際に使用するオプション情報

Returns:

フォーマット済みのメッセージ