From 81ba2f8e376545bc6f8134fabee729e121b9219b Mon Sep 17 00:00:00 2001 From: Raf Ponsaerts Date: Tue, 28 Jul 2020 11:00:01 +0200 Subject: [PATCH] [Task 72040] added javadocs and override annotations --- .../dspace/content/dao/impl/ProcessLogDAOImpl.java | 4 ++++ .../dspace/core/ManagedHibernateDBConnection.java | 3 +++ .../core/ThreadBoundHibernateDBConnection.java | 3 +++ .../handler/impl/RestDSpaceRunnableHandler.java | 12 ++++++++++-- 4 files changed, 20 insertions(+), 2 deletions(-) diff --git a/dspace-api/src/main/java/org/dspace/content/dao/impl/ProcessLogDAOImpl.java b/dspace-api/src/main/java/org/dspace/content/dao/impl/ProcessLogDAOImpl.java index 6a76c7e6c98d..d362332a801f 100644 --- a/dspace-api/src/main/java/org/dspace/content/dao/impl/ProcessLogDAOImpl.java +++ b/dspace-api/src/main/java/org/dspace/content/dao/impl/ProcessLogDAOImpl.java @@ -20,8 +20,12 @@ import org.dspace.scripts.ProcessLog; import org.dspace.scripts.ProcessLog_; +/** + * This is the implementing class for the {@link ProcessLogDAO} + */ public class ProcessLogDAOImpl extends AbstractHibernateDAO implements ProcessLogDAO { + @Override public List findByProcess(Context context, Process process) throws SQLException { CriteriaBuilder criteriaBuilder = getCriteriaBuilder(context); CriteriaQuery criteriaQuery = getCriteriaQuery(criteriaBuilder, ProcessLog.class); diff --git a/dspace-api/src/main/java/org/dspace/core/ManagedHibernateDBConnection.java b/dspace-api/src/main/java/org/dspace/core/ManagedHibernateDBConnection.java index c9b9514c683a..5a40f53eacbf 100644 --- a/dspace-api/src/main/java/org/dspace/core/ManagedHibernateDBConnection.java +++ b/dspace-api/src/main/java/org/dspace/core/ManagedHibernateDBConnection.java @@ -15,6 +15,9 @@ import org.springframework.beans.factory.annotation.Autowired; import org.springframework.beans.factory.annotation.Qualifier; +/** + * Implementing class for the MANAGED Context state for {@link HibernateDBConnection} + */ public class ManagedHibernateDBConnection extends HibernateDBConnection { @Autowired(required = true) diff --git a/dspace-api/src/main/java/org/dspace/core/ThreadBoundHibernateDBConnection.java b/dspace-api/src/main/java/org/dspace/core/ThreadBoundHibernateDBConnection.java index 9b08ae228bc8..ea1dfabe73a1 100644 --- a/dspace-api/src/main/java/org/dspace/core/ThreadBoundHibernateDBConnection.java +++ b/dspace-api/src/main/java/org/dspace/core/ThreadBoundHibernateDBConnection.java @@ -15,6 +15,9 @@ import org.springframework.beans.factory.annotation.Autowired; import org.springframework.beans.factory.annotation.Qualifier; +/** + * Implementing class for the regular Context states for {@link HibernateDBConnection} + */ public class ThreadBoundHibernateDBConnection extends HibernateDBConnection { @Autowired(required = true) diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/scripts/handler/impl/RestDSpaceRunnableHandler.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/scripts/handler/impl/RestDSpaceRunnableHandler.java index 144485e25060..1d4c78b19bec 100644 --- a/dspace-server-webapp/src/main/java/org/dspace/app/rest/scripts/handler/impl/RestDSpaceRunnableHandler.java +++ b/dspace-server-webapp/src/main/java/org/dspace/app/rest/scripts/handler/impl/RestDSpaceRunnableHandler.java @@ -175,11 +175,19 @@ public void logError(String message) { } - private void appendLogToProcess(String message, ProcessLogLevel error) { + /** + * This method will ensure that the current {@link Process} has the given {@link org.dspace.scripts.ProcessLog} + * objects made and attached to it in the DB when a log is called. + * It'll use a separate Context for this and close this one immediately afterwards so that it's updated in + * real-time + * @param message The message to be used in the log + * @param processLogLevel The log level to be used in the log + */ + private void appendLogToProcess(String message, ProcessLogLevel processLogLevel) { Context context = new Context(Context.Mode.MANAGED); try { Process process = processService.find(context, processId); - processService.appendLog(context, process, message, error); + processService.appendLog(context, process, message, processLogLevel); context.complete(); } catch (SQLException e) { log.error("RestDSpaceRunnableHandler with process: " + processId + " could not write log to process", e);