io.dropwizard.health.check.http

Class HttpHealthCheck

java.lang.Object

com.codahale.metrics.health.HealthCheck

io.dropwizard.health.check.http.HttpHealthCheck

public class HttpHealthCheck
extends com.codahale.metrics.health.HealthCheck

Nested Class Summary

Nested classes/interfaces inherited from class com.codahale.metrics.health.HealthCheck

com.codahale.metrics.health.HealthCheck.Result, com.codahale.metrics.health.HealthCheck.ResultBuilder

Constructor Summary

Constructors

Constructor and Description
HttpHealthCheck(String url)
HttpHealthCheck(String url, javax.ws.rs.client.Client client)
HttpHealthCheck(String url, Duration readTimeout, Duration connectionTimeout)

Method Summary

Modifier and Type	Method and Description
protected com.codahale.metrics.health.HealthCheck.Result	check()
protected HttpHealthResponse	httpCheck(String url) Performs a health check via HTTP against an external dependency.
protected boolean	isHealthResponseValid(HttpHealthResponse httpHealthResponse) Validates the response from the health check.

Methods inherited from class com.codahale.metrics.health.HealthCheck

clock, execute

Methods inherited from class java.lang.Object

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

Constructor Detail

HttpHealthCheck

public HttpHealthCheck(@Nonnull
                       String url)

HttpHealthCheck

public HttpHealthCheck(@Nonnull
                       String url,
                       Duration readTimeout,
                       Duration connectionTimeout)

HttpHealthCheck

public HttpHealthCheck(@Nonnull
                       String url,
                       @Nonnull
                       javax.ws.rs.client.Client client)

Method Detail

check

protected com.codahale.metrics.health.HealthCheck.Result check()

Specified by:

check in class com.codahale.metrics.health.HealthCheck

httpCheck

protected HttpHealthResponse httpCheck(String url)

Performs a health check via HTTP against an external dependency. By default uses the Jersey 2 HTTP client, but can be overridden to allow for different behavior.

Parameters:

url - the URL to check.

Returns:

response from the health check.

isHealthResponseValid

protected boolean isHealthResponseValid(HttpHealthResponse httpHealthResponse)

Validates the response from the health check. By default checks if the response status is 2xx.

Parameters:

httpHealthResponse - The response resulting from the http health check.

Returns:

healthiness flag.