Package nablarch.fw.web.handler

Class HttpAccessLogFormatter

java.lang.Object
nablarch.fw.web.handler.HttpAccessLogFormatter
Direct Known Subclasses:
HttpAccessJsonLogFormatter
@Published(tag="architect") public class HttpAccessLogFormatter extends Object
HTTPアクセスログのメッセージをフォーマットするクラス。
Author:
Kiyohito Itoh

  • Field Details

  • Constructor Details

    • HttpAccessLogFormatter

      public HttpAccessLogFormatter()
      フォーマット済みのログ出力項目を初期化する。

  • Method Details

    • initialize

      protected void initialize(Map<String,String> props)
      初期化。
      Parameters:
      props - 各種ログ出力の設定情報

    • initializeEnabled

      protected void initializeEnabled(Map<String,String> props)
      各ログ出力が有効か否かを初期化する。
      Parameters:
      props - 各種ログ出力の設定情報

    • initializeLogItems

      protected void initializeLogItems(Map<String,String> props)
      フォーマット済みのログ出力項目を初期化する。
      Parameters:
      props - 各種ログ出力の設定情報

    • createAccessLogContext

      public HttpAccessLogFormatter.HttpAccessLogContext createAccessLogContext()
      HttpAccessLogContextを生成する。
      Returns:
      HttpAccessLogContext

    • containsMemoryItem

      public boolean containsMemoryItem()
      出力対象にメモリ項目が含まれているか否かを判定する。
      Returns:
      出力対象にメモリ項目が含まれている場合はtrue

    • getLogItems

      protected Map<String,LogItem<HttpAccessLogFormatter.HttpAccessLogContext>> getLogItems(Map<String,String> props)
      フォーマット対象のログ出力項目を取得する。
      Parameters:
      props - 各種ログの設定情報
      Returns:
      フォーマット対象のログ出力項目

    • getDateFormat

      protected DateFormat getDateFormat(Map<String,String> props)
      日時フォーマットを取得する。
      プロパティの指定がない場合はデフォルトの日時フォーマットを返す。
      Parameters:
      props - 各種ログの設定情報
      Returns:
      日時フォーマット

    • getProp

      protected String getProp(Map<String,String> props, String propName, String defaultValue)
      プロパティを取得する。
      プロパティの指定がない場合はデフォルト値を返す。
      Parameters:
      props - 各種ログの設定情報
      propName - プロパティ名
      defaultValue - プロパティのデフォルト値
      Returns:
      プロパティ

    • getSeparator

      protected String getSeparator(Map<String,String> props, String propName, String defaultValue)
      区切り文字を取得する。
      Parameters:
      props - 各種ログの設定情報
      propName - プロパティ名
      defaultValue - プロパティのデフォルト値
      Returns:
      パラメータ間の区切り文字

    • getMaskingChar

      protected char getMaskingChar(Map<String,String> props)
      マスク文字を取得する。
      Parameters:
      props - 各種ログの設定情報
      Returns:
      マスク文字

    • getMaskingPatterns

      protected Pattern[] getMaskingPatterns(Map<String,String> props)
      マスク対象のパラメータ名を取得する。
      プロパティの指定がない場合はデフォルト値を返す。
      Parameters:
      props - 各種ログの設定情報
      Returns:
      マスク対象のパラメータ名

    • formatBegin

      public String formatBegin(HttpAccessLogFormatter.HttpAccessLogContext context)
      リクエスト処理開始時のメッセージをフォーマットする。
      Parameters:
      context - HttpAccessLogContext
      Returns:
      フォーマット済みのメッセージ

    • formatParameters

      public String formatParameters(HttpAccessLogFormatter.HttpAccessLogContext context)
      hiddenパラメータ復号後のメッセージをフォーマットする。
      Parameters:
      context - HttpAccessLogContext
      Returns:
      フォーマット済みのメッセージ

    • formatDispatchingClass

      public String formatDispatchingClass(HttpAccessLogFormatter.HttpAccessLogContext context)
      ディスパッチ先クラス決定後のメッセージをフォーマットする。
      Parameters:
      context - HttpAccessLogContext
      Returns:
      フォーマット済みのメッセージ

    • formatEnd

      public String formatEnd(HttpAccessLogFormatter.HttpAccessLogContext context)
      リクエスト処理終了時のメッセージをフォーマットする。
      Parameters:
      context - HttpAccessLogContext
      Returns:
      フォーマット済みのメッセージ

    • isBeginOutputEnabled

      public boolean isBeginOutputEnabled()
      リクエスト処理開始時の出力が有効かを判定する。
      Returns:
      リクエスト処理開始時の出力が有効な場合はtrue。

    • isParametersOutputEnabled

      public boolean isParametersOutputEnabled()
      hiddenパラメータ復号後の出力が有効かを判定する。
      Returns:
      hiddenパラメータ復号後の出力が有効な場合はtrue。

    • isDispatchingClassOutputEnabled

      public boolean isDispatchingClassOutputEnabled()
      ディスパッチ先クラス決定後の出力が有効かを判定する。
      Returns:
      ディスパッチ先クラス決定後の出力が有効な場合はtrue。

    • isEndOutputEnabled

      public boolean isEndOutputEnabled()
      リクエスト処理終了時の出力が有効かを判定する。
      Returns:
      リクエスト処理終了時の出力が有効な場合はtrue。