org.rhq.core.pluginapi.availability

Interface AvailabilityContext

public interface AvailabilityContext

Resource specific context through which to make availability related calls back into the plugin container.

Author:

Jay Shaughnessy

Method Summary

Methods

Modifier and Type	Method and Description
AvailabilityCollectorRunnable	createAvailabilityCollectorRunnable(AvailabilityFacet availChecker, long interval) Deprecated. this is no longer useful - all resources' avail checks are async since 4.10
void	disable() This method allows the component to request the server set the resource DISABLED in the same way that a user can set a resource DISABLED.
void	enable() This method allows the component to request the server set the resource ENABLED in the same way that a user can set a resource ENABLED.
org.rhq.core.domain.measurement.AvailabilityType	getLastReportedAvailability() This method will return the last reported AvailabilityType, which can be null if not yet reported.
void	requestAvailabilityCheck() The plugin container (PC) checks resource availability based on the collection interval on the {code}AvailabilityType{code} metric.

Method Detail

createAvailabilityCollectorRunnable

@Deprecated
AvailabilityCollectorRunnable createAvailabilityCollectorRunnable(AvailabilityFacet availChecker,
                                                                           long interval)

Deprecated. this is no longer useful - all resources' avail checks are async since 4.10

requestAvailabilityCheck

void requestAvailabilityCheck()

The plugin container (PC) checks resource availability based on the collection interval on the {code}AvailabilityType{code} metric. At times the plugin may want the PC to request an availability check be done prior to the next scheduled check time. For example, Start/Stop/Restart operation implementations may want to request that the PC check availability sooner rather than later, to pick up the new lifecycle state. This method should be used sparingly, and should not in general override the scheduled avail checks.

getLastReportedAvailability

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

This method will return the last reported AvailabilityType, which can be null if not yet reported. This method *does not* invoke a call to {link AvailabilityFacet.getAvailability(), raher it will return the result of the most recent call to that method, made by the plugin container.

Returns:

the last reported availability type, or null if not yet reported.

disable

void disable()

This method allows the component to request the server set the resource DISABLED in the same way that a user can set a resource DISABLED. This should be used with care by component code as it will mean that alerting and availability reporting will essentionally be ignored for the resource until it is again enabled. A user is free to enable a resource disabled by the component code. If the resource is already disabled then the call has no effect.

See Also:

#enable()}

enable

void enable()

This method allows the component to request the server set the resource ENABLED in the same way that a user can set a resource ENABLED. This should be used with care by component code as it does not care how the resource was DISABLED. It can override a user action. If the resource is already disabled then the call has no effect.

See Also:

#disable()}