JaxRsAccessLogFormatter (Nablarch-API)

java.lang.Object
- nablarch.fw.jaxrs.JaxRsAccessLogFormatter

Direct Known Subclasses:

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

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`JaxRsAccessLogFormatter.ClientHostItem` クライアント端末ホストを取得するクラス。
`static class`	`JaxRsAccessLogFormatter.ClientIpAddressItem` クライアント端末IPアドレスを取得するクラス。
`static class`	`JaxRsAccessLogFormatter.ClientUserAgentItem` HTTPヘッダの User-Agent を取得する。
`static class`	`JaxRsAccessLogFormatter.EndTimeItem` 終了日時を取得するクラス。
`static class`	`JaxRsAccessLogFormatter.ExecutionTimeItem` 実行時間を取得するクラス。
`static class`	`JaxRsAccessLogFormatter.FreeMemoryItem` 空きメモリ量(開始時)を取得するクラス。
`static class`	`JaxRsAccessLogFormatter.JaxRsAccessLogContext`
`static class`	`JaxRsAccessLogFormatter.MaxMemoryItem` 最大メモリ量を取得するクラス。
`static class`	`JaxRsAccessLogFormatter.MethodItem` HTTPメソッドを取得するクラス。
`static class`	`JaxRsAccessLogFormatter.ParametersItem` リクエストパラメータを取得するクラス。
`static class`	`JaxRsAccessLogFormatter.PortItem` ポート番号を取得するクラス。
`static class`	`JaxRsAccessLogFormatter.QueryStringItem` クエリ文字列を取得するクラス。
`static class`	`JaxRsAccessLogFormatter.RequestBodyItem` リクエストのボディを取得する。
`static class`	`JaxRsAccessLogFormatter.RequestIdItem` リクエストIDを取得するクラス。
`static class`	`JaxRsAccessLogFormatter.ResponseBodyItem` レスポンスのボディを取得する。
`static class`	`JaxRsAccessLogFormatter.SessionIdItem` セッションIDを取得するクラス。
`static class`	`JaxRsAccessLogFormatter.SessionScopeItem` セッションスコープ情報を取得するクラス。
`static class`	`JaxRsAccessLogFormatter.SessionStoreIdItem` セッションストアIDを取得するクラス。
`static class`	`JaxRsAccessLogFormatter.StartTimeItem` 開始日時を取得するクラス。
`static class`	`JaxRsAccessLogFormatter.StatusCodeItem` ステータスコードを取得するクラス。
`static class`	`JaxRsAccessLogFormatter.UrlItem` URLを取得するクラス。
`static class`	`JaxRsAccessLogFormatter.UserIdItem` ユーザIDを取得する。

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String PROPS_PREFIX
プロパティ名のプレフィックス

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`PROPS_PREFIX` プロパティ名のプレフィックス

Constructor Summary

Constructors
Constructor and Description

JaxRsAccessLogFormatter()

Constructors
Constructor and Description
`JaxRsAccessLogFormatter()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`containsMemoryItem()` 出力対象にメモリ項目が含まれているか否かを判定する。
`JaxRsAccessLogFormatter.JaxRsAccessLogContext`	`createAccessLogContext()` JaxRsAccessLogContextを生成する。
`protected MessageBodyLogTargetMatcher`	`createBodyLogTargetMatcher(java.util.Map<java.lang.String,java.lang.String> props)` ボディ出力対象であるか判定するMatcherを生成します。
`protected LogContentMaskingFilter`	`createBodyMaskingFilter(java.util.Map<java.lang.String,java.lang.String> props)` ボディ出力時のマスク処理を行うフィルタを生成します。
`java.lang.String`	`formatBegin(JaxRsAccessLogFormatter.JaxRsAccessLogContext context)` リクエスト処理開始時のメッセージをフォーマットする。
`java.lang.String`	`formatEnd(JaxRsAccessLogFormatter.JaxRsAccessLogContext context)` リクエスト処理終了時のメッセージをフォーマットする。
`protected java.text.DateFormat`	`getDateFormat(java.util.Map<java.lang.String,java.lang.String> props)` 日時フォーマットを取得する。プロパティの指定がない場合はデフォルトの日時フォーマットを返す。
`protected java.util.Map<java.lang.String,LogItem<JaxRsAccessLogFormatter.JaxRsAccessLogContext>>`	`getLogItems(java.util.Map<java.lang.String,java.lang.String> props)` フォーマット対象のログ出力項目を取得する。
`protected char`	`getMaskingChar(java.util.Map<java.lang.String,java.lang.String> props)` マスク文字を取得する。
`protected java.util.regex.Pattern[]`	`getMaskingPatterns(java.util.Map<java.lang.String,java.lang.String> props)` マスク対象のパラメータ名を取得する。プロパティの指定がない場合はデフォルト値を返す。
`protected java.lang.String`	`getProp(java.util.Map<java.lang.String,java.lang.String> props, java.lang.String propName, java.lang.String defaultValue)` プロパティを取得する。プロパティの指定がない場合はデフォルト値を返す。
`protected java.lang.String`	`getSeparator(java.util.Map<java.lang.String,java.lang.String> props, java.lang.String propName, java.lang.String defaultValue)` 区切り文字を取得する。
`void`	`initialize(java.util.Map<java.lang.String,java.lang.String> props)` 初期化する。
`protected void`	`initializeEnabled(java.util.Map<java.lang.String,java.lang.String> props)` 各ログ出力が有効か否かを初期化する。
`protected void`	`initializeLogItems(java.util.Map<java.lang.String,java.lang.String> props)` フォーマット済みのログ出力項目を初期化する。
`boolean`	`isBeginOutputEnabled()` リクエスト処理開始時の出力が有効かを判定する。
`boolean`	`isEndOutputEnabled()` リクエスト処理終了時の出力が有効かを判定する。

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - PROPS_PREFIX
```
public static final java.lang.String PROPS_PREFIX
```
    プロパティ名のプレフィックス
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - JaxRsAccessLogFormatter
```
public JaxRsAccessLogFormatter()
```
- Method Detail
  - initialize
```
public void initialize(java.util.Map<java.lang.String,java.lang.String> props)
```
    初期化する。
    
    Parameters:
    
    props - 各種ログ出力の設定情報
  - initializeEnabled
```
protected void initializeEnabled(java.util.Map<java.lang.String,java.lang.String> props)
```
    各ログ出力が有効か否かを初期化する。
    
    Parameters:
    
    props - 各種ログ出力の設定情報
  - initializeLogItems
```
protected void initializeLogItems(java.util.Map<java.lang.String,java.lang.String> props)
```
    フォーマット済みのログ出力項目を初期化する。
    
    Parameters:
    
    props - 各種ログ出力の設定情報
  - createAccessLogContext
```
public JaxRsAccessLogFormatter.JaxRsAccessLogContext createAccessLogContext()
```
    JaxRsAccessLogContextを生成する。
    
    Returns:
    
    JaxRsAccessLogContext
  - containsMemoryItem
```
public boolean containsMemoryItem()
```
    出力対象にメモリ項目が含まれているか否かを判定する。
    
    Returns:
    
    出力対象にメモリ項目が含まれている場合はtrue
  - getLogItems
```
protected java.util.Map<java.lang.String,LogItem<JaxRsAccessLogFormatter.JaxRsAccessLogContext>> getLogItems(java.util.Map<java.lang.String,java.lang.String> props)
```
    フォーマット対象のログ出力項目を取得する。
    
    Parameters:
    
    props - 各種ログの設定情報
    
    Returns:
    
    フォーマット対象のログ出力項目
  - createBodyMaskingFilter
```
protected LogContentMaskingFilter createBodyMaskingFilter(java.util.Map<java.lang.String,java.lang.String> props)
```
    ボディ出力時のマスク処理を行うフィルタを生成します。
    
    Parameters:
    
    props - 各種ログの設定情報
    
    Returns:
    
    マスク処理フィルタ
  - createBodyLogTargetMatcher
```
protected MessageBodyLogTargetMatcher createBodyLogTargetMatcher(java.util.Map<java.lang.String,java.lang.String> props)
```
    ボディ出力対象であるか判定するMatcherを生成します。
    
    Parameters:
    
    props - 各種ログの設定情報
    
    Returns:
    
    Matcher
  - getDateFormat
```
protected java.text.DateFormat getDateFormat(java.util.Map<java.lang.String,java.lang.String> props)
```
    日時フォーマットを取得する。プロパティの指定がない場合はデフォルトの日時フォーマットを返す。
    
    Parameters:
    
    props - 各種ログの設定情報
    
    Returns:
    
    日時フォーマット
  - getProp
```
protected java.lang.String getProp(java.util.Map<java.lang.String,java.lang.String> props,
                                   java.lang.String propName,
                                   java.lang.String defaultValue)
```
    プロパティを取得する。プロパティの指定がない場合はデフォルト値を返す。
    
    Parameters:
    
    props - 各種ログの設定情報
    
    propName - プロパティ名
    
    defaultValue - プロパティのデフォルト値
    
    Returns:
    
    プロパティ
  - getSeparator
```
protected java.lang.String getSeparator(java.util.Map<java.lang.String,java.lang.String> props,
                                        java.lang.String propName,
                                        java.lang.String defaultValue)
```
    区切り文字を取得する。
    
    Parameters:
    
    props - 各種ログの設定情報
    
    propName - プロパティ名
    
    defaultValue - プロパティのデフォルト値
    
    Returns:
    
    パラメータ間の区切り文字
  - getMaskingChar
```
protected char getMaskingChar(java.util.Map<java.lang.String,java.lang.String> props)
```
    マスク文字を取得する。
    
    Parameters:
    
    props - 各種ログの設定情報
    
    Returns:
    
    マスク文字
  - getMaskingPatterns
```
protected java.util.regex.Pattern[] getMaskingPatterns(java.util.Map<java.lang.String,java.lang.String> props)
```
    マスク対象のパラメータ名を取得する。プロパティの指定がない場合はデフォルト値を返す。
    
    Parameters:
    
    props - 各種ログの設定情報
    
    Returns:
    
    マスク対象のパラメータ名
  - formatBegin
```
public java.lang.String formatBegin(JaxRsAccessLogFormatter.JaxRsAccessLogContext context)
```
    リクエスト処理開始時のメッセージをフォーマットする。
    
    Parameters:
    
    context - JaxRsAccessLogContext
    
    Returns:
    
    フォーマット済みのメッセージ
  - formatEnd
```
public java.lang.String formatEnd(JaxRsAccessLogFormatter.JaxRsAccessLogContext context)
```
    リクエスト処理終了時のメッセージをフォーマットする。
    
    Parameters:
    
    context - JaxRsAccessLogContext
    
    Returns:
    
    フォーマット済みのメッセージ
  - isBeginOutputEnabled
```
public boolean isBeginOutputEnabled()
```
    リクエスト処理開始時の出力が有効かを判定する。
    
    Returns:
    
    リクエスト処理開始時の出力が有効な場合はtrue。
  - isEndOutputEnabled
```
public boolean isEndOutputEnabled()
```
    リクエスト処理終了時の出力が有効かを判定する。
    
    Returns:
    
    リクエスト処理終了時の出力が有効な場合はtrue。

Class JaxRsAccessLogFormatter

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

PROPS_PREFIX

Constructor Detail

JaxRsAccessLogFormatter

Method Detail

initialize

initializeEnabled

initializeLogItems

createAccessLogContext

containsMemoryItem

getLogItems

createBodyMaskingFilter

createBodyLogTargetMatcher

getDateFormat

getProp

getSeparator

getMaskingChar

getMaskingPatterns

formatBegin

formatEnd

isBeginOutputEnabled

isEndOutputEnabled