gov.nist.core

Class CommonLogger

java.lang.Object

gov.nist.core.CommonLogger

All Implemented Interfaces:

LogLevels, StackLogger

public class CommonLogger
extends Object
implements StackLogger

This class abstracts away single-instanct and multi0instance loggers legacyLogger is the old-school one logger per stack reference otherLogger is multiinstance logger

Author:

Vladimir Ralev

Field Summary

Fields

Modifier and Type	Field and Description
static StackLogger	legacyLogger
static boolean	useLegacyLogger

Fields inherited from interface gov.nist.core.LogLevels

TRACE_DEBUG, TRACE_ERROR, TRACE_EXCEPTION, TRACE_FATAL, TRACE_INFO, TRACE_MESSAGES, TRACE_NONE, TRACE_TRACE, TRACE_WARN

Constructor Summary

Constructors

Constructor and Description
CommonLogger(String name)

Method Summary

Methods

Modifier and Type	Method and Description
void	disableLogging() Disable logging altogether.
void	enableLogging() Enable logging (globally).
int	getLineCount() Get the line count in the log stream.
static StackLogger	getLogger(Class clazz)
static StackLogger	getLogger(String name)
String	getLoggerName() The category for the logger.
static void	init(Properties p)
boolean	isLoggingEnabled()
boolean	isLoggingEnabled(int logLevel) Return true/false if loging is enabled at a given level.
void	logDebug(String message) Log a message into the log file.
void	logError(String message) Log an error message.
void	logError(String message, Exception ex) Log an error message.
void	logException(Throwable ex) Log an exception.
void	logFatalError(String message) Log an error message.
void	logInfo(String string) Log an info message.
void	logStackTrace() log a stack trace.
void	logStackTrace(int traceLevel) Log a stack trace if the current logging level exceeds given trace level.
void	logTrace(String message) Log a message into the log file.
void	logWarning(String string) Log a warning mesasge.
void	setBuildTimeStamp(String buildTimeStamp) Set the build time stamp.
void	setStackProperties(Properties stackProperties) Stack creation properties.

Methods inherited from class java.lang.Object

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

Field Detail

useLegacyLogger

public static boolean useLegacyLogger

legacyLogger

public static StackLogger legacyLogger

Constructor Detail

CommonLogger

public CommonLogger(String name)

Method Detail

getLogger

public static StackLogger getLogger(String name)

getLogger

public static StackLogger getLogger(Class clazz)

init

public static void init(Properties p)

disableLogging

public void disableLogging()

Description copied from interface: StackLogger

Disable logging altogether.

Specified by:

disableLogging in interface StackLogger

enableLogging

public void enableLogging()

Description copied from interface: StackLogger

Enable logging (globally).

Specified by:

enableLogging in interface StackLogger

getLineCount

public int getLineCount()

Description copied from interface: StackLogger

Get the line count in the log stream.

Specified by:

getLineCount in interface StackLogger

Returns:

getLoggerName

public String getLoggerName()

Description copied from interface: StackLogger

The category for the logger.

Specified by:

getLoggerName in interface StackLogger

Returns:

isLoggingEnabled

public boolean isLoggingEnabled()

Specified by:

isLoggingEnabled in interface StackLogger

Returns:

flag to indicate if logging is enabled.

isLoggingEnabled

public boolean isLoggingEnabled(int logLevel)

Description copied from interface: StackLogger

Return true/false if loging is enabled at a given level.

Specified by:

isLoggingEnabled in interface StackLogger

logDebug

public void logDebug(String message)

Description copied from interface: StackLogger

Log a message into the log file.

Specified by:

logDebug in interface StackLogger

Parameters:

message - message to log into the log file.

logError

public void logError(String message)

Description copied from interface: StackLogger

Log an error message.

Specified by:

logError in interface StackLogger

Parameters:

message - -- error message to log.

logError

public void logError(String message,
            Exception ex)

Description copied from interface: StackLogger

Log an error message.

Specified by:

logError in interface StackLogger

logException

public void logException(Throwable ex)

Description copied from interface: StackLogger

Log an exception.

Specified by:

logException in interface StackLogger

logFatalError

public void logFatalError(String message)

Description copied from interface: StackLogger

Log an error message.

Specified by:

logFatalError in interface StackLogger

Parameters:

message - -- error message to log.

logInfo

public void logInfo(String string)

Description copied from interface: StackLogger

Log an info message.

Specified by:

logInfo in interface StackLogger

logStackTrace

public void logStackTrace()

Description copied from interface: StackLogger

log a stack trace. This helps to look at the stack frame.

Specified by:

logStackTrace in interface StackLogger

logStackTrace

public void logStackTrace(int traceLevel)

Description copied from interface: StackLogger

Log a stack trace if the current logging level exceeds given trace level.

Specified by:

logStackTrace in interface StackLogger

logTrace

public void logTrace(String message)

Description copied from interface: StackLogger

Log a message into the log file.

Specified by:

logTrace in interface StackLogger

Parameters:

message - message to log into the log file.

logWarning

public void logWarning(String string)

Description copied from interface: StackLogger

Log a warning mesasge.

Specified by:

logWarning in interface StackLogger

setBuildTimeStamp

public void setBuildTimeStamp(String buildTimeStamp)

Description copied from interface: StackLogger

Set the build time stamp. This is logged into the logging stream.

Specified by:

setBuildTimeStamp in interface StackLogger

setStackProperties

public void setStackProperties(Properties stackProperties)

Description copied from interface: StackLogger

Stack creation properties.

Specified by:

setStackProperties in interface StackLogger