Package nablarch.core.log.app

Class ApplicationSettingLogFormatter

java.lang.Object
nablarch.core.log.app.ApplicationSettingLogFormatter
Direct Known Subclasses:
ApplicationSettingJsonLogFormatter
@Published(tag="architect") public class ApplicationSettingLogFormatter extends Object
アプリケーション設定に関するログフォーマットを行うクラス。

主に、SystemRepository内の設定値をログ出力する際に使用する。

ログ出力対象の設定値は、ログ設定ファイルに設定されたキー値によって決定される。 SystemRepositoryに格納されている値が、String以外のオブジェクトの場合には、文字列への変換(toString())を行った結果の値をログに出力する。

以下に例を示す。 

 ◆ログ設定ファイル
 
 # 複数の設定値をログ出力したい場合には、以下のようにカンマ区切りで複数項目を列挙する。
 applicationSettingLogFormatter.systemSettingItems = dbUser, dbUrl, threadCount
 
 ◆ログ出力イメージ
 dbUser = [scott]
 dbUrl = [jdbc:oracle:thin:@localhost:1521:xe]
 threadCount = [3]

  • Field Details

  • Constructor Details

    • ApplicationSettingLogFormatter

      public ApplicationSettingLogFormatter()
      コンストラクタ。

  • Method Details

    • initialize

      protected void initialize()
      初期化処理。

    • getAppSettingsLogMsg

      public String getAppSettingsLogMsg()
      アプリケーション設定に関するログメッセージを生成する。

      getAppSettingsLogFormat()から取得したログフォーマットに従いログメッセージの生成を行う。 ログ出力対象は、アプリケーション設定はプロパティファイル("classpath:app-log.properties") に記載されている項目となる。
      システムプロパティ("nablarch.appLog.filePath")が指定されている場合は、 システムプロパティで指定されたパスを使用する。

      Returns:
      生成したアプリケーション設定ログ

    • getAppSettingsWithDateLogMsg

      public String getAppSettingsWithDateLogMsg()
      アプリケーション設定及び業務日付に関するログメッセージを生成する。

      getAppSettingsWithDateLogFormat()から取得したログフォーマットに従いログメッセージの生成を行う。 業務日付はBusinessDateUtil.getDate()を利用して取得する。

      Returns:
      生成したアプリケーション設定ログ

    • getAppSettingsLogFormat

      protected String getAppSettingsLogFormat()
      アプリケーション設定ログのフォーマットを取得する。

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

      Returns:
      生成したフォーマット

    • getAppSettingsLogItems

      protected Map<String,LogItem<ApplicationSettingLogFormatter.ApplicationSettingLogContext>> getAppSettingsLogItems()
      アプリケーション設定用のログ出力項目を生成する。
      Returns:
      生成したログ出力項目

    • getAppSettingsWithDateLogFormat

      public String getAppSettingsWithDateLogFormat()
      アプリケーション設定及び業務日付ログ用のログフォーマットを取得する。

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

      Returns:
      生成したフォーマット

    • getAppSettingsWithDateLogItems

      public Map<String,LogItem<ApplicationSettingLogFormatter.ApplicationSettingLogContext>> getAppSettingsWithDateLogItems()
      アプリケーション設定及び日付出力用のログ出力項目を生成する。
      Returns:
      ログ出力項目