org.apache.uima.ducc.common

Interface IServiceStatistics

All Superinterfaces:

Serializable

public interface IServiceStatistics
extends Serializable

The ServiceStatics class is used to return service health, availability, and monitoring statistics to the Service Manager.

Method Summary

Modifier and Type	Method and Description
String	getInfo() Return service statistics, if any.
boolean	isAlive() Query whether the service is alive.
boolean	isHealthy() Query wether the service is "healthy".
void	setAlive(boolean alive) Set the "aliveness" of the service.
void	setHealthy(boolean healthy) Set the "health" of the service.
void	setInfo(String info) Set the monitor statistics for the service.

Method Detail

isAlive

boolean isAlive()

Query whether the service is alive. This is used internally by the Service Manager.

Returns:

"true" if the service is responsive, "false" otherwise.

isHealthy

boolean isHealthy()

Query wether the service is "healthy". This is used internally by the Service Manager.

Returns:

"true" if the service is healthy, "false" otherwise.

getInfo

String getInfo()

Return service statistics, if any. This is used internally by the Service Manager.

Returns:

A string containing information regarding the service.

setAlive

void setAlive(boolean alive)

Set the "aliveness" of the service. This is called by each pinger for each service. Set this to return "true" if the service is responsive. Otherwise return "false" so the Service Manager can reject jobs dependent on this service.

Parameters:

alive - Set to "true" if the service is responseve, "false" otherwise.

setHealthy

void setHealthy(boolean healthy)

Set the "health" of the service. This is called by each pinger for each service. This is a subject judgement made by the service owner on behalf of his own service. This is used only to reflect status in the DUCC Web Server.

Parameters:

healthy - Set to "true" if the service is healthy, "false" otherwise.

setInfo

void setInfo(String info)

Set the monitor statistics for the service. This is any arbitray string describing critical or useful characteristics of the service. This string is presented as a "hover" in the webserver over the "health" field.

Parameters:

info - This is an arbitrary string summarizing the service's performance.