org.safs.tools

Interface CoreInterface

All Superinterfaces:

RuntimeDataInterface

All Known Implementing Classes:

EmbeddedHookSTAFHelper, SingletonSTAFHelper, STAFHelper

public interface CoreInterface
extends RuntimeDataInterface

Author:

Carl Nagle

Method Summary

Modifier and Type	Method and Description
java.util.Collection	getAppMapNames()
java.lang.String	getLogName()
java.lang.String	getMachine()
java.lang.String	getProcessName()
void	getSAFSTestRecordData(java.lang.String hookid, TestRecordData data)
boolean	isInitialized()
boolean	isSAFSINPUTAvailable()
boolean	isSAFSLOGSAvailable()
boolean	isSAFSMAPSAvailable()
boolean	isSAFSVARSAvailable()
boolean	isServiceAvailable(java.lang.String servicename)
boolean	isToolAvailable(java.lang.String toolname) Queries the Core communications protocol to see if a particular process name is currently registered and running.
void	setSAFSTestRecordData(java.lang.String hookid, TestRecordData data)

Methods inherited from interface org.safs.tools.RuntimeDataInterface

getAppMapItem, getVariable, setVariable

Method Detail

getLogName

java.lang.String getLogName()
                     throws SAFSException

Throws:

SAFSException

getMachine

java.lang.String getMachine()

getProcessName

java.lang.String getProcessName()

getAppMapNames

java.util.Collection getAppMapNames()
                             throws SAFSException

Throws:

SAFSException

getSAFSTestRecordData

void getSAFSTestRecordData(java.lang.String hookid,
                           TestRecordData data)
                    throws SAFSException

Throws:

SAFSException

setSAFSTestRecordData

void setSAFSTestRecordData(java.lang.String hookid,
                           TestRecordData data)
                    throws SAFSException

Throws:

SAFSException

isInitialized

boolean isInitialized()

isSAFSINPUTAvailable

boolean isSAFSINPUTAvailable()

isSAFSLOGSAvailable

boolean isSAFSLOGSAvailable()

isSAFSVARSAvailable

boolean isSAFSVARSAvailable()

isSAFSMAPSAvailable

boolean isSAFSMAPSAvailable()

isServiceAvailable

boolean isServiceAvailable(java.lang.String servicename)

isToolAvailable

boolean isToolAvailable(java.lang.String toolname)

Queries the Core communications protocol to see if a particular process name is currently registered and running.

For example, the SAFSVARS service process name is "SAFSVariableService".

For the STAF implementation of the core protocol: the routine will do a QUERY ALL on the HANDLE service and then evaluate if the requested tool appears anywhere in the returned list of named processes.

Future core services might be something alternative to STAF.

Note, because we do a substring search, we can match on just the most significant portion of the process name.

Parameters:

toolname - -- The name of the process of interest. Check your documentation to find the name normally registered by the tool of interest. This can be just a substring of the full tool name. It is NOT to be case-sensitive.

Returns:

true or false

Since:

Apr 1, 2014
History:

Apr 01, 2014 (Carl Nagle) Original Release