io.micronaut.management.health.indicator

Class AbstractHealthIndicator<T>

java.lang.Object

io.micronaut.management.health.indicator.AbstractHealthIndicator<T>

Type Parameters:

T - The health indication type

All Implemented Interfaces:

Ordered, HealthIndicator

Direct Known Subclasses:

DiskSpaceIndicator

public abstract class AbstractHealthIndicator<T>
extends Object
implements HealthIndicator

A base health indicator class to extend from that catches exceptions thrown from the getHealthInformation() method and updates the HealthResult with the exception information.

Since:

1.0

Author:

James Kleeh

Field Summary

Fields

Modifier and Type	Field and Description
protected ExecutorService	executorService
protected HealthStatus	healthStatus

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

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor and Description
AbstractHealthIndicator()

Method Summary

Modifier and Type	Method and Description
protected abstract T	getHealthInformation() Provides information (typically a Map) to be returned.
protected HealthResult	getHealthResult() Builds the whole health result.
protected abstract String	getName() Used to populate the HealthResult.
Publisher<HealthResult>	getResult()
void	setExecutorService(ExecutorService executorService)

Methods inherited from class java.lang.Object

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

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

getOrder

Field Detail

executorService

protected ExecutorService executorService

healthStatus

protected HealthStatus healthStatus

Constructor Detail

AbstractHealthIndicator

public AbstractHealthIndicator()

Method Detail

setExecutorService

@Inject
public void setExecutorService(@Named(value="io")
                                       ExecutorService executorService)

Parameters:

executorService - The executor service

getResult

public Publisher<HealthResult> getResult()

Specified by:

getResult in interface HealthIndicator

Returns:

A publisher that returns a HealthResult that provides the information necessary to build a response.

getHealthInformation

protected abstract T getHealthInformation()

Provides information (typically a Map) to be returned. Set the healthStatus field during execution, otherwise HealthStatus.UNKNOWN will be used.

Returns:

Any details to be included in the response.

getHealthResult

protected HealthResult getHealthResult()

Builds the whole health result.

Returns:

The health result to provide to the indicator.

getName

protected abstract String getName()

Used to populate the HealthResult. Provides a key to go along with the health information.

Returns:

The name of the indicator