Remove duplicate logging (#466)

Add javadoc on some public methods
Simplified complex methods

Author: e-pettersson-ericsson

src/main/java/com/ericsson/ei/services/ISubscriptionService.java

@@ -31,7 +31,6 @@ public interface ISubscriptionService {
      *
      * @param subscription
      * @throws JsonProcessingException
-     * @throws EncryptorException
      * @throws MongoWriteException
      */
     void addSubscription(Subscription subscription) throws JsonProcessingException, MongoWriteException;

src/main/java/com/ericsson/ei/services/SubscriptionService.java

@@ -121,6 +121,15 @@ public boolean doSubscriptionExist(String subscriptionName) {
         return !list.isEmpty();
     }
 
+    /**
+     * Finds an existing subscription and replaces with a new updated subscription. If the update
+     * was successful, any previous matches on aggregations for the old subscription is cleaned from
+     * the database.
+     *
+     * @param subscription the updated subscription to save in the database
+     * @param subscriptionName the name of the existing subscription which will be updated
+     * @return boolean result of the update operation
+     * */
     @Override
     public boolean modifySubscription(Subscription subscription, String subscriptionName) {
         ObjectMapper mapper = new ObjectMapper();
@@ -132,14 +141,7 @@ public boolean modifySubscription(Subscription subscription, String subscription
             query = generateQuery(subscriptionName, ldapUserName);
             result = subscriptionRepository.modifySubscription(query, stringSubscription);
             if (result != null) {
-                String subscriptionIdQuery = String.format(SUBSCRIPTION_ID, subscriptionName);
-                if (!cleanSubscriptionRepeatFlagHandlerDb(subscriptionIdQuery)) {
-                    LOGGER.info("Subscription  \"{}"
-                            + "\" matched aggregated objects id from repeat flag handler database could not be cleaned during the update of the subscription,\n"
-                            + "probably due to subscription has never matched any aggregated objects and "
-                            + "no matched aggregated objects id has been stored in database for the specific subscription.",
-                            subscriptionName);
-                }
+                cleanSubscriptionRepeatFlagHandlerDb(subscriptionName);
             }
 
         } catch (JSONException | JsonProcessingException e) {
@@ -149,20 +151,20 @@ public boolean modifySubscription(Subscription subscription, String subscription
         return true;
     }
 
+    /**
+     * Removes a given subscription from the database. If the operation was successful, any previous
+     * matches on aggregations for the removed subscription is also cleaned from the database.
+     *
+     * @param subscriptionName the name of the subscription to delete
+     * @return boolean result of the delete operation
+     * */
     @Override
     public boolean deleteSubscription(String subscriptionName) throws AccessException {
         String ldapUserName = getLdapUserName(subscriptionName);
         String deleteQuery = generateQuery(subscriptionName, ldapUserName);
         boolean deleteResult = subscriptionRepository.deleteSubscription(deleteQuery);
         if (deleteResult) {
-            String subscriptionIdQuery = String.format(SUBSCRIPTION_ID, subscriptionName);
-            if (!cleanSubscriptionRepeatFlagHandlerDb(subscriptionIdQuery)) {
-                LOGGER.info("Subscription  \"{}"
-                        + "\" matched aggregated objects id from repeat flag handler database could not be cleaned during the removal of subscription,\n"
-                        + "probably due to subscription has never matched any aggregated objects and "
-                        + "no matched aggregated objects id has been stored in database for the specific subscription.",
-                        subscriptionName);
-            }
+            cleanSubscriptionRepeatFlagHandlerDb(subscriptionName);
         } else if (doSubscriptionExist(subscriptionName)) {
             String message = "Failed to delete subscription \"" + subscriptionName
                     + "\" invalid ldapUserName";
@@ -172,6 +174,11 @@ public boolean deleteSubscription(String subscriptionName) throws AccessExceptio
         return deleteResult;
     }
 
+    /**
+     * Retrieves all existing subscriptions from the database in a list.
+     *
+     * @throws SubscriptionNotFoundException if no subscriptions exists in the database
+     * */
     @Override
     public List<Subscription> getSubscriptions() throws SubscriptionNotFoundException {
         String query = "{}";
@@ -215,13 +222,12 @@ private Subscription doEncryption(Subscription subscription) {
         return subscription;
     }
 
-    private boolean cleanSubscriptionRepeatFlagHandlerDb(String subscriptionNameQuery) {
-        LOGGER.debug(
-                "Cleaning and removing matched subscriptions AggrObjIds in ReapeatHandlerFlag database with query: {}",
-                subscriptionNameQuery);
+    private void cleanSubscriptionRepeatFlagHandlerDb(String subscriptionName) {
+        LOGGER.debug("Cleaning up previously matched aggregations for subscription: {}.",
+                subscriptionName);
+        String subscriptionIdQuery = String.format(SUBSCRIPTION_ID, subscriptionName);
         MongoDBHandler mongoDbHandler = subscriptionRepository.getMongoDbHandler();
-        return mongoDbHandler.dropDocument(dataBaseName, repeatFlagHandlerCollection,
-                subscriptionNameQuery);
+        mongoDbHandler.dropDocument(dataBaseName, repeatFlagHandlerCollection, subscriptionIdQuery);
     }
 
     /**