Package lumis.portal.healthmonitor

Interface IHealthMonitorManager

All Known Implementing Classes:

HealthMonitorManager

public interface IHealthMonitorManager

Service provider interface for the health monitor framework manager.

Since:

10.1.0

Version:

$Revision: 19963 $ $Date: 2017-02-21 19:28:29 -0300 (Tue, 21 Feb 2017) $

Method Summary

Modifier and Type	Method	Description
java.util.List<HealthCheckInfo>	getHealthChecks()	Returns a list of all available health checks.
java.util.Map<java.lang.String,java.util.Map<java.lang.String,HealthCheckResult>>	runCompleteHealthCheck(HttpServletRequest request)	Executes all health checks
HealthCheckResult	runHealthCheck(java.lang.String className, java.lang.String methodName, HttpServletRequest request)	Executes a single health check for the given class and method.
java.util.Map<java.lang.String,HealthCheckResult>	runHealthCheck(java.lang.String className, HttpServletRequest request)	Executes all health checks available in a class.

Method Detail

getHealthChecks

java.util.List<HealthCheckInfo> getHealthChecks()
                                         throws java.lang.Exception

Returns a list of all available health checks.

Returns:

a list of health checks.

Throws:

java.lang.Exception

Since:

10.1.0

runCompleteHealthCheck

java.util.Map<java.lang.String,java.util.Map<java.lang.String,HealthCheckResult>> runCompleteHealthCheck(HttpServletRequest request)
                                                                                                              throws java.lang.Exception

Executes all health checks

Returns:

a map of results grouped by class name

Throws:

java.lang.Exception

Since:

10.1.0

runHealthCheck

java.util.Map<java.lang.String,HealthCheckResult> runHealthCheck(java.lang.String className,
                                                                       HttpServletRequest request)
                                                                throws java.lang.Exception

Executes all health checks available in a class.

Parameters:

className - the class to execute

Returns:

a list of results for each method with the HealthCheck annotation

Throws:

java.lang.Exception

Since:

10.1.0

runHealthCheck

HealthCheckResult runHealthCheck(java.lang.String className,
                                 java.lang.String methodName,
                                 HttpServletRequest request)
                          throws java.lang.Exception

Executes a single health check for the given class and method.

Parameters:

className - the name of the class for which the check should be run

methodName - the name of the method for which the check should be run

request - a http request for which some check can use to

Returns:

the check result

Throws:

java.lang.Exception

Since:

10.1.0