org.safs.staf

Interface STAFHelperCompatibleInterface

All Known Implementing Classes:

AbstractSTAFHelperCompatible, STAFHelperCompatible2, STAFHelperCompatible3

public interface STAFHelperCompatibleInterface

 This interface contains some methods need by #STAFHelper, but can't
 be defined there due to the compatibility of STAF.
 From STAF3, there are some new classes that don't exist for STAF2. If we use
 them in STAFHelper, the ClassNotFoundException will be thrown with STAF2 environment.
 
 

Author:

Lei Wang

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	STAF2_CLASS_NAME
static java.lang.String	STAF3_CLASS_NAME

Method Summary

Modifier and Type	Method and Description
java.util.Collection	getRunningEngineNames(java.lang.String machine) Get collection of running Engine names.
java.util.List<java.lang.String>	getServiceEvents(java.lang.String machine, java.lang.String servicename) According to the service name, we try to get all events related to it.
void	setSTAFHelper(STAFHelper staf) This MUST be called to set the STAFHelper before calling other methods.

Field Detail

STAF2_CLASS_NAME

static final java.lang.String STAF2_CLASS_NAME

See Also:

Constant Field Values

STAF3_CLASS_NAME

static final java.lang.String STAF3_CLASS_NAME

See Also:

Constant Field Values

Method Detail

setSTAFHelper

void setSTAFHelper(STAFHelper staf)

This MUST be called to set the STAFHelper before calling other methods.

Parameters:

staf -

getServiceEvents

java.util.List<java.lang.String> getServiceEvents(java.lang.String machine,
                                                  java.lang.String servicename)
                                           throws SAFSException

According to the service name, we try to get all events related to it.

Parameters:

servicename - String, the service we want to get events for

Returns:

List of events related to the service, each list-item contains the event's name, state, number of waiters. The format is not the same for STAF2 and STAF3

Throws:

SAFSException

getRunningEngineNames

java.util.Collection getRunningEngineNames(java.lang.String machine)
                                    throws SAFSException

Get collection of running Engine names. We parse the STAF command: staf local SEM list EVENT
We deduce the number of unique <engine>Ready or <engine>Running events. We return the collection of unique engine names.

Returns:

Collection (Vector) of String engine names( ex: SAFS/RobotJ, SAFS/SELENIUM, etc..)

Throws:

SAFSException