ElasticHealthCheck (OpenNMS 28.0.0 API)

java.lang.Object
- org.opennms.features.jest.client.ElasticHealthCheck

All Implemented Interfaces:

HealthCheck

Direct Known Subclasses:

RequireConfigurationElasticHealthCheck
```
public class ElasticHealthCheck
extends java.lang.Object
implements HealthCheck
```
Verifies the connection to ElasticSearch. The health check may be located in an odd place for now. The reason for this is, that multiple Modules create their own clients. In order to not configure the client for the health check module as well, this HealthCheck is only validating if the connection to ElasticSearch from the view of the flows/elastic bundle is working.

Author:

mvrueden

Constructor Summary

Constructors
Constructor Description

ElasticHealthCheck(io.searchbox.client.JestClient jestClient, java.lang.String featureName)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`java.lang.String`	`getDescription()`	The description of the `HealthCheck`, e.g.
`Response`	`perform(Context context)`	Implements the check itself, e.g.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ElasticHealthCheck
```
public ElasticHealthCheck(io.searchbox.client.JestClient jestClient,
                          java.lang.String featureName)
```
- Method Detail
  - getDescription
```
public java.lang.String getDescription()
```
    Description copied from interface: HealthCheck
    
    The description of the HealthCheck, e.g. "Connecting to OpenNMS ReST API". This is used when visualizing the progress or result of the checks.
    
    Specified by:
    
    getDescription in interface HealthCheck
    
    Returns:
    
    The string, describing the check.
  - perform
```
public Response perform(Context context)
```
    Description copied from interface: HealthCheck
    
    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.
    
    Specified by:
    
    perform in interface HealthCheck
    
    Returns:
    
    The response indicating the Success/Failure/Timeout/etc of the check
    
    See Also:
    
    HealthCheckService