org.safs.tools.status

Class SAFSSTATUS

java.lang.Object

org.safs.tools.status.SAFSSTATUS

All Implemented Interfaces:

ConfigurableToolsInterface, GenericToolsInterface, StatusMonitorInterface

public class SAFSSTATUS
extends java.lang.Object
implements ConfigurableToolsInterface, StatusMonitorInterface

Field Summary

Fields

Modifier and Type	Field and Description
protected CountersInterface	counters
protected VarsInterface	vars

Constructor Summary

Constructors

Constructor and Description
SAFSSTATUS() Constructor for SAFSSTATUS

Method Summary

Modifier and Type	Method and Description
CoreInterface	getCoreInterface() Retrieve the instance of the CoreInterface used to communicate with the framework.
StatusInfoInterface	getStatusInfo(java.lang.String testLevel) Get the current status info for the specified test level.
boolean	isToolRunning() TRUE if the underlying tool is running.
void	launchInterface(java.lang.Object configInfo) Expects a DriverInterface for initialization.
void	reset() Reset or clear any cached information in the underlying tool or service.
void	setStatusInfo(java.lang.String testLevel, StatusInfoInterface statusInfo) Set/Overwrite the current status info for the specified test level.
void	shutdown() Shutdown the underlying tool or service.

Methods inherited from class java.lang.Object

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

Field Detail

counters

protected CountersInterface counters

vars

protected VarsInterface vars

Constructor Detail

SAFSSTATUS

public SAFSSTATUS()

Constructor for SAFSSTATUS

Method Detail

launchInterface

public void launchInterface(java.lang.Object configInfo)

Expects a DriverInterface for initialization.

Specified by:

launchInterface in interface ConfigurableToolsInterface

Parameters:

configInfo - can be whatever the final implementation needs it to be. This might be a String with configuration information, the name of a class, or an instance of some object used to provide configuration assets.

See Also:

ConfigurableToolsInterface.launchInterface(Object)

isToolRunning

public boolean isToolRunning()

TRUE if the underlying tool is running. Typically called AFTER initialization attempts have been made.

Specified by:

isToolRunning in interface GenericToolsInterface

reset

public void reset()

Description copied from interface: GenericToolsInterface

Reset or clear any cached information in the underlying tool or service. The implementation should be able to recognize if the underlying tool or service is not actually running. If the tool is not running, then this should exit gracefully without adversely affecting anything.

Specified by:

reset in interface GenericToolsInterface

See Also:

GenericToolsInterface#reset()

shutdown

public void shutdown()

Description copied from interface: GenericToolsInterface

Shutdown the underlying tool or service. The implementation should be able to recognize if the underlying tool or service is not actually running. If the tool is not running, then this should exit gracefully without adversely affecting anything.

Specified by:

shutdown in interface GenericToolsInterface

See Also:

GenericToolsInterface#shutdown()

getCoreInterface

public CoreInterface getCoreInterface()
                               throws java.lang.IllegalStateException

Description copied from interface: GenericToolsInterface

Retrieve the instance of the CoreInterface used to communicate with the framework.

Specified by:

getCoreInterface in interface GenericToolsInterface

Returns:

CoreInterface instance.

Throws:

java.lang.IllegalStateException - ALWAYS since there is no CoreInterface in this class.

See Also:

GenericToolsInterface#getCoreInterface()

getStatusInfo

public StatusInfoInterface getStatusInfo(java.lang.String testLevel)

Description copied from interface: StatusMonitorInterface

Get the current status info for the specified test level.

Specified by:

getStatusInfo in interface StatusMonitorInterface

See Also:

StatusMonitorInterface.getStatusInfo(String)

setStatusInfo

public void setStatusInfo(java.lang.String testLevel,
                          StatusInfoInterface statusInfo)

Description copied from interface: StatusMonitorInterface

Set/Overwrite the current status info for the specified test level.

Specified by:

setStatusInfo in interface StatusMonitorInterface

See Also:

StatusMonitorInterface.setStatusInfo(String, StatusInfoInterface)