HealthCheck (OpenNMS 28.1.1 API)

All Known Subinterfaces:

CachingHealthCheck

All Known Implementing Classes:

AdapterHealthCheck, ContainerIntegrityHealthCheck, DaoHealthCheck, DefaultPassiveHealthCheck, ElasticHealthCheck, ElasticHealthCheck, GrpcHealthCheck, JmsConnectionHealthCheck, KafkaHealthCheck, ListenerHealthCheck, NettyDnsHealthCheck, RequireConfigurationElasticHealthCheck, RestConnectionHealthCheck, SimpleHealthCheck
```
public interface HealthCheck
```
Interface to define a HealthCheck.

Author:

mvrueden

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`java.lang.String`	`getDescription()`	The description of the `HealthCheck`, e.g.
`java.util.List<java.lang.String>`	`getTags()`	A tag to indicate the category of the health-check.
`Response`	`perform(Context context)`	Implements the check itself, e.g.

- Method Detail
  - getDescription
```
java.lang.String getDescription()
```
    The description of the HealthCheck, e.g. "Connecting to OpenNMS ReST API". This is used when visualizing the progress or result of the checks.
    
    Returns:
    
    The string, describing the check.
  - getTags
```
java.util.List<java.lang.String> getTags()
```
    A tag to indicate the category of the health-check.
    
    Returns:
    
    The HealthTag type, describing category of the health-check.
  - perform
```
Response perform(Context context)
          throws java.lang.Exception
```
    Implements the check itself, e.g. Connecting to a HTTP Endpoint. As the method is called by the HealthCheckService, it is advised that all timeout restrictions etc are handled by the service instead of the HealthCheck implementation. Implementations might throw an Exception, which should be handled by the HealthCheckService as well. The response indicates if the check was successful, or encountered other problems. If null is returned, the HealthCheckService should consider this as Status.Unknown.
    
    Parameters:
    
    context -
    
    Returns:
    
    The response indicating the Success/Failure/Timeout/etc of the check
    
    Throws:
    
    java.lang.Exception - In case of an error
    
    See Also:
    
    HealthCheckService