Evaluated feedback on scripts and processes endpoints and model classes. Added javadoc, fixed tests and made improvements to various parts of the Scripts and processes feature

2025-10-18 23:43:06 +00:00 · 2019-10-21 16:31:04 +02:00
parent fa023db4ee
commit e2cc3a9391
30 changed files with 220 additions and 104 deletions
--- a/dspace-api/src/main/java/org/dspace/scripts/ProcessServiceImpl.java
+++ b/dspace-api/src/main/java/org/dspace/scripts/ProcessServiceImpl.java
@@ -0,0 +1,148 @@
+/**
+ * The contents of this file are subject to the license and copyright
+ * detailed in the LICENSE and NOTICE files at the root of the source
+ * tree and available online at
+ *
+ * http://www.dspace.org/license/
+ */
+package org.dspace.scripts;
+
+import java.sql.SQLException;
+import java.util.ArrayList;
+import java.util.Collections;
+import java.util.Comparator;
+import java.util.Date;
+import java.util.List;
+import java.util.regex.Pattern;
+
+import org.apache.commons.lang3.StringUtils;
+import org.apache.logging.log4j.Logger;
+import org.dspace.content.ProcessStatus;
+import org.dspace.content.dao.ProcessDAO;
+import org.dspace.core.Context;
+import org.dspace.core.LogManager;
+import org.dspace.eperson.EPerson;
+import org.dspace.scripts.service.ProcessService;
+import org.springframework.beans.factory.annotation.Autowired;
+
+/**
+ * The implementation for the {@link ProcessService} class
+ */
+public class ProcessServiceImpl implements ProcessService {
+
+    private static final Logger log = org.apache.logging.log4j.LogManager.getLogger(ProcessService.class);
+
+    @Autowired
+    private ProcessDAO processDAO;
+
+    @Override
+    public Process create(Context context, EPerson ePerson, String scriptName,
+                          List<DSpaceCommandLineParameter> parameters) throws SQLException {
+
+        Process process = new Process();
+        process.setEPerson(ePerson);
+        process.setName(scriptName);
+        process.setParameters(DSpaceCommandLineParameter.concatenate(parameters));
+        process.setCreationTime(new Date());
+        Process createdProcess = processDAO.create(context, process);
+        log.info(LogManager.getHeader(context, "process_create",
+                                      "Process has been created for eperson with email " + ePerson.getEmail()
+                                          + " with ID " + createdProcess.getID() + " and scriptName " +
+                                          scriptName + " and parameters " + parameters));
+        return createdProcess;
+    }
+
+    @Override
+    public Process find(Context context, int processId) throws SQLException {
+        return processDAO.findByID(context, Process.class, processId);
+    }
+
+    @Override
+    public List<Process> findAll(Context context) throws SQLException {
+        return processDAO.findAll(context, Process.class);
+    }
+
+    @Override
+    public List<Process> findAll(Context context, int limit, int offset) throws SQLException {
+        return processDAO.findAll(context, limit, offset);
+    }
+
+    @Override
+    public List<Process> findAllSortByScript(Context context) throws SQLException {
+        return processDAO.findAllSortByScript(context);
+    }
+
+    @Override
+    public List<Process> findAllSortByStartTime(Context context) throws SQLException {
+        List<Process> processes = findAll(context);
+        Comparator<Process> comparing = Comparator
+            .comparing(Process::getStartTime, Comparator.nullsLast(Comparator.naturalOrder()));
+        comparing = comparing.thenComparing(Process::getID);
+        processes.sort(comparing);
+        return processes;
+    }
+
+    @Override
+    public void start(Context context, Process process) throws SQLException {
+        process.setProcessStatus(ProcessStatus.RUNNING);
+        process.setStartTime(new Date());
+        update(context, process);
+        log.info(LogManager.getHeader(context, "process_start", "Process with ID " + process.getID()
+            + " and name " + process.getName() + " has started"));
+
+    }
+
+    @Override
+    public void fail(Context context, Process process) throws SQLException {
+        process.setProcessStatus(ProcessStatus.FAILED);
+        process.setFinishedTime(new Date());
+        update(context, process);
+        log.info(LogManager.getHeader(context, "process_fail", "Process with ID " + process.getID()
+            + " and name " + process.getName() + " has failed"));
+
+    }
+
+    @Override
+    public void complete(Context context, Process process) throws SQLException {
+        process.setProcessStatus(ProcessStatus.COMPLETED);
+        process.setFinishedTime(new Date());
+        update(context, process);
+        log.info(LogManager.getHeader(context, "process_complete", "Process with ID " + process.getID()
+            + " and name " + process.getName() + " has been completed"));
+
+    }
+
+    @Override
+    public void delete(Context context, Process process) throws SQLException {
+        processDAO.delete(context, process);
+        log.info(LogManager.getHeader(context, "process_delete", "Process with ID " + process.getID()
+            + " and name " + process.getName() + " has been deleted"));
+
+    }
+
+    @Override
+    public void update(Context context, Process process) throws SQLException {
+        processDAO.save(context, process);
+    }
+
+    @Override
+    public List<DSpaceCommandLineParameter> getParameters(Process process) {
+        if (StringUtils.isBlank(process.getParameters())) {
+            return Collections.emptyList();
+        }
+
+        String[] parameterArray = process.getParameters().split(Pattern.quote(DSpaceCommandLineParameter.SEPARATOR));
+        List<DSpaceCommandLineParameter> parameterList = new ArrayList<>();
+
+        for (String parameter : parameterArray) {
+            parameterList.add(new DSpaceCommandLineParameter(parameter));
+        }
+
+        return parameterList;
+    }
+
+    public int countTotal(Context context) throws SQLException {
+        return processDAO.countRows(context);
+    }
+
+}