org.rhq.core.pluginapi.availability

Interface AvailabilityFacet

All Known Subinterfaces:

ResourceComponent<T>

public interface AvailabilityFacet

Provides the basic availability checking for all managed resources.

Author:

John Mazzitelli

Method Summary

Methods

Modifier and Type	Method and Description
org.rhq.core.domain.measurement.AvailabilityType	getAvailability() The plugin container will occasionally call this method at the server level to see if the server is available.

Method Detail

getAvailability

org.rhq.core.domain.measurement.AvailabilityType getAvailability()

The plugin container will occasionally call this method at the server level to see if the server is available. This method is intended to attempt a remote connection to the resource. When a sever is in the down state, no child discoveries will be performed. A downed resource also shuts down access at the child level - for example, if a JBossAS instance is down, the plugin container will not try to collect availabilities or metrics on an EJB entity running inside it. Availability for all child resources would automatically be set to down in this case.

Returns:

AvailabilityType.UP if the resource is responding as expected; AvailabilityType.DOWN if it is not responding as expected; AvailabilityType.MISSING if the resource type supports this feature and the resource is physically missing. Any other return value is invalid.