com.esf.core.system.monitor.service
Interface ISystemMonitorService

public interface ISystemMonitorService

The System Monitoring Service provides tools for the management of system level services. This interface will provide a Critical Service Check-in (Watchdog) that monitors critical service bundles at runtime, an API for LED management, and aggregation of error/warning/notify messages that are sent to a back-end.

Field Summary

static java.lang.String

SERVICE_NAME Reports the class name representing this interface.

Method Summary

void	forceReboot() This method stops the updates to the hardware watchdog, forcing a reboot.
boolean	isRegistered(java.lang.String serviceName) Returns true if the specified service has been registered, false otherwise.
void	registerCriticalService(java.lang.String serviceName, int timeout) This method is used to register a critical service with the Critical Service Check-in (Watchdog).
void	unregisterCriticalService(java.lang.String serviceName) This method is used to unregister a critical service with the Critical Service Check-in (Watchdog).
void	updateCriticalService(java.lang.String serviceName) This method is used to notify the Critical Service Check-in Watchdog that a critical service has issued an update.

Field Detail

SERVICE_NAME

public static final java.lang.String SERVICE_NAME

Reports the class name representing this interface.

Method Detail

registerCriticalService

public void registerCriticalService(java.lang.String serviceName,
                                    int timeout)

This method is used to register a critical service with the Critical Service Check-in (Watchdog). Once registered, the critical service must call the updateCriticalService() method (at a frequency higher than 1/timeout) to prevent a system reboot.

Parameters:

serviceName - A String representing the name of the critical service.

timeout - A timeout value that the critical service cannot exceed between updates without generating a system reboot. The time is expressed in seconds.

unregisterCriticalService

public void unregisterCriticalService(java.lang.String serviceName)

This method is used to unregister a critical service with the Critical Service Check-in (Watchdog). Once unregistered, the critical service will no longer call the updateCriticalService() method.

Parameters:

serviceName - A String representing the name of the critical service.

updateCriticalService

public void updateCriticalService(java.lang.String serviceName)

This method is used to notify the Critical Service Check-in Watchdog that a critical service has issued an update.

Parameters:

serviceName - A String representing the name of the critical service.

forceReboot

public void forceReboot()

This method stops the updates to the hardware watchdog, forcing a reboot.

isRegistered

public boolean isRegistered(java.lang.String serviceName)

Returns true if the specified service has been registered, false otherwise.