Fix/rm 6941 retention action on frozen nodes (#640)

* RM-6941 Changes for retention action on frozen nodes [ags] * RM-6941 Changes for retention action on frozen nodes [ags] * RM-6941 Changes for retention action on frozen nodes [ags] * RM-6941 Changes for retention action on frozen nodes [ags] * RM-6941 Changes for retention action on frozen nodes [ags] * RM-6941 Changes for retention action on frozen nodes [ags] * RM-6941 Changes for retention action on frozen nodes [ags] * RM-6941 Changes for retention action on frozen nodes [ags] * RM-6941 added slf4j and junit test [ags] * RM-6941 added slf4j and junit test [ags] * RM-6941 added slf4j and junit test [ags] * RM-6941 added slf4j and junit test [ags] * RM-6941 added slf4j and test [ags] * RM-6941 added slf4j and test [ags] * RM-6941 added slf4j and test [ags] * RM-6941 added slf4j and test [ags] * RM-6941 added slf4j and test [ags] * RM-6941 code change for test case [ags] * RM-6941 code change for test case [ags] * RM-6941 code change for test case [ags] * RM-6941 change lombok dependency scope to compile [ags] * Revert "RM-6941 change lombok dependency scope to compile [ags]" This reverts commit 4cee68e8 * RM-6941 change lombok dependency scope to compile [ags] * RM-6941 revert change lombok dependency scope to compile [ags] * RM-6941 revert change lombok dependency scope to compile [ags]
2025-07-31 17:39:05 +00:00 · 2021-08-15 14:30:08 +05:30
parent 456e442438
commit 8b6dfa47b8
13 changed files with 185 additions and 121 deletions
--- a/amps/ags/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/action/RecordsManagementActionServiceImpl.java
+++ b/amps/ags/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/action/RecordsManagementActionServiceImpl.java
@@ -35,17 +35,17 @@ import java.util.List;
 import java.util.Map;
 import java.util.Set;

+import lombok.extern.slf4j.Slf4j;
 import org.alfresco.error.AlfrescoRuntimeException;
 import org.alfresco.module.org_alfresco_module_rm.RecordsManagementPolicies.BeforeRMActionExecution;
 import org.alfresco.module.org_alfresco_module_rm.RecordsManagementPolicies.OnRMActionExecution;
+import org.alfresco.module.org_alfresco_module_rm.freeze.FreezeService;
 import org.alfresco.module.org_alfresco_module_rm.util.PoliciesUtil;
 import org.alfresco.repo.policy.ClassPolicyDelegate;
 import org.alfresco.repo.policy.PolicyComponent;
 import org.alfresco.service.cmr.repository.NodeRef;
 import org.alfresco.service.cmr.repository.NodeService;
 import org.alfresco.service.namespace.QName;
-import org.apache.commons.logging.Log;
-import org.apache.commons.logging.LogFactory;
 import org.springframework.extensions.surf.util.I18NUtil;

 /**
@@ -53,14 +53,13 @@ import org.springframework.extensions.surf.util.I18NUtil;
 *
 * @author Roy Wetherall
 */
+@Slf4j
 public class RecordsManagementActionServiceImpl implements RecordsManagementActionService
 {
    /** I18N */
    private static final String MSG_NOT_DEFINED = "rm.action.not-defined";
    private static final String MSG_NO_IMPLICIT_NODEREF = "rm.action.no-implicit-noderef";
-
-    /** Logger */
-    private static Log logger = LogFactory.getLog(RecordsManagementActionServiceImpl.class);
+    private static final String MSG_NODE_FROZEN = "rm.action.node.frozen.error-message";

    /** Registered records management actions */
    private Map<String, RecordsManagementAction> rmActions = new HashMap<>(13);
@@ -78,6 +77,16 @@ public class RecordsManagementActionServiceImpl implements RecordsManagementActi
    private ClassPolicyDelegate<BeforeRMActionExecution> beforeRMActionExecutionDelegate;
    private ClassPolicyDelegate<OnRMActionExecution> onRMActionExecutionDelegate;

+    /**
+     * Freeze Service
+     */
+    private FreezeService freezeService;
+
+    /**
+     * list of retention actions to automatically execute
+     */
+    private List<String> retentionActions;
+
    /**
     * @return Policy component
     */
@@ -94,6 +103,19 @@ public class RecordsManagementActionServiceImpl implements RecordsManagementActi
        return this.nodeService;
    }

+    /**
+     * @param freezeService freeze service
+     */
+    public void setFreezeService(FreezeService freezeService)
+    {
+        this.freezeService = freezeService;
+    }
+
+    public void setRetentionActions(List<String> retentionActions)
+    {
+        this.retentionActions = retentionActions;
+    }
+
    /**
     * Set the policy component
     *
@@ -267,21 +289,23 @@ public class RecordsManagementActionServiceImpl implements RecordsManagementActi
     */
    public RecordsManagementActionResult executeRecordsManagementAction(NodeRef nodeRef, String name, Map<String, Serializable> parameters)
    {
-        if (logger.isDebugEnabled())
-        {
-            logger.debug("Executing record management action on " + nodeRef);
-            logger.debug("    actionName = " + name);
-            logger.debug("    parameters = " + parameters);
-        }
+        log.debug("Executing record management action on " + nodeRef);
+        log.debug("    actionName = " + name);
+        log.debug("    parameters = " + parameters);

        RecordsManagementAction rmAction = this.rmActions.get(name);
        if (rmAction == null)
        {
            String msg = I18NUtil.getMessage(MSG_NOT_DEFINED, name);
-            if (logger.isWarnEnabled())
-            {
-                logger.warn(msg);
-            }
+            log.warn(msg);
+            throw new AlfrescoRuntimeException(msg);
+        }
+
+        if (retentionActions.contains(name.toLowerCase()) && freezeService.isFrozenOrHasFrozenChildren(nodeRef))
+        {
+            String msg = I18NUtil.getMessage(MSG_NODE_FROZEN, name);
+            log.debug(msg);
+
            throw new AlfrescoRuntimeException(msg);
        }

@@ -307,10 +331,7 @@ public class RecordsManagementActionServiceImpl implements RecordsManagementActi
        if (implicitTargetNode == null)
        {
            String msg = I18NUtil.getMessage(MSG_NO_IMPLICIT_NODEREF, name);
-            if (logger.isWarnEnabled())
-            {
-                logger.warn(msg);
-            }
+            log.warn(msg);
            throw new AlfrescoRuntimeException(msg);
        }
        else
--- a/amps/ags/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/disposition/DispositionServiceImpl.java
+++ b/amps/ags/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/disposition/DispositionServiceImpl.java
@@ -45,7 +45,6 @@ import org.alfresco.module.org_alfresco_module_rm.disposition.property.Dispositi
 import org.alfresco.module.org_alfresco_module_rm.event.RecordsManagementEvent;
 import org.alfresco.module.org_alfresco_module_rm.fileplan.FilePlanComponentKind;
 import org.alfresco.module.org_alfresco_module_rm.fileplan.FilePlanService;
-import org.alfresco.module.org_alfresco_module_rm.freeze.FreezeService;
 import org.alfresco.module.org_alfresco_module_rm.model.RecordsManagementModel;
 import org.alfresco.module.org_alfresco_module_rm.record.RecordService;
 import org.alfresco.module.org_alfresco_module_rm.recordfolder.RecordFolderService;
@@ -59,7 +58,6 @@ import org.alfresco.repo.security.authentication.AuthenticationUtil;
 import org.alfresco.repo.security.authentication.AuthenticationUtil.RunAsWork;
 import org.alfresco.repo.transaction.AlfrescoTransactionSupport;
 import org.alfresco.repo.transaction.AlfrescoTransactionSupport.TxnReadState;
-import org.alfresco.repo.transaction.RetryingTransactionHelper;
 import org.alfresco.repo.transaction.RetryingTransactionHelper.RetryingTransactionCallback;
 import org.alfresco.service.cmr.dictionary.DictionaryService;
 import org.alfresco.service.cmr.repository.ChildAssociationRef;
--- a/amps/ags/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/freeze/FreezeService.java
+++ b/amps/ags/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/freeze/FreezeService.java
@@ -150,4 +150,12 @@ public interface FreezeService
    */
   @Deprecated
   Set<NodeRef> getHolds(NodeRef filePlan);
+
+    /**
+     * Check given node or its children are frozen
+     * The node should be record or record folder for retention schedule
+     *
+     * @param nodeRef
+     */
+    boolean isFrozenOrHasFrozenChildren(NodeRef nodeRef);
 }
--- a/amps/ags/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/freeze/FreezeServiceImpl.java
+++ b/amps/ags/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/freeze/FreezeServiceImpl.java
@@ -43,6 +43,8 @@ import org.alfresco.model.ContentModel;
 import org.alfresco.module.org_alfresco_module_rm.fileplan.FilePlanService;
 import org.alfresco.module.org_alfresco_module_rm.hold.HoldService;
 import org.alfresco.module.org_alfresco_module_rm.model.RecordsManagementModel;
+import org.alfresco.module.org_alfresco_module_rm.record.RecordService;
+import org.alfresco.module.org_alfresco_module_rm.recordfolder.RecordFolderService;
 import org.alfresco.module.org_alfresco_module_rm.util.ServiceBaseImpl;
 import org.alfresco.repo.security.authentication.AuthenticationUtil;
 import org.alfresco.repo.security.authentication.AuthenticationUtil.RunAsWork;
@@ -75,6 +77,32 @@ public class FreezeServiceImpl extends    ServiceBaseImpl
    /** Hold service */
    private HoldService holdService;

+    /**
+     * Record Folder Service
+     */
+    private RecordFolderService recordFolderService;
+
+    /**
+     * Record Service
+     */
+    private RecordService recordService;
+
+    /**
+     * @param recordFolderService record folder service
+     */
+    public void setRecordFolderService(RecordFolderService recordFolderService)
+    {
+        this.recordFolderService = recordFolderService;
+    }
+
+    /**
+     * @param recordService record service
+     */
+    public void setRecordService(RecordService recordService)
+    {
+        this.recordService = recordService;
+    }
+
    /**
     * @return File plan service
     */
@@ -392,4 +420,24 @@ public class FreezeServiceImpl extends    ServiceBaseImpl
        // create hold
        return getHoldService().createHold(filePlan, holdName, reason, null);
    }
+
+    /**
+     * Helper method to determine if a node is frozen or has frozen children
+     *
+     * @param nodeRef Node to be checked
+     * @return <code>true</code> if the node is frozen or has frozen children, <code>false</code> otherwise
+     */
+    @Override
+    public boolean isFrozenOrHasFrozenChildren(NodeRef nodeRef)
+    {
+        if (recordFolderService.isRecordFolder(nodeRef))
+        {
+            return isFrozen(nodeRef) || hasFrozenChildren(nodeRef);
+        }
+        else if (recordService.isRecord(nodeRef))
+        {
+            return isFrozen(nodeRef);
+        }
+        return Boolean.FALSE;
+    }
 }
--- a/amps/ags/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/job/DispositionLifecycleJobExecuter.java
+++ b/amps/ags/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/job/DispositionLifecycleJobExecuter.java
@@ -30,15 +30,14 @@ package org.alfresco.module.org_alfresco_module_rm.job;
 import static org.alfresco.module.org_alfresco_module_rm.action.RMDispositionActionExecuterAbstractBase.PARAM_NO_ERROR_CHECK;

 import java.io.Serializable;
-import java.util.HashMap;
 import java.util.List;
 import java.util.Map;

+import lombok.extern.slf4j.Slf4j;
 import org.alfresco.error.AlfrescoRuntimeException;
 import org.alfresco.module.org_alfresco_module_rm.action.RecordsManagementActionService;
+
 import org.alfresco.module.org_alfresco_module_rm.freeze.FreezeService;
-import org.alfresco.module.org_alfresco_module_rm.record.RecordService;
-import org.alfresco.module.org_alfresco_module_rm.recordfolder.RecordFolderService;
 import org.alfresco.repo.transaction.RetryingTransactionHelper.RetryingTransactionCallback;
 import org.alfresco.service.cmr.repository.ChildAssociationRef;
 import org.alfresco.service.cmr.repository.NodeRef;
@@ -48,8 +47,8 @@ import org.alfresco.service.cmr.search.ResultSet;
 import org.alfresco.service.cmr.search.SearchParameters;
 import org.alfresco.service.cmr.search.SearchService;
 import org.alfresco.service.cmr.security.PersonService;
-import org.apache.commons.logging.Log;
-import org.apache.commons.logging.LogFactory;
+import org.springframework.extensions.surf.util.I18NUtil;
+

 /**
 * The Disposition Lifecycle Job Finds all disposition action nodes which are for disposition actions specified Where
@@ -58,14 +57,14 @@ import org.apache.commons.logging.LogFactory;
 * @author mrogers
 * @author Roy Wetherall
 */
+@Slf4j
 public class DispositionLifecycleJobExecuter extends RecordsManagementJobExecuter
 {
-    /** logger */
-    private static Log logger = LogFactory.getLog(DispositionLifecycleJobExecuter.class);

    /** batching properties */
    private int batchSize;
    public static final int DEFAULT_BATCH_SIZE = 500;
+    private static final String MSG_NODE_FROZEN = "rm.action.node.frozen.error-message";

    /** list of disposition actions to automatically execute */
    private List<String> dispositionActions;
@@ -88,11 +87,13 @@ public class DispositionLifecycleJobExecuter extends RecordsManagementJobExecute
    /** freeze service */
    private FreezeService freezeService;

-    /** record service */
-    private RecordService recordService;
-
-    /** record folder service */
-    private RecordFolderService recordFolderService;
+    /**
+     * @param freezeService freeze service
+     */
+    public void setFreezeService(FreezeService freezeService)
+    {
+        this.freezeService = freezeService;
+    }

    /**
     * List of disposition actions to automatically execute when eligible.
@@ -133,30 +134,6 @@ public class DispositionLifecycleJobExecuter extends RecordsManagementJobExecute
        this.searchService = searchService;
    }

-    /**
-     * @param freezeService freeze service
-     */
-    public void setFreezeService(FreezeService freezeService)
-    {
-        this.freezeService = freezeService;
-    }
-
-    /**
-     * @param recordService record service
-     */
-    public void setRecordService(RecordService recordService)
-    {
-        this.recordService = recordService;
-    }
-
-    /**
-     * @param recordFolderService record folder service
-     */
-    public void setRecordFolderService(RecordFolderService recordFolderService)
-    {
-        this.recordFolderService = recordFolderService;
-    }
-
    /**
     * Get the search query string.
     *
@@ -207,11 +184,11 @@ public class DispositionLifecycleJobExecuter extends RecordsManagementJobExecute
    {
        try
        {
-            logger.debug("Job Starting");
+            log.debug("Job Starting");

            if (dispositionActions == null || dispositionActions.isEmpty())
            {
-                logger.debug("Job Finished as disposition action is empty");
+                log.debug("Job Finished as disposition action is empty");
                return;
            }

@@ -220,16 +197,11 @@ public class DispositionLifecycleJobExecuter extends RecordsManagementJobExecute

            if (batchSize < 1)
            {
-                if (logger.isDebugEnabled())
-                {
-                    logger.debug("Invalid value for batch size: " + batchSize + " default value used instead.");
-                }
+                log.debug("Invalid value for batch size: " + batchSize + " default value used instead.");
                batchSize = DEFAULT_BATCH_SIZE;
            }
-            if (logger.isTraceEnabled())
-            {
-                logger.trace("Using batch size of " + batchSize);
-            }
+
+            log.trace("Using batch size of " + batchSize);

            while (hasMore)
            {
@@ -247,10 +219,7 @@ public class DispositionLifecycleJobExecuter extends RecordsManagementJobExecute
                skipCount += resultNodes.size(); // increase by page size
                results.close();

-                if (logger.isDebugEnabled())
-                {
-                    logger.debug("Processing " + resultNodes.size() + " nodes");
-                }
+                log.debug("Processing " + resultNodes.size() + " nodes");

                // process search results
                if (!resultNodes.isEmpty())
@@ -258,14 +227,11 @@ public class DispositionLifecycleJobExecuter extends RecordsManagementJobExecute
                    executeAction(resultNodes);
                }
            }
-            logger.debug("Job Finished");
+            log.debug("Job Finished");
        }
        catch (AlfrescoRuntimeException exception)
        {
-            if (logger.isDebugEnabled())
-            {
-                logger.debug(exception);
-            }
+            log.debug(exception.getMessage());
        }
    }

@@ -299,12 +265,9 @@ public class DispositionLifecycleJobExecuter extends RecordsManagementJobExecute
                }
                Map<String, Serializable> props = Map.of(PARAM_NO_ERROR_CHECK, false);

-                if (isFrozenOrHasFrozenChildren(parent.getParentRef()))
+                if (freezeService.isFrozenOrHasFrozenChildren(parent.getParentRef()))
                {
-                    if (logger.isDebugEnabled()) {
-                        logger.debug("unable to perform action " + dispAction +
-                                " because node is frozen or has frozen children");
-                    }
+                    log.debug(I18NUtil.getMessage(MSG_NODE_FROZEN, dispAction));
                    continue;
                }

@@ -314,17 +277,13 @@ public class DispositionLifecycleJobExecuter extends RecordsManagementJobExecute
                    recordsManagementActionService
                        .executeRecordsManagementAction(parent.getParentRef(), dispAction, props);

-                    if (logger.isDebugEnabled())
-                    {
-                        logger.debug("Processed action: " + dispAction + "on" + parent);
-                    }
+                    log.debug("Processed action: " + dispAction + "on" + parent);
+
                }
                catch (AlfrescoRuntimeException exception)
                {
-                    if (logger.isDebugEnabled())
-                    {
-                        logger.debug(exception);
-                    }
+                    log.debug(exception.getMessage());
+
                }
            }
            return Boolean.TRUE;
@@ -332,25 +291,6 @@ public class DispositionLifecycleJobExecuter extends RecordsManagementJobExecute
        retryingTransactionHelper.doInTransaction(processTranCB, false, true);
    }

-    /**
-     * Helper method to determine if a node is frozen or has frozen children
-     *
-     * @param nodeRef Node to be checked
-     * @return <code>true</code> if the node is frozen or has frozen children, <code>false</code> otherwise
-     */
-    private boolean isFrozenOrHasFrozenChildren(NodeRef nodeRef)
-    {
-        if (recordFolderService.isRecordFolder(nodeRef))
-        {
-            return freezeService.isFrozen(nodeRef) || freezeService.hasFrozenChildren(nodeRef);
-        }
-        if (recordService.isRecord(nodeRef))
-        {
-            return freezeService.isFrozen(nodeRef);
-        }
-        throw new AlfrescoRuntimeException("The nodeRef '" + nodeRef + "' is neither a record nor a record folder.");
-    }
-
    public PersonService getPersonService()
    {
        return personService;