Package nablarch.fw.jaxrs
Class JaxRsAccessLogFormatter
java.lang.Object
nablarch.fw.jaxrs.JaxRsAccessLogFormatter
- Direct Known Subclasses:
JaxRsAccessJsonLogFormatter
RESTfulウェブサービスのアクセスログのメッセージをフォーマットするクラス。
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic class
クライアント端末ホストを取得するクラス。static class
クライアント端末IPアドレスを取得するクラス。static class
HTTPヘッダの User-Agent を取得する。static class
終了日時を取得するクラス。static class
実行時間を取得するクラス。static class
空きメモリ量(開始時)を取得するクラス。static class
static class
最大メモリ量を取得するクラス。static class
HTTPメソッドを取得するクラス。static class
リクエストパラメータを取得するクラス。static class
ポート番号を取得するクラス。static class
クエリ文字列を取得するクラス。static class
リクエストのボディを取得する。static class
リクエストIDを取得するクラス。static class
レスポンスのボディを取得する。static class
セッションIDを取得するクラス。static class
セッションスコープ情報を取得するクラス。static class
セッションストアIDを取得するクラス。static class
開始日時を取得するクラス。static class
ステータスコードを取得するクラス。static class
URLを取得するクラス。static class
ユーザIDを取得する。 -
Field Summary
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionboolean
出力対象にメモリ項目が含まれているか否かを判定する。JaxRsAccessLogContextを生成する。protected MessageBodyLogTargetMatcher
createBodyLogTargetMatcher
(Map<String, String> props) ボディ出力対象であるか判定するMatcherを生成します。protected LogContentMaskingFilter
createBodyMaskingFilter
(Map<String, String> props) ボディ出力時のマスク処理を行うフィルタを生成します。リクエスト処理開始時のメッセージをフォーマットする。リクエスト処理終了時のメッセージをフォーマットする。protected DateFormat
getDateFormat
(Map<String, String> props) 日時フォーマットを取得する。 プロパティの指定がない場合はデフォルトの日時フォーマットを返す。getLogItems
(Map<String, String> props) フォーマット対象のログ出力項目を取得する。protected char
getMaskingChar
(Map<String, String> props) マスク文字を取得する。protected Pattern[]
getMaskingPatterns
(Map<String, String> props) マスク対象のパラメータ名を取得する。 プロパティの指定がない場合はデフォルト値を返す。protected String
プロパティを取得する。 プロパティの指定がない場合はデフォルト値を返す。protected String
区切り文字を取得する。void
initialize
(Map<String, String> props) 初期化する。protected void
initializeEnabled
(Map<String, String> props) 各ログ出力が有効か否かを初期化する。protected void
initializeLogItems
(Map<String, String> props) フォーマット済みのログ出力項目を初期化する。boolean
リクエスト処理開始時の出力が有効かを判定する。boolean
リクエスト処理終了時の出力が有効かを判定する。
-
Field Details
-
PROPS_PREFIX
プロパティ名のプレフィックス- See Also:
-
-
Constructor Details
-
JaxRsAccessLogFormatter
public JaxRsAccessLogFormatter()
-
-
Method Details
-
initialize
初期化する。- Parameters:
props
- 各種ログ出力の設定情報
-
initializeEnabled
各ログ出力が有効か否かを初期化する。- Parameters:
props
- 各種ログ出力の設定情報
-
initializeLogItems
フォーマット済みのログ出力項目を初期化する。- Parameters:
props
- 各種ログ出力の設定情報
-
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
ボディ出力時のマスク処理を行うフィルタを生成します。- Parameters:
props
- 各種ログの設定情報- Returns:
- マスク処理フィルタ
-
createBodyLogTargetMatcher
ボディ出力対象であるか判定するMatcherを生成します。- Parameters:
props
- 各種ログの設定情報- Returns:
- Matcher
-
getDateFormat
日時フォーマットを取得する。 プロパティの指定がない場合はデフォルトの日時フォーマットを返す。- Parameters:
props
- 各種ログの設定情報- Returns:
- 日時フォーマット
-
getProp
プロパティを取得する。 プロパティの指定がない場合はデフォルト値を返す。- Parameters:
props
- 各種ログの設定情報propName
- プロパティ名defaultValue
- プロパティのデフォルト値- Returns:
- プロパティ
-
getSeparator
区切り文字を取得する。- Parameters:
props
- 各種ログの設定情報propName
- プロパティ名defaultValue
- プロパティのデフォルト値- Returns:
- パラメータ間の区切り文字
-
getMaskingChar
マスク文字を取得する。- Parameters:
props
- 各種ログの設定情報- Returns:
- マスク文字
-
getMaskingPatterns
マスク対象のパラメータ名を取得する。 プロパティの指定がない場合はデフォルト値を返す。- Parameters:
props
- 各種ログの設定情報- Returns:
- マスク対象のパラメータ名
-
formatBegin
リクエスト処理開始時のメッセージをフォーマットする。- Parameters:
context
- JaxRsAccessLogContext- Returns:
- フォーマット済みのメッセージ
-
formatEnd
リクエスト処理終了時のメッセージをフォーマットする。- Parameters:
context
- JaxRsAccessLogContext- Returns:
- フォーマット済みのメッセージ
-
isBeginOutputEnabled
public boolean isBeginOutputEnabled()リクエスト処理開始時の出力が有効かを判定する。- Returns:
- リクエスト処理開始時の出力が有効な場合はtrue。
-
isEndOutputEnabled
public boolean isEndOutputEnabled()リクエスト処理終了時の出力が有効かを判定する。- Returns:
- リクエスト処理終了時の出力が有効な場合はtrue。
-