Package org.opennms.netmgt.dnsresolver.netty

Class NettyDnsHealthCheck

java.lang.Object

org.opennms.netmgt.dnsresolver.netty.NettyDnsHealthCheck

All Implemented Interfaces:

HealthCheck

public class NettyDnsHealthCheck
extends java.lang.Object
implements HealthCheck

Constructor Summary

Constructors

Constructor	Description
NettyDnsHealthCheck(NettyDnsResolver dnsResolver)

Method Summary

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

NettyDnsHealthCheck

public NettyDnsHealthCheck(NettyDnsResolver dnsResolver)

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)
                 throws java.lang.InterruptedException,
                        java.util.concurrent.ExecutionException,
                        java.util.concurrent.TimeoutException

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:

java.lang.InterruptedException

java.util.concurrent.ExecutionException

java.util.concurrent.TimeoutException

See Also:

HealthCheckService