org.safs.tools.drivers

Class AbstractDriver

java.lang.Object

org.safs.tools.drivers.AbstractDriver

All Implemented Interfaces:

DriverInterface, PathInterface

Direct Known Subclasses:

DefaultDriver, STAFProcessContainerDriver

public abstract class AbstractDriver
extends java.lang.Object
implements DriverInterface

The root, abstract implementation of our tool-independent Driver.

Field Summary

Fields

Modifier and Type	Field and Description
protected AutoItComponent	autoitcomponent AutoItComponent
protected java.lang.String	benchSource
protected ConfigureInterface	configInfo
protected CoreInterface	core
UniqueStringCounterInfo	counterInfo
protected CountersInterface	counts
protected FlowControlInterface	cycleflowcontrol CYCLE shared flow control info used by all Driver/InputProcessors.
protected java.lang.String	cycleLinkedFac
protected long	cycleLogMode
protected java.lang.String	cycleLogName
protected java.lang.String	cycleSeparator
protected java.lang.String	cycleSuffix
protected java.lang.String	datapoolSource
protected DebugInterface	debug
protected java.lang.String	difSource
protected java.lang.String	driverConfigPath
protected java.lang.String	driverName Name of this Driver: Default = "SAFS/TIDriver"
protected java.lang.String	driverRootDir
protected boolean	exitCycle
protected boolean	exitSuite
protected boolean	expressionsOn
protected InputInterface	input
protected EngineInterface	ipcommands SAFSDRIVERCOMMANDS
protected ConfigureLocatorInterface	locator
protected java.lang.String	logLevel
protected LogsInterface	logs
protected java.lang.String	logsSource
protected MapsInterface	maps
protected int	millisBetweenRecords
protected boolean	perTableFlowControl If true then local flow control blocks can be defined for each separate test table (InputProcessor).
protected java.lang.String	projectConfigPath
protected java.lang.String	projectRootDir
protected StatusInterface	statuscounts StatusCounter
protected FlowControlInterface	stepflowcontrol STEP shared flow control info used by all Driver/InputProcessors.
protected java.lang.String	stepLinkedFac
protected long	stepLogMode
protected java.lang.String	stepLogName
protected java.lang.String	stepSeparator
protected java.lang.String	stepSuffix
protected FlowControlInterface	suiteflowcontrol SUITE shared flow control info used by all Driver/InputProcessors.
protected java.lang.String	suiteLinkedFac
protected long	suiteLogMode
protected java.lang.String	suiteLogName
protected java.lang.String	suiteSeparator
protected java.lang.String	suiteSuffix
protected java.lang.String	testLevel
protected java.lang.String	testName
protected java.lang.String	testSource
protected EngineInterface	tidcommands TIDDriverCommands
protected EngineInterface	tidcomponent TIDComponent
protected VarsInterface	vars
protected java.lang.String	verifySource

Fields inherited from interface org.safs.tools.drivers.DriverInterface

DRIVER_CONTROL_POF_VAR, DRIVER_CONTROL_POW_VAR, DRIVER_CONTROL_VAR

Constructor Summary

Constructors

Constructor and Description
AbstractDriver()

Method Summary

Modifier and Type	Method and Description
protected void	addConfigureInterfaceSource(ConfigureInterface source) Initialize or append a ConfigureInterface to existing ones in the search order.
StatusInterface	addStatusCounts(StatusInterface incstatus)
EngineInterface	getAutoItComponentSupport()
java.lang.String	getBenchDir()
ConfigureInterface	getConfigureInterface()
protected ConfigureLocatorInterface	getConfigureLocator(java.lang.String locatorInfo) Locate a ConfigureLocatorInterface given the locatorInfo, presumably provided from command-line options.
CoreInterface	getCoreInterface() Attempts to return an interface to the core framework through one of the existing interfaces.
CountersInterface	getCountersInterface()
long	getCycleLogMode()
java.lang.String	getCycleLogName()
java.lang.String	getCycleSeparator()
java.lang.String	getCycleSuffix()
java.lang.String	getDatapoolDir()
DebugInterface	getDebugInterface()
java.lang.String	getDifDir()
java.lang.String	getDriverName()
java.lang.String	getDriverRootDir()
FlowControlInterface	getFlowControlInterface(java.lang.String testlevel)
InputInterface	getInputInterface()
EngineInterface	getIPDriverCommands()
java.lang.String	getLogLevel()
java.lang.String	getLogsDir()
LogsInterface	getLogsInterface()
MapsInterface	getMapsInterface()
int	getMillisBetweenRecords()
protected java.lang.String	getParameterValue(java.lang.String param) Capture REQUIRED parameter values.
protected java.lang.String	getProjectDirectoryInfo(java.lang.String configItem, java.lang.String subdir, boolean datapoolRelative) Verify the existence of Project subdirectories.
java.lang.String	getProjectRootDir()
protected java.lang.String	getRootDirectoryInfo(java.lang.String store, java.lang.String configSection, java.lang.String configItem) Verify the existence of a "root" directory, like the Driver root or Project root.
java.lang.String	getRootVerifyDir()
StatusInterface	getStatusInterface()
long	getStepLogMode()
java.lang.String	getStepLogName()
java.lang.String	getStepSeparator()
java.lang.String	getStepSuffix()
long	getSuiteLogMode()
java.lang.String	getSuiteLogName()
java.lang.String	getSuiteSeparator()
java.lang.String	getSuiteSuffix()
java.lang.String	getTestDir()
java.lang.String	getTestLevel()
java.lang.String	getTestName()
EngineInterface	getTIDDriverCommands()
EngineInterface	getTIDGUIlessComponentSupport()
VarsInterface	getVarsInterface()
void	incrementGeneralStatus(int status) Increment General (not Test, means not T, TW, TF) record counts. There is an exceptional case, the status is like DriverConstant.STATUS_TESTXXX_LOGGED, then increment the "test"(NOT "general") counter, keep consistent with InputProcessor.
void	incrementTestStatus(int status) Increment Test Record (for T, TW, TF) counts.
boolean	isExitCycle()
boolean	isExitSuite()
boolean	isExpressionsEnabled()
protected static boolean	isModifiedConfig()
protected static boolean	isModifiedRoot()
boolean	isPerTableFlowControl()
void	logMessage(java.lang.String msg, java.lang.String msgdescription, int msgtype) Routine to log different message types to the active SAFS log.
protected java.lang.String	processEmbeddedVariable(java.lang.String rootDir) Checks to see if the path is (or startswith) an embedded variable. Embedded variables are in the form %VARIABLE_NAME% and will be sought as System Properties, or System Environment variables.
protected abstract StatusInterface	processTest() This is the one that actually opens and loops through our tests records! Typically, DriverInterface subclasses like SAFSDRIVER will be used to provide the concrete implementation.
protected static void	resetModifiedProperties() Clear System Properties for:
long	setBenchDir(java.lang.String absolute_path)
long	setDatapoolDir(java.lang.String absolute_path)
long	setDifDir(java.lang.String absolute_path)
void	setExitCycle(boolean enabled)
void	setExitSuite(boolean enabled)
void	setExpressionsEnabled(boolean enabled)
long	setLogsDir(java.lang.String absolute_path)
void	setMillisBetweenRecords(int millisBetween)
void	setPerTableFlowControl(boolean enabled)
long	setProjectRootDir(java.lang.String absolute_path)
long	setRootVerifyDir(java.lang.String absolute_path)
long	setTestDir(java.lang.String absolute_path)
protected void	validateRootConfigureParameters(boolean datapoolRelative) Verify the validity of REQUIRED parameters.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.safs.tools.drivers.DriverInterface

clearEnginePreferences, endEnginePreference, getEnginePreferences, getEngines, getPreferredEngine, hasEnginePreferences, isPreferredEngine, isPreferredEngine, startEnginePreference

Field Detail

driverName

protected java.lang.String driverName

Name of this Driver: Default = "SAFS/TIDriver"

configInfo

protected ConfigureInterface configInfo

input

protected InputInterface input

maps

protected MapsInterface maps

vars

protected VarsInterface vars

logs

protected LogsInterface logs

core

protected CoreInterface core

counts

protected CountersInterface counts

debug

protected DebugInterface debug

autoitcomponent

protected AutoItComponent autoitcomponent

AutoItComponent

tidcommands

protected EngineInterface tidcommands

TIDDriverCommands

tidcomponent

protected EngineInterface tidcomponent

TIDComponent

ipcommands

protected EngineInterface ipcommands

SAFSDRIVERCOMMANDS

statuscounts

protected StatusInterface statuscounts

StatusCounter

counterInfo

public UniqueStringCounterInfo counterInfo

millisBetweenRecords

protected int millisBetweenRecords

cycleflowcontrol

protected FlowControlInterface cycleflowcontrol

CYCLE shared flow control info used by all Driver/InputProcessors. This may be overridden by local flowcontrol info defined for each separate InputProcessor if local flowcontrol mode is ever enabled.

suiteflowcontrol

protected FlowControlInterface suiteflowcontrol

SUITE shared flow control info used by all Driver/InputProcessors. This may be overridden by local flowcontrol info defined for each separate InputProcessor if local flowcontrol mode is ever enabled.

stepflowcontrol

protected FlowControlInterface stepflowcontrol

STEP shared flow control info used by all Driver/InputProcessors. This may be overridden by local flowcontrol info defined for each separate InputProcessor if local flowcontrol mode is ever enabled.

perTableFlowControl

protected boolean perTableFlowControl

If true then local flow control blocks can be defined for each separate test table (InputProcessor). When true, shared flow control blockIDs are disabled in favor of per table flow control.

locator

protected ConfigureLocatorInterface locator

driverRootDir

protected java.lang.String driverRootDir

projectRootDir

protected java.lang.String projectRootDir

driverConfigPath

protected java.lang.String driverConfigPath

projectConfigPath

protected java.lang.String projectConfigPath

datapoolSource

protected java.lang.String datapoolSource

verifySource

protected java.lang.String verifySource

benchSource

protected java.lang.String benchSource

difSource

protected java.lang.String difSource

logsSource

protected java.lang.String logsSource

testSource

protected java.lang.String testSource

testName

protected java.lang.String testName

testLevel

protected java.lang.String testLevel

cycleSuffix

protected java.lang.String cycleSuffix

cycleSeparator

protected java.lang.String cycleSeparator

suiteSuffix

protected java.lang.String suiteSuffix

suiteSeparator

protected java.lang.String suiteSeparator

stepSuffix

protected java.lang.String stepSuffix

stepSeparator

protected java.lang.String stepSeparator

logLevel

protected java.lang.String logLevel

cycleLogName

protected java.lang.String cycleLogName

cycleLogMode

protected long cycleLogMode

cycleLinkedFac

protected java.lang.String cycleLinkedFac

suiteLogName

protected java.lang.String suiteLogName

suiteLogMode

protected long suiteLogMode

suiteLinkedFac

protected java.lang.String suiteLinkedFac

stepLogName

protected java.lang.String stepLogName

stepLogMode

protected long stepLogMode

stepLinkedFac

protected java.lang.String stepLinkedFac

expressionsOn

protected boolean expressionsOn

exitSuite

protected boolean exitSuite

exitCycle

protected boolean exitCycle

Constructor Detail

AbstractDriver

public AbstractDriver()

Method Detail

getMillisBetweenRecords

public int getMillisBetweenRecords()

Specified by:

getMillisBetweenRecords in interface DriverInterface

See Also:

DriverInterface.getMillisBetweenRecords()

setMillisBetweenRecords

public void setMillisBetweenRecords(int millisBetween)

Specified by:

setMillisBetweenRecords in interface DriverInterface

See Also:

DriverInterface.setMillisBetweenRecords(int)

isPerTableFlowControl

public boolean isPerTableFlowControl()

Specified by:

isPerTableFlowControl in interface DriverInterface

See Also:

DriverInterface.isPerTableFlowControl()

setPerTableFlowControl

public void setPerTableFlowControl(boolean enabled)

Specified by:

setPerTableFlowControl in interface DriverInterface

See Also:

DriverInterface.setPerTableFlowControl(boolean)

isExitSuite

public boolean isExitSuite()

Specified by:

isExitSuite in interface DriverInterface

See Also:

DriverInterface.isExitSuite()

setExitSuite

public void setExitSuite(boolean enabled)

Specified by:

setExitSuite in interface DriverInterface

See Also:

DriverInterface.setExitSuite(boolean)

isExitCycle

public boolean isExitCycle()

Specified by:

isExitCycle in interface DriverInterface

See Also:

DriverInterface.isExitCycle()

setExitCycle

public void setExitCycle(boolean enabled)

Specified by:

setExitCycle in interface DriverInterface

See Also:

DriverInterface.setExitCycle(boolean)

getConfigureInterface

public ConfigureInterface getConfigureInterface()

Specified by:

getConfigureInterface in interface DriverInterface

See Also:

DriverInterface.getConfigureInterface()

getInputInterface

public InputInterface getInputInterface()

Specified by:

getInputInterface in interface DriverInterface

See Also:

DriverInterface.getInputInterface()

getMapsInterface

public MapsInterface getMapsInterface()

Specified by:

getMapsInterface in interface DriverInterface

See Also:

DriverInterface.getMapsInterface()

getVarsInterface

public VarsInterface getVarsInterface()

Specified by:

getVarsInterface in interface DriverInterface

See Also:

DriverInterface.getVarsInterface()

getLogsInterface

public LogsInterface getLogsInterface()

Specified by:

getLogsInterface in interface DriverInterface

See Also:

DriverInterface.getLogsInterface()

getCoreInterface

public CoreInterface getCoreInterface()

Attempts to return an interface to the core framework through one of the existing interfaces.

Specified by:

getCoreInterface in interface DriverInterface

See Also:

DriverInterface.getCoreInterface()

getCountersInterface

public CountersInterface getCountersInterface()

Specified by:

getCountersInterface in interface DriverInterface

See Also:

DriverInterface.getCountersInterface()

getDebugInterface

public DebugInterface getDebugInterface()

Specified by:

getDebugInterface in interface DriverInterface

See Also:

DriverInterface.getDebugInterface()

getFlowControlInterface

public FlowControlInterface getFlowControlInterface(java.lang.String testlevel)

Specified by:

getFlowControlInterface in interface DriverInterface

See Also:

DriverInterface.getFlowControlInterface(String)

getStatusInterface

public StatusInterface getStatusInterface()

Specified by:

getStatusInterface in interface DriverInterface

See Also:

DriverInterface.getStatusInterface()

addStatusCounts

public StatusInterface addStatusCounts(StatusInterface incstatus)

Specified by:

addStatusCounts in interface DriverInterface

See Also:

DriverInterface.addStatusCounts(StatusInterface)

incrementGeneralStatus

public void incrementGeneralStatus(int status)

Increment General (not Test, means not T, TW, TF) record counts.
There is an exceptional case, the status is like DriverConstant.STATUS_TESTXXX_LOGGED, then
increment the "test"(NOT "general") counter, keep consistent with InputProcessor.

Specified by:

incrementGeneralStatus in interface DriverInterface

Parameters:

status -

See Also:

StatusCodes

incrementTestStatus

public void incrementTestStatus(int status)

Increment Test Record (for T, TW, TF) counts.

Specified by:

incrementTestStatus in interface DriverInterface

Parameters:

status -

See Also:

StatusCodes

getDriverName

public java.lang.String getDriverName()

Specified by:

getDriverName in interface DriverInterface

See Also:

DriverInterface.getDriverName()

getTIDDriverCommands

public EngineInterface getTIDDriverCommands()

Specified by:

getTIDDriverCommands in interface DriverInterface

See Also:

DriverInterface.getTIDDriverCommands()

getAutoItComponentSupport

public EngineInterface getAutoItComponentSupport()

Specified by:

getAutoItComponentSupport in interface DriverInterface

See Also:

DriverInterface.getAutoItComponentSupport()

getTIDGUIlessComponentSupport

public EngineInterface getTIDGUIlessComponentSupport()

Specified by:

getTIDGUIlessComponentSupport in interface DriverInterface

See Also:

DriverInterface.getTIDGUIlessComponentSupport()

getIPDriverCommands

public EngineInterface getIPDriverCommands()

Specified by:

getIPDriverCommands in interface DriverInterface

See Also:

DriverInterface.getIPDriverCommands()

getParameterValue

protected java.lang.String getParameterValue(java.lang.String param)

Capture REQUIRED parameter values.

Returns:

System property value or an empty string if not found.

resetModifiedProperties

protected static void resetModifiedProperties()

Clear System Properties for:

• safs.modified.config
• safs.modified.root

isModifiedConfig

protected static boolean isModifiedConfig()

isModifiedRoot

protected static boolean isModifiedRoot()

processEmbeddedVariable

protected java.lang.String processEmbeddedVariable(java.lang.String rootDir)

Checks to see if the path is (or startswith) an embedded variable.
Embedded variables are in the form %VARIABLE_NAME% and will be sought as System Properties, or System Environment variables.

Parameters:

rootDir -

Returns:

getDriverRootDir

public java.lang.String getDriverRootDir()

Specified by:

getDriverRootDir in interface DriverInterface

Specified by:

getDriverRootDir in interface PathInterface

getProjectRootDir

public java.lang.String getProjectRootDir()

Specified by:

getProjectRootDir in interface DriverInterface

Specified by:

getProjectRootDir in interface PathInterface

getConfigureLocator

protected ConfigureLocatorInterface getConfigureLocator(java.lang.String locatorInfo)

Locate a ConfigureLocatorInterface given the locatorInfo, presumably provided from command-line options.

Throws:

java.lang.IllegalArgumentException - if appropriate locator class cannot be instantiated.

addConfigureInterfaceSource

protected void addConfigureInterfaceSource(ConfigureInterface source)

Initialize or append a ConfigureInterface to existing ones in the search order.

setProjectRootDir

public long setProjectRootDir(java.lang.String absolute_path)

Specified by:

setProjectRootDir in interface DriverInterface

getProjectDirectoryInfo

protected java.lang.String getProjectDirectoryInfo(java.lang.String configItem,
                                                   java.lang.String subdir,
                                                   boolean datapoolRelative)

Verify the existence of Project subdirectories. The Project root directory must have already been validated with getRootDirectoryInfo.
Note, when attempting to locate relative project paths, the "datapool" directory is determined relative to the root project directory. All other (default) subdirectories are sought as relative to the "datapool" directory. Thus, the "datapool" directory must be verified and set prior to any of its subdirectories.

Parameters:

configItem - is usually null if the default directory structure is in use. It can contain an alternate directory specification, usually provided from a configuration file. When provided as a relative path, it will be relative to the Project directory, not the datapool directory.

subdir - is the default subdirectory name to use/verify if configItem is null, or does not resolve to a valid directory.

Throws:

java.lang.NullPointerException - if a directory cannot be resolved.

validateRootConfigureParameters

protected void validateRootConfigureParameters(boolean datapoolRelative)

Verify the validity of REQUIRED parameters. Verify valid driver root.
Verify valid project root.
Verify valid configure locator class.
Verify existence of at least 1 configuration source.
Verify existence of all required Project directories.
Verify existence of test name parameter.
Verify/Create existence of test level.
Verify existence of appropriate test level field separator.

Parameters:

datapoolRelative - -- if forced to create project subdirectories, create them relative to the Datapool directory. Otherwise, they will be considered relative to the Project directory.

Throws:

java.lang.IllegalArgumentException - if insufficient configuration information is available from command-line parameters or configuration files.

getRootDirectoryInfo

protected java.lang.String getRootDirectoryInfo(java.lang.String store,
                                                java.lang.String configSection,
                                                java.lang.String configItem)

Verify the existence of a "root" directory, like the Driver root or Project root. First tries based on stored command-line parameter. If that is not found, then we attempt to lookup valid path information in configuration files.

Returns:

the string path to a directory verified to exist.

Throws:

java.lang.NullPointerException - if no valid directory can be found.

getRootVerifyDir

public java.lang.String getRootVerifyDir()

Specified by:

getRootVerifyDir in interface DriverInterface

setRootVerifyDir

public long setRootVerifyDir(java.lang.String absolute_path)

Specified by:

setRootVerifyDir in interface DriverInterface

getDatapoolDir

public java.lang.String getDatapoolDir()

Specified by:

getDatapoolDir in interface DriverInterface

Specified by:

getDatapoolDir in interface PathInterface

setDatapoolDir

public long setDatapoolDir(java.lang.String absolute_path)

Specified by:

setDatapoolDir in interface DriverInterface

getBenchDir

public java.lang.String getBenchDir()

Specified by:

getBenchDir in interface DriverInterface

Specified by:

getBenchDir in interface PathInterface

setBenchDir

public long setBenchDir(java.lang.String absolute_path)

Specified by:

setBenchDir in interface DriverInterface

getDifDir

public java.lang.String getDifDir()

Specified by:

getDifDir in interface DriverInterface

Specified by:

getDifDir in interface PathInterface

setDifDir

public long setDifDir(java.lang.String absolute_path)

Specified by:

setDifDir in interface DriverInterface

getLogsDir

public java.lang.String getLogsDir()

Specified by:

getLogsDir in interface DriverInterface

Specified by:

getLogsDir in interface PathInterface

setLogsDir

public long setLogsDir(java.lang.String absolute_path)

Specified by:

setLogsDir in interface DriverInterface

getTestDir

public java.lang.String getTestDir()

Specified by:

getTestDir in interface DriverInterface

Specified by:

getTestDir in interface PathInterface

setTestDir

public long setTestDir(java.lang.String absolute_path)

Specified by:

setTestDir in interface DriverInterface

getTestName

public java.lang.String getTestName()

Specified by:

getTestName in interface DriverInterface

See Also:

DriverInterface.getTestName()

getTestLevel

public java.lang.String getTestLevel()

Specified by:

getTestLevel in interface DriverInterface

See Also:

DriverInterface.getTestLevel()

getCycleSuffix

public java.lang.String getCycleSuffix()

Specified by:

getCycleSuffix in interface DriverInterface

See Also:

DriverInterface.getCycleSuffix()

getCycleSeparator

public java.lang.String getCycleSeparator()

Specified by:

getCycleSeparator in interface DriverInterface

See Also:

DriverInterface.getCycleSeparator()

getSuiteSuffix

public java.lang.String getSuiteSuffix()

Specified by:

getSuiteSuffix in interface DriverInterface

See Also:

DriverInterface.getSuiteSuffix()

getSuiteSeparator

public java.lang.String getSuiteSeparator()

Specified by:

getSuiteSeparator in interface DriverInterface

See Also:

DriverInterface.getSuiteSeparator()

getStepSuffix

public java.lang.String getStepSuffix()

Specified by:

getStepSuffix in interface DriverInterface

See Also:

DriverInterface.getStepSuffix()

getStepSeparator

public java.lang.String getStepSeparator()

Specified by:

getStepSeparator in interface DriverInterface

See Also:

DriverInterface.getStepSeparator()

getLogLevel

public java.lang.String getLogLevel()

Specified by:

getLogLevel in interface DriverInterface

See Also:

DriverInterface.getLogLevel()

getCycleLogName

public java.lang.String getCycleLogName()

Specified by:

getCycleLogName in interface DriverInterface

See Also:

DriverInterface.getCycleLogName()

getCycleLogMode

public long getCycleLogMode()

Specified by:

getCycleLogMode in interface DriverInterface

See Also:

DriverInterface.getCycleLogMode()

getSuiteLogName

public java.lang.String getSuiteLogName()

Specified by:

getSuiteLogName in interface DriverInterface

See Also:

DriverInterface.getSuiteLogName()

getSuiteLogMode

public long getSuiteLogMode()

Specified by:

getSuiteLogMode in interface DriverInterface

See Also:

DriverInterface.getSuiteLogMode()

getStepLogName

public java.lang.String getStepLogName()

Specified by:

getStepLogName in interface DriverInterface

See Also:

DriverInterface.getStepLogName()

getStepLogMode

public long getStepLogMode()

Specified by:

getStepLogMode in interface DriverInterface

See Also:

DriverInterface.getStepLogMode()

isExpressionsEnabled

public boolean isExpressionsEnabled()

Specified by:

isExpressionsEnabled in interface DriverInterface

See Also:

DriverInterface.isExpressionsEnabled()

setExpressionsEnabled

public void setExpressionsEnabled(boolean enabled)

Specified by:

setExpressionsEnabled in interface DriverInterface

See Also:

DriverInterface.setExpressionsEnabled(boolean)

processTest

protected abstract StatusInterface processTest()

This is the one that actually opens and loops through our tests records! Typically, DriverInterface subclasses like SAFSDRIVER will be used to provide the concrete implementation.

See Also:

SAFSDRIVER.processTest()

logMessage

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

Routine to log different message types to the active SAFS log.

Specified by:

logMessage in interface DriverInterface

Parameters:

message - String message

description - String (optional) for more detailed info. Can be null.

type - int message type constant from AbstractLogFacility.

Some Message Types:

• AbstractLogFacility#GENERIC_MESSAGE
• AbstractLogFacility#PASSED_MESSAGE
• AbstractLogFacility#FAILED_MESSAGE
• AbstractLogFacility#FAILED_OK_MESSAGE
• AbstractLogFacility#WARNING_MESSAGE
• AbstractLogFacility#WARNING_OK_MESSAGE

See Also:

#logGENERIC(String, String), #logPASSED(String, String), #logFAILED(String, String), #logWARNING(String, String), LogsInterface.logMessage(org.safs.tools.logs.UniqueMessageInterface)