Class HealthResultFilter

java.lang.Object

io.micronaut.management.endpoint.health.filter.HealthResultFilter

@ServerFilter(value={"/?${endpoints.all.path:/}/?${endpoints.health.id:health}","/?${endpoints.all.path:/}/?${endpoints.health.id:health}/?liveness","/?${endpoints.all.path:/}/?${endpoints.health.id:health}/?readiness"},
              patternStyle=REGEX)
@Requires(beans=HealthEndpoint.class)
@Internal
public class HealthResultFilter
extends Object

A filter that matches the HealthEndpoint and returns an appropriate HTTP status code.

Since:

1.0

Author:

graemerocher

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_MAPPING	Configurable default mapping for filter.
static final String	LIVENESS_PROBE_MAPPING
static final String	READINESS_PROBE_MAPPING

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	HealthResultFilter(HealthEndpoint healthEndpoint)	Default constructor.

Method Summary

Modifier and Type	Method	Description
void	doFilter(MutableHttpResponse<?> response)	Set response status by health result.

Methods inherited from class Object

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

Field Details

DEFAULT_MAPPING

public static final String DEFAULT_MAPPING

Configurable default mapping for filter.

See Also:

• Constant Field Values

LIVENESS_PROBE_MAPPING

public static final String LIVENESS_PROBE_MAPPING

See Also:

• Constant Field Values

READINESS_PROBE_MAPPING

public static final String READINESS_PROBE_MAPPING

See Also:

• Constant Field Values

Constructor Details

HealthResultFilter

protected HealthResultFilter(HealthEndpoint healthEndpoint)

Default constructor.

Parameters:

healthEndpoint - The health endpoint

Method Details

doFilter

@ResponseFilter
public void doFilter(MutableHttpResponse<?> response)

Set response status by health result.

Parameters:

response - http response