[felix-dev] branch master updated: FELIX-6481 Ensure help text in html rendering only shows parameters that are available

[gh...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

ghenzler pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/felix-dev.git


The following commit(s) were added to refs/heads/master by this push:
     new 0616a35  FELIX-6481 Ensure help text in html rendering only shows parameters that are available
0616a35 is described below

commit 0616a356d717a4fd9bce126a07d39d17a082b533
Author: georg.henzler <ge...@netcentric.biz>
AuthorDate: Tue Dec 14 21:54:31 2021 +0100

    FELIX-6481 Ensure help text in html rendering only shows parameters that
    are available
---
 .../hc/core/impl/servlet/HealthCheckExecutorServlet.java   | 14 +++++++++++---
 1 file changed, 11 insertions(+), 3 deletions(-)

diff --git a/healthcheck/core/src/main/java/org/apache/felix/hc/core/impl/servlet/HealthCheckExecutorServlet.java b/healthcheck/core/src/main/java/org/apache/felix/hc/core/impl/servlet/HealthCheckExecutorServlet.java
index 2ae52ef..be9dac3 100644
--- a/healthcheck/core/src/main/java/org/apache/felix/hc/core/impl/servlet/HealthCheckExecutorServlet.java
+++ b/healthcheck/core/src/main/java/org/apache/felix/hc/core/impl/servlet/HealthCheckExecutorServlet.java
@@ -74,17 +74,21 @@ public class HealthCheckExecutorServlet extends HttpServlet {
 
     static class Param {
         final String name;
-        final String description;
+        String description;
 
         Param(String n, String d) {
             name = n;
             description = d;
         }
+        
+        void setDescription(String d) {
+            description = d;
+        }
     }
 
     static final Param PARAM_TAGS = new Param("tags",
             "Comma-separated list of health checks tags to select - can also be specified via path, e.g. /system/health/tag1,tag2.json. Exclusions can be done by prepending '-' to the tag name");
-    static final Param PARAM_FORMAT = new Param("format", "Output format, html|json|jsonp|txt - an extension in the URL overrides this");
+    static final Param PARAM_FORMAT = new Param("format", null /* to be set in activate() */);
     static final Param PARAM_HTTP_STATUS = new Param("httpStatus", "Specify HTTP result code, for example"
             + " CRITICAL:503 (status 503 if result >= CRITICAL)"
             + " or CRITICAL:503,HEALTH_CHECK_ERROR:500,OK:418 for more specific HTTP status");
@@ -173,6 +177,8 @@ public class HealthCheckExecutorServlet extends HttpServlet {
             allFormats[this.allowedFormats.length] = this.defaultFormat;
             this.allowedFormats = allFormats;
         }
+        PARAM_FORMAT.setDescription("Output format, " + String.join("|", allowedFormats) + " - an extension in the URL overrides this");
+
         this.corsAccessControlAllowOrigin = configuration.cors_accessControlAllowOrigin();
         this.disableRequestConfiguration = configuration.disable_request_configuration();
         
@@ -391,7 +397,9 @@ public class HealthCheckExecutorServlet extends HttpServlet {
             throws IOException {
         response.setContentType(CONTENT_TYPE_HTML);
         response.setCharacterEncoding("UTF-8");
-        response.getWriter().append(this.htmlSerializer.serialize(overallResult, executionResults, Arrays.asList(PARAM_LIST), includeDebug));
+        
+        List<Param> allowedParameters = disableRequestConfiguration ? Arrays.asList(PARAM_FORMAT) : Arrays.asList(PARAM_LIST);
+        response.getWriter().append(this.htmlSerializer.serialize(overallResult, executionResults, allowedParameters, includeDebug));
     }
 
     private void sendNoCacheHeaders(final HttpServletResponse response) {