org.safs.staf.service.logging.v3

Class STAFXmlLogItem3

java.lang.Object

org.safs.logging.LogItem

org.safs.logging.FileLogItem

org.safs.staf.service.logging.STAFFileLogItem

org.safs.staf.service.logging.AbstractSTAFXmlLogItem

org.safs.staf.service.logging.v3.STAFXmlLogItem3

public class STAFXmlLogItem3
extends AbstractSTAFXmlLogItem

This class is used to realize STAF-version related method. It will be instantiated in class SAFSLoggingService and class SLSLogFacility

Since:

MAY 19 2009 (LW) Realize the method getSTAFLogDirectory()

See Also:

SAFSLoggingService3, SLSLogFacility

Field Summary

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

capXML, PROPERTY_DATE, PROPERTY_IP, PROPERTY_MACHINE, PROPERTY_MAJOR, PROPERTY_MINOR, PROPERTY_NAME, PROPERTY_TIME, PROPERTY_TYPE, PROPERTY_USER, TAG_LOG_CLOSED, TAG_LOG_MESSAGE, TAG_LOG_OPENED, TAG_LOG_VERSION, TAG_MESSAGE_DETAILS, TAG_MESSAGE_TEXT, TAG_SAFS_LOG, TAG_STATUS_END_DETAILS, TAG_STATUS_END_TEXT, TAG_STATUS_ITEM, TAG_STATUS_ITEM_DETAILS, TAG_STATUS_ITEM_TEXT, TAG_STATUS_REPORT, TAG_STATUS_START_DETAILS, 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
STAFXmlLogItem3(java.lang.String file) Creates a disabled STAFXmlLogItem3 with default name (file name) and log level (LOGLEVEL_INFO), and empty parent directory.
STAFXmlLogItem3(java.lang.String parent, java.lang.String file) Creates a disabled STAFXmlLogItem3 with default name (file name) and log level (LOGLEVEL_INFO).
STAFXmlLogItem3(java.lang.String name, java.lang.String parent, java.lang.String file) Creates a disabled STAFXmlLogItem3 with default log level (LOGLEVEL_INFO).

Method Summary

Modifier and Type	Method and Description
protected java.lang.String	getSTAFLogDirectory() Returns the DIRECTORY setting of the STAF LOG service.

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

appendFinalLog, close, formatMessage, getCapXML, getCloseMessages, getInitMessages, init, logMessage, logMessage, logMessage, prependFinalLog, setCapXML

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

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

Constructor Detail

STAFXmlLogItem3

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

Creates a disabled STAFXmlLogItem3 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.

STAFXmlLogItem3

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

Creates a disabled STAFXmlLogItem3 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.

STAFXmlLogItem3

public STAFXmlLogItem3(java.lang.String file)

Creates a disabled STAFXmlLogItem3 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

getSTAFLogDirectory

protected java.lang.String getSTAFLogDirectory()

Returns the DIRECTORY setting of the STAF LOG service.

Specified by:

getSTAFLogDirectory in class STAFFileLogItem

Returns:

the Directory setting as returned by LIST SETTINGS request to STAF LOG service.