io.dropwizard.health.response

Class DefaultHealthServletFactory

java.lang.Object

io.dropwizard.health.response.DefaultHealthServletFactory

All Implemented Interfaces:

HealthServletFactory, Discoverable

public class DefaultHealthServletFactory
extends Object
implements HealthServletFactory

The default implementation of HealthServletFactory, which allows for configuration of the response.

Constructor Summary

Constructors

Constructor and Description
DefaultHealthServletFactory()

Method Summary

Modifier and Type	Method and Description
javax.servlet.http.HttpServlet	build(HealthStatusChecker healthStatusChecker) Build a servlet for responding to health check requests (e.g.
String	getCacheControlValue()
String	getContentType()
String	getHealthyValue()
String	getUnhealthyValue()
boolean	isCacheControlEnabled()
void	setCacheControlEnabled(boolean cacheControlEnabled)
void	setCacheControlValue(String cacheControlValue)
void	setContentType(String contentType)
void	setHealthyValue(String healthyValue)
void	setUnhealthyValue(String unhealthyValue)

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultHealthServletFactory

public DefaultHealthServletFactory()

Method Detail

isCacheControlEnabled

public boolean isCacheControlEnabled()

setCacheControlEnabled

public void setCacheControlEnabled(boolean cacheControlEnabled)

getCacheControlValue

public String getCacheControlValue()

setCacheControlValue

public void setCacheControlValue(String cacheControlValue)

getContentType

public String getContentType()

setContentType

public void setContentType(String contentType)

getHealthyValue

public String getHealthyValue()

setHealthyValue

public void setHealthyValue(String healthyValue)

getUnhealthyValue

public String getUnhealthyValue()

setUnhealthyValue

public void setUnhealthyValue(String unhealthyValue)

build

public javax.servlet.http.HttpServlet build(HealthStatusChecker healthStatusChecker)

Description copied from interface: HealthServletFactory

Build a servlet for responding to health check requests (e.g. from load balancer).

Specified by:

build in interface HealthServletFactory

Parameters:

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

Returns:

a HttpServlet that responds to health check requests