nablarch.fw.web.handler

Class HttpAccessLogFormatter

java.lang.Object

nablarch.fw.web.handler.HttpAccessLogFormatter

@Published(tag="architect")
public class HttpAccessLogFormatter
extends java.lang.Object

HTTPアクセスログのメッセージをフォーマットするクラス。

Author:

Kiyohito Itoh

Field Summary

Fields

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
boolean	containsMemoryItem() 出力対象にメモリ項目が含まれているか否かを判定する。
nablarch.fw.web.handler.HttpAccessLogFormatter.HttpAccessLogContext	createAccessLogContext() HttpAccessLogContextを生成する。
java.lang.String	formatBegin(nablarch.fw.web.handler.HttpAccessLogFormatter.HttpAccessLogContext context) リクエスト処理開始時のメッセージをフォーマットする。
java.lang.String	formatDispatchingClass(nablarch.fw.web.handler.HttpAccessLogFormatter.HttpAccessLogContext context) ディスパッチ先クラス決定後のメッセージをフォーマットする。
java.lang.String	formatEnd(nablarch.fw.web.handler.HttpAccessLogFormatter.HttpAccessLogContext context) リクエスト処理終了時のメッセージをフォーマットする。
java.lang.String	formatParameters(nablarch.fw.web.handler.HttpAccessLogFormatter.HttpAccessLogContext context) hiddenパラメータ復号後のメッセージをフォーマットする。
protected java.text.DateFormat	getDateFormat(java.util.Map props) 日時フォーマットを取得する。 プロパティの指定がない場合はデフォルトの日時フォーマットを返す。
protected java.util.Map<LogItem>	getLogItems(java.util.Map props) フォーマット対象のログ出力項目を取得する。
protected char	getMaskingChar(java.util.Map props) マスク文字を取得する。
protected java.util.regex.Pattern[]	getMaskingPatterns(java.util.Map props) マスク対象のパラメータ名を取得する。 プロパティの指定がない場合はデフォルト値を返す。
protected java.lang.String	getProp(java.util.Map props, java.lang.String propName, java.lang.String defaultValue) プロパティを取得する。 プロパティの指定がない場合はデフォルト値を返す。
protected java.lang.String	getSeparator(java.util.Map props, java.lang.String propName, java.lang.String defaultValue) 区切り文字を取得する。
boolean	isBeginOutputEnabled() リクエスト処理開始時の出力が有効かを判定する。
boolean	isDispatchingClassOutputEnabled() ディスパッチ先クラス決定後の出力が有効かを判定する。
boolean	isEndOutputEnabled() リクエスト処理終了時の出力が有効かを判定する。
boolean	isParametersOutputEnabled() hiddenパラメータ復号後の出力が有効かを判定する。

Field Detail

PROPS_PREFIX

public static final java.lang.String PROPS_PREFIX

プロパティ名のプレフィックス

See Also:

Constant Field Values

Constructor Detail

HttpAccessLogFormatter

public HttpAccessLogFormatter()

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

Method Detail

createAccessLogContext

public nablarch.fw.web.handler.HttpAccessLogFormatter.HttpAccessLogContext createAccessLogContext()

HttpAccessLogContextを生成する。

Returns:

HttpAccessLogContext

containsMemoryItem

public boolean containsMemoryItem()

出力対象にメモリ項目が含まれているか否かを判定する。

Returns:

出力対象にメモリ項目が含まれている場合はtrue

getLogItems

protected java.util.Map<LogItem> getLogItems(java.util.Map props)

フォーマット対象のログ出力項目を取得する。

Parameters:

props - 各種ログの設定情報

Returns:

フォーマット対象のログ出力項目

getDateFormat

protected java.text.DateFormat getDateFormat(java.util.Map props)

日時フォーマットを取得する。
プロパティの指定がない場合はデフォルトの日時フォーマットを返す。

Parameters:

props - 各種ログの設定情報

Returns:

日時フォーマット

getProp

protected java.lang.String getProp(java.util.Map props,
                                   java.lang.String propName,
                                   java.lang.String defaultValue)

プロパティを取得する。
プロパティの指定がない場合はデフォルト値を返す。

Parameters:

props - 各種ログの設定情報

propName - プロパティ名

defaultValue - プロパティのデフォルト値

Returns:

プロパティ

getSeparator

protected java.lang.String getSeparator(java.util.Map props,
                                        java.lang.String propName,
                                        java.lang.String defaultValue)

区切り文字を取得する。

Parameters:

props - 各種ログの設定情報

propName - プロパティ名

defaultValue - プロパティのデフォルト値

Returns:

パラメータ間の区切り文字

getMaskingChar

protected char getMaskingChar(java.util.Map props)

マスク文字を取得する。

Parameters:

props - 各種ログの設定情報

Returns:

マスク文字

getMaskingPatterns

protected java.util.regex.Pattern[] getMaskingPatterns(java.util.Map props)

マスク対象のパラメータ名を取得する。
プロパティの指定がない場合はデフォルト値を返す。

Parameters:

props - 各種ログの設定情報

Returns:

マスク対象のパラメータ名

formatBegin

public java.lang.String formatBegin(nablarch.fw.web.handler.HttpAccessLogFormatter.HttpAccessLogContext context)

リクエスト処理開始時のメッセージをフォーマットする。

Parameters:

context - HttpAccessLogContext

Returns:

フォーマット済みのメッセージ

formatParameters

public java.lang.String formatParameters(nablarch.fw.web.handler.HttpAccessLogFormatter.HttpAccessLogContext context)

hiddenパラメータ復号後のメッセージをフォーマットする。

Parameters:

context - HttpAccessLogContext

Returns:

フォーマット済みのメッセージ

formatDispatchingClass

public java.lang.String formatDispatchingClass(nablarch.fw.web.handler.HttpAccessLogFormatter.HttpAccessLogContext context)

ディスパッチ先クラス決定後のメッセージをフォーマットする。

Parameters:

context - HttpAccessLogContext

Returns:

フォーマット済みのメッセージ

formatEnd

public java.lang.String formatEnd(nablarch.fw.web.handler.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。