OPHYK-356 remove opintopolku-healthcheck-api

Opetushallitus · Nov 26, 2024 · 1168f7c · 1168f7c
1 parent 806433d
commit 1168f7c
Show file tree

Hide file tree

Showing 9 changed files with 38 additions and 41 deletions.
diff --git a/legacy-caching-rest-client/pom.xml b/legacy-caching-rest-client/pom.xml
@@ -91,11 +91,6 @@
 
     <dependencies>
         <!-- Internal -->
-        <dependency>
-            <groupId>fi.vm.sade.java-utils</groupId>
-            <artifactId>opintopolku-healthcheck-api</artifactId>
-            <version>0.3.0-SNAPSHOT</version>
-        </dependency>
         <dependency>
             <groupId>fi.vm.sade.java-utils</groupId>
             <artifactId>java-legacy-cas</artifactId>

diff --git a/...ient/src/main/java/fi/vm/sade/javautils/legacy_caching_rest_client/CachingRestClient.java b/...ient/src/main/java/fi/vm/sade/javautils/legacy_caching_rest_client/CachingRestClient.java
@@ -15,7 +15,6 @@
 
 import fi.vm.sade.javautils.cas.CasClient;
 import fi.vm.sade.javautils.legacy_cxf_cas.PERA;
-import fi.vm.sade.javautils.healthcheck.HealthChecker;
 import fi.vm.sade.javautils.legacy_cxf_cas.ui.portlet.security.ProxyAuthenticator;
 import org.apache.commons.httpclient.HttpStatus;
 import org.apache.commons.io.IOUtils;

diff --git a/...t-client/src/main/java/fi/vm/sade/javautils/legacy_caching_rest_client/HealthChecker.java b/...t-client/src/main/java/fi/vm/sade/javautils/legacy_caching_rest_client/HealthChecker.java
@@ -0,0 +1,37 @@
+package fi.vm.sade.javautils.legacy_caching_rest_client;
+
+/**
+ * Healthcheckiin kuuluva tarkastaja, jonka roolina on tarkastaa yksi kohde healthcheckin yhteydessä.
+ * SpringAwareHealthCheckServlet kutsuu spring application contextista löytyviä tämän HealthChecker -interfacen toteuttavia beaneja.
+ * checkHealth -metodin palauttama objekti serialisoidaan JSON:ksi, ja liitetään healthcheckin checks -osioon kentäksi [beanName].
+ * Mikäli tarkastuksessa on virhe, checkHealth -metodin tulee heittää sitä poikkeus (jonka message kuvaa virhetilannetta).
+ * Tällöin poikkeuksen message liitetään healthcheck tulokseen, ja koko healthcheckin tila on ERREOR.
+ *
+ * Esim:
+ *
+ *  @Component("solrIndexed")
+ *  public class SolrIndexedCheck implements HealthChecker {
+ *      Object checkHealth() throws Throwable {
+ *          // tarkastetaan tässä onko solr indeksoitu
+ *          return new LinkedHashMap(){{ put("status", "OK"); put("previouslyIndexed", timestamp); }}
+ *      }
+ *  }
+ *
+ *  ...johtaa tällaiseen healthcheck tulokseen...
+ *
+ *  {
+ *      "status": "OK",
+ *      "checks": {
+ *          "solrIndexed": {"status": "OK", "timestamp": [timestamp]}
+ *      }
+ *  }
+ *
+ * @see SpringAwareHealthCheckServlet (in other module)
+ */
+public interface HealthChecker {
+    /**
+     * @return something json-serializable that describes the state of this checker
+     * @throws Throwable if there is health check error
+     */
+    Object checkHealth() throws Throwable;
+}
diff --git a/legacy-cxf-cas/pom.xml b/legacy-cxf-cas/pom.xml
@@ -15,11 +15,6 @@
     <dependencyManagement>
         <dependencies>
             <!-- Internal -->
-            <dependency>
-                <groupId>fi.vm.sade.java-utils</groupId>
-                <artifactId>opintopolku-healthcheck-api</artifactId>
-                <version>0.3.0-SNAPSHOT</version>
-            </dependency>
             <dependency>
                 <groupId>fi.vm.sade.java-utils</groupId>
                 <artifactId>java-legacy-cas</artifactId>
@@ -76,10 +71,6 @@
 
     <dependencies>
         <!-- Internal -->
-        <dependency>
-            <groupId>fi.vm.sade.java-utils</groupId>
-            <artifactId>opintopolku-healthcheck-api</artifactId>
-        </dependency>
         <dependency>
             <groupId>fi.vm.sade.java-utils</groupId>
             <artifactId>java-legacy-cas</artifactId>

diff --git a/opintopolku-healthcheck-api/pom.xml b/opintopolku-healthcheck-api/pom.xml
diff --git a/pom.xml b/pom.xml
@@ -7,7 +7,6 @@
     <version>0.3.0-SNAPSHOT</version>
     <packaging>pom</packaging>
     <modules>
-        <module>opintopolku-healthcheck-api</module>
         <module>java-properties</module>
         <module>oid-generator</module>
         <module>tcp-utils</module>

diff --git a/spring-aware-health-check-servlet/pom.xml b/spring-aware-health-check-servlet/pom.xml
@@ -8,7 +8,7 @@
     <relativePath>..</relativePath>
   </parent>
   <artifactId>spring-aware-health-check-servlet</artifactId>
-  <version>0.5.0-SNAPSHOT</version>
+  <version>0.5.1-SNAPSHOT</version>
   <packaging>jar</packaging>
   <dependencyManagement>
     <dependencies>
@@ -73,11 +73,6 @@
         <artifactId>legacy-caching-rest-client</artifactId>
         <version>0.6.0-SNAPSHOT</version>
       </dependency>
-      <dependency>
-        <groupId>fi.vm.sade.java-utils</groupId>
-        <artifactId>opintopolku-healthcheck-api</artifactId>
-        <version>0.3.0-SNAPSHOT</version>
-      </dependency>
       <dependency>
         <groupId>fi.vm.sade.java-utils</groupId>
         <artifactId>java-cache</artifactId>
@@ -137,10 +132,6 @@
       <groupId>fi.vm.sade.java-utils</groupId>
       <artifactId>legacy-caching-rest-client</artifactId>
     </dependency>
-    <dependency>
-      <groupId>fi.vm.sade.java-utils</groupId>
-      <artifactId>opintopolku-healthcheck-api</artifactId>
-    </dependency>
     <dependency>
       <groupId>fi.vm.sade.java-utils</groupId>
       <artifactId>java-cache</artifactId>

diff --git a/.../javautils/healthcheck/HealthChecker.java → .../javautils/healthcheck/HealthChecker.java b/.../javautils/healthcheck/HealthChecker.java → .../javautils/healthcheck/HealthChecker.java
diff --git a/...servlet/src/main/java/fi/vm/sade/javautils/healthcheck/SpringAwareHealthCheckServlet.java b/...servlet/src/main/java/fi/vm/sade/javautils/healthcheck/SpringAwareHealthCheckServlet.java
@@ -2,7 +2,6 @@
 
 import com.google.gson.Gson;
 import com.google.gson.GsonBuilder;
-import fi.vm.sade.javautils.healthcheck.HealthChecker;
 import fi.vm.sade.security.SimpleCache;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;