Package io.vertigo.core.analytics.health.definitions

Class HealthCheckDefinition

java.lang.Object

io.vertigo.core.node.definition.AbstractDefinition

io.vertigo.core.analytics.health.definitions.HealthCheckDefinition

All Implemented Interfaces:

Definition

public final class HealthCheckDefinition
extends AbstractDefinition

This defines a health check with - a definition name - a health check name - a checker - a way to test that provides a HealthMeasure

Author:

mlaroche, pchretien

Field Summary

Fields

Modifier and Type	Field	Description
static String	PREFIX

Fields inherited from interface io.vertigo.core.node.definition.Definition

REGEX_DEFINITION_NAME

Constructor Summary

Constructors

Constructor	Description
HealthCheckDefinition(String name, String healthCheckName, String checker, String module, String feature, Supplier<HealthMeasure> checkMethod)	Constructor

Method Summary

Modifier and Type	Method	Description
String	getChecker()
Supplier<HealthMeasure>	getCheckMethod()
String	getFeature()
String	getHealthCheckName()
String	getModule()

Methods inherited from class io.vertigo.core.node.definition.AbstractDefinition

getLocalName, getName, toString

Methods inherited from class java.lang.Object

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

Field Detail

PREFIX

public static final String PREFIX

See Also:

Constant Field Values

Constructor Detail

HealthCheckDefinition

public HealthCheckDefinition(String name,
                             String healthCheckName,
                             String checker,
                             String module,
                             String feature,
                             Supplier<HealthMeasure> checkMethod)

Constructor

Parameters:

name - the definition name (must be unique)

healthCheckName - the name of the health check (must be unique)

checker - the name of the component that is responsible of providing the measure

checkMethod - the check method that provides a health measure

Method Detail

getHealthCheckName

public String getHealthCheckName()

Returns:

the health check name;

getChecker

public String getChecker()

Returns:

the name of the health checker

getModule

public String getModule()

getFeature

public String getFeature()

getCheckMethod

public Supplier<HealthMeasure> getCheckMethod()

Returns:

the check method that provides a health measure