public interface HealthCheck
HealthCheck
.Health, {@link HealthCheckService}
Modifier and Type | Method and Description |
---|---|
String |
getDescription()
The description of the
HealthCheck , e.g. |
Response |
perform(Context context)
Implements the check itself, e.g.
|
String getDescription()
HealthCheck
, e.g. "Connecting to OpenNMS ReST API".
This is used when visualizing the progress or result of the checks.Response perform(Context context) throws Exception
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
.context
- Exception
- In case of an errorHealthCheckService
Copyright © 2020. All rights reserved.