Marked deprecated HealthCheck API. Modified examples to use current HealthCheck API properly. (helidon-io#2656)

Signed-off-by: Tomas Kraus <Tomas.Kraus@oracle.com>

Author: Tomáš Kraus

archetypes/database-se/src/main/resources/src/main/java/__pkg__/Main.java.mustache

@@ -86,7 +86,7 @@ public final class Main {
 
         // Support for health
         HealthSupport health = HealthSupport.builder()
-                .addLiveness(DbClientHealthCheck.create(dbClient))
+                .addLiveness(DbClientHealthCheck.create(dbClient, dbConfig.get("health-check")))
                 .build();
 
         // Initialize database schema

archetypes/database-se/src/main/resources/src/main/resources/application.yaml

@@ -21,6 +21,9 @@ db:
   services:
     metrics:
       - type: METER
+  health-check:
+    type: "dml"
+    statementName: "ping"
   statements:
     # Ping statement
     ping: "SET @HELIDON_PING=0"

dbclient/dbclient/src/main/java/io/helidon/dbclient/DbClient.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2019, 2020 Oracle and/or its affiliates.
+ * Copyright (c) 2019, 2021 Oracle and/or its affiliates.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -22,7 +22,6 @@
 import java.util.function.Supplier;
 
 import io.helidon.common.mapper.MapperManager;
-import io.helidon.common.reactive.Single;
 import io.helidon.common.reactive.Subscribable;
 import io.helidon.common.serviceloader.HelidonServiceLoader;
 import io.helidon.config.Config;
@@ -57,20 +56,6 @@ public interface DbClient {
      */
     <U, T extends Subscribable<U>> T execute(Function<DbExecute, T> executor);
 
-    /**
-     * Name of the named statement used in database health checks.
-     */
-    String PING_STATEMENT_NAME = "ping";
-
-    /**
-     * Pings the database, completes when DB is up and ready, completes exceptionally if not.
-     * Executes simple SQL query defined as {@code db.statements.ping} configuration property.
-     *
-     * @return stage that completes when the ping finished
-     * @deprecated Use {@code io.helidon.dbclient.health.DbClientHealthCheck} instead.
-     */
-    Single<Void> ping();
-
     /**
      * Type of this database provider (such as jdbc:mysql, mongoDB etc.).
      *

dbclient/health/pom.xml

@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <!--
-  Copyright (c) 2019, 2020 Oracle and/or its affiliates. All rights reserved.
+  Copyright (c) 2019, 2021 Oracle and/or its affiliates. All rights reserved.
 
   Licensed under the Apache License, Version 2.0 (the "License");
   you may not use this file except in compliance with the License.
@@ -39,5 +39,20 @@
             <groupId>io.helidon.health</groupId>
             <artifactId>helidon-health</artifactId>
         </dependency>
+        <dependency>
+            <groupId>io.helidon.config</groupId>
+            <artifactId>helidon-config-yaml</artifactId>
+            <scope>test</scope>
+        </dependency>
+        <dependency>
+            <groupId>org.junit.jupiter</groupId>
+            <artifactId>junit-jupiter-api</artifactId>
+            <scope>test</scope>
+        </dependency>
+        <dependency>
+            <groupId>org.hamcrest</groupId>
+            <artifactId>hamcrest-all</artifactId>
+            <scope>test</scope>
+        </dependency>
     </dependencies>
 </project>