Remove messageHandlingOptions which were accidentally added back to the API (#1172)

* Remove messageHandlingOptions which were accidentally added back to the API
---------

Co-authored-by: marregui <[email protected]>

Author: codepitbull

ext/35771.md

@@ -5837,12 +5837,6 @@ components:
           format: int64
           description: The message expiry interval.
           default: 9007199254740991L
-        messageHandlingOptions:
-          type: string
-          description: How collected tags should or shouldn't be aggregated.
-          enum:
-            - MQTTMessagePerTag
-            - MQTTMessagePerSubscription
         tagName:
           type: string
           format: mqtt-tag

ext/hivemq-edge-openapi-2025.16-SNAPSHOT.yaml

@@ -16,12 +16,6 @@ properties:
     format: int64
     description: The message expiry interval.
     default: 9007199254740991L
-  messageHandlingOptions:
-    type: string
-    description: How collected tags should or shouldn't be aggregated.
-    enum:
-      - MQTTMessagePerTag
-      - MQTTMessagePerSubscription
   tagName:
     type: string
     format: mqtt-tag

hivemq-edge-openapi/openapi/components/schemas/NorthboundMapping.yaml

@@ -17,7 +17,6 @@
 
 import com.fasterxml.jackson.annotation.JsonCreator;
 import com.fasterxml.jackson.annotation.JsonProperty;
-import com.hivemq.adapter.sdk.api.config.MessageHandlingOptions;
 import com.hivemq.adapter.sdk.api.config.MqttUserProperty;
 import com.hivemq.api.model.QoSModel;
 import com.hivemq.configuration.entity.adapter.MqttUserPropertyEntity;
@@ -43,10 +42,6 @@ public class NorthboundMappingModel {
     @Schema(description = "The target mqtt topic where received tags should be sent to.")
     private final @NotNull String topic;
 
-    @JsonProperty(value = "messageHandlingOptions", required = true)
-    @Schema(description = "How collected tags should or shouldn't be aggregated.")
-    private final @NotNull MessageHandlingOptions messageHandlingOptions;
-
     @JsonProperty(value = "includeTagNames", required = true)
     @Schema(description = "Should tag names be included when sent out.")
     private final boolean includeTagNames;
@@ -71,16 +66,13 @@ public class NorthboundMappingModel {
     public NorthboundMappingModel(
             @JsonProperty(value = "tagName", required = true) final @NotNull String tagName,
             @JsonProperty(value = "topic", required = true) final @NotNull String topic,
-            @JsonProperty(value = "messageHandlingOptions") final @Nullable MessageHandlingOptions messageHandlingOptions,
             @JsonProperty(value = "includeTagNames") final @Nullable Boolean includeTagNames,
             @JsonProperty(value = "includeTimestamp") final @Nullable Boolean includeTimestamp,
             @JsonProperty(value = "userProperties") final @Nullable List<MqttUserPropertyModel> userProperties,
             @JsonProperty(value = "maxQoS") final @Nullable QoSModel maxQoS,
             @JsonProperty(value = "messageExpiryInterval") final @Nullable Long messageExpiryInterval) {
         this.tagName = tagName;
         this.topic = topic;
-        this.messageHandlingOptions =
-                requireNonNullElse(messageHandlingOptions, MessageHandlingOptions.MQTTMessagePerTag);
         this.includeTagNames = requireNonNullElse(includeTagNames, false);
         this.includeTimestamp = requireNonNullElse(includeTimestamp, false);
         this.userProperties = requireNonNullElse(userProperties, List.of());
@@ -94,7 +86,6 @@ public NorthboundMappingModel(
     public static NorthboundMappingModel fromPersistence(final @NotNull NorthboundMapping mapping) {
         return new NorthboundMappingModel(mapping.getTagName(),
                 mapping.getMqttTopic(),
-                mapping.getMessageHandlingOptions(),
                 mapping.getIncludeTagNames(),
                 mapping.getIncludeTimestamp(),
                 mapping.getUserProperties().stream().map(NorthboundMappingModel::userProp).toList(),
@@ -105,7 +96,6 @@ public static NorthboundMappingModel fromPersistence(final @NotNull NorthboundMa
     public static NorthboundMappingModel fromEntity(final @NotNull NorthboundMappingEntity northboundMapping) {
         return new NorthboundMappingModel(northboundMapping.getTagName(),
                 northboundMapping.getTopic(),
-                northboundMapping.getMessageHandlingOptions(),
                 northboundMapping.isIncludeTagNames(),
                 northboundMapping.isIncludeTimestamp(),
                 northboundMapping.getUserProperties().stream().map(NorthboundMappingModel::userProp).toList(),
@@ -131,7 +121,6 @@ public static NorthboundMappingModel fromEntity(final @NotNull NorthboundMapping
         return new NorthboundMapping(tagName,
                 topic,
                 maxQoS.getQosNumber(),
-                messageHandlingOptions,
                 includeTagNames,
                 includeTimestamp,
                 userProperties.stream().map(NorthboundMappingModel::userProp).toList(),
@@ -146,10 +135,6 @@ public static NorthboundMappingModel fromEntity(final @NotNull NorthboundMapping
         return topic;
     }
 
-    public @NotNull MessageHandlingOptions getMessageHandlingOptions() {
-        return messageHandlingOptions;
-    }
-
     public boolean isIncludeTagNames() {
         return includeTagNames;
     }

hivemq-edge/src/main/java/com/hivemq/api/model/mappings/northbound/NorthboundMappingModel.java

@@ -41,9 +41,6 @@ public class NorthboundMappingEntity implements EntityValidatable {
     @XmlElement(name = "maxQos", required = true)
     private final int maxQoS;
 
-    @XmlElement(name = "messageHandlingOptions", required = true)
-    private final @NotNull MessageHandlingOptions messageHandlingOptions;
-
     @XmlElement(name = "includeTagNames", required = true)
     private final @Nullable Boolean includeTagNames;
 
@@ -62,7 +59,6 @@ public NorthboundMappingEntity() {
         tagName = "";
         topic = "";
         maxQoS = QoS.AT_LEAST_ONCE.getQosNumber();
-        messageHandlingOptions = MessageHandlingOptions.MQTTMessagePerTag;
         includeTagNames = false;
         includeTimestamp = true;
         userProperties = new ArrayList<>();
@@ -73,15 +69,13 @@ public NorthboundMappingEntity(
             final @NotNull String tagName,
             final @NotNull String topic,
             final int maxQoS,
-            final @NotNull MessageHandlingOptions messageHandlingOptions,
             final boolean includeTagNames,
             final boolean includeTimestamp,
             final @NotNull List<MqttUserPropertyEntity> userProperties,
             final @Nullable Long messageExpiryInterval) {
         this.tagName = tagName;
         this.topic = topic;
         this.maxQoS = maxQoS;
-        this.messageHandlingOptions = messageHandlingOptions;
         this.includeTagNames = includeTagNames;
         this.includeTimestamp = includeTimestamp;
         this.userProperties = userProperties;
@@ -92,7 +86,6 @@ public NorthboundMappingEntity(
         return new NorthboundMappingEntity(mapping.getTagName(),
                 mapping.getMqttTopic(),
                 mapping.getMqttQos(),
-                mapping.getMessageHandlingOptions(),
                 mapping.getIncludeTagNames(),
                 mapping.getIncludeTimestamp(),
                 mapping.getUserProperties().stream().map(NorthboundMappingEntity::userProp).toList(),
@@ -115,7 +108,6 @@ public NorthboundMappingEntity(
                     case AT_LEAST_ONCE -> 1;
                     case EXACTLY_ONCE -> 2;
                 },
-                MessageHandlingOptions.MQTTMessagePerTag,
                 mapping.getIncludeTagNames(),
                 mapping.getIncludeTimestamp(),
                 mapping.getUserProperties().stream().map(NorthboundMappingEntity::userProp).toList(),
@@ -131,7 +123,7 @@ public NorthboundMappingEntity(
     }
 
     public @NotNull MessageHandlingOptions getMessageHandlingOptions() {
-        return messageHandlingOptions;
+        return MessageHandlingOptions.MQTTMessagePerTag;
     }
 
     public boolean isIncludeTagNames() {
@@ -161,7 +153,6 @@ public void validate(final @NotNull List<ValidationEvent> validationEvents) {
         EntityValidatable.notMatch(validationEvents,
                 () -> QoS.valueOf(maxQoS) != null,
                 () -> "maxQos" + ' ' + maxQoS + " is invalid");
-        EntityValidatable.notNull(validationEvents, messageHandlingOptions, "messageHandlingOptions");
         EntityValidatable.notNull(validationEvents, includeTagNames, "includeTagNames");
         EntityValidatable.notNull(validationEvents, includeTimestamp, "includeTimestamp");
         if (EntityValidatable.notNull(validationEvents, messageExpiryInterval, "messageExpiryInterval")) {
@@ -175,7 +166,6 @@ public void validate(final @NotNull List<ValidationEvent> validationEvents) {
         return new NorthboundMapping(tagName,
                 topic,
                 maxQoS,
-                messageHandlingOptions,
                 includeTagNames,
                 includeTimestamp,
                 userProperties.stream().map(p -> new MqttUserProperty(p.getName(), p.getValue())).toList(),
@@ -193,8 +183,6 @@ public void validate(final @NotNull List<ValidationEvent> validationEvents) {
                 '\'' +
                 ", maxQoS=" +
                 maxQoS +
-                ", messageHandlingOptions=" +
-                messageHandlingOptions +
                 ", includeTagNames=" +
                 includeTagNames +
                 ", includeTimestamp=" +
@@ -212,7 +200,6 @@ public boolean equals(final @Nullable Object o) {
             return Objects.equals(tagName, that.tagName) &&
                     Objects.equals(topic, that.topic) &&
                     maxQoS == that.maxQoS &&
-                    messageHandlingOptions == that.messageHandlingOptions &&
                     includeTagNames == that.includeTagNames &&
                     includeTimestamp == that.includeTimestamp &&
                     Objects.equals(userProperties, that.userProperties) &&
@@ -226,7 +213,6 @@ public int hashCode() {
         return Objects.hash(tagName,
                 topic,
                 maxQoS,
-                messageHandlingOptions,
                 includeTagNames,
                 includeTimestamp,
                 userProperties,

hivemq-edge/src/main/java/com/hivemq/configuration/entity/adapter/NorthboundMappingEntity.java

@@ -35,7 +35,6 @@ public class NorthboundMapping implements PollingContext {
     private final @NotNull String topic;
     private final @NotNull String tagName;
     private final int maxQoS;
-    private final @NotNull MessageHandlingOptions messageHandlingOptions;
     private final @NotNull Boolean includeTagNames;
     private final @NotNull Boolean includeTimestamp;
     private final @NotNull List<MqttUserProperty> userProperties;
@@ -45,16 +44,13 @@ public NorthboundMapping(
             final @NotNull String tagName,
             final @NotNull String topic,
             final int maxQoS,
-            final @Nullable MessageHandlingOptions messageHandlingOptions,
             final @Nullable Boolean includeTagNames,
             final @Nullable Boolean includeTimestamp,
             final @Nullable List<MqttUserProperty> userProperties,
             final @Nullable Long messageExpiryInterval) {
         this.tagName = tagName;
         this.topic = topic;
         this.maxQoS = maxQoS;
-        this.messageHandlingOptions =
-                messageHandlingOptions != null ? messageHandlingOptions : MessageHandlingOptions.MQTTMessagePerTag;
         this.includeTagNames = includeTagNames != null && includeTagNames;
         this.includeTimestamp = includeTimestamp == null || includeTimestamp; // default is true
         this.userProperties = userProperties != null ? userProperties : new ArrayList<>();
@@ -69,7 +65,6 @@ public NorthboundMapping(
         return new NorthboundMapping(model.getTagName(),
                 model.getTopic(),
                 model.getMaxQoS() == null ? DEFAULT_QOS : model.getMaxQoS().ordinal(),
-                MessageHandlingOptions.MQTTMessagePerTag,
                 model.getIncludeTagNames() != null && model.getIncludeTagNames(),
                 model.getIncludeTimestamp() == null || model.getIncludeTimestamp(),
                 model.getUserProperties() != null ?
@@ -95,7 +90,7 @@ public int getMqttQos() {
 
     @Override
     public @NotNull MessageHandlingOptions getMessageHandlingOptions() {
-        return messageHandlingOptions;
+        return MessageHandlingOptions.MQTTMessagePerTag;
     }
 
     @Override
@@ -124,7 +119,6 @@ public boolean equals(final @Nullable Object o) {
             return Objects.equals(tagName, that.tagName) &&
                     Objects.equals(topic, that.topic) &&
                     maxQoS == that.maxQoS &&
-                    messageHandlingOptions == that.messageHandlingOptions &&
                     Objects.equals(includeTagNames, that.includeTagNames) &&
                     Objects.equals(includeTimestamp, that.includeTimestamp) &&
                     Objects.equals(userProperties, that.userProperties) &&
@@ -139,7 +133,6 @@ public int hashCode() {
         return Objects.hash(tagName,
                 topic,
                 maxQoS,
-                messageHandlingOptions,
                 includeTagNames,
                 includeTimestamp,
                 userProperties,
@@ -154,10 +147,7 @@ public int hashCode() {
                 '\'' +
                 ", tagName='" +
                 tagName +
-                '\'' +
-                ", messageHandlingOptions=" +
-                messageHandlingOptions +
-                ", includeTagNames=" +
+                "', includeTagNames=" +
                 includeTagNames +
                 ", includeTimestamp=" +
                 includeTimestamp +

hivemq-edge/src/main/java/com/hivemq/persistence/mappings/NorthboundMapping.java

@@ -15,7 +15,6 @@
  */
 package com.hivemq.api.model.mappings.northbound;
 
-import com.hivemq.adapter.sdk.api.config.MessageHandlingOptions;
 import com.hivemq.api.model.JavaScriptConstants;
 import com.hivemq.api.model.QoSModel;
 import com.hivemq.persistence.mappings.NorthboundMapping;
@@ -33,7 +32,6 @@ void test_constructor_whenInputExpiryIsMaxLong_thenStoredExpiryIsMaxSafeJSValue(
         assertEquals(JavaScriptConstants.JS_MAX_SAFE_INTEGER,
                 new NorthboundMappingModel("tag",
                         "topic",
-                        MessageHandlingOptions.MQTTMessagePerSubscription,
                         false,
                         false,
                         List.of(),
@@ -45,7 +43,6 @@ void test_constructor_whenInputExpiryIsMaxLong_thenStoredExpiryIsMaxSafeJSValue(
     void test_to_whenMessageExpiryMaxSafeValue_thenParsedValueIsMaxLong() {
         final NorthboundMappingModel northboundMappingModel = new NorthboundMappingModel("tag",
                 "topic",
-                MessageHandlingOptions.MQTTMessagePerSubscription,
                 false,
                 false,
                 List.of(),

hivemq-edge/src/test/java/com/hivemq/api/model/mappings/northbound/NorthboundMappingModelTest.java

@@ -15,7 +15,6 @@
  */
 package com.hivemq.configuration.reader;
 
-import com.hivemq.adapter.sdk.api.config.MessageHandlingOptions;
 import com.hivemq.configuration.entity.HiveMQConfigEntity;
 import com.hivemq.configuration.entity.adapter.NorthboundMappingEntity;
 import com.hivemq.configuration.entity.adapter.ProtocolAdapterEntity;
@@ -114,49 +113,6 @@ public void whenNorthboundMappingQoSIsProvided_thenApplyConfigShouldWorkAsExpect
         }
     }
 
-    @ParameterizedTest
-    @CsvSource({"true,MQTTMessagePerTag", "true,MQTTMessagePerSubscription", "false,abc"})
-    public void whenNorthboundMappingMessageHandlingOptionsIsProvided_thenApplyConfigShouldWorkAsExpected(
-            final boolean valid,
-            final @NotNull String messageHandlingOptions)
-            throws IOException {
-        final ConfigFileReaderWriter configFileReader = getConfigFileReaderWriter("""
-                <hivemq>
-                  <protocol-adapters>
-                    <protocol-adapter>
-                      <adapterId>simInvalid</adapterId>
-                      <protocolId>simulation</protocolId>
-                      <configVersion>1</configVersion>
-                      <config>
-                        <pollingIntervalMillis>123</pollingIntervalMillis>
-                        <timeout>10000</timeout>
-                        <minDelay>0</minDelay>
-                        <maxDelay>0</maxDelay>
-                      </config>
-                      <northboundMappings>
-                        <northboundMapping>
-                          <topic>MTConnect/my-steams</topic>
-                          <tagName>tag1</tagName>
-                          <messageHandlingOptions>${messageHandlingOptions}</messageHandlingOptions>
-                        </northboundMapping>
-                      </northboundMappings>
-                      <tags>
-                        <tag>
-                          <name>tag1</name>
-                          <description>description1</description>
-                        </tag>
-                      </tags>
-                    </protocol-adapter>
-                  </protocol-adapters>
-                </hivemq>
-                """.replace("${messageHandlingOptions}", messageHandlingOptions));
-        if (valid) {
-            assertThat(configFileReader.applyConfig()).isNotNull();
-        } else {
-            assertThatThrownBy(configFileReader::applyConfig).isInstanceOf(UnrecoverableException.class);
-        }
-    }
-
     @ParameterizedTest
     @CsvSource({"true,true", "true,false", "false,abc"})
     public void whenNorthboundMappingIncludeTagNamesIsProvided_thenApplyConfigShouldWorkAsExpected(
@@ -414,14 +370,8 @@ public void whenNoTags_setConfigurationShouldReturnFalse() throws IOException {
         final ConfigFileReaderWriter configFileReader = getConfigFileReaderWriter();
         final HiveMQConfigEntity entity = configFileReader.applyConfig();
         assertThat(entity).isNotNull();
-        final NorthboundMappingEntity northboundMappingEntity = new NorthboundMappingEntity("tagName",
-                "topic",
-                1,
-                MessageHandlingOptions.MQTTMessagePerTag,
-                false,
-                true,
-                List.of(),
-                100L);
+        final NorthboundMappingEntity northboundMappingEntity =
+                new NorthboundMappingEntity("tagName", "topic", 1, false, true, List.of(), 100L);
         final ProtocolAdapterEntity protocolAdapterEntity = new ProtocolAdapterEntity("adapterId",
                 "protocolId",
                 1,
@@ -438,14 +388,8 @@ public void whenNorthboundMappingTagNameAreNotFound_setConfigurationShouldReturn
         final ConfigFileReaderWriter configFileReader = getConfigFileReaderWriter();
         final HiveMQConfigEntity entity = configFileReader.applyConfig();
         assertThat(entity).isNotNull();
-        final NorthboundMappingEntity northboundMappingEntity = new NorthboundMappingEntity("tagName",
-                "topic",
-                1,
-                MessageHandlingOptions.MQTTMessagePerTag,
-                false,
-                true,
-                List.of(),
-                100L);
+        final NorthboundMappingEntity northboundMappingEntity =
+                new NorthboundMappingEntity("tagName", "topic", 1, false, true, List.of(), 100L);
         final ProtocolAdapterEntity protocolAdapterEntity = new ProtocolAdapterEntity("adapterId",
                 "protocolId",
                 1,
@@ -466,14 +410,8 @@ public void whenNorthboundMappingTagNameOrTopicIsEmpty_setConfigurationShouldRet
         final ConfigFileReaderWriter configFileReader = getConfigFileReaderWriter();
         final HiveMQConfigEntity entity = configFileReader.applyConfig();
         assertThat(entity).isNotNull();
-        final NorthboundMappingEntity northboundMappingEntity = new NorthboundMappingEntity(tagName,
-                topic,
-                1,
-                MessageHandlingOptions.MQTTMessagePerTag,
-                false,
-                true,
-                List.of(),
-                100L);
+        final NorthboundMappingEntity northboundMappingEntity =
+                new NorthboundMappingEntity(tagName, topic, 1, false, true, List.of(), 100L);
         final ProtocolAdapterEntity protocolAdapterEntity = new ProtocolAdapterEntity("adapterId",
                 "protocolId",
                 1,