com.hp.sdn.adm.app

Interface HealthService

public interface HealthService

A service for monitoring health from various HealthMonitorable's.

Author:

Liem Nguyen

Method Summary

Methods

Modifier and Type	Method and Description
void	addHealthListener(HealthListener listener) Add a health listener.
void	addHealthMonitor(HealthMonitorable monitor) Add a new HealthMonitorable.
void	addHealthMonitorableListener(HealthMonitorableListener listener) Add a health monitorable listener.
Health	fetchImmediateHealth(String monitorId) Immediately interrogate the health monitorable for the given monitorid to retrieve the health at this time.
Health	getHealth(String id) Retrieve the last-known health reported by the HealthMonitorable with the given id.
boolean	hasHealthListener(HealthListener listener) Check to see if the given HealthListener has been registered with the HealthService yet.
boolean	hasHealthMonitor(String monitorId) Check to see if the HealthMonitorable with the given id has been registered already.
Map<String,Health>	listHealth() Retrieve all the last-known health reported.
void	removeHealthListener(HealthListener listener) Remove a health listener.
void	removeHealthMonitor(String monitorId) Remove a HealthMonitorable.
void	removeHealthMonitorableListener(HealthMonitorableListener listener) Remove a listener for health monitorable events.
void	updateHealth(String monitorId, Health health) Inject a Health status.

Method Detail

hasHealthMonitor

boolean hasHealthMonitor(String monitorId)

Check to see if the HealthMonitorable with the given id has been registered already.

Parameters:

monitorId - id of monitor to check

Returns:

true if exists, false otherwise

addHealthMonitor

void addHealthMonitor(HealthMonitorable monitor)

Add a new HealthMonitorable. It is the responsibility of the client to removeHealthMonitor(String) for any HealthMonitorable it registers with the HealthService upon its departure.

Parameters:

monitor - HealthMonitorable

removeHealthMonitor

void removeHealthMonitor(String monitorId)

Remove a HealthMonitorable.

Parameters:

monitorId - id of the HealthMonitorable to remove

updateHealth

void updateHealth(String monitorId,
                Health health)

Inject a Health status. This is pro-active health reporting in addition to health monitoring. If there is no HealthMonitor by the given id, this call is a NO-OP.

Parameters:

monitorId - id of the HealthMonitorable

health - health

getHealth

Health getHealth(String id)
                 throws NotFoundException

Retrieve the last-known health reported by the HealthMonitorable with the given id.

Parameters:

id - id of HealthMonitorable

Returns:

Health reported

Throws:

NotFoundException - if the given id is not found

fetchImmediateHealth

Health fetchImmediateHealth(String monitorId)

Immediately interrogate the health monitorable for the given monitorid to retrieve the health at this time. This call makes a direct request for the current health directly from the health monitorable. This request to contact and extract the current health for the health monitorable is executed using the caller's thread.

Note: This call will not update the last-known health value for this health monitorable so the value obtained by the getHealth(String) may be different. Normal operation is to use the getHealth(String) method.

Parameters:

monitorId - THe ID of the monitorable to get health for.

Returns:

The health object returned by the monitorable.

Throws:

NotFoundException - if there is no health monitorable registered with the given id

listHealth

Map<String,Health> listHealth()

Retrieve all the last-known health reported.

Returns:

Map of all health reported, keyed by the id's of HealthMonitorable's

hasHealthListener

boolean hasHealthListener(HealthListener listener)

Check to see if the given HealthListener has been registered with the HealthService yet.

Parameters:

listener - HealthListener

Returns:

true if it has been registered, false otherwise

addHealthListener

void addHealthListener(HealthListener listener)

Add a health listener. The listener will be notified when there is a health change. It is the responsibility of the client to call removeHealthListener(HealthListener) with the HealthService upon its departure.

Parameters:

listener - listener to be added

removeHealthListener

void removeHealthListener(HealthListener listener)

Remove a health listener.

Parameters:

listener - listener to be removed

addHealthMonitorableListener

void addHealthMonitorableListener(HealthMonitorableListener listener)

Add a health monitorable listener. The listener will be informed when there is a change in the set of contributors of health information. It is the responsibility of the client to call removeHealthMonitorableListener(HealthMonitorableListener) with the HealthService upon its departure.

Parameters:

listener - listener to be added

removeHealthMonitorableListener

void removeHealthMonitorableListener(HealthMonitorableListener listener)

Remove a listener for health monitorable events.

Parameters:

listener - listener to be removed