docs: add commend for method ConfigObject.checkAttributeCombinations().

flyisland · Mar 30, 2021 · da79cb4 · da79cb4
1 parent e88d642
commit da79cb4
Showing 1 changed file with 13 additions and 0 deletions.
diff --git a/src/main/java/com/solace/tools/sempcfg/model/ConfigObject.java b/src/main/java/com/solace/tools/sempcfg/model/ConfigObject.java
@@ -190,6 +190,19 @@ public void removeAttributesWithDefaultValue() {
         forEachChild(ConfigObject::removeAttributesWithDefaultValue);
     }
 
+    /**
+     * For example, below is the description of POST action of URI: /msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/restConsumers,
+     * means that if attribute `remotePort` is present in the payload, then attribute `tlsEnabled` is required in the payload too.
+     *
+     *| Class                               | Attribute                        | Requires                        | Conflicts |
+     * | :---------------------------------- | :------------------------------- | :------------------------------ | :-------- |
+     * | MsgVpnRestDeliveryPointRestConsumer | authenticationClientCertPassword | authenticationClientCertContent |
+     * | MsgVpnRestDeliveryPointRestConsumer | authenticationHttpBasicPassword  | authenticationHttpBasicUsername |
+     * | MsgVpnRestDeliveryPointRestConsumer | authenticationHttpBasicUsername  | authenticationHttpBasicPassword |
+     * | MsgVpnRestDeliveryPointRestConsumer | remotePort                       | tlsEnabled                      |
+     * | MsgVpnRestDeliveryPointRestConsumer | tlsEnabled                       | remotePort                      |
+     */
+
     public void checkAttributeCombinations() {
         var requiresAttributesWithDefalutValue = sempSpec.getRequiresAttributeWithDefaultValue(attributes.keySet());
         attributes.putAll(requiresAttributesWithDefalutValue);