org.safs.tools.drivers

Class EmbeddedHookSTAFHelper

java.lang.Object

org.safs.STAFHelper

org.safs.tools.drivers.EmbeddedHookSTAFHelper

All Implemented Interfaces:

CoreInterface, RuntimeDataInterface

public class EmbeddedHookSTAFHelper
extends STAFHelper

Field Summary

Fields

Modifier and Type	Field and Description
(package private) TestRecordData	_data
(package private) boolean	_engineRun

Fields inherited from class org.safs.STAFHelper

embedQUEUE, embedSEM, eventsToReset, getQueueMessageField, LOCAL_MACHINE, no_staf_handles, queue, ROBOTJ_EVENT_DISPATCH, ROBOTJ_EVENT_DONE, ROBOTJ_EVENT_READY, ROBOTJ_EVENT_RESULTS, ROBOTJ_EVENT_RUNNING, ROBOTJ_EVENT_SHUTDOWN, ROBOTJ_EVENT_START, SAFS_ABBOT_PROCESS, SAFS_ABBOT_PROCESS_ID, SAFS_APPMAP_SERVICE, SAFS_CLASSIC_PROCESS, SAFS_CLASSIC_PROCESS_ID, SAFS_CYCLE_TRD, SAFS_EVENT_DISPATCH, SAFS_EVENT_DONE, SAFS_EVENT_READY, SAFS_EVENT_RESULTS, SAFS_EVENT_RUNNING, SAFS_EVENT_SHUTDOWN, SAFS_EVENT_START, SAFS_GENERIC_PROCESS, SAFS_GENERIC_PROCESS_ID, SAFS_HOOK_TRD, SAFS_HOOK_TRD_MUTEX, SAFS_INPUT_PROCESS, SAFS_INPUT_SERVICE, SAFS_LOGGING_SERVICE, SAFS_LOGGINGLOG_SERVICE, SAFS_ROBOTJ_PROCESS, SAFS_ROBOTJ_PROCESS_ID, SAFS_SAFSLOGS_PROCESS, SAFS_SAFSMAPS_PROCESS, SAFS_SAFSVARS_PROCESS, SAFS_STEP_TRD, SAFS_SUITE_TRD, SAFS_VAR_APPMAPNAME, SAFS_VAR_BENCHDIRECTORY, SAFS_VAR_COMMANDLINEBREAKPOINT, SAFS_VAR_DATAPOOLDIRECTORY, SAFS_VAR_DIFDIRECTORY, SAFS_VAR_FAC, SAFS_VAR_FILENAME, SAFS_VAR_GLOBAL_LAST_LOG_DESC, SAFS_VAR_GLOBAL_LAST_LOG_MSG, SAFS_VAR_GLOBAL_LAST_LOG_TYPE, SAFS_VAR_INPUTRECORD, SAFS_VAR_LINENUMBER, SAFS_VAR_LOGSDIRECTORY, SAFS_VAR_PROJECTDIRECTORY, SAFS_VAR_ROOTVERIFYDIRECTORY, SAFS_VAR_RUNTIMEREPOSITORY, SAFS_VAR_SAFSACTIVECYCLE, SAFS_VAR_SAFSACTIVESTEP, SAFS_VAR_SAFSACTIVESUITE, SAFS_VAR_SECSWAITFORCOMPONENT, SAFS_VAR_SECSWAITFORWINDOW, SAFS_VAR_SEPARATOR, SAFS_VAR_STATUSCODE, SAFS_VAR_STATUSINFO, SAFS_VAR_SYSTEMUSERID, SAFS_VAR_TESTDIRECTORY, SAFS_VAR_TESTLEVEL, SAFS_VARIABLE_SERVICE, sem, STAF_DELAY_SERVICE, STAF_GLOBALVARS_VERSION, STAF_SERVICELOADER_V2, STAF_SERVICELOADER_V3, STAF_VARIABLE_SERVICE, stafCompatible, STAFQueueMessageClass

Constructor Summary

Constructors

Constructor and Description
EmbeddedHookSTAFHelper()
EmbeddedHookSTAFHelper(java.lang.String processName)

Method Summary

Modifier and Type	Method and Description
protected TestRecordData	_getData()
java.lang.String	getNextHookTestEvent(java.lang.String process_name, java.lang.String trd_name) The "engine" waits until the _engineRun flag is true and then begins execution.
void	getSAFSTestRecordData(java.lang.String trd_root, TestRecordData trd) Get the SAFSVARS Test Record Data into the given trd_root.
java.lang.String	getSTAFEnv(java.lang.String env) getSTAFEnv returns string value or an empty string.
com.ibm.staf.STAFResult	localStartProcess(java.lang.String appname, java.lang.String workdir) Cannot use STAF to run a process when STAF is not running!
int	postNextHookTestEvent(java.lang.String process_name, java.lang.String trd_root, TestRecordData trd) Sets _engineRun = true to kickoff the "engine" execution.
void	setHookTestResultsWTimeout(java.lang.String process_name, long timeoutseconds) Prevents the posting of STAF EVENTS (RESULTS and DONE) events since everything is local in the same JVM process.
void	setSAFSTestRecordData(java.lang.String trd_root, TestRecordData trd) Sets the local driver/engine shared _data object and sets the TRD_HOOK data per the superclass.

Methods inherited from class org.safs.STAFHelper

addService, addServiceSAFSVARS, configEmbeddedServices, delay, getAppMapItem, getAppMapItem, getAppMapNames, getEventDispatchString, getEventDoneString, getEventReadyString, getEventResultsString, getEventRunningString, getEventShutdownString, getEventStartString, getHandle, getHandleNumber, getLogName, getMachine, getNextTestEvent, getProcessName, getQueueMessage, getRunningEngineNames, getServiceEvents, getSTAFVariable, getSTAFVersion, getSTAFVersionString, getVariable, initialize, isInitialized, isOnlyShutdownPosted, isSAFSINPUTAvailable, isSAFSLOGSAvailable, isSAFSMAPSAvailable, isSAFSVARSAvailable, isServiceAvailable, isServiceLibraryRunning, isToolAvailable, lentagValue, localPing, logMessage, postEvent, pulseEvent, reinstateShutdownHook, releaseSTAFMutex, removeService, removeShutdownHook, resetEvent, resetEvents, resetHookEvents, sendQueueMessage, setHookTestResults, setLocalMachine, setMachine, setSTAFVariable, setTestResults, setVariable, shutDown, shutdownEmbeddedServices, startEmbeddedQueueService, startProcess, submit, submit2, submit2ForFormatUnchangedService, submit2WithVar, unRegister, waitEvent, waitEventMillis, waitEventWaiter, waitSTAFMutex

Methods inherited from class java.lang.Object

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

Field Detail

_data

TestRecordData _data

_engineRun

boolean _engineRun

Constructor Detail

EmbeddedHookSTAFHelper

public EmbeddedHookSTAFHelper()

EmbeddedHookSTAFHelper

public EmbeddedHookSTAFHelper(java.lang.String processName)
                       throws SAFSSTAFRegistrationException

Throws:

SAFSSTAFRegistrationException

Method Detail

_getData

protected TestRecordData _getData()

getNextHookTestEvent

public java.lang.String getNextHookTestEvent(java.lang.String process_name,
                                             java.lang.String trd_name)
                                      throws SAFSException

The "engine" waits until the _engineRun flag is true and then begins execution.

Overrides:

getNextHookTestEvent in class STAFHelper

Parameters:

process_name - -- the STAF-registered name of the engine involved.

trd_name - -- the TestRecordData SAFSVARS storage root, normally "SAFS/HOOK/".

Returns:

String, the variable INPUTRECORD

Throws:

SAFSException - if staf has a problem

See Also:

STAFHelper.getNextHookTestEvent(java.lang.String, java.lang.String)

postNextHookTestEvent

public int postNextHookTestEvent(java.lang.String process_name,
                                 java.lang.String trd_root,
                                 TestRecordData trd)
                          throws SAFSException

Sets _engineRun = true to kickoff the "engine" execution.

The "driver" then waits for _engineRun flag to change to indicate the "engine" is finished.

Overrides:

postNextHookTestEvent in class STAFHelper

Parameters:

process_name - -- the STAF-registered name of the engine to dispatch.

trd_root - -- the TestRecordData SAFSVARS storage root, normally "SAFS/HOOK/".

trd - -- the TestRecordData to place into SAFSVARS for execution by the engine.

Returns:

the statuscode from the call

Throws:

SAFSException - if staf has a problem

See Also:

STAFHelper.postNextHookTestEvent(java.lang.String, java.lang.String, org.safs.TestRecordData)

setSAFSTestRecordData

public void setSAFSTestRecordData(java.lang.String trd_root,
                                  TestRecordData trd)
                           throws SAFSException

Sets the local driver/engine shared _data object and sets the TRD_HOOK data per the superclass.

Specified by:

setSAFSTestRecordData in interface CoreInterface

Overrides:

setSAFSTestRecordData in class STAFHelper

Throws:

SAFSException

See Also:

STAFHelper.setSAFSTestRecordData(java.lang.String, org.safs.TestRecordData)

getSAFSTestRecordData

public void getSAFSTestRecordData(java.lang.String trd_root,
                                  TestRecordData trd)

Description copied from class: STAFHelper

Get the SAFSVARS Test Record Data into the given trd_root. The most common trd_root is "SAFS/HOOK/", which is used by all official drivers and engines. The routine does not deal with the TRD Mutex for the trd_root provided. It assumes the caller is handling the mutex.

Gets the following record data:
• inputrecord
• separator
• filename
• linenumber
• testlevel
• appmapname
• fac
• statuscode
• statusinfo

Specified by:

getSAFSTestRecordData in interface CoreInterface

Overrides:

getSAFSTestRecordData in class STAFHelper

setHookTestResultsWTimeout

public void setHookTestResultsWTimeout(java.lang.String process_name,
                                       long timeoutseconds)
                                throws SAFSException

Prevents the posting of STAF EVENTS (RESULTS and DONE) events since everything is local in the same JVM process.

Sets _engineRun = false to indicate the "engine" has finished processing the record and allow the "driver" to evaluate the results.

Overrides:

setHookTestResultsWTimeout in class STAFHelper

Throws:

SAFSException - if staf has a problem

See Also:

STAFHelper.setHookTestResultsWTimeout(java.lang.String, long)

getSTAFEnv

public java.lang.String getSTAFEnv(java.lang.String env)

Description copied from class: STAFHelper

getSTAFEnv returns string value or an empty string. null if not successfully executed or found.

Overrides:

getSTAFEnv in class STAFHelper

localStartProcess

public com.ibm.staf.STAFResult localStartProcess(java.lang.String appname,
                                                 java.lang.String workdir)
                                          throws java.io.IOException

Cannot use STAF to run a process when STAF is not running!

Overrides:

localStartProcess in class STAFHelper

Parameters:

machine - String, the name of the ("local") machine where the application will run

appname - String, the name of application to run

workdir - String, the directory serves as working directory for application

Returns:

STAFResult the result. STAFResult.OK, STAFResult.STAFNotRunning, STAFResult.InvalidParam, STAFResult.UnknownError, STAFResult.ProcessNotComplete

Throws:

java.io.IOException