Merge pull request #254 from folio-org/master

Downport aggies-sprint-8 staging.

Author: kaladay

descriptors/ModuleDescriptor-template.json

@@ -1,6 +1,7 @@
 package org.folio.rest.camunda.delegate;
 
 import com.fasterxml.jackson.databind.ObjectMapper;
+import org.camunda.bpm.engine.delegate.DelegateExecution;
 import org.camunda.bpm.engine.delegate.JavaDelegate;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
@@ -10,26 +11,86 @@ public abstract class AbstractDelegate implements JavaDelegate {
 
   private final Logger log;
 
+  @Autowired
+  protected ObjectMapper objectMapper;
+
   AbstractDelegate() {
     // The logger is non-static to ensure that the implementing class name is used for the logger.
     log = LoggerFactory.getLogger(this.getClass());
   }
 
-  @Autowired
-  protected ObjectMapper objectMapper;
+  /**
+   * Get the delegate class name.
+   *
+   * @return The delegate name.
+   */
+  protected String getDelegateClass() {
+    String simpleName = getClass().getSimpleName();
+
+    return simpleName.substring(0, 1).toLowerCase() + simpleName.substring(1);
+  }
 
+  /**
+   * Get the delegate name.
+   *
+   * @param execution The delegate execution data.
+   *
+   * @return The delegate name.
+   */
+  protected String getDelegateName(DelegateExecution execution) {
+    return execution.getBpmnModelElementInstance().getName();
+  }
+
+  /**
+   * Get the expression.
+   *
+   * @return The formatted expression string.
+   */
   public String getExpression() {
-    String simpleName = getClass().getSimpleName();
-    String delegateName = simpleName.substring(0, 1).toLowerCase() + simpleName.substring(1);
-    return String.format("${%s}", delegateName);
+    return String.format("${%s}", getDelegateClass());
   }
 
+  /**
+   * Get the logger.
+   *
+   * @return The logger for this class.
+   */
   public Logger getLogger() {
     return log;
   }
 
+  /**
+   * Get the Object Mapper.
+   *
+   * @return The Object Mapper for this class.
+   */
   public ObjectMapper getObjectMapper() {
     return objectMapper;
   }
 
+  /**
+   * Determine the start time of the query and print log.
+   *
+   * @param execution The delegate execution data.
+   * @param args additional string arguments to pass.
+   *
+   * @return The start time.
+   */
+  protected long determineStartTime(DelegateExecution execution, Object ...args) {
+    getLogger().info("{} {} started", getDelegateName(execution), args);
+
+    return System.nanoTime();
+  }
+
+  /**
+   * Given the start time, determine the total time spent.
+   *
+   * @param execution The delegate execution data.
+   *
+   * @param startTime The time the process started.
+   */
+  protected void determineEndTime(DelegateExecution execution, long startTime) {
+    getLogger().info("{} finished in {} milliseconds", getDelegateName(execution), (System.nanoTime() - startTime) / (double) 1000000);
+  }
+
 }

src/main/java/org/folio/rest/camunda/delegate/AbstractDelegate.java

@@ -7,5 +7,4 @@ public abstract class AbstractRuntimeDelegate extends AbstractDelegate {
 
   @Autowired
   protected RuntimeService runtimeService;
-
 }

src/main/java/org/folio/rest/camunda/delegate/AbstractRuntimeDelegate.java

@@ -20,7 +20,6 @@
 import org.apache.commons.compress.compressors.CompressorStreamFactory;
 import org.camunda.bpm.engine.delegate.DelegateExecution;
 import org.camunda.bpm.engine.delegate.Expression;
-import org.camunda.bpm.model.bpmn.instance.FlowElement;
 import org.folio.rest.workflow.enums.CompressFileContainer;
 import org.folio.rest.workflow.enums.CompressFileFormat;
 import org.folio.rest.workflow.model.CompressFileTask;
@@ -51,11 +50,7 @@ public class CompressFileDelegate extends AbstractWorkflowIODelegate {
 
   @Override
   public void execute(DelegateExecution execution) throws Exception {
-    long startTime = System.nanoTime();
-    FlowElement bpmnModelElement = execution.getBpmnModelElementInstance();
-    String delegateName = bpmnModelElement.getName();
-
-    getLogger().info("{} started", delegateName);
+    final long startTime = determineStartTime(execution);
 
     String sourcePathTemplate = this.source.getValue(execution).toString();
     String destinationPathTemplate = this.destination.getValue(execution).toString();
@@ -165,8 +160,7 @@ public void execute(DelegateExecution execution) throws Exception {
       }
     }
 
-    long endTime = System.nanoTime();
-    getLogger().info("{} finished in {} milliseconds", delegateName, (endTime - startTime) / (double) 1000000);
+    determineEndTime(execution, startTime);
   }
 
   public void setSource(Expression source) {

src/main/java/org/folio/rest/camunda/delegate/CompressFileDelegate.java

@@ -1,10 +1,8 @@
 package org.folio.rest.camunda.delegate;
 
 import java.util.Properties;
-
 import org.camunda.bpm.engine.delegate.DelegateExecution;
 import org.camunda.bpm.engine.delegate.Expression;
-import org.camunda.bpm.model.bpmn.instance.FlowElement;
 import org.folio.rest.workflow.model.DatabaseConnectionTask;
 import org.springframework.context.annotation.Scope;
 import org.springframework.stereotype.Service;
@@ -19,11 +17,7 @@ public class DatabaseConnectionDelegate extends AbstractDatabaseDelegate {
 
   @Override
   public void execute(DelegateExecution execution) throws Exception {
-    long startTime = System.nanoTime();
-    FlowElement bpmnModelElement = execution.getBpmnModelElementInstance();
-    String delegateName = bpmnModelElement.getName();
-
-    getLogger().info("{} started", delegateName);
+    final long startTime = determineStartTime(execution);
 
     String urlValue = this.url.getValue(execution).toString();
     String key = this.designation.getValue(execution).toString();
@@ -34,8 +28,7 @@ public void execute(DelegateExecution execution) throws Exception {
 
     connectionService.createPool(key, urlValue, info);
 
-    long endTime = System.nanoTime();
-    getLogger().info("{} finished in {} milliseconds", delegateName, (endTime - startTime) / (double) 1000000);
+    determineEndTime(execution, startTime);
   }
 
   public void setUrl(Expression url) {

src/main/java/org/folio/rest/camunda/delegate/DatabaseConnectionDelegate.java

@@ -1,7 +1,6 @@
 package org.folio.rest.camunda.delegate;
 
 import org.camunda.bpm.engine.delegate.DelegateExecution;
-import org.camunda.bpm.model.bpmn.instance.FlowElement;
 import org.folio.rest.workflow.model.DatabaseDisconnectTask;
 import org.springframework.context.annotation.Scope;
 import org.springframework.stereotype.Service;
@@ -12,18 +11,13 @@ public class DatabaseDisconnectDelegate extends AbstractDatabaseDelegate {
 
   @Override
   public void execute(DelegateExecution execution) throws Exception {
-    long startTime = System.nanoTime();
-    FlowElement bpmnModelElement = execution.getBpmnModelElementInstance();
-    String delegateName = bpmnModelElement.getName();
-
-    getLogger().info("{} started", delegateName);
+    final long startTime = determineStartTime(execution);
 
     String key = this.designation.getValue(execution).toString();
 
     connectionService.destroyConnection(key);
 
-    long endTime = System.nanoTime();
-    getLogger().info("{} finished in {} milliseconds", delegateName, (endTime - startTime) / (double) 1000000);
+    determineEndTime(execution, startTime);
   }
 
   @Override

src/main/java/org/folio/rest/camunda/delegate/DatabaseDisconnectDelegate.java

@@ -1,5 +1,10 @@
 package org.folio.rest.camunda.delegate;
 
+import com.fasterxml.jackson.core.JsonProcessingException;
+import com.fasterxml.jackson.databind.JsonNode;
+import com.fasterxml.jackson.databind.node.ObjectNode;
+import freemarker.cache.StringTemplateLoader;
+import freemarker.template.Configuration;
 import java.io.FileWriter;
 import java.io.IOException;
 import java.sql.Connection;
@@ -11,22 +16,13 @@
 import java.util.List;
 import java.util.Map;
 import java.util.Objects;
-
 import org.camunda.bpm.engine.delegate.DelegateExecution;
 import org.camunda.bpm.engine.delegate.Expression;
-import org.camunda.bpm.model.bpmn.instance.FlowElement;
 import org.folio.rest.workflow.model.DatabaseQueryTask;
 import org.springframework.context.annotation.Scope;
 import org.springframework.stereotype.Service;
 import org.springframework.ui.freemarker.FreeMarkerTemplateUtils;
 
-import com.fasterxml.jackson.core.JsonProcessingException;
-import com.fasterxml.jackson.databind.JsonNode;
-import com.fasterxml.jackson.databind.node.ObjectNode;
-
-import freemarker.cache.StringTemplateLoader;
-import freemarker.template.Configuration;
-
 @Service
 @Scope("prototype")
 public class DatabaseQueryDelegate extends AbstractDatabaseOutputDelegate {
@@ -41,11 +37,7 @@ public class DatabaseQueryDelegate extends AbstractDatabaseOutputDelegate {
 
   @Override
   public void execute(DelegateExecution execution) throws Exception {
-    long startTime = System.nanoTime();
-    FlowElement bpmnModelElement = execution.getBpmnModelElementInstance();
-    String delegateName = bpmnModelElement.getName();
-
-    getLogger().info("{} started", delegateName);
+    final long startTime = determineStartTime(execution);
 
     String queryTemplate = this.query.getValue(execution).toString();
 
@@ -95,7 +87,7 @@ public void execute(DelegateExecution execution) throws Exception {
           if (hasOutputVariable(execution)) {
             setOutput(execution, count);
           } else {
-            getLogger().info("{} did not specify output variable for result count", delegateName);
+            getLogger().info("{} did not specify output variable for result count", getDelegateName(execution));
           }
         }
 
@@ -105,8 +97,7 @@ public void execute(DelegateExecution execution) throws Exception {
       conn.close();
     }
 
-    long endTime = System.nanoTime();
-    getLogger().info("{} finished in {} milliseconds", delegateName, (endTime - startTime) / (double) 1000000);
+    determineEndTime(execution, startTime);
   }
 
   public void setQuery(Expression query) {

src/main/java/org/folio/rest/camunda/delegate/DatabaseQueryDelegate.java

@@ -9,7 +9,6 @@
 import java.util.Optional;
 import org.camunda.bpm.engine.delegate.DelegateExecution;
 import org.camunda.bpm.engine.delegate.Expression;
-import org.camunda.bpm.model.bpmn.instance.FlowElement;
 import org.folio.rest.workflow.model.EmailTask;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.context.annotation.Scope;
@@ -50,11 +49,7 @@ public EmailDelegate(JavaMailSender emailSender) {
 
   @Override
   public void execute(DelegateExecution execution) throws Exception {
-    long startTime = System.nanoTime();
-    FlowElement bpmnModelElement = execution.getBpmnModelElementInstance();
-    String delegateName = bpmnModelElement.getName();
-
-    getLogger().info("{} started", delegateName);
+    final long startTime = determineStartTime(execution);
 
     String subjectTemplate = this.mailSubject.getValue(execution).toString();
     String textTemplate = this.mailText.getValue(execution).toString();
@@ -135,8 +130,7 @@ public void prepare(MimeMessage mimeMessage) throws Exception {
 
     emailSender.send(preparator);
 
-    long endTime = System.nanoTime();
-    getLogger().info("{} finished in {} milliseconds", delegateName, (endTime - startTime) / (double) 1000000);
+    determineEndTime(execution, startTime);
   }
 
   public void setMailTo(Expression mailTo) {