Module io.helidon.dbclient.health

Package io.helidon.dbclient.health

Class DbClientHealthCheck

java.lang.Object

io.helidon.dbclient.health.DbClientHealthCheck

All Implemented Interfaces:

org.eclipse.microprofile.health.HealthCheck

public final class DbClientHealthCheck
extends Object
implements org.eclipse.microprofile.health.HealthCheck

Database health check.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DbClientHealthCheck.Builder	Fluent API builder for DbClientHealthCheck.

Method Summary

Modifier and Type	Method	Description
static DbClientHealthCheck.Builder	builder(DbClient dbClient)	A fluent API builder to create a fully customized database health check.
org.eclipse.microprofile.health.HealthCheckResponse	call()
static DbClientHealthCheck	create(DbClient dbClient)	Create a health check for the database.

Methods inherited from class java.lang.Object

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

Method Detail

create

public static DbClientHealthCheck create(DbClient dbClient)

Create a health check for the database.

Parameters:

dbClient - A database that implements DbClient.ping()

Returns:

health check that can be used with HealthSupport.Builder.addReadiness(org.eclipse.microprofile.health.HealthCheck...) or HealthSupport.Builder.addLiveness(org.eclipse.microprofile.health.HealthCheck...)

builder

public static DbClientHealthCheck.Builder builder(DbClient dbClient)

A fluent API builder to create a fully customized database health check.

Parameters:

dbClient - database

Returns:

a new builder

call

public org.eclipse.microprofile.health.HealthCheckResponse call()

Specified by:

call in interface org.eclipse.microprofile.health.HealthCheck