nablarch.fw.web.handler

クラス HttpAccessLogFormatter

java.lang.Object

nablarch.fw.web.handler.HttpAccessLogFormatter

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

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

作成者:

Kiyohito Itoh

ネストされたクラスのサマリー

ネストされたクラス

修飾子とタイプ	クラスと説明
static class	HttpAccessLogFormatter.EndTimeItem 終了日時を取得するクラス。
static class	HttpAccessLogFormatter.StartTimeItem 開始日時を取得するクラス。

フィールドのサマリー

フィールド

修飾子とタイプ	フィールドと説明
static String	PROPS_PREFIX プロパティ名のプレフィックス

コンストラクタのサマリー

コンストラクタ

コンストラクタと説明
HttpAccessLogFormatter() フォーマット済みのログ出力項目を初期化する。

メソッドのサマリー

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

フィールドの詳細

PROPS_PREFIX

public static final String PROPS_PREFIX

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

関連項目:

定数フィールド値

コンストラクタの詳細

HttpAccessLogFormatter

public HttpAccessLogFormatter()

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

メソッドの詳細

createAccessLogContext

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

HttpAccessLogContextを生成する。

戻り値:

HttpAccessLogContext

containsMemoryItem

public boolean containsMemoryItem()

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

戻り値:

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

getLogItems

protected Map<LogItem> getLogItems(Map props)

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

パラメータ:

props - 各種ログの設定情報

戻り値:

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

getDateFormat

protected DateFormat getDateFormat(Map props)

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

パラメータ:

props - 各種ログの設定情報

戻り値:

日時フォーマット

getProp

protected String getProp(Map props,
                         String propName,
                         String defaultValue)

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

パラメータ:

props - 各種ログの設定情報

propName - プロパティ名

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

戻り値:

プロパティ

getSeparator

protected String getSeparator(Map props,
                              String propName,
                              String defaultValue)

区切り文字を取得する。

パラメータ:

props - 各種ログの設定情報

propName - プロパティ名

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

戻り値:

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

getMaskingChar

protected char getMaskingChar(Map props)

マスク文字を取得する。

パラメータ:

props - 各種ログの設定情報

戻り値:

マスク文字

getMaskingPatterns

protected Pattern[] getMaskingPatterns(Map props)

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

パラメータ:

props - 各種ログの設定情報

戻り値:

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

formatBegin

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

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

パラメータ:

context - HttpAccessLogContext

戻り値:

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

formatParameters

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

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

パラメータ:

context - HttpAccessLogContext

戻り値:

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

formatDispatchingClass

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

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

パラメータ:

context - HttpAccessLogContext

戻り値:

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

formatEnd

public String formatEnd(nablarch.fw.web.handler.HttpAccessLogFormatter.HttpAccessLogContext context)

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

パラメータ:

context - HttpAccessLogContext

戻り値:

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

isBeginOutputEnabled

public boolean isBeginOutputEnabled()

リクエスト処理開始時の出力が有効かを判定する。

戻り値:

リクエスト処理開始時の出力が有効な場合はtrue。

isParametersOutputEnabled

public boolean isParametersOutputEnabled()

hiddenパラメータ復号後の出力が有効かを判定する。

戻り値:

hiddenパラメータ復号後の出力が有効な場合はtrue。

isDispatchingClassOutputEnabled

public boolean isDispatchingClassOutputEnabled()

ディスパッチ先クラス決定後の出力が有効かを判定する。

戻り値:

ディスパッチ先クラス決定後の出力が有効な場合はtrue。

isEndOutputEnabled

public boolean isEndOutputEnabled()

リクエスト処理終了時の出力が有効かを判定する。

戻り値:

リクエスト処理終了時の出力が有効な場合はtrue。