org.safs.staf.service.logging

Class AbstractSTAFXmlLogItem

java.lang.Object

org.safs.logging.LogItem

org.safs.logging.FileLogItem

org.safs.staf.service.logging.STAFFileLogItem

org.safs.staf.service.logging.AbstractSTAFXmlLogItem

Direct Known Subclasses:

EmbeddedXMLLogItem, STAFXmlLogItem, STAFXmlLogItem3

public abstract class AbstractSTAFXmlLogItem
extends STAFFileLogItem

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

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

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	capXML TRUE if the XML log should be capped at closure.
protected static java.lang.String	PROPERTY_DATE
protected static java.lang.String	PROPERTY_IP
protected static java.lang.String	PROPERTY_MACHINE
protected static java.lang.String	PROPERTY_MAJOR
protected static java.lang.String	PROPERTY_MINOR
protected static java.lang.String	PROPERTY_NAME
protected static java.lang.String	PROPERTY_TIME
protected static java.lang.String	PROPERTY_TYPE
protected static java.lang.String	PROPERTY_USER
protected static java.lang.String	TAG_LOG_CLOSED
protected static java.lang.String	TAG_LOG_MESSAGE
protected static java.lang.String	TAG_LOG_OPENED
protected static java.lang.String	TAG_LOG_VERSION
protected static java.lang.String	TAG_MESSAGE_DETAILS
protected static java.lang.String	TAG_MESSAGE_TEXT
protected static java.lang.String	TAG_SAFS_LOG
protected static java.lang.String	TAG_STATUS_END_DETAILS
protected static java.lang.String	TAG_STATUS_END_TEXT
protected static java.lang.String	TAG_STATUS_ITEM
protected static java.lang.String	TAG_STATUS_ITEM_DETAILS
protected static java.lang.String	TAG_STATUS_ITEM_TEXT
protected static java.lang.String	TAG_STATUS_REPORT
protected static java.lang.String	TAG_STATUS_START_DETAILS
protected static java.lang.String	TAG_STATUS_START_TEXT

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
AbstractSTAFXmlLogItem(java.lang.String file) Creates a disabled AbstractSTAFXmlLogItem with default name (file name) and log level (LOGLEVEL_INFO), and empty parent directory.
AbstractSTAFXmlLogItem(java.lang.String parent, java.lang.String file) Creates a disabled AbstractSTAFXmlLogItem with default name (file name) and log level (LOGLEVEL_INFO).
AbstractSTAFXmlLogItem(java.lang.String name, java.lang.String parent, java.lang.String file) Creates a disabled AbstractSTAFXmlLogItem with default log level (LOGLEVEL_INFO).

Method Summary

Modifier and Type	Method and Description
protected void	appendFinalLog(java.io.Writer out) Override superclass prepend to provide a valid XML header if capXML is true.
void	close() Close this log if enabled and open.
protected java.lang.String	formatMessage(java.lang.String msg, java.lang.String desc, MessageTypeInfo info) Prepares the message to standard SAFS xml format.
boolean	getCapXML() Returns the current setting of whether the XML log will be capped on closure.
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 xml log format if enabled and open.
protected void	prependFinalLog(java.io.Writer out) Override superclass prepend to provide a valid XML header if capXML is true.
void	setCapXML(boolean capbool) Set true if this log should be "capped" (made valid XML) upon closure.

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

exportSTAFLog, finalizeLogFile, getMachineName, getSTAFLogDirectory, getTestName, 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

Field Detail

TAG_LOG_OPENED

protected static final java.lang.String TAG_LOG_OPENED

See Also:

Constant Field Values

TAG_LOG_VERSION

protected static final java.lang.String TAG_LOG_VERSION

See Also:

Constant Field Values

TAG_LOG_CLOSED

protected static final java.lang.String TAG_LOG_CLOSED

See Also:

Constant Field Values

TAG_SAFS_LOG

protected static final java.lang.String TAG_SAFS_LOG

See Also:

Constant Field Values

TAG_LOG_MESSAGE

protected static final java.lang.String TAG_LOG_MESSAGE

See Also:

Constant Field Values

TAG_MESSAGE_TEXT

protected static final java.lang.String TAG_MESSAGE_TEXT

See Also:

Constant Field Values

TAG_MESSAGE_DETAILS

protected static final java.lang.String TAG_MESSAGE_DETAILS

See Also:

Constant Field Values

TAG_STATUS_REPORT

protected static final java.lang.String TAG_STATUS_REPORT

See Also:

Constant Field Values

TAG_STATUS_ITEM

protected static final java.lang.String TAG_STATUS_ITEM

See Also:

Constant Field Values

TAG_STATUS_ITEM_TEXT

protected static final java.lang.String TAG_STATUS_ITEM_TEXT

See Also:

Constant Field Values

TAG_STATUS_ITEM_DETAILS

protected static final java.lang.String TAG_STATUS_ITEM_DETAILS

See Also:

Constant Field Values

TAG_STATUS_START_TEXT

protected static final java.lang.String TAG_STATUS_START_TEXT

See Also:

Constant Field Values

TAG_STATUS_START_DETAILS

protected static final java.lang.String TAG_STATUS_START_DETAILS

See Also:

Constant Field Values

TAG_STATUS_END_TEXT

protected static final java.lang.String TAG_STATUS_END_TEXT

See Also:

Constant Field Values

TAG_STATUS_END_DETAILS

protected static final java.lang.String TAG_STATUS_END_DETAILS

See Also:

Constant Field Values

PROPERTY_TYPE

protected static final java.lang.String PROPERTY_TYPE

See Also:

Constant Field Values

PROPERTY_DATE

protected static final java.lang.String PROPERTY_DATE

See Also:

Constant Field Values

PROPERTY_TIME

protected static final java.lang.String PROPERTY_TIME

See Also:

Constant Field Values

PROPERTY_USER

protected static final java.lang.String PROPERTY_USER

See Also:

Constant Field Values

PROPERTY_MACHINE

protected static final java.lang.String PROPERTY_MACHINE

See Also:

Constant Field Values

PROPERTY_IP

protected static final java.lang.String PROPERTY_IP

See Also:

Constant Field Values

PROPERTY_NAME

protected static final java.lang.String PROPERTY_NAME

See Also:

Constant Field Values

PROPERTY_MAJOR

protected static final java.lang.String PROPERTY_MAJOR

See Also:

Constant Field Values

PROPERTY_MINOR

protected static final java.lang.String PROPERTY_MINOR

See Also:

Constant Field Values

capXML

protected boolean capXML

TRUE if the XML log should be capped at closure. Capping the log provides final XML header and footer text to make the XML valid.

Constructor Detail

AbstractSTAFXmlLogItem

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

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

The type of this log item is always LOGMODE_SAFS_XML.

Parameters:

name - the name of this log.

parent - the parent directory for this log.

file - the file spec of this log.

AbstractSTAFXmlLogItem

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

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

The type of this log item is always LOGMODE_SAFS_XML.

Parameters:

parent - the parent directory for this log.

file - the file spec of this log.

AbstractSTAFXmlLogItem

public AbstractSTAFXmlLogItem(java.lang.String file)

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

The type of this log item is always LOGMODE_SAFS_XML.

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

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

setCapXML

public void setCapXML(boolean capbool)

Set true if this log should be "capped" (made valid XML) upon closure.

Parameters:

capbool -

getCapXML

public boolean getCapXML()

Returns the current setting of whether the XML log will be capped on closure.

Returns:

true if the log is set to be XML capped on closure.

logMessage

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

Logs a message in standard SAFS xml 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.

formatMessage

protected java.lang.String formatMessage(java.lang.String msg,
                                         java.lang.String desc,
                                         MessageTypeInfo info)

Prepares the message to standard SAFS xml format.

Parameters:

msg - the message to log.

desc - additional description to log.

info - the constant info for the message type.

Returns:

the standard-SAFS-xml-formatted message.

prependFinalLog

protected void prependFinalLog(java.io.Writer out)

Override superclass prepend to provide a valid XML header if capXML is true. This routine does nothing if capXML is false.

Overrides:

prependFinalLog in class STAFFileLogItem

Parameters:

out - PrintWriter

appendFinalLog

protected void appendFinalLog(java.io.Writer out)

Override superclass prepend to provide a valid XML header if capXML is true. This routine does nothing if capXML is false.

Overrides:

appendFinalLog in class STAFFileLogItem

Parameters:

out - PrintWriter