HttpAccessLogFormatter (Nablarch-API)

java.lang.Object
- nablarch.fw.web.handler.HttpAccessLogFormatter

Direct Known Subclasses:

HttpAccessJsonLogFormatter
```
@Published(tag="architect")
public class HttpAccessLogFormatter
extends java.lang.Object
```
HTTPアクセスログのメッセージをフォーマットするクラス。

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`HttpAccessLogFormatter.ClientHostItem` クライアント端末ホストを取得するクラス。
`static class`	`HttpAccessLogFormatter.ClientIpAddressItem` クライアント端末IPアドレスを取得するクラス。
`static class`	`HttpAccessLogFormatter.ClientUserAgentItem` HTTPヘッダの User-Agent を取得する。
`static class`	`HttpAccessLogFormatter.ContentPathItem` コンテンツパスを取得するクラス。
`static class`	`HttpAccessLogFormatter.DispatchingClassItem` ディスパッチ先クラスを取得するクラス。
`static class`	`HttpAccessLogFormatter.EndTimeItem` 終了日時を取得するクラス。
`static class`	`HttpAccessLogFormatter.ExecutionTimeItem` 実行時間を取得するクラス。
`static class`	`HttpAccessLogFormatter.FreeMemoryItem` 空きメモリ量(開始時)を取得するクラス。
`static class`	`HttpAccessLogFormatter.HttpAccessLogContext` HTTPアクセスログの出力項目を保持するクラス。
`static class`	`HttpAccessLogFormatter.MaxMemoryItem` 最大メモリ量を取得するクラス。
`static class`	`HttpAccessLogFormatter.MethodItem` HTTPメソッドを取得するクラス。
`static class`	`HttpAccessLogFormatter.ParametersItem` リクエストパラメータを取得するクラス。
`static class`	`HttpAccessLogFormatter.PortItem` ポート番号を取得するクラス。
`static class`	`HttpAccessLogFormatter.QueryStringItem` クエリ文字列を取得するクラス。クエリ文字列があれば"?"を含めクエリ文字列を取得する。
`static class`	`HttpAccessLogFormatter.RequestIdItem` リクエストIDを取得するクラス。
`static class`	`HttpAccessLogFormatter.ResponseStatusCodeItem` クライアントへのレスポンスに使用するステータスコードを取得するクラス。
`static class`	`HttpAccessLogFormatter.SessionIdItem` セッションIDを取得するクラス。
`static class`	`HttpAccessLogFormatter.SessionScopeItem` セッションスコープ情報を取得するクラス。
`static class`	`HttpAccessLogFormatter.SessionStoreIdItem` セッションストアIDを取得するクラス。
`static class`	`HttpAccessLogFormatter.StartTimeItem` 開始日時を取得するクラス。
`static class`	`HttpAccessLogFormatter.StatusCodeItem` ステータスコードを取得するクラス。
`static class`	`HttpAccessLogFormatter.UrlItem` URLを取得するクラス。
`static class`	`HttpAccessLogFormatter.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

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

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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`containsMemoryItem()` 出力対象にメモリ項目が含まれているか否かを判定する。
`HttpAccessLogFormatter.HttpAccessLogContext`	`createAccessLogContext()` HttpAccessLogContextを生成する。
`java.lang.String`	`formatBegin(HttpAccessLogFormatter.HttpAccessLogContext context)` リクエスト処理開始時のメッセージをフォーマットする。
`java.lang.String`	`formatDispatchingClass(HttpAccessLogFormatter.HttpAccessLogContext context)` ディスパッチ先クラス決定後のメッセージをフォーマットする。
`java.lang.String`	`formatEnd(HttpAccessLogFormatter.HttpAccessLogContext context)` リクエスト処理終了時のメッセージをフォーマットする。
`java.lang.String`	`formatParameters(HttpAccessLogFormatter.HttpAccessLogContext context)` hiddenパラメータ復号後のメッセージをフォーマットする。
`protected java.text.DateFormat`	`getDateFormat(java.util.Map<java.lang.String,java.lang.String> props)` 日時フォーマットを取得する。プロパティの指定がない場合はデフォルトの日時フォーマットを返す。
`protected java.util.Map<java.lang.String,LogItem<HttpAccessLogFormatter.HttpAccessLogContext>>`	`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)` 区切り文字を取得する。
`protected 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`	`isDispatchingClassOutputEnabled()` ディスパッチ先クラス決定後の出力が有効かを判定する。
`boolean`	`isEndOutputEnabled()` リクエスト処理終了時の出力が有効かを判定する。
`boolean`	`isParametersOutputEnabled()` hiddenパラメータ復号後の出力が有効かを判定する。

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
  - HttpAccessLogFormatter
```
public HttpAccessLogFormatter()
```
    フォーマット済みのログ出力項目を初期化する。
- Method Detail
  - initialize
```
protected 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 HttpAccessLogFormatter.HttpAccessLogContext createAccessLogContext()
```
    HttpAccessLogContextを生成する。
    
    Returns:
    
    HttpAccessLogContext
  - containsMemoryItem
```
public boolean containsMemoryItem()
```
    出力対象にメモリ項目が含まれているか否かを判定する。
    
    Returns:
    
    出力対象にメモリ項目が含まれている場合はtrue
  - getLogItems
```
protected java.util.Map<java.lang.String,LogItem<HttpAccessLogFormatter.HttpAccessLogContext>> getLogItems(java.util.Map<java.lang.String,java.lang.String> props)
```
    フォーマット対象のログ出力項目を取得する。
    
    Parameters:
    
    props - 各種ログの設定情報
    
    Returns:
    
    フォーマット対象のログ出力項目
  - 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(HttpAccessLogFormatter.HttpAccessLogContext context)
```
    リクエスト処理開始時のメッセージをフォーマットする。
    
    Parameters:
    
    context - HttpAccessLogContext
    
    Returns:
    
    フォーマット済みのメッセージ
  - formatParameters
```
public java.lang.String formatParameters(HttpAccessLogFormatter.HttpAccessLogContext context)
```
    hiddenパラメータ復号後のメッセージをフォーマットする。
    
    Parameters:
    
    context - HttpAccessLogContext
    
    Returns:
    
    フォーマット済みのメッセージ
  - formatDispatchingClass
```
public java.lang.String formatDispatchingClass(HttpAccessLogFormatter.HttpAccessLogContext context)
```
    ディスパッチ先クラス決定後のメッセージをフォーマットする。
    
    Parameters:
    
    context - HttpAccessLogContext
    
    Returns:
    
    フォーマット済みのメッセージ
  - formatEnd
```
public java.lang.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。

Class HttpAccessLogFormatter

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

PROPS_PREFIX

Constructor Detail

HttpAccessLogFormatter

Method Detail

initialize

initializeEnabled

initializeLogItems

createAccessLogContext

containsMemoryItem

getLogItems

getDateFormat

getProp

getSeparator

getMaskingChar

getMaskingPatterns

formatBegin

formatParameters

formatDispatchingClass

formatEnd

isBeginOutputEnabled

isParametersOutputEnabled

isDispatchingClassOutputEnabled

isEndOutputEnabled