Add confidentiality agreement configuration to admin-api, expose with api/v1/frontend/configuration

ext/hivemq-edge-openapi-2025.14.yaml

@@ -5103,6 +5103,18 @@ components:
             $ref: '#/components/schemas/Link'
       required:
         - items
+    ConfidentialityAgreement:
+      type: object
+      description: A list of resources to render
+      properties:
+        enabled:
+          type: boolean
+          description: Whether the CA should be shown prior to login
+        content:
+          type: string
+          description: The text of the CA
+      required:
+        - enabled
     EnvironmentProperties:
       type: object
       description: A map of properties relating to the installation
@@ -5256,6 +5268,8 @@ components:
         trackingAllowed:
           type: boolean
           description: Is the tracking of user actions allowed.
+        confidentialityAgreement:
+            $ref: '#/components/schemas/ConfidentialityAgreement'
     Notification:
       type: object
       description: List of result items that are returned by this endpoint

ext/openAPI/components/schemas/ConfidentialityAgreement.yaml

@@ -0,0 +1,11 @@
+type: object
+description: A list of resources to render
+properties:
+  enabled:
+    type: boolean
+    description: Whether the CA should be shown prior to login
+  content:
+    type: string
+    description: The text of the CA
+required:
+  - enabled

ext/openAPI/components/schemas/GatewayConfiguration.yaml

@@ -24,3 +24,5 @@ properties:
   trackingAllowed:
     type: boolean
     description: Is the tracking of user actions allowed.
+  confidentialityAgreement:
+    $ref: ./ConfidentialityAgreement.yaml

hivemq-edge/src/main/java/com/hivemq/api/model/components/ConfidentialityAgreement.java

@@ -0,0 +1,41 @@
+package com.hivemq.api.model.components;
+
+import com.fasterxml.jackson.annotation.JsonCreator;
+import com.fasterxml.jackson.annotation.JsonProperty;
+import io.swagger.v3.oas.annotations.media.Schema;
+import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.Nullable;
+
+import static java.util.Objects.requireNonNullElse;
+
+public class ConfidentialityAgreement {
+
+    @JsonProperty("enabled")
+    @Schema(description = "Whether the confidentiality agreement should be shown prior to login in")
+    private final @NotNull Boolean enabled;
+
+    @JsonProperty("content")
+    @Schema(description = "The confidentiality agreement")
+    private final @Nullable String content;
+
+    public ConfidentialityAgreement() {
+        this(false, null);
+    }
+
+    @JsonCreator(mode = JsonCreator.Mode.PROPERTIES)
+    public ConfidentialityAgreement(final @Nullable Boolean enabled, final @Nullable String content) {
+        this.enabled = requireNonNullElse(enabled, false);
+        if (this.enabled && (content == null || content.isEmpty())) {
+            throw new IllegalArgumentException("Content cannot be null or empty when enabled");
+        }
+        this.content = content;
+    }
+
+    public boolean getEnabled() {
+        return enabled;
+    }
+
+    public @Nullable String getContent() {
+        return content;
+    }
+}

hivemq-edge/src/main/java/com/hivemq/api/model/components/GatewayConfiguration.java

@@ -18,57 +18,58 @@
 import com.fasterxml.jackson.annotation.JsonCreator;
 import com.fasterxml.jackson.annotation.JsonProperty;
 import com.hivemq.api.model.firstuse.FirstUseInformation;
-import org.jetbrains.annotations.NotNull;
 import io.swagger.v3.oas.annotations.media.Schema;
+import org.jetbrains.annotations.NotNull;
 
-/**
- * @author Simon L Johnson
- */
 public class GatewayConfiguration {
 
     @JsonProperty("environment")
     @Schema(description = "A map of properties relating to the installation", nullable = true)
-    private @NotNull EnvironmentProperties environment;
+    private final @NotNull EnvironmentProperties environment;
 
     @JsonProperty("cloudLink")
     @Schema(description = "A referral link to HiveMQ Cloud")
-    private @NotNull Link cloudLink;
+    private final @NotNull Link cloudLink;
 
     @JsonProperty("gitHubLink")
     @Schema(description = "A link to the GitHub Project")
-    private @NotNull Link gitHubLink;
+    private final @NotNull Link gitHubLink;
 
     @JsonProperty("documentationLink")
     @Schema(description = "A link to the documentation Project")
-    private @NotNull Link documentationLink;
+    private final @NotNull Link documentationLink;
 
     @JsonProperty("firstUseInformation")
     @Schema(description = "Information relating to the firstuse experience")
-    private @NotNull FirstUseInformation firstUseInformation;
+    private final @NotNull FirstUseInformation firstUseInformation;
 
     @JsonProperty("ctas")
     @Schema(description = "The calls main to action")
-    private @NotNull LinkList ctas;
+    private final @NotNull LinkList ctas;
 
     @JsonProperty("resources")
     @Schema(description = "A list of resources to render")
-    private @NotNull LinkList resources;
+    private final @NotNull LinkList resources;
 
     @JsonProperty("modules")
     @Schema(description = "The modules available for installation")
-    private @NotNull ModuleList modules;
+    private final @NotNull ModuleList modules;
 
     @JsonProperty("extensions")
     @Schema(description = "The extensions available for installation")
-    private @NotNull ExtensionList extensions;
+    private final @NotNull ExtensionList extensions;
 
     @JsonProperty("hivemqId")
     @Schema(description = "The current id of hivemq edge. Changes at restart.")
-    private @NotNull String hivemqId;
+    private final @NotNull String hivemqId;
 
     @JsonProperty("trackingAllowed")
     @Schema(description = "Is the tracking of user actions allowed.")
-    private boolean trackingAllowed;
+    private final boolean trackingAllowed;
+
+    @JsonProperty("confidentialityAgreement")
+    @Schema(description = "CA configuration")
+    private final @NotNull ConfidentialityAgreement confidentialityAgreement;
 
     @JsonCreator(mode = JsonCreator.Mode.PROPERTIES)
     public GatewayConfiguration(
@@ -82,7 +83,8 @@ public GatewayConfiguration(
             @JsonProperty("modules") final @NotNull ModuleList modules,
             @JsonProperty("extensions") final @NotNull ExtensionList extensions,
             @JsonProperty("hivemqId") final @NotNull String hivemqId,
-            @JsonProperty("trackingAllowed")final boolean trackingAllowed) {
+            @JsonProperty("trackingAllowed") final boolean trackingAllowed,
+            @JsonProperty("confidentialityAgreement") final ConfidentialityAgreement confidentialityAgreement) {
         this.environment = environment;
         this.cloudLink = cloudLink;
         this.gitHubLink = gitHubLink;
@@ -94,6 +96,7 @@ public GatewayConfiguration(
         this.extensions = extensions;
         this.hivemqId = hivemqId;
         this.trackingAllowed = trackingAllowed;
+        this.confidentialityAgreement = confidentialityAgreement;
     }
 
     public @NotNull EnvironmentProperties getEnvironment() {
@@ -131,4 +134,16 @@ public GatewayConfiguration(
     public @NotNull ExtensionList getExtensions() {
         return extensions;
     }
+
+    public @NotNull String getHivemqId() {
+        return hivemqId;
+    }
+
+    public boolean isTrackingAllowed() {
+        return trackingAllowed;
+    }
+
+    public @NotNull ConfidentialityAgreement getConfidentialityAgreement() {
+        return confidentialityAgreement;
+    }
 }