Fix use of mergeidmarker property in MatchIdRulesHandler (#391)

* Rename property mergeidmarker to rules.replacement.marker 
* Update documentation for configuration and rules.replacement.marker
* Update application.properties with comments
* Update all rules with new placeholder key
* Move rules classes into rules package

Author: e-pettersson-ericsson

src/main/java/com/ericsson/ei/config/ConfigurationLogger.java

@@ -38,7 +38,7 @@ private void logConfiguration() {
                 + "rabbitmq.queue.durable: " + environment.getProperty("rabbitmq.queue.durable") + "\n"
                 + "rabbitmq.binding.key: " + environment.getProperty("rabbitmq.binding.key") + "\n"
                 + "rabbitmq.waitlist.queue.suffix: " + environment.getProperty("rabbitmq.waitlist.queue.suffix") + "\n"
-                + "mergeidmarker: " + environment.getProperty("mergeidmarker") + "\n"
+                + "rules.replacement.marker: " + environment.getProperty("rules.replacement.marker") + "\n"
                 + "spring.data.mongodb.host: " + environment.getProperty("spring.data.mongodb.host") + "\n"
                 + "spring.data.mongodb.port: " + environment.getProperty("spring.data.mongodb.port") + "\n"
                 + "spring.data.mongodb.username: " + environment.getProperty("spring.data.mongodb.username") + "\n"

src/main/java/com/ericsson/ei/handlers/DownstreamIdRulesHandler.java

@@ -18,6 +18,7 @@
 
 import java.util.List;
 
+import com.ericsson.ei.rules.MatchIdRulesHandler;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import org.springframework.beans.factory.annotation.Autowired;

src/main/java/com/ericsson/ei/handlers/EventHandler.java

@@ -16,6 +16,7 @@
 */
 package com.ericsson.ei.handlers;
 
+import com.ericsson.ei.rules.IdRulesHandler;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import org.springframework.amqp.core.Message;

src/main/java/com/ericsson/ei/handlers/ExtractionHandler.java

@@ -16,6 +16,7 @@
  */
 package com.ericsson.ei.handlers;
 
+import com.ericsson.ei.rules.ProcessRulesHandler;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import org.springframework.beans.factory.annotation.Autowired;

src/main/java/com/ericsson/ei/jsonmerge/MergeHandler.java

@@ -37,8 +37,8 @@ public class MergeHandler {
 
     private static final Logger LOGGER = LoggerFactory.getLogger(MergeHandler.class);
 
-    @Value("${mergeidmarker}")
-    private String mergeIdMarker;
+    @Value("${rules.replacement.marker}")
+    private String replacementMarker;
 
     @Autowired
     private JmesPathInterface jmesPathInterface;
@@ -57,8 +57,8 @@ public void setPrepareMergePrepareObject(MergePrepare prepareMergePrepareObject)
         this.prepareMergePrepareObject = prepareMergePrepareObject;
     }
 
-    public void setMergeIdMarker(String marker) {
-        mergeIdMarker = marker;
+    public void setReplacementMarker(String marker) {
+        replacementMarker = marker;
     }
 
     /**
@@ -102,7 +102,7 @@ public String mergeObject(String id, String mergeId, RulesObject rules, String e
     }
 
     /**
-     * 
+     *
      * @param id            the id of the aggregated object
      * @param mergeId       the id of the link used to identify this aggregated
      *                      object
@@ -143,18 +143,19 @@ protected String getMergeRules(RulesObject rules) {
     }
 
     /**
-     * The merge rule can contain a placeholder for the ids from IdentifyRules. This
-     * placeholder need to be replaced with an id from the ones extracted with
-     * IdentifyRules before we use it in JMESPath.
-     * 
+     * The merge rule can contain a placeholder for the ids extracted from IdentifyRules.
+     * This placeholder need to be replaced with an id from the ones extracted with
+     * IdentifyRules before we use it in JMESPath. The placeholder is defined in
+     * application.properties as 'rules.replacement.marker'.
+     *
      * @param rule string
      * @param id   that the mergeIdMarker will be replaced with
      * @return JSON object ready to be used in JMESPath
      */
     public String replaceIdMarkerInRules(String rule, String id) {
 
-        if (rule.contains(mergeIdMarker)) {
-            String updatedRule = rule.replaceAll(mergeIdMarker, "\"" + id + "\"");
+        if (rule.contains(replacementMarker)) {
+            String updatedRule = rule.replaceAll(replacementMarker, "\"" + id + "\"");
             updatedRule = "`" + updatedRule + "`";
             return updatedRule;
         }
@@ -175,7 +176,7 @@ public String mergeContentToObject(String aggregatedObject, String preparedObjec
 
     /**
      * Append preparedJsonObject to the given aggregatedJsonObject
-     * 
+     *
      * @param aggregatedJsonObject JSON object
      * @param preparedJsonObject   JSON object
      */
@@ -217,7 +218,7 @@ private void updateJsonObject(JSONObject aggregatedJsonObject, JSONObject prepar
     /**
      * Append JSON elements from preparedJsonObject element-wise into
      * aggregatedJsonObject JSON array
-     * 
+     *
      * @param aggregatedJsonObject JSON array
      * @param preparedJsonObject   JSON array
      */

src/main/java/com/ericsson/ei/notifications/UrlParser.java

@@ -49,6 +49,7 @@ public class UrlParser {
      * the url containing the new parameters.
      *
      * @param url
+     * @param aggregatedObject
      *
      * @return String
      */
@@ -87,7 +88,6 @@ public String runJmesPathOnParameters(String url, String aggregatedObject) {
      * @param url A String containing a URL
      * @return The base url, which excludes context path and parameters.
      * @throws MalformedURLException
-     * @throws URISyntaxException
      */
     public String extractBaseUrl(String url) throws MalformedURLException {
         URL absoluteUrl = new URL(url);
@@ -117,8 +117,7 @@ private String extractContextPath(String url) throws MalformedURLException {
      * @return
      * @throws MalformedURLException
      */
-    private List<NameValuePair> extractUrlParameters(String url)
-            throws MalformedURLException {
+    private List<NameValuePair> extractUrlParameters(String url) throws MalformedURLException {
         URL absoluteUrl = new URL(url);
         String query = absoluteUrl.getQuery();
         List<NameValuePair> params = splitQuery(query);

src/main/java/com/ericsson/ei/handlers/IdRulesHandler.java renamed to src/main/java/com/ericsson/ei/rules/IdRulesHandler.java

@@ -14,10 +14,10 @@
    See the License for the specific language governing permissions and
    limitations under the License.
 */
-package com.ericsson.ei.handlers;
+package com.ericsson.ei.rules;
 
+import com.ericsson.ei.handlers.ExtractionHandler;
 import com.ericsson.ei.jmespath.JmesPathInterface;
-import com.ericsson.ei.rules.RulesObject;
 import com.ericsson.ei.waitlist.WaitListStorageHandler;
 import com.fasterxml.jackson.databind.JsonNode;
 import org.slf4j.Logger;

src/main/java/com/ericsson/ei/handlers/MatchIdRulesHandler.java renamed to src/main/java/com/ericsson/ei/rules/MatchIdRulesHandler.java

@@ -14,11 +14,13 @@
    See the License for the specific language governing permissions and
    limitations under the License.
 */
-package com.ericsson.ei.handlers;
+package com.ericsson.ei.rules;
 
 import java.util.List;
 
+import com.ericsson.ei.handlers.ObjectHandler;
 import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.beans.factory.annotation.Value;
 import org.springframework.stereotype.Component;
 
 import com.ericsson.ei.mongo.MongoQuery;
@@ -28,9 +30,16 @@
 @Component
 public class MatchIdRulesHandler {
 
+    @Value("${rules.replacement.marker:%IdentifyRulesEventId%}")
+    private String replacementMarker;
+
     @Autowired
     private ObjectHandler objHandler;
 
+    /**
+     * This method searches the database for any aggregated objects matching the search condition
+     * written in the rules MatchIdRules.
+     * */
     public List<String> fetchObjectsById(RulesObject ruleObject, String id) {
         String matchIdString = ruleObject.getMatchIdRules();
         String fetchQueryString = replaceIdInRules(matchIdString, id);
@@ -39,11 +48,24 @@ public List<String> fetchObjectsById(RulesObject ruleObject, String id) {
         return objects;
     }
 
-    public static String replaceIdInRules(String matchIdString, String id) {
-        if (matchIdString.contains("%IdentifyRules%")) {
-            return matchIdString.replace("%IdentifyRules%", id);
-        } else if (matchIdString.contains("%IdentifyRules_objid%")) {
-            return matchIdString.replace("%IdentifyRules_objid%", id);
+    /**
+     * This method replaces the 'replacementMarker' placeholder in MatchIdRules with a given Eiffel
+     * event id. The 'replacementMarker' property is defined in application.properties.
+     *
+     * <p>
+     * If 'replacementMarker' is defined as:'%myPlaceHolderId%', <br />
+     * and this method is called with the matchIdString: {"_id": "%myPlaceHolderId%"} <br />
+     * and the id: aaaaaaaa-bbbb-5ccc-8ddd-eeeeeeeeeee0 <br />
+     * the updated string will look like: {"_id":"aaaaaaaa-bbbb-5ccc-8ddd-eeeeeeeeeee0"}
+     * </p>
+     *
+     * @param matchIdString the string containing a placeholder key to be replaced
+     * @param id            the Eiffel event id to replace placeholder with
+     * @return an updated matchIdString
+     */
+    public String replaceIdInRules(String matchIdString, String id) {
+        if (matchIdString.contains(replacementMarker)) {
+            return matchIdString.replace(replacementMarker, id);
         } else {
             return null;
         }

src/main/java/com/ericsson/ei/handlers/ProcessRulesHandler.java renamed to src/main/java/com/ericsson/ei/rules/ProcessRulesHandler.java

@@ -14,24 +14,26 @@
    See the License for the specific language governing permissions and
    limitations under the License.
 */
-package com.ericsson.ei.handlers;
+package com.ericsson.ei.rules;
 
-import com.ericsson.ei.rules.RulesHandler;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.beans.factory.annotation.Value;
 import org.springframework.stereotype.Component;
 
 import com.ericsson.ei.jmespath.JmesPathInterface;
 import com.ericsson.ei.jsonmerge.MergeHandler;
-import com.ericsson.ei.rules.RulesObject;
 import com.fasterxml.jackson.databind.JsonNode;
 
 @Component
 public class ProcessRulesHandler {
 
     private static final Logger LOGGER = LoggerFactory.getLogger(ProcessRulesHandler.class);
 
+    @Value("${rules.replacement.marker:%IdentifyRulesEventId%}")
+    private String replacementMarker;
+
     @Autowired
     private JmesPathInterface jmespath;
 
@@ -55,8 +57,8 @@ public String runProcessRules(String event, RulesObject rulesObject, String aggr
             String identifyRule = rulesHandler.getRulesForEvent(event).getIdentifyRules();
             String id = jmespath.runRuleOnEvent(identifyRule, event).get(0).textValue();
 
-            if(processRules.contains("%IdentifyRules%")) {
-                processRules = processRules.replace("%IdentifyRules%", id);
+            if(processRules.contains(replacementMarker)) {
+                processRules = processRules.replace(replacementMarker, id);
             }
 
             LOGGER.info("processRules: {}\n aggregationObject: {}\n event: {}", processRules, aggregationObject, event);

src/main/java/com/ericsson/ei/waitlist/WaitListWorker.java

@@ -28,7 +28,7 @@
 import org.springframework.stereotype.Component;
 
 import com.ericsson.ei.handlers.EventToObjectMapHandler;
-import com.ericsson.ei.handlers.MatchIdRulesHandler;
+import com.ericsson.ei.rules.MatchIdRulesHandler;
 import com.ericsson.ei.handlers.RMQHandler;
 import com.ericsson.ei.jmespath.JmesPathInterface;
 import com.ericsson.ei.rules.RulesHandler;