Package org.opennms.core.health.impl

Class DefaultHealthCheckService

java.lang.Object

org.opennms.core.health.impl.DefaultHealthCheckService

All Implemented Interfaces:

HealthCheckService

public class DefaultHealthCheckService
extends java.lang.Object
implements HealthCheckService

The "Default" implementation of the HealthCheckService. It loads all available HealthCheckServices from the OSGi service registry. If no checks are available, the overall health is "Unhealthy".

Author:

mvrueden

Constructor Summary

Constructors

Constructor	Description
DefaultHealthCheckService(org.osgi.framework.BundleContext bundleContext)

Method Summary

Modifier and Type	Method	Description
protected java.util.List<HealthCheck>	getHealthChecks()
java.util.concurrent.CompletableFuture<Health>	performAsyncHealthCheck(Context context, java.util.function.Consumer<HealthCheck> onStartConsumer, java.util.function.Consumer<Response> onFinishConsumer)	Performs various HealthChecks asynchronously and returns a CompletableFuture which contains the Health representing each HealthChecks Response.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DefaultHealthCheckService

public DefaultHealthCheckService(org.osgi.framework.BundleContext bundleContext)

Method Detail

getHealthChecks

protected java.util.List<HealthCheck> getHealthChecks()
                                               throws org.osgi.framework.InvalidSyntaxException

Throws:

org.osgi.framework.InvalidSyntaxException

performAsyncHealthCheck

public java.util.concurrent.CompletableFuture<Health> performAsyncHealthCheck(Context context,
                                                                              java.util.function.Consumer<HealthCheck> onStartConsumer,
                                                                              java.util.function.Consumer<Response> onFinishConsumer)

Description copied from interface: HealthCheckService

Performs various HealthChecks asynchronously and returns a CompletableFuture which contains the Health representing each HealthChecks Response. It is up to the implementator to respect timeouts and handle exceptions accordingly, when these situations arise when calling HealthCheck.perform(Context). Callback methods can be provided to print information before and after a HealthCheck is invoked. When providing a onFinishConsumer please note, that this is invoked even if the HealthCheck.perform(Context) execution failed or timed out and therefore may not represent the value when calling HealthCheck.perform(Context) directly.

Specified by:

performAsyncHealthCheck in interface HealthCheckService

Parameters:

context - The context object

onStartConsumer - Callback method which is invoked before the HealthCheck.perform(Context) method is invoked. May be null.

onFinishConsumer - Callback method which is invoked after the HealthCheck.perform(Context) method is invoked. May be null.

Returns:

The CompletableFuture to retrieve the Health from.