Package dev.voidframework.healthcheck

Class HealthCheckManager

java.lang.Object

dev.voidframework.healthcheck.HealthCheckManager

public final class HealthCheckManager
extends Object

Health check manager takes care of executing the various hooks defined by the use of the HealthChecker annotation.

Since:

1.0.0

Constructor Summary

Constructors

Constructor	Description
HealthCheckManager()	Build a new instance.

Method Summary

Modifier and Type	Method	Description
Map<String,Health>	checkHealth()	Checks the health status of the various components being monitored.
void	registerHealthCheck(Class<? extends HealthChecker> healthCheckerClassType)	Registers a new health checker.
void	setInjector(com.google.inject.Injector injector)	Sets the injector to use.

Methods inherited from class java.lang.Object

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

Constructor Details

HealthCheckManager

public HealthCheckManager()

Build a new instance.

Since:

1.0.0

Method Details

setInjector

@Inject
public void setInjector(com.google.inject.Injector injector)

Sets the injector to use.

Parameters:

injector - The injector instance

Since:

1.1.0

registerHealthCheck

public void registerHealthCheck(Class<? extends HealthChecker> healthCheckerClassType)

Registers a new health checker.

Parameters:

healthCheckerClassType - The health checker to register

Since:

1.0.0

checkHealth

public Map<String,Health> checkHealth()

Checks the health status of the various components being monitored.

Returns:

The health status report

Since:

1.0.0