org.safs.control

Class Control

java.lang.Object

org.safs.control.Control

Direct Known Subclasses:

ControlStep

public abstract class Control
extends java.lang.Object

Description : Control, commands used to control an engine by sending step commands

Since:

NOV 24, 2003
NOV 24, 2003 (DBauman) Original Release, cut from ControlStep, which extends us

Author:

dbauman

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
(package private) static class	Control.HookTestRecordData

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	appMapName if the appmapName is null, the code will search for the appmapname list from the safsmaps service, and use the first one
protected TestRecordData	data
protected boolean	debug
protected java.lang.String	delim the Test Step delimiter
protected java.lang.String	driver driver, any of the engines, possibly SAFS/RobotJ or SAFS/DriverCommands
protected java.lang.String	fac
protected java.lang.String	filename
protected boolean	firstFoundMsg
protected boolean	firstMapMsg
protected STAFHelper	helper
protected boolean	nodebug
static java.lang.String	ROBOTJ_PROCESS_NAME
static java.lang.String	SAFS_SHARED_TRD_PREFIX
static java.lang.String	SAFS_TESTLOG_MSG
protected java.lang.String	testLevel
protected long	timeout number of seconds to allow for the driver's response.

Constructor Summary

Constructors

Constructor and Description
Control()

Method Summary

Modifier and Type	Method and Description
void	callSAFSJHook() callSAFSJHook
void	fireJRequest(java.lang.String request) Purpose: fireJRequest, execute a test steps.
void	getSAFSTestRecordData() getSAFSTestRecordData
protected void	initHelper()
protected abstract void	invokeSetInputRecord(java.lang.String request)
TestRecordData	prepTestRecordData(long ln) Purpose: prepare the test record data
void	setSAFSTestRecordData() setSAFSTestRecordData
protected abstract void	showStatus()
void	testJHook(java.util.Collection c, java.lang.String filename) Purpose: testJHook, execute a collection of test steps

Methods inherited from class java.lang.Object

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

Field Detail

ROBOTJ_PROCESS_NAME

public static final java.lang.String ROBOTJ_PROCESS_NAME

See Also:

Constant Field Values

SAFS_SHARED_TRD_PREFIX

public static final java.lang.String SAFS_SHARED_TRD_PREFIX

See Also:

Constant Field Values

SAFS_TESTLOG_MSG

public static final java.lang.String SAFS_TESTLOG_MSG

See Also:

Constant Field Values

driver

protected java.lang.String driver

driver, any of the engines, possibly SAFS/RobotJ or SAFS/DriverCommands

timeout

protected long timeout

number of seconds to allow for the driver's response. ( < 0 = wait indefinitely)

helper

protected STAFHelper helper

delim

protected java.lang.String delim

the Test Step delimiter

data

protected TestRecordData data

filename

protected java.lang.String filename

appMapName

protected java.lang.String appMapName

if the appmapName is null, the code will search for the appmapname list from the safsmaps service, and use the first one

fac

protected java.lang.String fac

testLevel

protected java.lang.String testLevel

debug

protected boolean debug

nodebug

protected boolean nodebug

firstMapMsg

protected boolean firstMapMsg

firstFoundMsg

protected boolean firstFoundMsg

Constructor Detail

Control

public Control()

Method Detail

setSAFSTestRecordData

public void setSAFSTestRecordData()
                           throws SAFSException

setSAFSTestRecordData

DESCRIPTION: Populates the shared "SAFS/Hook/" TestRecordData in SAFSVARS This is used to pass info TO and FROM other tools (like RobotJ).

Throws:

SAFSException - Throws exception if STAF is not installed.
Author: Doug Bauman
Date: JUN 19, 2003
History:

JUN 19, 2003 Original Release
JUN 26, 2003 dbauman: ported to java
NOV 24, 2003 dbauman: copyied from RobotJHook

getSAFSTestRecordData

public void getSAFSTestRecordData()
                           throws SAFSException

getSAFSTestRecordData

DESCRIPTION: Populates the data structure FROM shared "SAFS/Hook/" TestRecordData in SAFSVARS. This is used to pass info TO and FROM other tools (like RobotJ).

Throws:

SAFSException - Throws "Error in loading DLL" if STAF is not installed.
Orig Author: Carl Nagle
Orig Date: JUN 19, 2003
History:

JUN 19, 2003 Original Release
JUN 26, 2003 dbauman: ported to java
NOV 24, 2003 dbauman: copyied from RobotJHook

callSAFSJHook

public void callSAFSJHook()
                   throws SAFSException

callSAFSJHook

DESCRIPTION: Perform the full event-driven exchange for Classic to invoke a driver to process a test input record.

Throws:

SAFSException - if STAF is not installed.
Orig Author: Doug Bauman
Orig Date: NOV 24, 2003
History:

NOV 24, 2003 dbauman: copyied from RobotJHook

prepTestRecordData

public TestRecordData prepTestRecordData(long ln)

Purpose: prepare the test record data

Returns:

TestRecordData

fireJRequest

public void fireJRequest(java.lang.String request)
                  throws SAFSException

Purpose: fireJRequest, execute a test steps. First sets the status code to SCRIPT_NOT_EXECUTED and the inputRecord to the request, then calls 'callSAFSJHook'

Parameters:

request, - one test step

Throws:

SAFSException

testJHook

public void testJHook(java.util.Collection c,
                      java.lang.String filename)
               throws SAFSException

Purpose: testJHook, execute a collection of test steps

Parameters:

filename, - String

c, - Collection of Test Steps

Throws:

SAFSException

initHelper

protected void initHelper()

invokeSetInputRecord

protected abstract void invokeSetInputRecord(java.lang.String request)

showStatus

protected abstract void showStatus()