simplified HealthCheck classes

Author: lamdav

src/main/java/org/gitlab4j/api/HealthCheckApi.java

@@ -1,7 +1,6 @@
 package org.gitlab4j.api;
 
-import org.gitlab4j.api.models.LivenessHealthCheck;
-import org.gitlab4j.api.models.ReadinessHealthCheck;
+import org.gitlab4j.api.models.HealthCheckInfo;
 
 import javax.ws.rs.core.Response;
 import java.io.IOException;
@@ -14,67 +13,77 @@ public HealthCheckApi(GitLabApi gitLabApi) {
 
     /**
      * Get Health Checks from the liveness endpoint.
+     *
      * Requires ip_whitelist
+     * https://docs.gitlab.com/ee/administration/monitoring/ip_whitelist.html
      *
      * GET /-/liveness
      *
-     * @return LivenessHealthCheck instance
+     * @return HealthCheckInfo instance
      * @throws GitLabApiException if any exception occurs
      */
-    public LivenessHealthCheck getLiveness() throws GitLabApiException, IOException {
+    public HealthCheckInfo getLiveness() throws GitLabApiException, IOException {
         URL livenessUrl = getApiClient().getUrlWithBase("-", "liveness");
         Response response = get(Response.Status.OK, null, livenessUrl);
-        return (response.readEntity(LivenessHealthCheck.class));
+        return (response.readEntity(HealthCheckInfo.class));
     }
 
     /**
      * Get Health Checks from the liveness endpoint.
      *
+     * Requires ip_whitelist
+     * https://docs.gitlab.com/ee/administration/monitoring/ip_whitelist.html
+     *
      * GET /-/liveness
      *
      * @param token Health Status token
-     * @return LivenessHealthCheck instance
+     * @return HealthCheckInfo instance
      * @throws GitLabApiException if any exception occurs
      * @deprecated
      */
-    public LivenessHealthCheck getLiveness(String token) throws GitLabApiException, IOException {
+    public HealthCheckInfo getLiveness(String token) throws GitLabApiException, IOException {
         URL livenessUrl = getApiClient().getUrlWithBase("-", "liveness");
         GitLabApiForm formData = new GitLabApiForm()
                 .withParam("token", token, false);
         Response response = get(Response.Status.OK, formData.asMap(), livenessUrl);
-        return (response.readEntity(LivenessHealthCheck.class));
+        return (response.readEntity(HealthCheckInfo.class));
     }
 
     /**
      * Get Health Checks from the readiness endpoint.
+     *
      * Requires ip_whitelist
+     * https://docs.gitlab.com/ee/administration/monitoring/ip_whitelist.html
      *
      * GET /-/readiness
      *
-     * @return ReadinessHealthCheck instance
+     * @return HealthCheckInfo instance
      * @throws GitLabApiException if any exception occurs
      */
-    public ReadinessHealthCheck getReadiness() throws GitLabApiException, IOException {
+    public HealthCheckInfo getReadiness() throws GitLabApiException, IOException {
         URL readinessUrl = getApiClient().getUrlWithBase("-", "readiness");
         Response response = get(Response.Status.OK, null, readinessUrl);
-        return (response.readEntity(ReadinessHealthCheck.class));
+        return (response.readEntity(HealthCheckInfo.class));
     }
 
     /**
      * Get Health Checks from the readiness endpoint.
      *
+     * Requires ip_whitelist
+     * https://docs.gitlab.com/ee/administration/monitoring/ip_whitelist.html
+     *
      * GET /-/readiness
      *
      * @param token Health Status token
-     * @return LivenessHealthCheck instance
+     * @return HealthCheckInfo instance
      * @throws GitLabApiException if any exception occurs
      * @deprecated
      */
-    public ReadinessHealthCheck getReadiness(String token) throws GitLabApiException, IOException {
+    public HealthCheckInfo getReadiness(String token) throws GitLabApiException, IOException {
         URL readinessUrl = getApiClient().getUrlWithBase("-", "readiness");
         GitLabApiForm formData = new GitLabApiForm()
                 .withParam("token", token, false);
         Response response = get(Response.Status.OK, formData.asMap(), readinessUrl);
-        return (response.readEntity(ReadinessHealthCheck.class));
+        return (response.readEntity(HealthCheckInfo.class));
     }
 }

src/main/java/org/gitlab4j/api/models/HealthCheckInfo.java

@@ -0,0 +1,73 @@
+package org.gitlab4j.api.models;
+
+import javax.xml.bind.annotation.XmlAccessType;
+import javax.xml.bind.annotation.XmlAccessorType;
+import javax.xml.bind.annotation.XmlRootElement;
+
+@XmlRootElement
+@XmlAccessorType(XmlAccessType.FIELD)
+public class HealthCheckInfo {
+    private HealthCheckItem dbCheck;
+    private HealthCheckItem redisCheck;
+    private HealthCheckItem cacheCheck;
+    private HealthCheckItem queuesCheck;
+    private HealthCheckItem sharedStateCheck;
+    private HealthCheckItem fsShardsCheck;
+    private HealthCheckItem gitalyCheck;
+
+    public HealthCheckItem getDbCheck() {
+        return this.dbCheck;
+    }
+
+    public void setDbCheck(HealthCheckItem dbCheck) {
+        this.dbCheck = dbCheck;
+    }
+
+    public HealthCheckItem getRedisCheck() {
+        return this.redisCheck;
+    }
+
+    public void setRedisCheck(HealthCheckItem redisCheck) {
+        this.redisCheck = redisCheck;
+    }
+
+    public HealthCheckItem getCacheCheck() {
+        return this.cacheCheck;
+    }
+
+    public void setCacheCheck(HealthCheckItem cacheCheck) {
+        this.cacheCheck = cacheCheck;
+    }
+
+    public HealthCheckItem getQueuesCheck() {
+        return this.queuesCheck;
+    }
+
+    public void setQueuesCheck(HealthCheckItem queuesCheck) {
+        this.queuesCheck = queuesCheck;
+    }
+
+    public HealthCheckItem getSharedStateCheck() {
+        return this.sharedStateCheck;
+    }
+
+    public void setSharedStateCheck(HealthCheckItem sharedStateCheck) {
+        this.sharedStateCheck = sharedStateCheck;
+    }
+
+    public HealthCheckItem getFsShardsCheck() {
+        return this.fsShardsCheck;
+    }
+
+    public void setFsShardsCheck(HealthCheckItem fsShardsCheck) {
+        this.fsShardsCheck = fsShardsCheck;
+    }
+
+    public HealthCheckItem getGitalyCheck() {
+        return this.gitalyCheck;
+    }
+
+    public void setGitalyCheck(HealthCheckItem gitalyCheck) {
+        this.gitalyCheck = gitalyCheck;
+    }
+}

src/main/java/org/gitlab4j/api/models/HealthCheckItem.java

@@ -0,0 +1,37 @@
+package org.gitlab4j.api.models;
+
+import javax.xml.bind.annotation.XmlAccessType;
+import javax.xml.bind.annotation.XmlAccessorType;
+import java.util.Map;
+
+@XmlAccessorType(XmlAccessType.FIELD)
+public class HealthCheckItem {
+    private HealthCheckStatus status;
+    private Map<String, String> labels;
+    private String message;
+
+    public HealthCheckStatus getStatus() {
+        return this.status;
+    }
+
+    public void setStatus(HealthCheckStatus status) {
+        this.status = status;
+    }
+
+    public Map<String, String> getLabels() {
+        return labels;
+    }
+
+    public void setLabels(Map<String, String> labels) {
+        this.labels = labels;
+    }
+
+    public String getMessage() {
+        return message;
+    }
+
+    public void setMessage(String message) {
+        this.message = message;
+    }
+
+}

src/main/java/org/gitlab4j/api/models/HealthCheckStatus.java

@@ -1,17 +1,26 @@
 package org.gitlab4j.api.models;
 
-import javax.xml.bind.annotation.XmlAccessType;
-import javax.xml.bind.annotation.XmlAccessorType;
+import com.fasterxml.jackson.annotation.JsonCreator;
+import com.fasterxml.jackson.annotation.JsonValue;
+import org.gitlab4j.api.utils.JacksonJsonEnumHelper;
 
-@XmlAccessorType(XmlAccessType.FIELD)
-public class HealthCheckStatus {
-    private String status;
+public enum HealthCheckStatus {
+    OK, FAILED;
 
-    public String getStatus() {
-        return this.status;
+    private static JacksonJsonEnumHelper<HealthCheckStatus> enumHelper = new JacksonJsonEnumHelper<>(HealthCheckStatus.class);
+
+    @JsonCreator
+    public static HealthCheckStatus forValue(String value) {
+        return enumHelper.forValue(value);
+    }
+
+    @JsonValue
+    public String toValue() {
+        return enumHelper.toString(this);
     }
 
-    public void setStatus(String status) {
-        this.status = status;
+    @Override
+    public String toString() {
+        return enumHelper.toString(this);
     }
 }