net.bluemind.metrics.alerts.api

Interface IProductChecks

All Known Implementing Classes:

ProductChecksService

@Path(value="/check")
public interface IProductChecks

This API provides "status oriented" (ok, warn, failed) monitoring results. Single checks can be re-executed thanks to check(String) and the last result can be retrieved with lastResult(String).

Method Summary

Modifier and Type	Method and Description
java.util.Set<java.lang.String>	availableChecks() Returns the list of executed check names.
TaskRef	check(java.lang.String checkName) Starts asynchronously a product check with the given name.
CheckResult	lastResult(java.lang.String checkName) Returns the result of the last execution of a given check

Method Detail

availableChecks

@GET
java.util.Set<java.lang.String> availableChecks()

Returns the list of executed check names.

Returns:

check names with available results

lastResult

@GET
 @Path(value="{checkName}")
CheckResult lastResult(@PathParam(value="checkName")
                                                        java.lang.String checkName)

Returns the result of the last execution of a given check

Parameters:

checkName -

Returns:

a result or null if the check was never executed

check

@POST
 @Path(value="{checkName}")
TaskRef check(@PathParam(value="checkName")
                                                java.lang.String checkName)

Starts asynchronously a product check with the given name.

Parameters:

checkName - the name of the product check to start

Returns:

a TaskRef suitable for tracking the progress of the check.