org.safs

Class SingletonSTAFHelper

java.lang.Object

org.safs.STAFHelper

org.safs.SingletonSTAFHelper

All Implemented Interfaces:

CoreInterface, RuntimeDataInterface

public class SingletonSTAFHelper
extends STAFHelper

Purpose: a wrapper class for the STAFHandle, includes some common functionality used many places associated with the SAFSVARS and SAFSMAPS; This is the Singleton version.

Since:

JUN 27, 2003
JUN 27, 2003 (DBauman) Original Release

Author:

Doug Bauman

Field Summary

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

Method Summary

Modifier and Type	Method and Description
static STAFHelper	getHelper() Purpose: static reference to only Singleton instance of this class Assumptions: it's up to the user to 'initialize()' the helper.
static STAFHelper	getInitializedHelper(java.lang.String processName) Purpose: static reference to only Singleton instance of this class.
static void	setInitializedHelper(STAFHelper _helper) Set the internal STAFHelper with an initialized STAFHelper only if the internal one is not already initialized.

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, getNextHookTestEvent, getNextTestEvent, getProcessName, getQueueMessage, getRunningEngineNames, getSAFSTestRecordData, getServiceEvents, getSTAFEnv, getSTAFVariable, getSTAFVersion, getSTAFVersionString, getVariable, initialize, isInitialized, isOnlyShutdownPosted, isSAFSINPUTAvailable, isSAFSLOGSAvailable, isSAFSMAPSAvailable, isSAFSVARSAvailable, isServiceAvailable, isServiceLibraryRunning, isToolAvailable, lentagValue, localPing, localStartProcess, logMessage, postEvent, postNextHookTestEvent, pulseEvent, reinstateShutdownHook, releaseSTAFMutex, removeService, removeShutdownHook, resetEvent, resetEvents, resetHookEvents, sendQueueMessage, setHookTestResults, setHookTestResultsWTimeout, setLocalMachine, setMachine, setSAFSTestRecordData, 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

Method Detail

getHelper

public static STAFHelper getHelper()

Purpose: static reference to only Singleton instance of this class
Assumptions: it's up to the user to 'initialize()' the helper.

Returns:

STAFHelper instance

setInitializedHelper

public static void setInitializedHelper(STAFHelper _helper)

Set the internal STAFHelper with an initialized STAFHelper only if the internal one is not already initialized.

Parameters:

_helper - An initialized STAFHelper

getInitializedHelper

public static STAFHelper getInitializedHelper(java.lang.String processName)
                                       throws SAFSSTAFRegistrationException

Purpose: static reference to only Singleton instance of this class. If the user provides a non-null processName, the object will automatically be initialized *if* it is not already initialized.

Parameters:

processName - The name of the process to register with STAF. If the object has not been initialized, and a null processName is provided, then we will initialize the object with the SAFS_GENERIC_PROCESS processName.

Returns:

STAFHelper instance, initialized as necessary.

Throws:

SAFSSTAFRegistrationException