org.safs.staf

Class STAFHelperCompatible3

java.lang.Object

org.safs.staf.AbstractSTAFHelperCompatible

org.safs.staf.STAFHelperCompatible3

All Implemented Interfaces:

STAFHelperCompatibleInterface

public class STAFHelperCompatible3
extends AbstractSTAFHelperCompatible

 Contains the specific implementation related to STAF3.
 Be careful to import this class into other class or use the static methods 
 of this class in other class, which will cause the backward compatibility problem.
 
 To get an instance of this class, use AbstractSTAFHelperCompatible.getCompatibleSTAF(int).
 

Author:

Lei Wang

Field Summary

Fields inherited from class org.safs.staf.AbstractSTAFHelperCompatible

staf

Fields inherited from interface org.safs.staf.STAFHelperCompatibleInterface

STAF2_CLASS_NAME, STAF3_CLASS_NAME

Constructor Summary

Constructors

Constructor and Description
STAFHelperCompatible3()

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.
static com.ibm.staf.STAFMarshallingContext	getUnMarshallResult(java.lang.String result) From STAF3.3, the result returned from submit will be marshaled String. We need to un-marshal it to get the structure for human to understand. The returned structure STAFMarshallingContext need to be parsed.
static java.lang.String	getUnMarshallStringResult(java.lang.String result) From STAF3.3, the result returned from submit will be marshalled String. We need to un-marshal it to get the string for humain to understand. #submit(String, String, String) and #submit2(String, String, String) may need to call this method to get the human-understood string.

Methods inherited from class org.safs.staf.AbstractSTAFHelperCompatible

getCompatibleSTAF, setSTAFHelper

Methods inherited from class java.lang.Object

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

Constructor Detail

STAFHelperCompatible3

public STAFHelperCompatible3()

Method Detail

getUnMarshallResult

public static com.ibm.staf.STAFMarshallingContext getUnMarshallResult(java.lang.String result)

From STAF3.3, the result returned from submit will be marshaled String.
We need to un-marshal it to get the structure for human to understand.
The returned structure STAFMarshallingContext need to be parsed. Click the link to see how to parse it.

Parameters:

result -

Returns:

STAFMarshallingContext, if result can't be un-marshaled, null is returned.

See Also:

#submit(String, String, String)

getUnMarshallStringResult

public static java.lang.String getUnMarshallStringResult(java.lang.String result)

From STAF3.3, the result returned from submit will be marshalled String.
We need to un-marshal it to get the string for humain to understand.
#submit(String, String, String) and #submit2(String, String, String) may
need to call this method to get the human-understood string.

Parameters:

result -

Returns:

See Also:

#submit(String, String, String)

getServiceEvents

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

Description copied from interface: STAFHelperCompatibleInterface

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

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

public 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