SAFSLOGS (SAFS API DOCUMENT)

java.lang.Object
- org.safs.tools.drivers.DriverConfiguredSTAFInterfaceClass
- - org.safs.tools.logs.SAFSLOGS

All Implemented Interfaces:: ConfigurableToolsInterface, GenericToolsInterface, LogsInterface

public class SAFSLOGS
extends DriverConfiguredSTAFInterfaceClass
implements LogsInterface

This concrete implementation interfaces clients to the SAFSLOGS service. This class expects a DriverInterface object to provide access to all configuration information.

ConfigureInterface Information

 [STAF]
 ;NOSTAF=TRUE  will launch this service as an embedded services if AUTOLAUNCH=TRUE.
 
 [SAFS_LOGS]
 AUTOLAUNCH=TRUE
 OVERWRITE=TRUE
 CAPXML=TRUE
 TRUNCATE=ON|OFF|#chars
 ;ITEM=org.safs.tools.logs.SAFSLOGS
 ;Service=SAFSLOGS
 ;ServiceClass will be different for STAF2 and STAF3
 ;ServiceClass=org.safs.staf.service.logging.v2.SAFSLoggingService
 ;ServiceClass=org.safs.staf.service.logging.v3.SAFSLoggingService3
 ;If we indicate the SERVICEJAR, the jar's manifest file contains the necessary info to
 ;distinguish the STAF's version, and select the right class to load service
 ;SERVICEJAR=C:\safs\lib\safslogs.jar
 ;OPTIONS=

Note those items commented with semicolons are only needed when using alternate values.

AUTOLAUNCH

TRUE--Enable this class to launch the STAF service if it is not already running.
FALSE--Do not try to launch the service if it is not running.

The Driver's 'safs.driver.autolaunch' command-line option is also queried for this setting and overrides any other configuration source setting.

The default AUTOLAUNCH setting is TRUE.

OVERWRITE

TRUE for the service to delete/overwrite existing logs of the same name. If this parameter is not TRUE, the service will NOT overwrite existing logs and no logs will be generated. The files will have to be moved or renamed before logging will commence.

The default OVERWRITE value is FALSE

CAPXML

TRUE for the service to "cap" the XML logs when they are closed. XML logs when closed are not yet valid XML because they do not have the standard XML header, nor a single root node. This allows multiple logs to be appended together before they are made into valid XML.

The default CAPXML value is FALSE. Most users will want to provide this value set to TRUE, unless they intend to cap the XML themselves at some later time.

TRUNCATE

Truncate messages and descriptions to a fixed length. By default, Truncate is disabled. When enabled, the default truncate length for messages and descriptions is 128 characters each.
The user can change the truncate length by sending an integer > 0 as the value of the option.
Ex: TRUNCATE 256
TRUNCATE ON -- same as TRUNCATE with no option value. Enables truncate mode.
TRUNCATE OFF -- disables truncate mode.

The default CAPXML value is FALSE. Most users will want to provide this value set to TRUE, unless they intend to cap the XML themselves at some later time.

ITEM

The full class name for an alternate LogsInterface class for SAFSLOGS. This parameter is only needed if an alternate/custom LogsInterface is used. The class must be findable by the JVM and Class.forName functions.

The default ITEM value is org.safs.tools.logs.SAFSLOGS

SERVICECLASS

The full class name for an alternate service class for SAFSLOGS. This parameter is only needed if an alternate/custom service is used. This class must be findable by the JVM. This setting, if provided, will cause any SERVICEJAR setting to be ignored.

The default SERVICECLASS value is org.safs.staf.service.logging.v2.SAFSLoggingService

SERVICEJAR

The full path and name for an alternate service JAR for SAFSLOGS. This parameter is only needed if an alternate/custom service is used. This class must be findable by the JVM. If a value is specified for SERVICECLASS, then this setting is ignored.

The default SERVICEJAR value is [safsroot]/lib/safslogs.jar

SERVICE

The service name for an alternate service instead of "SAFSLOGS". This parameter is only needed if an alternate/custom service is used. Note: All of the standard SAFS Framework tools currently expect the default "SAFSLOGS" service name.

OPTIONS

Any additional PARMS to be sent to the service upon initialization. We already handle sending the DIR parameter with the path obtained from the Driver. Any other options needed for service initialization should be specified here. There typically will be none.

Author:: Carl Nagle DEC 14, 2005

Field Summary

Fields
Modifier and Type	Field and Description
`protected boolean`	`capXML` Enables "capping" the XML log when it is closed.
`protected java.lang.String`	`classpath` Stores classname or JAR file fullpath for STAF service initialization.
`protected static java.lang.String`	`DEFAULT_EMBEDDED_SAFSLOGS_CLASS` "org.safs.staf.service.logging.EmbeddedLogService"
`protected static java.lang.String`	`DEFAULT_SAFSLOGS_CLASS` "org.safs.staf.service.logging.v2.SAFSLoggingService"
`protected static java.lang.String`	`DEFAULT_SAFSLOGS_CLASS3` "org.safs.staf.service.logging.v3.SAFSLoggingService3"
`protected static java.lang.String`	`DEFAULT_SAFSLOGS_JAR` "safslogs.jar"
`protected boolean`	`overwrite` Enables/Disables previous log overwrite when initializing a new log.
`protected boolean`	`truncate` Enables "TRUNCATE" of log messages.
`protected int`	`truncateLength` Default length of enabled TRUNCATE is 128 chars.

Fields inherited from class org.safs.tools.drivers.DriverConfiguredSTAFInterfaceClass
config, customStr, customText, debugStr, debugText, driver, DRIVER_TEMP_PROCESS, failedStr, failedText, genericStr, genericText, launchCount, log, machine, otherStr, otherText, passedStr, passedText, processName, running, SAFS_RESBUN_NAME, servicename, shutdownCount, staf, STAFPROC_EXE, warningStr, warningText, weStartedService, weStartedSTAF

Fields inherited from interface org.safs.tools.logs.LogsInterface
DEFAULT_STATUSINFO_ID

Constructor Summary

Constructors
Constructor and Description

SAFSLOGS()
Constructor for SAFSLOGS

Constructors
Constructor and Description
`SAFSLOGS()` Constructor for SAFSLOGS

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`closeAllLogs()` This makes sure that all the open logs are closed.
`void`	`closeLog(UniqueIDInterface log)` This closes the specified Log .
`protected void`	`finalize()` Invoke all superclass finalization.
`void`	`initLog(UniqueLogInterface logInfo)` Initialize/Open the specified log.
`void`	`launchInterface(java.lang.Object configInfo)` Expects a DriverInterface for initialization.
`void`	`logMessage(UniqueMessageInterface message)` Log a message to a particular log.
`void`	`logStatusInfo(UniqueIDInterface log, StatusInterface info, java.lang.String infoID)` Log a status report for the particular StatusInterface object provided.
`void`	`reset()` This should probably make sure that all open logs are closed.
`void`	`resumeAllLogs()` Resume loggint to ALL previosly suspended logs.
`void`	`resumeLog(UniqueIDInterface log)` Resume logging to a previously suspended log.
`void`	`setLogLevel(UniqueLogLevelInterface logLevel)` Set/Change the log level or filter for log messages.
`void`	`suspendAllLogs()` Suspend logging to ALL open logs.
`void`	`suspendLog(UniqueIDInterface log)` Suspend logging for a particular log.
`void`	`truncate(boolean enabled)` Enables or disables the truncation of logged messages.
`void`	`truncate(int numchars)` Enables truncation of logged messages to the numchars length provided.

Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - DEFAULT_SAFSLOGS_CLASS
```
protected static final java.lang.String DEFAULT_SAFSLOGS_CLASS
```
    "org.safs.staf.service.logging.v2.SAFSLoggingService"
    
    See Also:
    
    Constant Field Values
  - DEFAULT_SAFSLOGS_CLASS3
```
protected static final java.lang.String DEFAULT_SAFSLOGS_CLASS3
```
    "org.safs.staf.service.logging.v3.SAFSLoggingService3"
    
    See Also:
    
    Constant Field Values
  - DEFAULT_EMBEDDED_SAFSLOGS_CLASS
```
protected static final java.lang.String DEFAULT_EMBEDDED_SAFSLOGS_CLASS
```
    "org.safs.staf.service.logging.EmbeddedLogService"
    
    See Also:
    
    Constant Field Values
  - DEFAULT_SAFSLOGS_JAR
```
protected static final java.lang.String DEFAULT_SAFSLOGS_JAR
```
    "safslogs.jar"
    
    See Also:
    
    Constant Field Values
  - classpath
```
protected java.lang.String classpath
```
    Stores classname or JAR file fullpath for STAF service initialization.
  - overwrite
```
protected boolean overwrite
```
    Enables/Disables previous log overwrite when initializing a new log. Defaults to FALSE -- delete/overwrite previous log
  - capXML
```
protected boolean capXML
```
    Enables "capping" the XML log when it is closed. Defaults to FALSE --
  - truncate
```
protected boolean truncate
```
    Enables "TRUNCATE" of log messages. Defaults to FALSE --
  - truncateLength
```
protected int truncateLength
```
    Default length of enabled TRUNCATE is 128 chars.
- Constructor Detail
  - SAFSLOGS
```
public SAFSLOGS()
```
    Constructor for SAFSLOGS
- Method Detail
  - launchInterface
```
public void launchInterface(java.lang.Object configInfo)
```
    Expects a DriverInterface for initialization. The superclass handles generic initialization and then we provide SAFSLOGS-specific initialization.
    
    Specified by:
    
    launchInterface in interface ConfigurableToolsInterface
    
    Overrides:
    
    launchInterface in class DriverConfiguredSTAFInterfaceClass
    
    Parameters:
    
    configInfo - can be whatever the final implementation needs it to be. This might be a String with configuration information, the name of a class, or an instance of some object used to provide configuration assets.
    
    See Also:
    
    ConfigurableToolsInterface.launchInterface(Object)
  - initLog
```
public void initLog(UniqueLogInterface logInfo)
```
    Description copied from interface: LogsInterface
    
    Initialize/Open the specified log.
    
    Specified by:
    
    initLog in interface LogsInterface
    
    See Also:
    
    Initializes the Log Facility. It checks the types of logging enabled on the basis of LOG MODE. For example if only TextLog or XML log is enabled then it initializes the LOG Facility with only those two enabled. It also checks if any alternate name or path is specified for Text Log and XML log. Log Facility is still not taken care of.
  - setLogLevel
```
public void setLogLevel(UniqueLogLevelInterface logLevel)
```
    Description copied from interface: LogsInterface
    
    Set/Change the log level or filter for log messages. This will likely be implementation specific.
    
    Specified by:
    
    setLogLevel in interface LogsInterface
    
    See Also:
    
    Set's the Logging Level . I am allowing an empty Log Level because the service does not give an error instead it returns the current log level . But the intended set operation is not done. .
  - logMessage
```
public void logMessage(UniqueMessageInterface message)
```
    Description copied from interface: LogsInterface
    
    Log a message to a particular log.
    
    Specified by:
    
    logMessage in interface LogsInterface
    
    See Also:
    
    Log's a message in the Log Facility. If Log Facility or the Message to be logged is not specified then the request is not made. If Description is null it is not included in the request to the SAFSLOGGING service.
  - logStatusInfo
```
public void logStatusInfo(UniqueIDInterface log,
                          StatusInterface info,
                          java.lang.String infoID)
```
    Log a status report for the particular StatusInterface object provided.
    
    Specified by:
    
    logStatusInfo in interface LogsInterface
    
    Parameters:
    
    log - -- String name of an open LogFacility in SAFSLOGS.
    
    info - -- StatusInterface containing status counts.
    
    infoID - -- Name or ID to give to the status information in the log. This is usually used to show the subject of the status info. For example, "Regression Test", "TestCase 123456", etc.. DEFAULT_STATUSINFO_ID used if null or zero-length.
  - suspendLog
```
public void suspendLog(UniqueIDInterface log)
```
    Description copied from interface: LogsInterface
    
    Suspend logging for a particular log.
    
    Specified by:
    
    suspendLog in interface LogsInterface
    
    See Also:
    
    This ensure that the specified log is suspended.
  - suspendAllLogs
```
public void suspendAllLogs()
```
    Description copied from interface: LogsInterface
    
    Suspend logging to ALL open logs.
    
    Specified by:
    
    suspendAllLogs in interface LogsInterface
    
    See Also:
    
    This ensures that all the Logs are supended.
  - resumeLog
```
public void resumeLog(UniqueIDInterface log)
```
    Description copied from interface: LogsInterface
    
    Resume logging to a previously suspended log.
    
    Specified by:
    
    resumeLog in interface LogsInterface
    
    See Also:
    
    This ensures that the specified Log is resumed again.
  - resumeAllLogs
```
public void resumeAllLogs()
```
    Description copied from interface: LogsInterface
    
    Resume loggint to ALL previosly suspended logs.
    
    Specified by:
    
    resumeAllLogs in interface LogsInterface
    
    See Also:
    
    This ensures that all the previously suspended Logs are started again.
  - truncate
```
public void truncate(int numchars)
```
    Enables truncation of logged messages to the numchars length provided.
    
    Specified by:
    
    truncate in interface LogsInterface
  - truncate
```
public void truncate(boolean enabled)
```
    Enables or disables the truncation of logged messages.
    
    Specified by:
    
    truncate in interface LogsInterface
  - closeLog
```
public void closeLog(UniqueIDInterface log)
```
    This closes the specified Log .
    
    Specified by:
    
    closeLog in interface LogsInterface
    
    See Also:
    
    LogsInterface.closeLog(UniqueIDInterface)
  - closeAllLogs
```
public void closeAllLogs()
```
    This makes sure that all the open logs are closed.
    
    Specified by:
    
    closeAllLogs in interface LogsInterface
    
    See Also:
    
    LogsInterface.closeAllLogs()
  - reset
```
public void reset()
```
    This should probably make sure that all open logs are closed. This would allow us to recover from interrupted tests when logs are left open and unprocessed.
    
    Specified by:
    
    reset in interface GenericToolsInterface
    
    See Also:
    
    GenericToolsInterface.reset()
  - finalize
```
protected void finalize()
                 throws java.lang.Throwable
```
    Invoke all superclass finalization.
    
    Overrides:
    
    finalize in class DriverConfiguredSTAFInterfaceClass
    
    Throws:
    
    java.lang.Throwable
    
    See Also:
    
    DriverConfiguredSTAFInterfaceClass.finalize()

Class SAFSLOGS

ConfigureInterface Information

Field Summary

Fields inherited from class org.safs.tools.drivers.DriverConfiguredSTAFInterfaceClass

Fields inherited from interface org.safs.tools.logs.LogsInterface

Constructor Summary

Method Summary

Methods inherited from class org.safs.tools.drivers.DriverConfiguredSTAFInterfaceClass

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_SAFSLOGS_CLASS

DEFAULT_SAFSLOGS_CLASS3

DEFAULT_EMBEDDED_SAFSLOGS_CLASS

DEFAULT_SAFSLOGS_JAR

classpath

overwrite

capXML

truncate

truncateLength

Constructor Detail

SAFSLOGS

Method Detail

launchInterface

initLog

setLogLevel

logMessage

logStatusInfo

suspendLog

suspendAllLogs

resumeLog

resumeAllLogs

truncate

truncate

closeLog

closeAllLogs

reset

finalize