gov.nist.core

Interface StackLogger

All Superinterfaces:

LogLevels

All Known Implementing Classes:

CommonLogger, CommonLoggerLog4j, LogWriter, StackLoggerImpl

public interface StackLogger
extends LogLevels

interface that loggers should implement so that the stack can log to various loggers impl such as log4j, commons logging, sl4j, ...

Author:

[email protected]

Field Summary

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

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.
String	getLoggerName() The category for the logger.
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 stackProperties) Stack creation properties.

Method Detail

logStackTrace

void logStackTrace()

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

logStackTrace

void logStackTrace(int traceLevel)

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

Parameters:

traceLevel -

getLineCount

int getLineCount()

Get the line count in the log stream.

Returns:

logException

void logException(Throwable ex)

Log an exception.

Parameters:

ex -

logDebug

void logDebug(String message)

Log a message into the log file.

Parameters:

message - message to log into the log file.

logDebug

void logDebug(String message,
            Exception ex)

Log a message into the log file.

Parameters:

message - message to log into the log file.

ex -

logTrace

void logTrace(String message)

Log a message into the log file.

Parameters:

message - message to log into the log file.

logFatalError

void logFatalError(String message)

Log an error message.

Parameters:

message - -- error message to log.

logError

void logError(String message)

Log an error message.

Parameters:

message - -- error message to log.

isLoggingEnabled

boolean isLoggingEnabled()

Returns:

flag to indicate if logging is enabled.

isLoggingEnabled

boolean isLoggingEnabled(int logLevel)

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

Parameters:

logLevel -

logError

void logError(String message,
            Exception ex)

Log an error message.

Parameters:

message -

ex -

logWarning

void logWarning(String string)

Log a warning mesasge.

Parameters:

string -

logInfo

void logInfo(String string)

Log an info message.

Parameters:

string -

disableLogging

void disableLogging()

Disable logging altogether.

enableLogging

void enableLogging()

Enable logging (globally).

setBuildTimeStamp

void setBuildTimeStamp(String buildTimeStamp)

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

setStackProperties

void setStackProperties(Properties stackProperties)

Stack creation properties.

Parameters:

stackProperties -

getLoggerName

String getLoggerName()

The category for the logger.

Returns: