org.safs

Class JavaSocketsHook

java.lang.Object

org.safs.JavaHook

org.safs.JavaSocketsHook

All Implemented Interfaces:

HookConfig, DebugListener, NamedListener

Direct Known Subclasses:

DJavaHook

public abstract class JavaSocketsHook
extends JavaHook
implements DebugListener

A class to extend the standard JavaHook allowing the integration/control of a "remote" engine controlled via TCP Sockets where STAF is NOT available. This class implements an interface between a "local" STAF-controlled engine agent and the actual "remote" engine communicating via TCP Sockets.

Author:

Carl Nagle

Field Summary

Fields

Modifier and Type	Field and Description
protected int	remoteConnectionTimeout Default remote connection timeout is 30 seconds.
(package private) int	remoteLogtype
protected int	remoteReadyTimeout Default remote Ready timeout is 10 seconds.
protected int	remoteRunningTimeout Default remote Running timeout is 10 seconds.
(package private) boolean	remoteShutdown
protected SocketTestRecordHelper	socketdata The standard data TestRecordHelper simply cast to a SocketTestRecordHelper type for convenience.
protected SAFSRemoteControl	tcpServer Not instantiated until the call to createProtocolRunner().

Fields inherited from class org.safs.JavaHook

data, DEBUG_MESSAGE, errorText, FAILED_MESSAGE, FAILED_OK_MESSAGE, GENERIC_ERROR, GENERIC_MESSAGE, helper, hookconfig, log, PASSED_MESSAGE, PAUSE_EXECUTION, PAUSE_SWITCH_OFF, PAUSE_SWITCH_ON, process_name, processor, REQUEST_PROCEED_TESTING, REQUEST_USER_STOPPED_SCRIPT_REQUEST, RUNNING_EXECUTION, semaphore_name, SHUTDOWN_RECORD, STAF_ERROR, STEP_EXECUTION, STEP_RETRY_EXECUTION, STEPPING_EXECUTION, STEPPING_RETRY_EXECUTION, trd_name, utils, WARNING_MESSAGE, WARNING_OK_MESSAGE

Constructor Summary

Constructors

Constructor and Description
JavaSocketsHook()
JavaSocketsHook(java.lang.String process_name)
JavaSocketsHook(java.lang.String process_name, LogUtilities logs)
JavaSocketsHook(java.lang.String process_name, java.lang.String trd_name)
JavaSocketsHook(java.lang.String process_name, java.lang.String trd_name, LogUtilities logs)
JavaSocketsHook(java.lang.String process_name, java.lang.String trd_name, LogUtilities logs, SocketTestRecordHelper trd_data, DDGUIUtilities gui_utils, ProcessRequest aprocessor)

Method Summary

Modifier and Type	Method and Description
protected boolean	afterLaunchRemoteEngine() Invoked during start loop initialization.
protected boolean	beforeLaunchRemoteEngine() Invoked during start loop initialization.
protected abstract boolean	createProtocolRunner() Invoked during start loop initialization.
protected void	disconnectSocketServer()
java.lang.String	getListenerName() Default implementation returns our process_name.
TestRecordHelper	getTRDData() Retrieve the SocketTestRecordHelper used by the subclass.
protected boolean	hook_shutdown() Sends a shutdown command to the tcpServer if the tcpServer is NOT the one that initiated the shutdown.
protected void	interpretResultProperties(java.util.Properties remoteResultProperties) Called by the running loop to extract whatever remoteResultProperties were received.
protected abstract boolean	launchRemoteEngine() Invoked during start loop initialization.
protected abstract void	logResultsMessage() Called by the running loop when it is time to log the results of the executed command.
void	onReceiveDebug(java.lang.String message) Default implementation logs the message to the SAFS Debug Log.
void	setTRDData(TestRecordHelper trd_data) Force the use of a SocketTestRecordHelper as required by the underlying remote engine hook.
void	start() Normal JavaHook start loop initialization and looping is augmented with additional requirements to handle the communications and synchronization with a remote socket-controlled engine as follows: normal initialization for STAFHelper, GUIUtilities, TestRecordHelper, and RequestProcessor.
protected boolean	startProtocolRunner() Invoked during start loop initialization.

Methods inherited from class org.safs.JavaHook

allowSystemExit, checkConfiguration, driverShutdownRequest, evaluateRuntimeException, getGUIUtilities, getHelper, getLogUtilities, getProcessName, getRequestProcessor, getSemaphoreName, getTRDName, initConfigPaths, instantiateHookConfig, setGUIUtilities, setHelper, setLogUtilities, setProcessName, setRequestProcessor, setSemaphoreName, setTRDName

Methods inherited from class java.lang.Object

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

Field Detail

tcpServer

protected SAFSRemoteControl tcpServer

Not instantiated until the call to createProtocolRunner().

remoteConnectionTimeout

protected int remoteConnectionTimeout

Default remote connection timeout is 30 seconds. This timeout is used AFTER the tcpServer has been started and, in theory, the remote engine was already remotely launched. Thus, the time to wait for the remote Connection being made should be relatively short.

See Also:

SoloRemoteControl.waitForRemoteConnected(int)

remoteReadyTimeout

protected int remoteReadyTimeout

Default remote Ready timeout is 10 seconds. This timeout is used AFTER the remote connection has already been established, and AFTER the Results of a previous start loop execution have been received and processed. Thus, the time to wait for the remote Ready signal should be relatively short.

See Also:

SoloRemoteControl.waitForRemoteReady(int)

remoteRunningTimeout

protected int remoteRunningTimeout

Default remote Running timeout is 10 seconds. This timeout is used AFTER the remote Ready has already been established, and AFTER we have issued the remote Dispatch. Thus, the time to wait for the remote Running signal should be relatively short.

See Also:

SoloRemoteControl.waitForRemoteRunning(int)

socketdata

protected SocketTestRecordHelper socketdata

The standard data TestRecordHelper simply cast to a SocketTestRecordHelper type for convenience.

remoteShutdown

boolean remoteShutdown

remoteLogtype

int remoteLogtype

Constructor Detail

JavaSocketsHook

public JavaSocketsHook()

JavaSocketsHook

public JavaSocketsHook(java.lang.String process_name)

Parameters:

process_name -

JavaSocketsHook

public JavaSocketsHook(java.lang.String process_name,
                       LogUtilities logs)

Parameters:

process_name -

logs -

JavaSocketsHook

public JavaSocketsHook(java.lang.String process_name,
                       java.lang.String trd_name)

Parameters:

process_name -

trd_name -

JavaSocketsHook

public JavaSocketsHook(java.lang.String process_name,
                       java.lang.String trd_name,
                       LogUtilities logs)

Parameters:

process_name -

trd_name -

logs -

JavaSocketsHook

public JavaSocketsHook(java.lang.String process_name,
                       java.lang.String trd_name,
                       LogUtilities logs,
                       SocketTestRecordHelper trd_data,
                       DDGUIUtilities gui_utils,
                       ProcessRequest aprocessor)

Parameters:

process_name -

trd_name -

logs -

trd_data -

gui_utils -

aprocessor -

Method Detail

beforeLaunchRemoteEngine

protected boolean beforeLaunchRemoteEngine()

Invoked during start loop initialization. Allows subclasses to perform any necessarily initialization prior to the call to launchRemoteEngine(). The default implementation does nothing and returns true to allow execution to proceed.

Returns:

true to proceed with engine execution. false will cause an abort of the engine startup procedure and any attempt to launch the remote engine.

launchRemoteEngine

protected abstract boolean launchRemoteEngine()

Invoked during start loop initialization. Allows subclasses to initiate the launching of a remote engine prior to starting the local TCP Server and entering the actual working loop.

Returns:

true to proceed with engine execution. Returning false will cause an abort of the engine startup procedure.

afterLaunchRemoteEngine

protected boolean afterLaunchRemoteEngine()

Invoked during start loop initialization. Allows subclasses to perform any work after a successful call to launchRemoteEngine() but prior to the entry to the main start loop. The default implementation does nothing and returns true to allow execution to proceed.

Returns:

true to proceed with engine execution. Returning false will cause an abort of the engine startup procedure.

createProtocolRunner

protected abstract boolean createProtocolRunner()

Invoked during start loop initialization. Creates the default instance of our abstractProtocolRunner with the hook process_name and provides this hook as the default NamedListener for the server.

Returns:

true to allow normal execution to proceed. Returning false will cause an abort of the engine startup procedure.

startProtocolRunner

protected boolean startProtocolRunner()

Invoked during start loop initialization. Creates the default instance of the tcpServerThread providing the current tcpServer Runnable as its argument. The tcpServerThread is then immediately started.

Returns:

true to allow normal execution to proceed. Returning false will cause an abort of the engine startup procedure.

getTRDData

public TestRecordHelper getTRDData()

Retrieve the SocketTestRecordHelper used by the subclass. If no SocketTestRecordHelper has been set (data == null), then the implementation is expected to instantiate and return a SocketTestRecordHelper instance appropriate for the hook.

Specified by:

getTRDData in class JavaHook

Throws:

SAFSRuntimeException - if the instance is NOT a SocketTestRecordHelper subclass.

setTRDData

public void setTRDData(TestRecordHelper trd_data)

Force the use of a SocketTestRecordHelper as required by the underlying remote engine hook.

Overrides:

setTRDData in class JavaHook

Throws:

SAFSRuntimeException - if the instance is NOT a SocketTestRecordHelper subclass.

interpretResultProperties

protected void interpretResultProperties(java.util.Properties remoteResultProperties)

Called by the running loop to extract whatever remoteResultProperties were received. Subclasses will extend this to extract additional properties.

logResultsMessage

protected abstract void logResultsMessage()

Called by the running loop when it is time to log the results of the executed command. Implementations should #see LogUtilities.logMessage(String, String, int, String)

start

public void start()

Normal JavaHook start loop initialization and looping is augmented with additional requirements to handle the communications and synchronization with a remote socket-controlled engine as follows:

1. normal initialization for STAFHelper, GUIUtilities, TestRecordHelper, and RequestProcessor.
2. createProtocolRunner()
3. beforeLaunchRemoteEngine()
4. launchRemoteEngine()
5. afterLaunchRemoteEngine()
6. startProtocolRunner()
7. SoloRemoteControl.waitForRemoteConnected(int)

Overrides:

start in class JavaHook

See Also:

JavaHook.start()

hook_shutdown

protected boolean hook_shutdown()

Sends a shutdown command to the tcpServer if the tcpServer is NOT the one that initiated the shutdown. Also removes ourselves as the SocketServerListener for the tcpServer and nulls out our to the tcpServer. Then continues by invoking the superclass hook_shutdown.

Overrides:

hook_shutdown in class JavaHook

Returns:

The default implementation will return true allowing the additional check of allowSystemExit. If a subclass overrides and returns false then the attempt to allowSystemExit will not happen.

See Also:

JavaHook.hook_shutdown()

disconnectSocketServer

protected void disconnectSocketServer()

getListenerName

public java.lang.String getListenerName()

Default implementation returns our process_name.

Specified by:

getListenerName in interface NamedListener

Returns:

name of listener. Might be null.

onReceiveDebug

public void onReceiveDebug(java.lang.String message)

Default implementation logs the message to the SAFS Debug Log.

Specified by:

onReceiveDebug in interface DebugListener