sc.log4j

Class Log4jUtilities

java.lang.Object

sc.log4j.Log4jUtilities

public final class Log4jUtilities
extends java.lang.Object

This class provides a set of simple utilities for use with various aspects of log4j.

Constructor Summary

Constructors

Constructor and Description
Log4jUtilities()

Method Summary

Modifier and Type	Method and Description
static java.lang.String	getLevelAsString(org.apache.log4j.Logger logger) Returns a string representation of a log4j Logger's log level.
static java.util.Map	getMDCCopy() Capture copy of current MDC map; returns null if MDC map is currently null
static java.util.Map	getMDCCopy(java.util.Hashtable mdcContext) Capture copy of MDC map mdcContext; returns null if MDC map is null
static void	putStringInMDC(java.lang.String key, java.lang.String value) Manipulates log4j MDC for the given key.
static void	putStringInMDC(java.lang.String key, java.lang.String value, java.util.Hashtable mdcContext) Manipulates log4j MDC mdcContext for the given key.
static void	revertMDC(java.util.Map prevContext) Reverts MDC to a previous state indicated by prevContext
static void	revertMDC(java.util.Map prevContext, java.util.Hashtable mdcContext) Reverts MDC map mdcContext to a previous state indicated by prevContext
static void	setLoggerLevel(org.apache.log4j.Logger logger, java.lang.String levelString) Sets a log4j Logger's log level to that indicated by 'levelString'.

Methods inherited from class java.lang.Object

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

Constructor Detail

Log4jUtilities

public Log4jUtilities()

Method Detail

getLevelAsString

public static java.lang.String getLevelAsString(org.apache.log4j.Logger logger)

Returns a string representation of a log4j Logger's log level.

setLoggerLevel

public static void setLoggerLevel(org.apache.log4j.Logger logger,
                                  java.lang.String levelString)

Sets a log4j Logger's log level to that indicated by 'levelString'.

putStringInMDC

public static void putStringInMDC(java.lang.String key,
                                  java.lang.String value)

Manipulates log4j MDC for the given key. This utility ensures uniform handling of the 'null' value case (as you can't call MDC.put(key,null) without an raising an exception) and allows easy modification of this handling.

putStringInMDC

public static void putStringInMDC(java.lang.String key,
                                  java.lang.String value,
                                  java.util.Hashtable mdcContext)

Manipulates log4j MDC mdcContext for the given key. This utility ensures uniform handling of the 'null' value case (as you can't call MDC.put(key,null) without an raising an exception) and allows easy modification of this handling.

getMDCCopy

public static java.util.Map getMDCCopy()

Capture copy of current MDC map; returns null if MDC map is currently null

getMDCCopy

public static java.util.Map getMDCCopy(java.util.Hashtable mdcContext)

Capture copy of MDC map mdcContext; returns null if MDC map is null

revertMDC

public static void revertMDC(java.util.Map prevContext)

Reverts MDC to a previous state indicated by prevContext

revertMDC

public static void revertMDC(java.util.Map prevContext,
                             java.util.Hashtable mdcContext)

Reverts MDC map mdcContext to a previous state indicated by prevContext