nablarch.core.log

クラス LogUtil

java.lang.Object

nablarch.core.log.LogUtil

public final class LogUtil
extends java.lang.Object

ログ出力の実装を助けるユーティリティ。

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

ネストされたクラス

修飾子とタイプ	クラスと説明
static class	LogUtil.BasicMapValueEditor マップの値を編集するインタフェースの基本実装クラス。
static interface	LogUtil.MapValueEditor マップの値を編集するインタフェース。
static class	LogUtil.MaskingMapValueEditor マップの値をマスキングするクラス。
static interface	LogUtil.ObjectCreator<T> クラスローダに紐付くオブジェクトを生成するインタフェース。

メソッドのサマリー

修飾子とタイプ	メソッドと説明
static boolean	contains(LogItem[] logItems, java.lang.Class... classes) フォーマット済みのログ出力項目に指定された出力項目が含まれているかを判定する。
static <T> LogItem<T>[]	createFormattedLogItems(java.util.Map<java.lang.String,LogItem<T>> logItems, java.lang.String format) フォーマット文字列からフォーマット済みのログ出力項目を生成する。
static <T> LogItem<T>[]	createFormattedLogItems(java.util.Map<java.lang.String,LogItem<T>> logItems, java.lang.String format, java.util.regex.Pattern pattern) フォーマット文字列からフォーマット済みのログ出力項目を生成する。
static java.util.regex.Pattern	createReplacementsPattern(java.util.Set<java.lang.String> replacements) プレースホルダ($名前$形式)検索用のパターンを作成する。
static <T> java.lang.String	dumpMap(java.util.Map<java.lang.String,T> map, java.lang.String separator) マップをダンプした文字列を返す。
static <T> java.lang.String	dumpMap(java.util.Map<java.lang.String,T> map, java.lang.String separator, LogUtil.MapValueEditor valueEditor) マップをダンプした文字列を返す。
static <T> java.lang.String	dumpMap(java.util.Map<java.lang.String,T> map, java.lang.String separator, java.util.regex.Pattern excludeKeyPattern) マップをダンプした文字列を返す。
static LogItem	findLogItem(LogItem[] logItems, java.lang.Class c) フォーマット済みのログ出力項目から指定された出力項目を検索する。
static <T> java.lang.String	formatMessage(LogItem<T>[] logItems, T context) フォーマット済みのログ出力項目を使用してメッセージをフォーマットする。
static java.lang.String	generateExecutionId() 実行時IDを生成する。
static java.lang.String	getBootProcess() システムプロパティ("nablarch.bootProcess")から起動プロセスを識別する文字列を取得する。
static <T> T	getObjectBoundToClassLoader(LogUtil.ObjectCreator<T> creator) クラスローダに紐付くオブジェクトを取得する。
static void	removeAllObjectsBoundToContextClassLoader() コンテキストクラスローダに紐付く全てのオブジェクトを削除する。
static <T> T	removeObjectBoundToContextClassLoader(LogUtil.ObjectCreator<T> creator) コンテキストクラスローダに紐付くオブジェクトを削除する。

クラスから継承されたメソッド java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

メソッドの詳細

generateExecutionId

public static java.lang.String generateExecutionId()

実行時IDを生成する。

 実行時IDは下記のフォーマットで生成する。
 
 起動プロセス＋日時("yyyyMMddHHmmssSSS")＋連番(4桁)
 
 起動プロセスはgetBootProcess()から取得する。
 

戻り値:

実行時ID

getBootProcess

public static java.lang.String getBootProcess()

システムプロパティ("nablarch.bootProcess")から起動プロセスを識別する文字列を取得する。

戻り値:

起動プロセスを識別する文字列。指定がない場合はブランク

createReplacementsPattern

public static java.util.regex.Pattern createReplacementsPattern(java.util.Set<java.lang.String> replacements)

プレースホルダ($名前$形式)検索用のパターンを作成する。

パラメータ:

replacements - 置き換え文字($名前$形式)

戻り値:

プレースホルダ($名前$形式)検索用のパターン

createFormattedLogItems

public static <T> LogItem<T>[] createFormattedLogItems(java.util.Map<java.lang.String,LogItem<T>> logItems,
                                                       java.lang.String format)

フォーマット文字列からフォーマット済みのログ出力項目を生成する。
指定されたログ出力項目のキーをプレースホルダ($名前$形式)検索用のパターンに使用する。

型パラメータ:

T - ログ出力項目の取得に使用するコンテキストの型

パラメータ:

logItems - ログ出力項目

format - フォーマット文字列

戻り値:

フォーマット済みのログ出力項目

createFormattedLogItems

public static <T> LogItem<T>[] createFormattedLogItems(java.util.Map<java.lang.String,LogItem<T>> logItems,
                                                       java.lang.String format,
                                                       java.util.regex.Pattern pattern)

フォーマット文字列からフォーマット済みのログ出力項目を生成する。
プレースホルダでない固定文字列には、FixedStringItemを使用する。

型パラメータ:

T - ログ出力項目の取得に使用するコンテキストの型

パラメータ:

logItems - ログ出力項目

format - フォーマット文字列

pattern - プレースホルダのパターン

戻り値:

フォーマット済みのログ出力項目

formatMessage

public static <T> java.lang.String formatMessage(LogItem<T>[] logItems,
                                                 T context)

フォーマット済みのログ出力項目を使用してメッセージをフォーマットする。

型パラメータ:

T - ログ出力項目の取得に使用するコンテキストの型

パラメータ:

logItems - フォーマット済みのログ出力項目

context - ログ出力項目の取得に使用するコンテキスト

戻り値:

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

dumpMap

public static <T> java.lang.String dumpMap(java.util.Map<java.lang.String,T> map,
                                           java.lang.String separator)

マップをダンプした文字列を返す。

型パラメータ:

T - マップの値の型

パラメータ:

map - マップ

separator - マップエントリのセパレータ

戻り値:

マップをダンプした文字列

dumpMap

public static <T> java.lang.String dumpMap(java.util.Map<java.lang.String,T> map,
                                           java.lang.String separator,
                                           java.util.regex.Pattern excludeKeyPattern)

マップをダンプした文字列を返す。

型パラメータ:

T - マップの値の型

パラメータ:

map - マップ

separator - マップエントリのセパレータ

excludeKeyPattern - ダンプから除外するキーのパターン。指定しない場合はnull

戻り値:

マップをダンプした文字列

dumpMap

public static <T> java.lang.String dumpMap(java.util.Map<java.lang.String,T> map,
                                           java.lang.String separator,
                                           LogUtil.MapValueEditor valueEditor)

マップをダンプした文字列を返す。

型パラメータ:

T - マップの値の型

パラメータ:

map - マップ

separator - マップエントリのセパレータ

valueEditor - LogUtil.MapValueEditor

戻り値:

マップをダンプした文字列

contains

public static boolean contains(LogItem[] logItems,
                               java.lang.Class... classes)

フォーマット済みのログ出力項目に指定された出力項目が含まれているかを判定する。

パラメータ:

logItems - フォーマット済みのログ出力項目

classes - 出力項目クラス

戻り値:

指定された出力項目が1つでも含まれている場合はtrue

findLogItem

public static LogItem findLogItem(LogItem[] logItems,
                                  java.lang.Class c)

フォーマット済みのログ出力項目から指定された出力項目を検索する。

パラメータ:

logItems - フォーマット済みのログ出力項目

c - 出力項目クラス

戻り値:

最初に見つかったログ出力項目。見つからない場合はnull

getObjectBoundToClassLoader

public static <T> T getObjectBoundToClassLoader(LogUtil.ObjectCreator<T> creator)

クラスローダに紐付くオブジェクトを取得する。

 カレントスレッドから取得したコンテキストクラスローダまたはその祖先のクラスローダに紐づくオブジェクトを取得する。
 クラスローダに紐付くオブジェクトが存在しない場合は、LogUtil.ObjectCreatorを使用してオブジェクトを生成し、
 カレントスレッドから取得したコンテキストクラスローダに紐付けて保持する。
 

型パラメータ:

T - クラスローダに紐付くオブジェクトの型

パラメータ:

creator - クラスローダに紐付くオブジェクトを生成するLogUtil.ObjectCreator

戻り値:

クラスローダに紐付くオブジェクト

removeObjectBoundToContextClassLoader

public static <T> T removeObjectBoundToContextClassLoader(LogUtil.ObjectCreator<T> creator)

コンテキストクラスローダに紐付くオブジェクトを削除する。

型パラメータ:

T - クラスローダに紐付くオブジェクトの型

パラメータ:

creator - クラスローダに紐付くオブジェクトを生成したLogUtil.ObjectCreator

戻り値:

削除したオブジェクト。コンテキストクラスローダに紐付くオブジェクトが存在しない場合はnull

removeAllObjectsBoundToContextClassLoader

public static void removeAllObjectsBoundToContextClassLoader()

コンテキストクラスローダに紐付く全てのオブジェクトを削除する。