Integrate Logging Library

Updated SO to use ONAP provided filters and constants to meet logging
standards.
Removed redundant classes
Updated constant references

Issue-ID: SO-2301
Signed-off-by: Benjamin, Max (mb388a) <mb388a@att.com>
Change-Id: Ia4e3c2b1a4dcb3881aa34d39885c8b2782880d64

6 files changed, 95 insertions, 55 deletions

diff --git a/adapters/mso-openstack-adapters/src/main/java/org/onap/so/adapters/audit/AbstractAuditService.java b/adapters/mso-openstack-adapters/src/main/java/org/onap/so/adapters/audit/AbstractAuditService.java
index 493ac4a54f..0c05df959f 100644
--- a/adapters/mso-openstack-adapters/src/main/java/org/onap/so/adapters/audit/AbstractAuditService.java
+++ b/adapters/mso-openstack-adapters/src/main/java/org/onap/so/adapters/audit/AbstractAuditService.java
@@ -25,6 +25,7 @@ import java.util.Optional;
 import org.onap.so.objects.audit.AAIObjectAudit;
 import org.onap.so.objects.audit.AAIObjectAuditList;
 import org.onap.so.utils.ExternalTaskUtils;
+import org.onap.logging.filter.base.ONAPComponents;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import org.springframework.beans.factory.annotation.Autowired;
@@ -79,5 +80,4 @@ public abstract class AbstractAuditService extends ExternalTaskUtils {
             return false;
         }
     }
-
 }
diff --git a/adapters/mso-openstack-adapters/src/main/java/org/onap/so/adapters/audit/AuditCreateStackService.java b/adapters/mso-openstack-adapters/src/main/java/org/onap/so/adapters/audit/AuditCreateStackService.java
index d03c86ac30..54ffc597f4 100644
--- a/adapters/mso-openstack-adapters/src/main/java/org/onap/so/adapters/audit/AuditCreateStackService.java
+++ b/adapters/mso-openstack-adapters/src/main/java/org/onap/so/adapters/audit/AuditCreateStackService.java
@@ -30,6 +30,7 @@ import org.camunda.bpm.client.task.ExternalTaskService;
 import org.onap.logging.ref.slf4j.ONAPLogConstants;
 import org.onap.so.audit.beans.AuditInventory;
 import org.onap.so.client.graphinventory.GraphInventoryCommonObjectMapperProvider;
+import org.onap.so.externaltasks.logging.AuditMDCSetup;
 import org.onap.so.objects.audit.AAIObjectAuditList;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
@@ -44,14 +45,17 @@ public class AuditCreateStackService extends AbstractAuditService {
     @Autowired
     public HeatStackAudit heatStackAudit;
 
+    @Autowired
+    private AuditMDCSetup mdcSetup;
+
     protected void executeExternalTask(ExternalTask externalTask, ExternalTaskService externalTaskService) {
-        setupMDC(externalTask);
+        mdcSetup.setupMDC(externalTask);
         AuditInventory auditInventory = externalTask.getVariable("auditInventory");
         Map<String, Object> variables = new HashMap<>();
         boolean success = false;
         try {
-            logger.info("Executing External Task Audit Inventory, Retry Number: {} \n {}", auditInventory,
-                    externalTask.getRetries());
+            Integer retryCount = externalTask.getRetries();
+            logger.info("Executing External Task Audit Inventory, Retry Number: {} \n {}", auditInventory, retryCount);
             Optional<AAIObjectAuditList> auditListOpt = heatStackAudit.auditHeatStack(auditInventory.getCloudRegion(),
                     auditInventory.getCloudOwner(), auditInventory.getTenantId(), auditInventory.getHeatStackName());
             if (auditListOpt.isPresent()) {
@@ -65,29 +69,35 @@ public class AuditCreateStackService extends AbstractAuditService {
             logger.error("Error during audit of stack", e);
         }
         variables.put("auditIsSuccessful", success);
+        mdcSetup.setElapsedTime();
+        String externalTaskId = externalTask.getId();
         if (success) {
             externalTaskService.complete(externalTask, variables);
-            logger.debug("The External Task Id: {}  Successful", externalTask.getId());
+            mdcSetup.setResponseCode(ONAPLogConstants.ResponseStatus.COMPLETE.toString());
+            logger.debug("The External Task Id: {}  Successful", externalTaskId);
             logger.info(ONAPLogConstants.Markers.EXIT, "Exiting");
+            mdcSetup.clearClientMDCs();
         } else {
-            if (externalTask.getRetries() == null) {
+            Integer retryCount = externalTask.getRetries();
+            if (retryCount == null) {
                 logger.debug("The External Task Id: {}  Failed, Setting Retries to Default Start Value: {}",
-                        externalTask.getId(), getRetrySequence().length);
+                        externalTaskId, getRetrySequence().length);
                 externalTaskService.handleFailure(externalTask, UNABLE_TO_FIND_ALL_V_SERVERS_AND_L_INTERACES_IN_A_AI,
                         UNABLE_TO_FIND_ALL_V_SERVERS_AND_L_INTERACES_IN_A_AI, getRetrySequence().length, 10000);
-            } else if (externalTask.getRetries() != null && externalTask.getRetries() - 1 == 0) {
-                logger.debug("The External Task Id: {}  Failed, All Retries Exhausted", externalTask.getId());
+            } else if (retryCount != null && retryCount - 1 == 0) {
                 externalTaskService.complete(externalTask, variables);
+                mdcSetup.setResponseCode(ONAPLogConstants.ResponseStatus.ERROR.toString());
+                logger.debug("The External Task Id: {}  Failed, All Retries Exhausted", externalTaskId);
                 logger.info(ONAPLogConstants.Markers.EXIT, "Exiting");
+                mdcSetup.clearClientMDCs();
             } else {
                 logger.debug("The External Task Id: {}  Failed, Decrementing Retries: {} , Retry Delay: ",
-                        externalTask.getId(), externalTask.getRetries() - 1,
-                        calculateRetryDelay(externalTask.getRetries()));
+                        externalTaskId, retryCount - 1, calculateRetryDelay(retryCount));
                 externalTaskService.handleFailure(externalTask, UNABLE_TO_FIND_ALL_V_SERVERS_AND_L_INTERACES_IN_A_AI,
-                        UNABLE_TO_FIND_ALL_V_SERVERS_AND_L_INTERACES_IN_A_AI, externalTask.getRetries() - 1,
-                        calculateRetryDelay(externalTask.getRetries()));
+                        UNABLE_TO_FIND_ALL_V_SERVERS_AND_L_INTERACES_IN_A_AI, retryCount - 1,
+                        calculateRetryDelay(retryCount));
             }
-            logger.debug("The External Task Id: {} Failed", externalTask.getId());
+            logger.debug("The External Task Id: {} Failed", externalTaskId);
         }
     }
 
diff --git a/adapters/mso-openstack-adapters/src/main/java/org/onap/so/adapters/audit/AuditDeleteStackService.java b/adapters/mso-openstack-adapters/src/main/java/org/onap/so/adapters/audit/AuditDeleteStackService.java
index 0aa4f9bdc3..9a4f154347 100644
--- a/adapters/mso-openstack-adapters/src/main/java/org/onap/so/adapters/audit/AuditDeleteStackService.java
+++ b/adapters/mso-openstack-adapters/src/main/java/org/onap/so/adapters/audit/AuditDeleteStackService.java
@@ -28,6 +28,7 @@ import org.camunda.bpm.client.task.ExternalTaskService;
 import org.onap.logging.ref.slf4j.ONAPLogConstants;
 import org.onap.so.audit.beans.AuditInventory;
 import org.onap.so.client.graphinventory.GraphInventoryCommonObjectMapperProvider;
+import org.onap.so.externaltasks.logging.AuditMDCSetup;
 import org.onap.so.objects.audit.AAIObjectAuditList;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
@@ -44,6 +45,9 @@ public class AuditDeleteStackService extends AbstractAuditService {
     protected HeatStackAudit heatStackAudit;
 
     @Autowired
+    private AuditMDCSetup mdcSetup;
+
+    @Autowired
     protected AuditVServer auditVservers;
 
     @Autowired
@@ -53,12 +57,13 @@ public class AuditDeleteStackService extends AbstractAuditService {
     protected Environment env;
 
     protected void executeExternalTask(ExternalTask externalTask, ExternalTaskService externalTaskService) {
-        setupMDC(externalTask);
+        mdcSetup.setupMDC(externalTask);
         AuditInventory auditInventory = externalTask.getVariable("auditInventory");
         Map<String, Object> variables = new HashMap<>();
         boolean success = false;
         try {
-            logger.info("Executing External Task Delete Audit Inventory. Retry Number: {}", externalTask.getRetries());
+            Integer retryCount = externalTask.getRetries();
+            logger.info("Executing External Task Delete Audit Inventory. Retry Number: {}", retryCount);
             Optional<AAIObjectAuditList> auditListOpt = auditDataService.getStackDataFromRequestDb(auditInventory);
             if (auditListOpt.isPresent()) {
                 auditVservers.auditVservers(auditListOpt.get());
@@ -77,29 +82,35 @@ public class AuditDeleteStackService extends AbstractAuditService {
             logger.error("Error during audit of stack", e);
         }
         variables.put("auditIsSuccessful", success);
+        mdcSetup.setElapsedTime();
+        String externalTaskId = externalTask.getId();
         if (success) {
             externalTaskService.complete(externalTask, variables);
-            logger.debug("The External Task Id: {}  Successful", externalTask.getId());
+            mdcSetup.setResponseCode(ONAPLogConstants.ResponseStatus.COMPLETE.toString());
+            logger.debug("The External Task Id: {}  Successful", externalTaskId);
             logger.info(ONAPLogConstants.Markers.EXIT, "Exiting");
+            mdcSetup.clearClientMDCs();
         } else {
-            if (externalTask.getRetries() == null) {
+            Integer retryCount = externalTask.getRetries();
+            if (retryCount == null) {
                 logger.debug("The External Task Id: {}  Failed, Setting Retries to Default Start Value: {}",
-                        externalTask.getId(), getRetrySequence().length);
+                        externalTaskId, getRetrySequence().length);
                 externalTaskService.handleFailure(externalTask, UNABLE_TO_FIND_ALL_V_SERVERS_AND_L_INTERACES_IN_A_AI,
                         UNABLE_TO_FIND_ALL_V_SERVERS_AND_L_INTERACES_IN_A_AI, getRetrySequence().length, 10000);
-            } else if (externalTask.getRetries() != null && externalTask.getRetries() - 1 == 0) {
-                logger.debug("The External Task Id: {}  Failed, All Retries Exhausted", externalTask.getId());
+            } else if (retryCount != null && retryCount - 1 == 0) {
                 externalTaskService.complete(externalTask, variables);
+                mdcSetup.setResponseCode(ONAPLogConstants.ResponseStatus.ERROR.toString());
+                logger.debug("The External Task Id: {}  Failed, All Retries Exhausted", externalTaskId);
                 logger.info(ONAPLogConstants.Markers.EXIT, "Exiting");
+                mdcSetup.clearClientMDCs();
             } else {
                 logger.debug("The External Task Id: {}  Failed, Decrementing Retries: {} , Retry Delay: ",
-                        externalTask.getId(), externalTask.getRetries() - 1,
-                        calculateRetryDelay(externalTask.getRetries()));
+                        externalTaskId, retryCount - 1, calculateRetryDelay(retryCount));
                 externalTaskService.handleFailure(externalTask, UNABLE_TO_FIND_ALL_V_SERVERS_AND_L_INTERACES_IN_A_AI,
-                        UNABLE_TO_FIND_ALL_V_SERVERS_AND_L_INTERACES_IN_A_AI, externalTask.getRetries() - 1,
-                        calculateRetryDelay(externalTask.getRetries()));
+                        UNABLE_TO_FIND_ALL_V_SERVERS_AND_L_INTERACES_IN_A_AI, retryCount - 1,
+                        calculateRetryDelay(retryCount));
             }
-            logger.debug("The External Task Id: {} Failed", externalTask.getId());
+            logger.debug("The External Task Id: {} Failed", externalTaskId);
         }
     }
 
diff --git a/adapters/mso-openstack-adapters/src/main/java/org/onap/so/adapters/audit/AuditQueryStackService.java b/adapters/mso-openstack-adapters/src/main/java/org/onap/so/adapters/audit/AuditQueryStackService.java
index 2ef7d5b325..dc672ff017 100644
--- a/adapters/mso-openstack-adapters/src/main/java/org/onap/so/adapters/audit/AuditQueryStackService.java
+++ b/adapters/mso-openstack-adapters/src/main/java/org/onap/so/adapters/audit/AuditQueryStackService.java
@@ -7,6 +7,7 @@ import org.camunda.bpm.client.task.ExternalTask;
 import org.camunda.bpm.client.task.ExternalTaskService;
 import org.onap.logging.ref.slf4j.ONAPLogConstants;
 import org.onap.so.audit.beans.AuditInventory;
+import org.onap.so.externaltasks.logging.AuditMDCSetup;
 import org.onap.so.objects.audit.AAIObjectAuditList;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
@@ -22,47 +23,56 @@ public class AuditQueryStackService extends AbstractAuditService {
     protected HeatStackAudit heatStackAudit;
 
     @Autowired
+    private AuditMDCSetup mdcSetup;
+
+    @Autowired
     protected AuditDataService auditDataService;
 
     protected void executeExternalTask(ExternalTask externalTask, ExternalTaskService externalTaskService) {
-        setupMDC(externalTask);
+        mdcSetup.setupMDC(externalTask);
         AuditInventory auditInventory = externalTask.getVariable("auditInventory");
         boolean success = false;
         Map<String, Object> variables = new HashMap<>();
         try {
+            Integer retryCount = externalTask.getRetries();
             logger.info("Executing External Task Query Audit Inventory. Audit Inventory: {} \n Retry Number: {}",
-                    auditInventory.toString(), externalTask.getRetries());
+                    auditInventory.toString(), retryCount);
 
             Optional<AAIObjectAuditList> auditList = heatStackAudit.queryHeatStack(auditInventory.getCloudOwner(),
                     auditInventory.getCloudRegion(), auditInventory.getTenantId(), auditInventory.getHeatStackName());
 
             if (auditList.isPresent()) {
+                mdcSetup.setResponseCode(ONAPLogConstants.ResponseStatus.COMPLETE.toString());
                 success = true;
                 auditDataService.writeStackDataToRequestDb(auditInventory, auditList.get());
             }
+            mdcSetup.setElapsedTime();
+            String externalTaskId = externalTask.getId();
             if (success) {
                 externalTaskService.complete(externalTask, variables);
-                logger.debug("The External Task {}  was Successful", externalTask.getId());
+                mdcSetup.setResponseCode(ONAPLogConstants.ResponseStatus.COMPLETE.toString());
+                logger.debug("The External Task {}  was Successful", externalTaskId);
                 logger.info(ONAPLogConstants.Markers.EXIT, "Exiting");
+                mdcSetup.clearClientMDCs();
             } else {
-                if (externalTask.getRetries() == null) {
+                if (retryCount == null) {
                     logger.debug("The External Task {} Failed. Setting Retries to Default Start Value: {}",
-                            externalTask.getId(), getRetrySequence().length);
+                            externalTaskId, getRetrySequence().length);
                     externalTaskService.handleFailure(externalTask, UNABLE_TO_FIND_V_SERVERS_IN_OPENSTACK,
                             UNABLE_TO_FIND_V_SERVERS_IN_OPENSTACK, getRetrySequence().length, 10000);
-                } else if (externalTask.getRetries() != null && externalTask.getRetries() - 1 == 0) {
-                    logger.debug("The External Task {} Failed. All Retries Exhausted", externalTask.getId());
+                } else if (retryCount != null && retryCount - 1 == 0) {
                     externalTaskService.complete(externalTask, variables);
+                    mdcSetup.setResponseCode(ONAPLogConstants.ResponseStatus.ERROR.toString());
+                    logger.debug("The External Task {} Failed. All Retries Exhausted", externalTaskId);
                     logger.info(ONAPLogConstants.Markers.EXIT, "Exiting");
+                    mdcSetup.clearClientMDCs();
                 } else {
                     logger.debug("The External Task {} Failed. Decrementing Retries to {} , Retry Delay: ",
-                            externalTask.getId(), externalTask.getRetries() - 1,
-                            calculateRetryDelay(externalTask.getRetries()));
+                            externalTaskId, retryCount - 1, calculateRetryDelay(retryCount));
                     externalTaskService.handleFailure(externalTask, UNABLE_TO_FIND_V_SERVERS_IN_OPENSTACK,
-                            UNABLE_TO_FIND_V_SERVERS_IN_OPENSTACK, externalTask.getRetries() - 1,
-                            calculateRetryDelay(externalTask.getRetries()));
+                            UNABLE_TO_FIND_V_SERVERS_IN_OPENSTACK, retryCount - 1, calculateRetryDelay(retryCount));
                 }
-                logger.debug("The External Task {} Failed", externalTask.getId());
+                logger.debug("The External Task {} Failed", externalTaskId);
             }
         } catch (Exception e) {
             logger.error("Error during audit query of stack", e);
diff --git a/adapters/mso-openstack-adapters/src/main/java/org/onap/so/adapters/inventory/create/CreateInventoryTask.java b/adapters/mso-openstack-adapters/src/main/java/org/onap/so/adapters/inventory/create/CreateInventoryTask.java
index 29d0ef633f..3d2d1d2aa3 100644
--- a/adapters/mso-openstack-adapters/src/main/java/org/onap/so/adapters/inventory/create/CreateInventoryTask.java
+++ b/adapters/mso-openstack-adapters/src/main/java/org/onap/so/adapters/inventory/create/CreateInventoryTask.java
@@ -26,6 +26,7 @@ import org.camunda.bpm.client.task.ExternalTask;
 import org.camunda.bpm.client.task.ExternalTaskService;
 import org.onap.logging.ref.slf4j.ONAPLogConstants;
 import org.onap.so.client.graphinventory.GraphInventoryCommonObjectMapperProvider;
+import org.onap.so.externaltasks.logging.AuditMDCSetup;
 import org.onap.so.objects.audit.AAIObjectAuditList;
 import org.onap.so.utils.ExternalTaskUtils;
 import org.slf4j.Logger;
@@ -45,22 +46,29 @@ public class CreateInventoryTask extends ExternalTaskUtils {
     @Autowired
     CreateAAIInventory createInventory;
 
+    @Autowired
+    private AuditMDCSetup mdcSetup;
+
     protected void executeExternalTask(ExternalTask externalTask, ExternalTaskService externalTaskService) {
-        setupMDC(externalTask);
+        mdcSetup.setupMDC(externalTask);
         boolean success = true;
         boolean inventoryException = false;
         String auditInventoryString = externalTask.getVariable("auditInventoryResult");
         AAIObjectAuditList auditInventory = null;
+        String externalTaskId = externalTask.getId();
         try {
             GraphInventoryCommonObjectMapperProvider objectMapper = new GraphInventoryCommonObjectMapperProvider();
             auditInventory = objectMapper.getMapper().readValue(auditInventoryString, AAIObjectAuditList.class);
         } catch (Exception e) {
+            mdcSetup.setResponseCode(ONAPLogConstants.ResponseStatus.ERROR.toString());
             logger.error("Error Parsing Audit Results", e);
         }
+        mdcSetup.setElapsedTime();
         if (auditInventory != null) {
+            Integer retryCount = externalTask.getRetries();
             try {
                 logger.info("Executing External Task Create Inventory, Retry Number: {} \n {}", auditInventory,
-                        externalTask.getRetries());
+                        retryCount);
                 createInventory.createInventory(auditInventory);
             } catch (InventoryException e) {
                 logger.error("Error during inventory of stack", e);
@@ -70,38 +78,39 @@ public class CreateInventoryTask extends ExternalTaskUtils {
                 logger.error("Error during inventory of stack", e);
                 success = false;
             }
+            mdcSetup.setElapsedTime();
             if (success) {
                 externalTaskService.complete(externalTask);
-                logger.debug("The External Task Id: {}  Successful", externalTask.getId());
+                mdcSetup.setResponseCode(ONAPLogConstants.ResponseStatus.COMPLETE.toString());
+                logger.debug("The External Task Id: {}  Successful", externalTaskId);
                 logger.info(ONAPLogConstants.Markers.EXIT, "Exiting");
+                mdcSetup.clearClientMDCs();
             } else if (inventoryException) {
-                logger.debug("The External Task Id: {}  Failed, Retry not needed", externalTask.getId());
+                mdcSetup.setResponseCode(ONAPLogConstants.ResponseStatus.ERROR.toString());
+                logger.debug("The External Task Id: {}  Failed, Retry not needed", externalTaskId);
                 externalTaskService.handleBpmnError(externalTask, AAI_INVENTORY_FAILURE);
             } else {
-                if (externalTask.getRetries() == null) {
+                if (retryCount == null) {
                     logger.debug("The External Task Id: {}  Failed, Setting Retries to Default Start Value: {}",
-                            externalTask.getId(), getRetrySequence().length);
+                            externalTaskId, getRetrySequence().length);
                     externalTaskService.handleFailure(externalTask, UNABLE_TO_WRITE_ALL_INVENTORY_TO_A_AI,
                             UNABLE_TO_WRITE_ALL_INVENTORY_TO_A_AI, getRetrySequence().length, 10000);
-                } else if (externalTask.getRetries() != null && externalTask.getRetries() - 1 == 0) {
-                    logger.debug("The External Task Id: {}  Failed, All Retries Exhausted", externalTask.getId());
+                } else if (retryCount != null && retryCount - 1 == 0) {
                     externalTaskService.handleBpmnError(externalTask, AAI_INVENTORY_FAILURE);
+                    mdcSetup.setResponseCode(ONAPLogConstants.ResponseStatus.ERROR.toString());
+                    logger.debug("The External Task Id: {}  Failed, All Retries Exhausted", externalTaskId);
                     logger.info(ONAPLogConstants.Markers.EXIT, "Exiting");
                 } else {
                     logger.debug("The External Task Id: {}  Failed, Decrementing Retries: {} , Retry Delay: ",
-                            externalTask.getId(), externalTask.getRetries() - 1,
-                            calculateRetryDelay(externalTask.getRetries()));
+                            externalTaskId, retryCount - 1, calculateRetryDelay(retryCount));
                     externalTaskService.handleFailure(externalTask, UNABLE_TO_WRITE_ALL_INVENTORY_TO_A_AI,
-                            UNABLE_TO_WRITE_ALL_INVENTORY_TO_A_AI, externalTask.getRetries() - 1,
-                            calculateRetryDelay(externalTask.getRetries()));
+                            UNABLE_TO_WRITE_ALL_INVENTORY_TO_A_AI, retryCount - 1, calculateRetryDelay(retryCount));
                 }
-                logger.debug("The External Task Id: {} Failed", externalTask.getId());
+                logger.debug("The External Task Id: {} Failed", externalTaskId);
             }
         } else {
-            logger.debug("The External Task Id: {}  Failed, No Audit Results Written", externalTask.getId());
+            logger.debug("The External Task Id: {}  Failed, No Audit Results Written", externalTaskId);
             externalTaskService.handleBpmnError(externalTask, AAI_INVENTORY_FAILURE);
         }
     }
-
-
 }
diff --git a/adapters/mso-openstack-adapters/src/main/java/org/onap/so/adapters/openstack/MsoOpenstackAdaptersApplication.java b/adapters/mso-openstack-adapters/src/main/java/org/onap/so/adapters/openstack/MsoOpenstackAdaptersApplication.java
index 436836491d..d9a83e6a9a 100644
--- a/adapters/mso-openstack-adapters/src/main/java/org/onap/so/adapters/openstack/MsoOpenstackAdaptersApplication.java
+++ b/adapters/mso-openstack-adapters/src/main/java/org/onap/so/adapters/openstack/MsoOpenstackAdaptersApplication.java
@@ -21,7 +21,7 @@
 package org.onap.so.adapters.openstack;
 
 import java.util.concurrent.Executor;
-import org.onap.so.logging.jaxrs.filter.MDCTaskDecorator;
+import org.onap.logging.filter.spring.MDCTaskDecorator;
 import org.springframework.beans.factory.annotation.Value;
 import org.springframework.boot.SpringApplication;
 import org.springframework.boot.autoconfigure.SpringBootApplication;