Package org.opennms.core.ipc.grpc.client
Class GrpcHealthCheck
- java.lang.Object
-
- org.opennms.core.ipc.grpc.client.GrpcHealthCheck
-
- All Implemented Interfaces:
HealthCheck
public class GrpcHealthCheck extends java.lang.Object implements HealthCheck
-
-
Constructor Summary
Constructors Constructor Description GrpcHealthCheck(MinionGrpcClient minionGrpcClient)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.String
getDescription()
The description of theHealthCheck
, 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.
-
-
-
Constructor Detail
-
GrpcHealthCheck
public GrpcHealthCheck(MinionGrpcClient minionGrpcClient)
-
-
Method Detail
-
getDescription
public java.lang.String getDescription()
Description copied from interface:HealthCheck
The description of theHealthCheck
, e.g. "Connecting to OpenNMS ReST API". This is used when visualizing the progress or result of the checks.- Specified by:
getDescription
in interfaceHealthCheck
- Returns:
- The string, describing the check.
-
getTags
public java.util.List<java.lang.String> getTags()
Description copied from interface:HealthCheck
A tag to indicate the category of the health-check.- Specified by:
getTags
in interfaceHealthCheck
- Returns:
- The HealthTag type, describing category of the health-check.
-
perform
public Response perform(Context context) throws java.lang.Exception
Description copied from interface:HealthCheck
Implements the check itself, e.g. Connecting to a HTTP Endpoint. As the method is called by theHealthCheckService
, it is advised that all timeout restrictions etc are handled by the service instead of theHealthCheck
implementation. Implementations might throw an Exception, which should be handled by theHealthCheckService
as well. The response indicates if the check was successful, or encountered other problems. If null is returned, theHealthCheckService
should consider this asStatus.Unknown
.- Specified by:
perform
in interfaceHealthCheck
- Returns:
- The response indicating the Success/Failure/Timeout/etc of the check
- Throws:
java.lang.Exception
- In case of an error- See Also:
HealthCheckService
-
-