Repurposed plain text status checks for the APIs into simple json check.

ORCID · Jan 2, 2024 · c806c37 · c806c37
1 parent ad5a15f
commit c806c37
Show file tree

Hide file tree

Showing 10 changed files with 30 additions and 14 deletions.
diff --git a/orcid-api-web/src/main/java/org/orcid/api/memberV3/server/MemberV3ApiServiceImplV3_0.java b/orcid-api-web/src/main/java/org/orcid/api/memberV3/server/MemberV3ApiServiceImplV3_0.java
@@ -163,10 +163,12 @@ public Response viewSwaggerO2c() {
      * @return Plain text message indicating health of service
      */
     @GET
-    @Produces(value = { MediaType.TEXT_PLAIN })
+    @Produces(value = { MediaType.APPLICATION_JSON })
     @Path(STATUS_PATH)
-    public Response viewStatusText() {
-        return serviceDelegator.viewStatusText();
+    public Response viewStatusSimple() {
+        httpRequest.setAttribute("skipAccessLog", true);
+        httpRequest.setAttribute("isMonitoring", true);
+        return serviceDelegator.viewStatusSimple();
     }
 
     @GET

diff --git a/...eb/src/main/java/org/orcid/api/memberV3/server/delegator/MemberV3ApiServiceDelegator.java b/...eb/src/main/java/org/orcid/api/memberV3/server/delegator/MemberV3ApiServiceDelegator.java
@@ -9,7 +9,7 @@ public interface MemberV3ApiServiceDelegator<DISTINCTION, EDUCATION, EMPLOYMENT,
 
     static final String LATEST_V3_VERSION = "3.0";
 
-    Response viewStatusText();
+    Response viewStatusSimple();
 
     Response viewStatus();
 

diff --git a/...in/java/org/orcid/api/memberV3/server/delegator/impl/MemberV3ApiServiceDelegatorImpl.java b/...in/java/org/orcid/api/memberV3/server/delegator/impl/MemberV3ApiServiceDelegatorImpl.java
@@ -279,8 +279,9 @@ public void setFilterVersionOfIdentifiers(Boolean filterVersionOfIdentifiers) {
     }
 
     @Override
-    public Response viewStatusText() {
-        return Response.ok(STATUS_OK_MESSAGE).build();
+    public Response viewStatusSimple() {
+        Map<String, Boolean> statusMap = statusManager.createStatusMapSimple();
+        return Response.ok(statusMap).build();
     }
 
     @Override

diff --git a/orcid-api-web/src/main/resources/orcid-api-security-context.xml b/orcid-api-web/src/main/resources/orcid-api-security-context.xml
@@ -22,6 +22,7 @@
 	<sec:http pattern="/v3**/o2c.html" security="none"/>
 
 	<!--  Status check -->
+    <sec:http pattern="/v*/status" security="none"/>
 	<sec:http pattern="/v*/apiStatus" security="none"/>
 
     <!-- Authenticate the client before reaching the token endpoint -->

diff --git a/orcid-core/src/main/java/org/orcid/core/manager/StatusManager.java b/orcid-core/src/main/java/org/orcid/core/manager/StatusManager.java
@@ -15,5 +15,7 @@ public interface StatusManager {
     String TOMCAT_UP = "tomcatUp";
 
     Map<String, Boolean> createStatusMap();
+
+    Map<String, Boolean> createStatusMapSimple();
 
 }
diff --git a/orcid-core/src/main/java/org/orcid/core/manager/impl/StatusManagerImpl.java b/orcid-core/src/main/java/org/orcid/core/manager/impl/StatusManagerImpl.java
@@ -41,6 +41,13 @@ public Map<String, Boolean> createStatusMap() {
         return result;
     }
 
+    @Override
+    public Map<String, Boolean> createStatusMapSimple() {
+        Map<String, Boolean> result = new LinkedHashMap<>();
+        result.put(TOMCAT_UP, true);
+        return result;
+    }
+
     private boolean isConnectionOk(MiscDao miscDao) {
         try {
             Date dbDate = miscDao.retrieveDatabaseDatetime();

diff --git a/orcid-pub-web/src/main/java/org/orcid/api/publicV3/server/PublicV3ApiServiceImplV3_0.java b/orcid-pub-web/src/main/java/org/orcid/api/publicV3/server/PublicV3ApiServiceImplV3_0.java
@@ -128,10 +128,12 @@ public Response viewSwagger() {
 
 
   @GET
-  @Produces(value = { MediaType.TEXT_PLAIN })
+  @Produces(value = { MediaType.APPLICATION_JSON })
   @Path(STATUS_PATH)
-  public Response viewStatusText() {
-      return serviceDelegator.viewStatusText();
+  public Response viewStatusSimple() {
+      httpRequest.setAttribute("skipAccessLog", true);
+      httpRequest.setAttribute("isMonitoring", true);
+      return serviceDelegator.viewStatusSimple();
   }
 
   @GET

diff --git a/...eb/src/main/java/org/orcid/api/publicV3/server/delegator/PublicV3ApiServiceDelegator.java b/...eb/src/main/java/org/orcid/api/publicV3/server/delegator/PublicV3ApiServiceDelegator.java
@@ -14,7 +14,7 @@ public interface PublicV3ApiServiceDelegator<DISTINCTION, EDUCATION, EMPLOYMENT,
 
     static final String LATEST_V3_VERSION = "3.0";
 
-    Response viewStatusText();
+    Response viewStatusSimple();
 
     Response viewStatus();
 

diff --git a/...in/java/org/orcid/api/publicV3/server/delegator/impl/PublicV3ApiServiceDelegatorImpl.java b/...in/java/org/orcid/api/publicV3/server/delegator/impl/PublicV3ApiServiceDelegatorImpl.java
@@ -226,8 +226,9 @@ public void setFilterVersionOfIdentifiers(Boolean filterVersionOfIdentifiers) {
     }
 
     @Override
-    public Response viewStatusText() {
-        return Response.ok(STATUS_OK_MESSAGE).build();
+    public Response viewStatusSimple() {
+        Map<String, Boolean> statusMap = statusManager.createStatusMapSimple();
+        return Response.ok(statusMap).build();
     }
 
     @Override

diff --git a/...rg/orcid/api/publicV3/server/delegator/impl/PublicV3ApiServiceVersionedDelegatorImpl.java b/...rg/orcid/api/publicV3/server/delegator/impl/PublicV3ApiServiceVersionedDelegatorImpl.java
@@ -38,8 +38,8 @@ public void setPublicV3ApiServiceDelegator(
     }
 
     @Override
-    public Response viewStatusText() {
-        return publicV3ApiServiceDelegator.viewStatusText();
+    public Response viewStatusSimple() {
+        return publicV3ApiServiceDelegator.viewStatusSimple();
     }
 
     @Override