org.opennms.distributed.core.impl

Class RestConnectionHealthCheck

java.lang.Object

org.opennms.distributed.core.impl.RestConnectionHealthCheck

All Implemented Interfaces:

HealthCheck

public class RestConnectionHealthCheck
extends Object
implements HealthCheck

Verifies the connection to the OpenNMS ReST API.

Author:

mvrueden

Constructor Summary

Constructors

Constructor and Description
RestConnectionHealthCheck(RestClient restClient)

Method Summary

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.

Methods inherited from class java.lang.Object

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

Constructor Detail

RestConnectionHealthCheck

public RestConnectionHealthCheck(RestClient restClient)

Method Detail

perform

public Response perform(Context context)
                 throws Exception

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

Throws:

Exception - In case of an error

See Also:

HealthCheckService

getDescription

public 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.