io.dropwizard.health.response

Interface HealthResponseProviderFactory

All Superinterfaces:

Discoverable

All Known Implementing Classes:

JsonHealthResponseProviderFactory

public interface HealthResponseProviderFactory
extends Discoverable

A factory for building an HealthResponseProvider instance used to provide responses to health check requests.

See Also:

JsonHealthResponseProviderFactory

Method Summary

Modifier and Type	Method and Description
HealthResponseProvider	build(HealthStatusChecker healthStatusChecker, HealthStateAggregator healthStateAggregator, com.fasterxml.jackson.databind.ObjectMapper mapper) Configures a health responder for responding to health check requests (e.g.

Method Detail

build

HealthResponseProvider build(HealthStatusChecker healthStatusChecker,
                             HealthStateAggregator healthStateAggregator,
                             com.fasterxml.jackson.databind.ObjectMapper mapper)

Configures a health responder for responding to health check requests (e.g. from load balancer).

Parameters:

healthStatusChecker - an interface that exposes the ability to check current status of health.

healthStateAggregator - an interface that exposes the ability to check an aggregate view of all health states.

mapper - A Jackson object mapper to allow writing JSON responses (if needed).