org.sdase.commons.server.healthcheck.helper

Class ExternalServiceHealthCheck

java.lang.Object

com.codahale.metrics.health.HealthCheck

org.sdase.commons.server.healthcheck.helper.ExternalServiceHealthCheck

@ExternalHealthCheck
public class ExternalServiceHealthCheck
extends com.codahale.metrics.health.HealthCheck

Default health check for checking if an external URL returns status code 2xx when invoking a simple HTTP GET

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
ExternalServiceHealthCheck(java.lang.String url, int timeoutMillis)
ExternalServiceHealthCheck(java.lang.String url, int timeoutMillis, OpenConnectionFunction openConnection)
ExternalServiceHealthCheck(java.lang.String requestMethod, java.lang.String url, int timeoutMillis)
ExternalServiceHealthCheck(java.lang.String requestMethod, java.lang.String url, int timeoutMillis, OpenConnectionFunction openConnection)

Method Summary

Modifier and Type	Method and Description
com.codahale.metrics.health.HealthCheck.Result	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

ExternalServiceHealthCheck

public ExternalServiceHealthCheck(java.lang.String url,
                                  int timeoutMillis)

Parameters:

url - the URL that is requested using GET

timeoutMillis - the timeout for establishing the connection and waiting for data

ExternalServiceHealthCheck

public ExternalServiceHealthCheck(java.lang.String requestMethod,
                                  java.lang.String url,
                                  int timeoutMillis)

Parameters:

requestMethod - the method to use for the check request, GET and HEAD are allowed values

url - the URL that is requested using GET

timeoutMillis - the timeout for establishing the connection and waiting for data

ExternalServiceHealthCheck

public ExternalServiceHealthCheck(java.lang.String url,
                                  int timeoutMillis,
                                  OpenConnectionFunction openConnection)

Parameters:

url - the URL that is requested using GET

timeoutMillis - the timeout for establishing the connection and waiting for data

openConnection - provider of the HttpURLConnection

ExternalServiceHealthCheck

public ExternalServiceHealthCheck(java.lang.String requestMethod,
                                  java.lang.String url,
                                  int timeoutMillis,
                                  OpenConnectionFunction openConnection)

Parameters:

requestMethod - the method to use for the check request, GET and HEAD are allowed values

url - the URL that is requested using GET

timeoutMillis - the timeout for establishing the connection and waiting for data

openConnection - provider of the HttpURLConnection

Method Detail

check

public com.codahale.metrics.health.HealthCheck.Result check()
                                                     throws java.lang.Exception

Specified by:

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

Throws:

java.lang.Exception