org.safs.staf.service.logging

Class EmbeddedXMLLogItem

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.EmbeddedXMLLogItem

public class EmbeddedXMLLogItem
extends AbstractSTAFXmlLogItem

Field Summary

Fields

Modifier and Type	Field and Description
protected java.io.OutputStreamWriter	out

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

capXML

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
EmbeddedXMLLogItem(java.lang.String file)
EmbeddedXMLLogItem(java.lang.String parent, java.lang.String file)
EmbeddedXMLLogItem(java.lang.String name, java.lang.String parent, java.lang.String file)

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 void	finalizeLogFile() Finalizes the detination log file.
protected java.lang.String	getSTAFLogDirectory() Returns the DIRECTORY setting of the STAF LOG service.
void	init() Initializes this log and writes the log open message.
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.
protected void	write(java.lang.String msg)

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

formatMessage, getCapXML, logMessage, logMessage, setCapXML

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

exportSTAFLog, getMachineName, readStringFromSTAFLog, readUIntFromSTAFLog, setDebugLog, setHandle, stafLogLog, stafLogLog, stafLogRequest

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

out

protected java.io.OutputStreamWriter out

Constructor Detail

EmbeddedXMLLogItem

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

EmbeddedXMLLogItem

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

EmbeddedXMLLogItem

public EmbeddedXMLLogItem(java.lang.String file)

Method Detail

getSTAFLogDirectory

protected java.lang.String getSTAFLogDirectory()

Description copied from class: STAFFileLogItem

Returns the DIRECTORY setting of the STAF LOG service. This method is defined as abstract. Because STAF 2 and STAF 3 return non-marshaled and marshaled result. While to un-marshal the result, we must import the STAF 3 library; To separate STAF 2 and STAF 3, this method is defined as abstract, and it will be implemented in STAFTextLogItem, STAFTextLogItem3, STAFXmlLogItem and STAFXmlLogItem3.

Specified by:

getSTAFLogDirectory in class STAFFileLogItem

Returns:

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

write

protected void write(java.lang.String msg)

logMessage

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

Description copied from class: AbstractSTAFXmlLogItem

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

Overrides:

logMessage in class AbstractSTAFXmlLogItem

Parameters:

msg - the message to log.

desc - additional description to log.

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

init

public void init()

Description copied from class: AbstractSTAFXmlLogItem

Initializes this log and writes the log open message.

Overrides:

init in class AbstractSTAFXmlLogItem

prependFinalLog

protected void prependFinalLog(java.io.Writer out)

Description copied from class: AbstractSTAFXmlLogItem

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 AbstractSTAFXmlLogItem

Parameters:

out - PrintWriter

appendFinalLog

protected void appendFinalLog(java.io.Writer out)

Description copied from class: AbstractSTAFXmlLogItem

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 AbstractSTAFXmlLogItem

Parameters:

out - PrintWriter

close

public void close()
           throws STAFLogException

Close this log if enabled and open.

Overrides:

close in class AbstractSTAFXmlLogItem

Throws:

STAFLogException - if this method failed for any reason.

finalizeLogFile

protected void finalizeLogFile()
                        throws STAFLogException

Description copied from class: STAFFileLogItem

Finalizes the detination log file.

Overrides:

finalizeLogFile in class STAFFileLogItem

Throws:

STAFLogException