io.micronaut.management.endpoint.health.filter

Class HealthResultFilter

java.lang.Object

io.micronaut.http.filter.OncePerRequestHttpServerFilter

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

All Implemented Interfaces:

Ordered, HttpFilter, HttpServerFilter

@Filter(value={"${endpoints.all.path:/}${endpoints.health.id:health}","${endpoints.all.path:/}${endpoints.health.id:health}/liveness","${endpoints.all.path:/}${endpoints.health.id:health}/readiness"})
 @Requires(beans=HealthEndpoint.class)
public class HealthResultFilter
extends OncePerRequestHttpServerFilter

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 and Description
static String	DEFAULT_MAPPING Configurable default mapping for filter.
static String	LIVENESS_PROBE_MAPPING
static String	READINESS_PROBE_MAPPING

Fields inherited from interface io.micronaut.core.order.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
protected Publisher<MutableHttpResponse<?>>	doFilterOnce(HttpRequest<?> request, ServerFilterChain chain)

Methods inherited from class io.micronaut.http.filter.OncePerRequestHttpServerFilter

doFilter, getKey

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.micronaut.http.filter.HttpServerFilter

doFilter

Methods inherited from interface io.micronaut.core.order.Ordered

getOrder

Field Detail

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 Detail

HealthResultFilter

protected HealthResultFilter(HealthEndpoint healthEndpoint)

Default constructor.

Parameters:

healthEndpoint - The health endpoint

Method Detail

doFilterOnce

protected Publisher<MutableHttpResponse<?>> doFilterOnce(HttpRequest<?> request,
                                                         ServerFilterChain chain)

Specified by:

doFilterOnce in class OncePerRequestHttpServerFilter

Parameters:

request - The HttpRequest instance

chain - The ServerFilterChain instance

Returns:

A Publisher for the Http response