Class ConnectionFactoryHealthIndicator

java.lang.Object

org.springframework.boot.health.contributor.AbstractReactiveHealthIndicator

org.springframework.boot.r2dbc.health.ConnectionFactoryHealthIndicator

All Implemented Interfaces:

ReactiveHealthContributor, ReactiveHealthIndicator

public class ConnectionFactoryHealthIndicator
extends AbstractReactiveHealthIndicator

A HealthIndicator to validate a R2DBC ConnectionFactory.

Since:

4.0.0

Author:

Mark Paluch, Stephane Nicoll

Constructor Summary

Constructors

Constructor	Description
ConnectionFactoryHealthIndicator(io.r2dbc.spi.ConnectionFactory connectionFactory)	Create a new ConnectionFactoryHealthIndicator using the specified ConnectionFactory and no validation query.
ConnectionFactoryHealthIndicator(io.r2dbc.spi.ConnectionFactory connectionFactory, @Nullable String validationQuery)	Create a new ConnectionFactoryHealthIndicator using the specified ConnectionFactory and validation query.

Method Summary

Modifier and Type	Method	Description
protected final reactor.core.publisher.Mono<Health>	doHealthCheck(Health.Builder builder)	Actual health check logic.

Methods inherited from class org.springframework.boot.health.contributor.AbstractReactiveHealthIndicator

health

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.boot.health.contributor.ReactiveHealthIndicator

asHealthContributor, health

Constructor Details

ConnectionFactoryHealthIndicator

public ConnectionFactoryHealthIndicator(io.r2dbc.spi.ConnectionFactory connectionFactory)

Create a new ConnectionFactoryHealthIndicator using the specified ConnectionFactory and no validation query.

Parameters:

connectionFactory - the connection factory

See Also:

• Connection.validate(ValidationDepth)

ConnectionFactoryHealthIndicator

public ConnectionFactoryHealthIndicator(io.r2dbc.spi.ConnectionFactory connectionFactory,
 @Nullable String validationQuery)

Create a new ConnectionFactoryHealthIndicator using the specified ConnectionFactory and validation query.

Parameters:

connectionFactory - the connection factory

validationQuery - the validation query, can be null to use connection validation

Method Details

doHealthCheck

protected final reactor.core.publisher.Mono<Health> doHealthCheck(Health.Builder builder)

Description copied from class: AbstractReactiveHealthIndicator

Actual health check logic. If an error occurs in the pipeline, it will be handled automatically.

Specified by:

doHealthCheck in class AbstractReactiveHealthIndicator

Parameters:

builder - the Health.Builder to report health status and details

Returns:

a Mono that provides the Health