org.safs

Class SocketTestRecordHelper

java.lang.Object

org.safs.TestRecordData

org.safs.TestRecordHelper

org.safs.SocketTestRecordHelper

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

DTestRecordHelper

public class SocketTestRecordHelper
extends TestRecordHelper

Author:

Carl Nagle

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.safs.TestRecordHelper

TestRecordHelper.MySTAFRequester

Field Summary

Fields

Modifier and Type	Field and Description
(package private) boolean	processRemotely
(package private) java.util.Properties	props Keyword-specific properties/values passed via a SocketServer to a remote engine.

Fields inherited from class org.safs.TestRecordHelper

requester

Fields inherited from class org.safs.TestRecordData

POSSIBLE_SEPARATOR

Constructor Summary

Constructors

Constructor and Description
SocketTestRecordHelper()

Method Summary

Modifier and Type	Method and Description
void	addKeywordProperty(java.lang.String propname, java.lang.String propvalue) Add a keyword property to the Properties list.
int	getCommandTimeout()
java.util.Properties	getKeywordProperties() Can be null if no additional properties/values are needed for remote execution.
java.lang.String	getKeywordProperty(java.lang.String propname) Get a keyword property from the Properties list.
int	getReadyTimeout()
int	getRunningTimeout()
boolean	processRemotely()
void	reinit() Set our added fields to their default values during each command initialization: setKeywordProperties(false); setProcessRemotely(false);
void	setCommandTimeout(int commandTimeout) Every command might want to change its default timeout.
void	setKeywordProperties(java.util.Properties _props) Can set to null if no additional properties/values are needed for remote execution.
void	setProcessRemotely(boolean processRemotely) Keyword implementors will set this to true if the keyword is expecting a remote engine to complete the processing of the inputrecord.
void	setReadyTimeout(int readyTimeout) Every command might want to change its default timeouts.
void	setRunningTimeout(int runningTimeout) Every command might want to change its default timeouts.

Methods inherited from class org.safs.TestRecordHelper

getCompGuiId, getCompInstancePath, getConfig, getDDGUtils, getStaf, getSTAFHelper, getWindowGuiId, isMixedRsUsed, populateDataFromVar, sendbackResponse, setConfig, setDDGUtils, setSTAFHelper, targetIsComponent, targetIsWindow

Methods inherited from class org.safs.TestRecordData

copyData, getAltCompType, getAppMapName, getCommand, getCompClass, getCompModule, getCompName, getCompType, getEnvironment, getFac, getFileID, getFilename, getInputRecord, getInputRecordToken, getInstanceName, getLineNumber, getNotSeparatorString, getRecordType, getSeparator, getStatusCode, getStatusInfo, getTestLevel, getTrimmedUnquotedInputRecordToken, getWinCompName, getWindowName, inputRecordSize, setAltCompType, setAppMapName, setCommand, setCompClass, setCompGuiId, setCompModule, setCompName, setCompType, setEnvironment, setFac, setFileID, setFilename, setInputRecord, setInstanceName, setLineNumber, setRecordType, setSeparator, setShutdownData, setStatusCode, setStatusInfo, setTestLevel, setWindowGuiId, setWindowName, toString

Methods inherited from class java.lang.Object

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

Field Detail

props

java.util.Properties props

Keyword-specific properties/values passed via a SocketServer to a remote engine.

processRemotely

boolean processRemotely

Constructor Detail

SocketTestRecordHelper

public SocketTestRecordHelper()

Method Detail

getKeywordProperties

public java.util.Properties getKeywordProperties()

Can be null if no additional properties/values are needed for remote execution.

setKeywordProperties

public void setKeywordProperties(java.util.Properties _props)

Can set to null if no additional properties/values are needed for remote execution.

addKeywordProperty

public void addKeywordProperty(java.lang.String propname,
                               java.lang.String propvalue)

Add a keyword property to the Properties list. If the Properties list does not yet exist, it will be created prior to adding the new keyword property.

Parameters:

propname - case-insensitive name of the property. It will be stored and transmitted in lowerCase.

propvalue - case-sensitive value for the property.

getKeywordProperty

public java.lang.String getKeywordProperty(java.lang.String propname)

Get a keyword property from the Properties list.

Parameters:

propname - case-insensitive name of the property. It will be converted to lowerCase before use.

Returns:

String value of the property, or null.

processRemotely

public boolean processRemotely()

Returns:

true if the underlying engine is expected to dispatch the command to a remote engine. return false if the keyword was handled locally in its entirety.

setProcessRemotely

public void setProcessRemotely(boolean processRemotely)

Keyword implementors will set this to true if the keyword is expecting a remote engine to complete the processing of the inputrecord.

Parameters:

processRemotely - set true if the underlying engine is expected to dispatch the command to a remote engine. set false if the keyword was handled locally in its entirety.

getCommandTimeout

public int getCommandTimeout()

Returns:

the commandTimeout

setCommandTimeout

public void setCommandTimeout(int commandTimeout)

Every command might want to change its default timeout.

Parameters:

commandTimeout - -- number of seconds to wait for "Results" after Running before a timeout is suspected.

getReadyTimeout

public int getReadyTimeout()

Returns:

number of seconds to wait for "Ready" before Dispatch before a timeout is suspected.

setReadyTimeout

public void setReadyTimeout(int readyTimeout)

Every command might want to change its default timeouts.

Parameters:

readyTimeout - - number of seconds to wait for "Ready" before Dispatch before a timeout is suspected.

getRunningTimeout

public int getRunningTimeout()

Returns:

number of seconds to wait for "Running" after Dispatch before a timeout is suspected.

setRunningTimeout

public void setRunningTimeout(int runningTimeout)

Every command might want to change its default timeouts.

Parameters:

runningTimeout - - number of seconds to wait for Running after Dispatch before a timeout is suspected.

reinit

public void reinit()

Set our added fields to their default values during each command initialization:
setKeywordProperties(false);
setProcessRemotely(false);

Overrides:

reinit in class TestRecordData

See Also:

TestRecordData.reinit()