com.sdl.context.common.logging

Class LogUtils

java.lang.Object

com.sdl.context.common.logging.LogUtils

public final class LogUtils
extends Object

Common log utils that interacting with logging libraries. Currently implemented against logback implementation, but it could be extended to support other log implementations.

Note that this class is safe to be invoked what ever logging library (if any) is on the classpath and hence is safe for stand alone usage.

Method Summary

Modifier and Type	Method and Description
static LogCapture	captureLog(String pattern) Capture log for the given pattern with a simple appender.
static void	decreaseLogging(String pattern)
static LogPatternLevel	getLevel(String pattern)
static void	increaseLogging(String pattern)
static void	loadLogbackConfigurationFile(String fileName) Loads the logback configuration from a file on the class path.
static LogPatternLevel	setLevel(LogPatternLevel logPatternLevel)
static LogPatternLevel	setLevel(String pattern, int level)
static LogPatternLevel	setLevelOff(String pattern)
static void	stopCapture(LogCapture logCapture) Stop capturing the log via the given appender for the given pattern.

Methods inherited from class java.lang.Object

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

Method Detail

decreaseLogging

public static void decreaseLogging(String pattern)

increaseLogging

public static void increaseLogging(String pattern)

getLevel

public static LogPatternLevel getLevel(String pattern)

setLevel

public static LogPatternLevel setLevel(LogPatternLevel logPatternLevel)

setLevel

public static LogPatternLevel setLevel(String pattern,
                                       int level)

setLevelOff

public static LogPatternLevel setLevelOff(String pattern)

captureLog

public static LogCapture captureLog(String pattern)

Capture log for the given pattern with a simple appender. Note that you must stop a capture after starting it with capture Log using try { ... } finally { logCapture.stop }.

Parameters:

pattern - log pattern to capture

Returns:

log capture

stopCapture

public static void stopCapture(LogCapture logCapture)

Stop capturing the log via the given appender for the given pattern.

Parameters:

logCapture - log capture

loadLogbackConfigurationFile

public static void loadLogbackConfigurationFile(String fileName)

Loads the logback configuration from a file on the class path. The default logback configuration is always loaded from "logback.xml", this method allows you to change it.

Parameters:

fileName - a file name (on the classpath) to load the logback configuration from.