org.safs.staf.service.logging

Class AbstractSTAFTextLogItem

java.lang.Object

org.safs.logging.LogItem

org.safs.logging.FileLogItem

org.safs.staf.service.logging.STAFFileLogItem

org.safs.staf.service.logging.AbstractSTAFTextLogItem

Direct Known Subclasses:

EmbeddedTextLogItem, STAFTextLogItem, STAFTextLogItem3

public abstract class AbstractSTAFTextLogItem
extends STAFFileLogItem

This class encapsulates a standard SAFS text file log implemented using STAF. Log messages are written to a temporary STAF log while the log is running. Upon closing, the content of of the STAF log is formatted to the SAFS text log standard and exported to the destination log file.

Note that logging function of this class is for local use only.

Since:

MAY 19, 2009 (LW) This class contains most code of org.safs.staf.service.logging.STAFTextLogItem, and the original STAFTextLogItem is removed.

Field Summary

Fields inherited from class org.safs.staf.service.logging.STAFFileLogItem

debugLog, handle, LINEFEED, SAFSLOG_MAJOR_VER, SAFSLOG_MINOR_VER, STAFVersion

Fields inherited from class org.safs.logging.LogItem

closed, enabled, level, mode, name

Constructor Summary

Constructors

Constructor and Description
AbstractSTAFTextLogItem(java.lang.String file) Creates a disabled AbstractSTAFTextLogItem with default name (file name) and log level (LOGLEVEL_INFO), and empty parent directory.
AbstractSTAFTextLogItem(java.lang.String parent, java.lang.String file) Creates a disabled AbstractSTAFTextLogItem with default name (file name) and log level (LOGLEVEL_INFO).
AbstractSTAFTextLogItem(java.lang.String name, java.lang.String parent, java.lang.String file) Creates a disabled AbstractSTAFTextLogItem with default log level (LOGLEVEL_INFO).

Method Summary

Modifier and Type	Method and Description
void	close() Close this log if enabled and open.
protected java.util.List<java.lang.String>	getCloseMessages() Return the messages to write before the log is closed.
protected java.util.List<java.lang.String>	getInitMessages() Return the messages to write after the log is initialized.
void	init() Initializes this log and writes the log open message.
void	logMessage(java.lang.String msg) Logs a message in standard SAFS text log format if enabled and open.
void	logMessage(java.lang.String msg, int msgType) Logs a message in standard SAFS text log format if enabled and open.
void	logMessage(java.lang.String msg, java.lang.String desc, int msgType) Logs a message in standard SAFS text log format if enabled and open.

Methods inherited from class org.safs.staf.service.logging.STAFFileLogItem

appendFinalLog, exportSTAFLog, finalizeLogFile, getMachineName, getSTAFLogDirectory, getTestName, prependFinalLog, readStringFromSTAFLog, readUIntFromSTAFLog, setDebugLog, setHandle, stafLogLog, stafLogLog, stafLogRequest, write, writeCloseMessages, writeInitMessages

Methods inherited from class org.safs.logging.FileLogItem

fileExists, getAbsolutePath, getFileSpec, getParentDir, isFileSpecAbsolute, setParentDir

Methods inherited from class org.safs.logging.LogItem

dateTime, isClosed

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractSTAFTextLogItem

public AbstractSTAFTextLogItem(java.lang.String name,
                               java.lang.String parent,
                               java.lang.String file)

Creates a disabled AbstractSTAFTextLogItem with default log level (LOGLEVEL_INFO).

The type of this log item is always LOGMODE_SAFS_TEXT.

Parameters:

name - the name of this log.

parent - the parent directory for this log.

file - the file spec of this log.

AbstractSTAFTextLogItem

public AbstractSTAFTextLogItem(java.lang.String parent,
                               java.lang.String file)

Creates a disabled AbstractSTAFTextLogItem with default name (file name) and log level (LOGLEVEL_INFO).

The type of this log item is always LOGMODE_SAFS_TEXT.

Parameters:

parent - the parent directory for this log.

file - the file spec of this log.

AbstractSTAFTextLogItem

public AbstractSTAFTextLogItem(java.lang.String file)

Creates a disabled AbstractSTAFTextLogItem with default name (file name) and log level (LOGLEVEL_INFO), and empty parent directory.

The type of this log item is always LOGMODE_SAFS_TEXT.

Parameters:

file - the file spec of this log.

Method Detail

init

public void init()

Initializes this log and writes the log open message.

Overrides:

init in class STAFFileLogItem

logMessage

public void logMessage(java.lang.String msg,
                       java.lang.String desc,
                       int msgType)

Logs a message in standard SAFS text log format if enabled and open.

Specified by:

logMessage in class LogItem

Parameters:

msg - the message to log.

desc - additional description to log.

msgType - the int identifier of the type of message being logged.

logMessage

public void logMessage(java.lang.String msg,
                       int msgType)

Logs a message in standard SAFS text log format if enabled and open.

Parameters:

msg - the message to log.

msgType - the int identifier of the type of message being logged.

logMessage

public void logMessage(java.lang.String msg)

Logs a message in standard SAFS text log format if enabled and open.

Message type defaults to GENERIC_MESSAGE.

Parameters:

msg - the message to log.

close

public void close()
           throws STAFLogException

Close this log if enabled and open.

Specified by:

close in class STAFFileLogItem

Throws:

STAFLogException - if this method failed for any reason.

getInitMessages

protected java.util.List<java.lang.String> getInitMessages()

Description copied from class: STAFFileLogItem

Return the messages to write after the log is initialized.

Specified by:

getInitMessages in class STAFFileLogItem

getCloseMessages

protected java.util.List<java.lang.String> getCloseMessages()

Description copied from class: STAFFileLogItem

Return the messages to write before the log is closed.

Specified by:

getCloseMessages in class STAFFileLogItem