com.highqsoft.importtool

Class Logfile

java.lang.Object

com.highqsoft.importtool.Logfile

public class Logfile
extends java.lang.Object

Write Messages with Timestamp to a Logfile. The Logfile Class is used to write Log- and Errormessages to a file. INFO messages are also written to stdout without the timestamp and severity information. There are several severities that can be logged:

INFO, WARNING, ERROR and FATAL

The level of logging can be set to any of these severities. All Messages with a severity higher than the level of logging are written to the Logfile. There are two additional loglevels that can be set:

SILENT is used to suppress output of all Messages.
ALL is used to write all Messages (same as INFO).
All messages are prepended with the name of the current Thread which is normally set to the testrun name in the importtool.

Since:

$Date: 2017/04/06 13:29:19 $

Version:

$Revision: 4.10 $

Author:

Markus Schuldlos

Field Summary

Fields

Modifier and Type	Field and Description
static byte	ALL Log all Messages regardless of their severity
static byte	ERROR Log only Messages with severity ERROR or FATAL
static byte	FATAL Log only Messages with severity FATAL
static byte	INFO Log all Messages with severity INFO, WARNING, ERROR or FATAL
static byte	SILENT Do not log any Messages
static byte	TRACE Log all Messages with severity TRACE, INFO, WARNING, ERROR or FATAL
static byte	WARNING Log only Messages with severity WARNING, ERROR or FATAL

Method Summary

Methods

Modifier and Type	Method and Description
static byte	getCurrentLogLevel() Get the current level of logging.
static java.lang.String	getLogLevelString(byte level) Get the String representation for a logging level.
static void	initLogging(java.lang.String logFilePath, java.lang.String message) Initialize the Error Logging.
static void	initLogging(java.lang.String logFilePath, java.lang.String message, java.lang.String logPref, java.lang.String fatalPref) Initialize the Error Logging.
static boolean	isConsoleOutpt()
static void	putAlert(java.lang.String message) Write a Message to the alert file.
static void	putError(java.lang.String message) Write an Error Message to the Logfile.
static void	putException(java.lang.String message, java.lang.String severity, java.lang.Exception exception) Write Information about an AoException to the Logfile.
static void	putFatal(java.lang.String message) Write a Fatal Error Message to the Logfile.
static void	putInfo(java.lang.String message) Write an Informational Message to the Logfile and to stdout The message is always written when the current loglevel is INFO or ALL
static void	putTrace(java.lang.String message) Write a Trace Message to the Logfile and to stdout The message is always written when the current loglevel is INFO, TRACE or ALL
static void	putWarning(java.lang.String message) Write a Warning Message to the Logfile.
static void	putWarningOnce(java.lang.String message) Write a Warning Message to the Logfile only once.
static void	setAlertFileName(java.lang.String path) Set the path where the alert file will be created
static void	setConsoleOutpt(boolean consoleOutpt)
static void	setLogLevel(byte level) Set the current level of logging.
static void	setLogLevelString(java.lang.String levelString) Set the logging level using a String representation of the Enumeration.

Methods inherited from class java.lang.Object

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

Field Detail

ALL

public static final byte ALL

Log all Messages regardless of their severity

See Also:

Constant Field Values

TRACE

public static final byte TRACE

Log all Messages with severity TRACE, INFO, WARNING, ERROR or FATAL

See Also:

Constant Field Values

INFO

public static final byte INFO

Log all Messages with severity INFO, WARNING, ERROR or FATAL

See Also:

Constant Field Values

WARNING

public static final byte WARNING

Log only Messages with severity WARNING, ERROR or FATAL

See Also:

Constant Field Values

ERROR

public static final byte ERROR

Log only Messages with severity ERROR or FATAL

See Also:

Constant Field Values

FATAL

public static final byte FATAL

Log only Messages with severity FATAL

See Also:

Constant Field Values

SILENT

public static final byte SILENT

Do not log any Messages

See Also:

Constant Field Values

Method Detail

initLogging

public static void initLogging(java.lang.String logFilePath,
               java.lang.String message,
               java.lang.String logPref,
               java.lang.String fatalPref)

Initialize the Error Logging. Create the Instance of Logfile and Write an initial Message to the File. If there is a Problem opening the Logfile all further writes to the file are redirected to System.err! Use this method if you do not want the default prefixes for the logfile.

Parameters:

logFilePath - The path where the logfile is created.

message - Initial Message to be written

logPref - Logfile prefix (default is "importtool_");

fatalPref - Fatal file prefix (default is "importlog_");

initLogging

public static void initLogging(java.lang.String logFilePath,
               java.lang.String message)

Initialize the Error Logging. Create the Instance of Logfile and Write an initial Message to the File. If there is a Problem opening the Logfile all further writes to the file are redirected to System.err!

Parameters:

logFilePath - The path where the logfile is created.

message - Initial Message to be written

setLogLevel

public static void setLogLevel(byte level)

Set the current level of logging. Possible levels are ALL, INFO, WARNING, ERROR, FATAL and SILENT.

Parameters:

level - The level of logging

setAlertFileName

public static void setAlertFileName(java.lang.String path)

Set the path where the alert file will be created

Parameters:

path - The path name. ("" means no alert file)

getCurrentLogLevel

public static byte getCurrentLogLevel()

Get the current level of logging.

Returns:

The current level of logging. SILENT if Logging is not initialized.

getLogLevelString

public static java.lang.String getLogLevelString(byte level)

Get the String representation for a logging level.

Parameters:

level - The logging level

Returns:

The String representation of the logging level

setLogLevelString

public static void setLogLevelString(java.lang.String levelString)

Set the logging level using a String representation of the Enumeration.

Parameters:

levelString - The loglevel string

putTrace

public static void putTrace(java.lang.String message)

Write a Trace Message to the Logfile and to stdout The message is always written when the current loglevel is INFO, TRACE or ALL

Parameters:

message - Message to be written

putInfo

public static void putInfo(java.lang.String message)

Write an Informational Message to the Logfile and to stdout The message is always written when the current loglevel is INFO or ALL

Parameters:

message - Message to be written

putException

public static void putException(java.lang.String message,
                java.lang.String severity,
                java.lang.Exception exception)

Write Information about an AoException to the Logfile. The message is always written when the current loglevel is INFO or ALL

Parameters:

severity - Severity of the message ("I", "W", "E" of "F")

exception - The exception to be logged

message - Message to be written

putWarning

public static void putWarning(java.lang.String message)

Write a Warning Message to the Logfile. The message is only written when the current loglevel is INFO, WARNING or ALL.

Parameters:

message - Message to be written

putWarningOnce

public static void putWarningOnce(java.lang.String message)

Write a Warning Message to the Logfile only once. The message is only written when the current loglevel is INFO, WARNING or ALL and it has not be written before. This is useful for warnings regarding configuration errors.

Parameters:

message - Message to be written

putError

public static void putError(java.lang.String message)

Write an Error Message to the Logfile. The message is only written when the current loglevel is INFO, WARNING, ERROR or ALL.

Parameters:

message - Message to be written

putAlert

public static void putAlert(java.lang.String message)

Write a Message to the alert file.

Parameters:

message - Message to be written

putFatal

public static void putFatal(java.lang.String message)

Write a Fatal Error Message to the Logfile. The message is always written if the current loglevel is not SILENT

Parameters:

message - Message to be written

isConsoleOutpt

public static boolean isConsoleOutpt()

setConsoleOutpt

public static void setConsoleOutpt(boolean consoleOutpt)