Package nablarch.fw.jaxrs

Class JaxRsAccessLogFormatter

java.lang.Object
nablarch.fw.jaxrs.JaxRsAccessLogFormatter
Direct Known Subclasses:
JaxRsAccessJsonLogFormatter
@Published(tag="architect") public class JaxRsAccessLogFormatter extends Object
RESTfulウェブサービスのアクセスログのメッセージをフォーマットするクラス。

  • Field Details

  • Constructor Details

    • JaxRsAccessLogFormatter

      public JaxRsAccessLogFormatter()

  • Method Details

    • initialize

      public 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 JaxRsAccessLogFormatter.JaxRsAccessLogContext createAccessLogContext()
      JaxRsAccessLogContextを生成する。
      Returns:
      JaxRsAccessLogContext

    • containsMemoryItem

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

    • getLogItems

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

    • createBodyMaskingFilter

      protected LogContentMaskingFilter createBodyMaskingFilter(Map<String,String> props)
      ボディ出力時のマスク処理を行うフィルタを生成します。
      Parameters:
      props - 各種ログの設定情報
      Returns:
      マスク処理フィルタ

    • createBodyLogTargetMatcher

      protected MessageBodyLogTargetMatcher createBodyLogTargetMatcher(Map<String,String> props)
      ボディ出力対象であるか判定するMatcherを生成します。
      Parameters:
      props - 各種ログの設定情報
      Returns:
      Matcher

    • 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(JaxRsAccessLogFormatter.JaxRsAccessLogContext context)
      リクエスト処理開始時のメッセージをフォーマットする。
      Parameters:
      context - JaxRsAccessLogContext
      Returns:
      フォーマット済みのメッセージ

    • formatEnd

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

    • isBeginOutputEnabled

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

    • isEndOutputEnabled

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