Package io.dropwizard.health.response

Interface HealthResponderFactory

All Superinterfaces:

Discoverable

All Known Implementing Classes:

ServletHealthResponderFactory

public interface HealthResponderFactory
extends Discoverable

A factory for configuring a responder used for responding to health check requests.

See Also:

• ServletHealthResponderFactory

Method Summary

Modifier and Type	Method	Description
void	configure(String name, Collection<String> healthCheckUrlPaths, HealthResponseProvider healthResponseProvider, HealthEnvironment health, JerseyEnvironment jersey, ServletEnvironment servlets, com.fasterxml.jackson.databind.ObjectMapper mapper)	Configures a health responder for responding to health check requests (e.g. from load balancer).

Method Details

configure

void configure(String name,
 Collection<String> healthCheckUrlPaths,
 HealthResponseProvider healthResponseProvider,
 HealthEnvironment health,
 JerseyEnvironment jersey,
 ServletEnvironment servlets,
 com.fasterxml.jackson.databind.ObjectMapper mapper)

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

Parameters:

name - The name of the application.

healthCheckUrlPaths - The paths to expose a health check on.

healthResponseProvider - A provider of responses to respond to requests with.

health - The health environment.

jersey - The Jersey environment.

servlets - The servlet environment.

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