gov.nist.core

Class LogWriter

java.lang.Object

gov.nist.core.LogWriter

All Implemented Interfaces:

LogLevels, StackLogger

public class LogWriter
extends Object
implements StackLogger

A wrapper around log4j that is used for logging debug and errors. You can replace this file if you want to change the way in which messages are logged.

Version:

1.2

Author:

M. Ranganathan
, M.Andrews, Jeroen van Bemmel, Jean Deruelle

Field Summary

Fields

Modifier and Type	Field and Description
protected int	traceLevel trace level

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
LogWriter()

Method Summary

Methods

Modifier and Type	Method and Description
void	addAppender(org.apache.log4j.Appender appender) This method allows you to add an external appender.
void	disableLogging() Disable logging altogether.
void	enableLogging() Enable logging (globally).
org.apache.log4j.Level	getLevel(int traceLevel)
int	getLineCount() Get the line count in the log stream.
org.apache.log4j.Logger	getLogger() Get the logger.
String	getLoggerName() The category for the logger.
org.apache.log4j.Priority	getLogPriority()
int	getTraceLevel() Get the trace level for the stack.
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	logDebug(String message, Exception ex) 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 configurationProperties) Stack creation properties.

Methods inherited from class java.lang.Object

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

Field Detail

traceLevel

protected int traceLevel

trace level

Constructor Detail

LogWriter

public LogWriter()

Method Detail

logStackTrace

public void logStackTrace()

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

getLineCount

public int getLineCount()

Get the line count in the log stream.

Specified by:

getLineCount in interface StackLogger

Returns:

getLogger

public org.apache.log4j.Logger getLogger()

Get the logger.

Returns:

addAppender

public void addAppender(org.apache.log4j.Appender appender)

This method allows you to add an external appender. This is useful for the case when you want to log to a different log stream than a file.

Parameters:

appender -

logException

public void logException(Throwable ex)

Log an exception.

Specified by:

logException in interface StackLogger

Parameters:

ex -

logDebug

public void logDebug(String message)

Log a message into the log file.

Specified by:

logDebug in interface StackLogger

Parameters:

message - message to log into the log file.

logDebug

public void logDebug(String message,
            Exception ex)

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.

logTrace

public void logTrace(String message)

Log a message into the log file.

Specified by:

logTrace in interface StackLogger

Parameters:

message - message to log into the log file.

getTraceLevel

public int getTraceLevel()

Get the trace level for the stack.

logFatalError

public void logFatalError(String message)

Log an error message.

Specified by:

logFatalError in interface StackLogger

Parameters:

message - -- error message to log.

logError

public void logError(String message)

Log an error message.

Specified by:

logError in interface StackLogger

Parameters:

message - -- error message to log.

setStackProperties

public void setStackProperties(Properties configurationProperties)

Description copied from interface: StackLogger

Stack creation properties.

Specified by:

setStackProperties in interface StackLogger

isLoggingEnabled

public boolean isLoggingEnabled()

Specified by:

isLoggingEnabled in interface StackLogger

Returns:

flag to indicate if logging is enabled.

isLoggingEnabled

public boolean isLoggingEnabled(int logLevel)

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

Specified by:

isLoggingEnabled in interface StackLogger

Parameters:

logLevel -

logError

public void logError(String message,
            Exception ex)

Log an error message.

Specified by:

logError in interface StackLogger

Parameters:

message -

ex -

logWarning

public void logWarning(String string)

Log a warning mesasge.

Specified by:

logWarning in interface StackLogger

Parameters:

string -

logInfo

public void logInfo(String string)

Log an info message.

Specified by:

logInfo in interface StackLogger

Parameters:

string -

disableLogging

public void disableLogging()

Disable logging altogether.

Specified by:

disableLogging in interface StackLogger

enableLogging

public void enableLogging()

Enable logging (globally).

Specified by:

enableLogging 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

getLogPriority

public org.apache.log4j.Priority getLogPriority()

getLevel

public org.apache.log4j.Level getLevel(int traceLevel)

getLoggerName

public String getLoggerName()

Description copied from interface: StackLogger

The category for the logger.

Specified by:

getLoggerName in interface StackLogger

Returns: