From e19101823169032e4e915442ee095e66cc96c1cc Mon Sep 17 00:00:00 2001 From: ehardon Date: Wed, 3 Mar 2021 15:10:33 +0200 Subject: [PATCH 1/5] APPS-832: prevent multiple nodes from initializing the custom properties --- .../rm-service-context.xml | 1 + .../RecordsManagementAdminServiceImpl.java | 129 +++++++++++++++--- 2 files changed, 108 insertions(+), 22 deletions(-) diff --git a/rm-community/rm-community-repo/config/alfresco/module/org_alfresco_module_rm/rm-service-context.xml b/rm-community/rm-community-repo/config/alfresco/module/org_alfresco_module_rm/rm-service-context.xml index 29b5a0e785..3d46d6a87a 100644 --- a/rm-community/rm-community-repo/config/alfresco/module/org_alfresco_module_rm/rm-service-context.xml +++ b/rm-community/rm-community-repo/config/alfresco/module/org_alfresco_module_rm/rm-service-context.xml @@ -806,6 +806,7 @@ + rma:recordCategory diff --git a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/admin/RecordsManagementAdminServiceImpl.java b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/admin/RecordsManagementAdminServiceImpl.java index 9cd8e0c096..0e8da44a36 100644 --- a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/admin/RecordsManagementAdminServiceImpl.java +++ b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/admin/RecordsManagementAdminServiceImpl.java @@ -37,6 +37,7 @@ import java.util.HashSet; import java.util.List; import java.util.Map; import java.util.Set; +import java.util.concurrent.atomic.AtomicBoolean; import org.alfresco.error.AlfrescoRuntimeException; import org.alfresco.model.ContentModel; @@ -53,6 +54,9 @@ import org.alfresco.repo.dictionary.M2Aspect; import org.alfresco.repo.dictionary.M2Constraint; import org.alfresco.repo.dictionary.M2Model; import org.alfresco.repo.dictionary.M2Property; +import org.alfresco.repo.lock.JobLockService; +import org.alfresco.repo.lock.JobLockService.JobLockRefreshCallback; +import org.alfresco.repo.lock.LockAcquisitionException; import org.alfresco.repo.node.NodeServicePolicies; import org.alfresco.repo.policy.Behaviour.NotificationFrequency; import org.alfresco.repo.policy.annotation.Behaviour; @@ -71,6 +75,7 @@ import org.alfresco.service.cmr.dictionary.TypeDefinition; import org.alfresco.service.cmr.repository.AssociationRef; import org.alfresco.service.cmr.repository.ChildAssociationRef; import org.alfresco.service.cmr.repository.NodeRef; +import org.alfresco.service.namespace.NamespaceService; import org.alfresco.service.namespace.QName; import org.alfresco.service.namespace.RegexQNamePattern; import org.alfresco.service.transaction.TransactionService; @@ -112,6 +117,7 @@ public class RecordsManagementAdminServiceImpl extends RecordsManagementAdminBas private static final String PARAM_ALLOWED_VALUES = "allowedValues"; private static final String PARAM_CASE_SENSITIVE = "caseSensitive"; private static final String PARAM_MATCH_LOGIC = "matchLogic"; + private static final long DEFAULT_TIME = 30000L; /** Relationship service */ private RelationshipService relationshipService; @@ -119,6 +125,9 @@ public class RecordsManagementAdminServiceImpl extends RecordsManagementAdminBas /** Transaction service */ private TransactionService transactionService; + /** Job Lock service */ + private JobLockService jobLockService; + /** List of types that can be customisable */ private List pendingCustomisableTypes; private Map customisableTypes; @@ -152,7 +161,15 @@ public class RecordsManagementAdminServiceImpl extends RecordsManagementAdminBas return this.relationshipService; } - /** + /** + * @param jobLockService The Job Lock service + */ + public void setJobLockService(JobLockService jobLockService) + { + this.jobLockService = jobLockService; + } + + /** * Indicate that this application content listener must be executed with the lowest * precedence. (ie last) * @@ -172,30 +189,98 @@ public class RecordsManagementAdminServiceImpl extends RecordsManagementAdminBas @Override public void onApplicationEvent(ContextRefreshedEvent event) { - if(!isCustomMapInit && getDictionaryService().getAllModels().contains(RM_CUSTOM_MODEL)) - { - // run as System on bootstrap - AuthenticationUtil.runAs(new RunAsWork() - { - public Object doWork() - { - RetryingTransactionCallback callback = new RetryingTransactionCallback() - { - public Void execute() - { - // initialise custom properties - initCustomMap(); - return null; - } - }; - transactionService.getRetryingTransactionHelper().doInTransaction(callback); + final LockCallback lockCallback = new LockCallback(); - return null; + // try and get the lock + String lockToken = getLock(); + if (lockToken != null) + { + try + { + jobLockService.refreshLock(lockToken, getLockQName(), DEFAULT_TIME, lockCallback); + + if (!isCustomMapInit && getDictionaryService().getAllModels().contains(RM_CUSTOM_MODEL)) + { + // run as System on bootstrap + AuthenticationUtil.runAs(new RunAsWork() + { + public Object doWork() + { + RetryingTransactionCallback callback = new RetryingTransactionCallback() + { + public Void execute() + { + // initialise custom properties + initCustomMap(); + return null; + } + }; + transactionService.getRetryingTransactionHelper().doInTransaction(callback); + + return null; + } + }, AuthenticationUtil.getSystemUserName()); + } } - }, AuthenticationUtil.getSystemUserName()); - } + finally + { + try + { + lockCallback.running.set(false); + jobLockService.releaseLock(lockToken, getLockQName()); + } + catch (LockAcquisitionException e) + { + // Ignore + if (logger.isDebugEnabled()) + { + logger.debug("Lock release failed: " + getLockQName() + ": " + lockToken + "(" + + e.getMessage() + ")"); + } + } + } + } } - + + private QName getLockQName() + { + return QName.createQName(NamespaceService.SYSTEM_MODEL_1_0_URI, this.getClass().getName()); + } + + /** + * Attempts to get the lock. If the lock couldn't be taken, then null is returned. + * + * @return Returns the lock token or null + */ + private String getLock() + { + try + { + return jobLockService.getLock(getLockQName(), DEFAULT_TIME); + } + catch (LockAcquisitionException e) + { + return null; + } + } + + private class LockCallback implements JobLockRefreshCallback + { + final AtomicBoolean running = new AtomicBoolean(true); + + @Override + public boolean isActive() + { + return running.get(); + } + + @Override + public void lockReleased() + { + running.set(false); + } + } + /** * Helper method to indicate whether the custom map is initialised or not. * From 9c3c2354a809d03bef992415ec87b6d277ea49b3 Mon Sep 17 00:00:00 2001 From: ehardon Date: Thu, 4 Mar 2021 13:40:15 +0200 Subject: [PATCH 2/5] APPS-832: address PR comment --- .../RecordsManagementAdminServiceImpl.java | 50 +++++++------------ .../java/org/alfresco/util/LockCallback.java | 27 ++++++++++ 2 files changed, 44 insertions(+), 33 deletions(-) create mode 100644 rm-community/rm-community-repo/source/java/org/alfresco/util/LockCallback.java diff --git a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/admin/RecordsManagementAdminServiceImpl.java b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/admin/RecordsManagementAdminServiceImpl.java index 0e8da44a36..cce7d92977 100644 --- a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/admin/RecordsManagementAdminServiceImpl.java +++ b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/admin/RecordsManagementAdminServiceImpl.java @@ -37,7 +37,6 @@ import java.util.HashSet; import java.util.List; import java.util.Map; import java.util.Set; -import java.util.concurrent.atomic.AtomicBoolean; import org.alfresco.error.AlfrescoRuntimeException; import org.alfresco.model.ContentModel; @@ -55,7 +54,6 @@ import org.alfresco.repo.dictionary.M2Constraint; import org.alfresco.repo.dictionary.M2Model; import org.alfresco.repo.dictionary.M2Property; import org.alfresco.repo.lock.JobLockService; -import org.alfresco.repo.lock.JobLockService.JobLockRefreshCallback; import org.alfresco.repo.lock.LockAcquisitionException; import org.alfresco.repo.node.NodeServicePolicies; import org.alfresco.repo.policy.Behaviour.NotificationFrequency; @@ -80,6 +78,9 @@ import org.alfresco.service.namespace.QName; import org.alfresco.service.namespace.RegexQNamePattern; import org.alfresco.service.transaction.TransactionService; import org.alfresco.util.GUID; +import org.alfresco.util.LockCallback; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; import org.springframework.context.ApplicationListener; import org.springframework.context.event.ContextRefreshedEvent; import org.springframework.core.Ordered; @@ -101,6 +102,9 @@ public class RecordsManagementAdminServiceImpl extends RecordsManagementAdminBas ApplicationListener, Ordered { + + private static final Logger LOGGER = LoggerFactory.getLogger(RecordsManagementAdminServiceImpl.class); + /** I18N messages*/ private static final String MSG_SERVICE_NOT_INIT = "rm.admin.service-not-init"; private static final String MSG_PROP_EXIST = "rm.admin.prop-exist"; @@ -113,10 +117,12 @@ public class RecordsManagementAdminServiceImpl extends RecordsManagementAdminBas /** Constants */ private static final String CUSTOM_CONSTRAINT_TYPE = org.alfresco.module.org_alfresco_module_rm.caveat.RMListOfValuesConstraint.class.getName(); - private static final String CAPATIBILITY_CUSTOM_CONTRAINT_TYPE = org.alfresco.module.org_alfresco_module_dod5015.caveat.RMListOfValuesConstraint.class.getName(); + private static final String CAPABILITY_CUSTOM_CONSTRAINT_TYPE = org.alfresco.module.org_alfresco_module_dod5015.caveat.RMListOfValuesConstraint.class.getName(); private static final String PARAM_ALLOWED_VALUES = "allowedValues"; private static final String PARAM_CASE_SENSITIVE = "caseSensitive"; private static final String PARAM_MATCH_LOGIC = "matchLogic"; + + private static final QName LOCK_QNAME = QName.createQName(NamespaceService.SYSTEM_MODEL_1_0_URI, "RecordsManagementAdminServiceImpl"); private static final long DEFAULT_TIME = 30000L; /** Relationship service */ @@ -197,7 +203,7 @@ public class RecordsManagementAdminServiceImpl extends RecordsManagementAdminBas { try { - jobLockService.refreshLock(lockToken, getLockQName(), DEFAULT_TIME, lockCallback); + jobLockService.refreshLock(lockToken, LOCK_QNAME, DEFAULT_TIME, lockCallback); if (!isCustomMapInit && getDictionaryService().getAllModels().contains(RM_CUSTOM_MODEL)) { @@ -226,27 +232,21 @@ public class RecordsManagementAdminServiceImpl extends RecordsManagementAdminBas { try { - lockCallback.running.set(false); - jobLockService.releaseLock(lockToken, getLockQName()); + lockCallback.setIsRunning(false); + jobLockService.releaseLock(lockToken, LOCK_QNAME); } catch (LockAcquisitionException e) { - // Ignore - if (logger.isDebugEnabled()) + if (LOGGER.isDebugEnabled()) { - logger.debug("Lock release failed: " + getLockQName() + ": " + lockToken + "(" - + e.getMessage() + ")"); + LOGGER.debug("Lock release failed: {}: {}", LOCK_QNAME, lockToken, e); + } } } } } - private QName getLockQName() - { - return QName.createQName(NamespaceService.SYSTEM_MODEL_1_0_URI, this.getClass().getName()); - } - /** * Attempts to get the lock. If the lock couldn't be taken, then null is returned. * @@ -256,7 +256,7 @@ public class RecordsManagementAdminServiceImpl extends RecordsManagementAdminBas { try { - return jobLockService.getLock(getLockQName(), DEFAULT_TIME); + return jobLockService.getLock(LOCK_QNAME, DEFAULT_TIME); } catch (LockAcquisitionException e) { @@ -264,22 +264,6 @@ public class RecordsManagementAdminServiceImpl extends RecordsManagementAdminBas } } - private class LockCallback implements JobLockRefreshCallback - { - final AtomicBoolean running = new AtomicBoolean(true); - - @Override - public boolean isActive() - { - return running.get(); - } - - @Override - public void lockReleased() - { - running.set(false); - } - } /** * Helper method to indicate whether the custom map is initialised or not. @@ -1283,7 +1267,7 @@ public class RecordsManagementAdminServiceImpl extends RecordsManagementAdminBas String type = customConstraint.getType(); if (type == null || (!type.equals(CUSTOM_CONSTRAINT_TYPE) && - !type.equals(CAPATIBILITY_CUSTOM_CONTRAINT_TYPE))) + !type.equals(CAPABILITY_CUSTOM_CONSTRAINT_TYPE))) { throw new AlfrescoRuntimeException(I18NUtil.getMessage(MSG_UNEXPECTED_TYPE_CONSTRAINT, type, constraintNameAsPrefixString, CUSTOM_CONSTRAINT_TYPE)); } diff --git a/rm-community/rm-community-repo/source/java/org/alfresco/util/LockCallback.java b/rm-community/rm-community-repo/source/java/org/alfresco/util/LockCallback.java new file mode 100644 index 0000000000..c89eccbd93 --- /dev/null +++ b/rm-community/rm-community-repo/source/java/org/alfresco/util/LockCallback.java @@ -0,0 +1,27 @@ +package org.alfresco.util; + +import java.util.concurrent.atomic.AtomicBoolean; + +import org.alfresco.repo.lock.JobLockService.JobLockRefreshCallback; + +public class LockCallback implements JobLockRefreshCallback +{ + private final AtomicBoolean running = new AtomicBoolean(true); + + @Override + public boolean isActive() + { + return running.get(); + } + + @Override + public void lockReleased() + { + running.set(false); + } + + public void setIsRunning(boolean isRunning) + { + this.running.set(isRunning); + } +} From 20f877d5fe93a7d6e73528a546b9d89d00298971 Mon Sep 17 00:00:00 2001 From: ehardon Date: Thu, 4 Mar 2021 15:54:31 +0200 Subject: [PATCH 3/5] add header for LockCallback class --- .../java/org/alfresco/util/LockCallback.java | 27 +++++++++++++++++++ 1 file changed, 27 insertions(+) diff --git a/rm-community/rm-community-repo/source/java/org/alfresco/util/LockCallback.java b/rm-community/rm-community-repo/source/java/org/alfresco/util/LockCallback.java index c89eccbd93..ae87470fa3 100644 --- a/rm-community/rm-community-repo/source/java/org/alfresco/util/LockCallback.java +++ b/rm-community/rm-community-repo/source/java/org/alfresco/util/LockCallback.java @@ -1,3 +1,30 @@ +/* + * #%L + * Alfresco Records Management Module + * %% + * Copyright (C) 2005 - 2021 Alfresco Software Limited + * %% + * This file is part of the Alfresco software. + * - + * If the software was purchased under a paid Alfresco license, the terms of + * the paid license agreement will prevail. Otherwise, the software is + * provided under the following open source license terms: + * - + * Alfresco is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * - + * Alfresco is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License for more details. + * - + * You should have received a copy of the GNU Lesser General Public License + * along with Alfresco. If not, see . + * #L% + */ + package org.alfresco.util; import java.util.concurrent.atomic.AtomicBoolean; From ab3f4a16eb7e25244f1ebd348c6e3f1c624b149e Mon Sep 17 00:00:00 2001 From: ehardon Date: Fri, 5 Mar 2021 10:14:53 +0200 Subject: [PATCH 4/5] address PR comment --- .../RecordsManagementAdminServiceImpl.java | 25 ++++++------------- 1 file changed, 8 insertions(+), 17 deletions(-) diff --git a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/admin/RecordsManagementAdminServiceImpl.java b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/admin/RecordsManagementAdminServiceImpl.java index cce7d92977..bcd9e3fbe0 100644 --- a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/admin/RecordsManagementAdminServiceImpl.java +++ b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/admin/RecordsManagementAdminServiceImpl.java @@ -208,24 +208,15 @@ public class RecordsManagementAdminServiceImpl extends RecordsManagementAdminBas if (!isCustomMapInit && getDictionaryService().getAllModels().contains(RM_CUSTOM_MODEL)) { // run as System on bootstrap - AuthenticationUtil.runAs(new RunAsWork() - { - public Object doWork() - { - RetryingTransactionCallback callback = new RetryingTransactionCallback() - { - public Void execute() - { - // initialise custom properties - initCustomMap(); - return null; - } - }; - transactionService.getRetryingTransactionHelper().doInTransaction(callback); - + AuthenticationUtil.runAsSystem((RunAsWork) () -> { + transactionService.getRetryingTransactionHelper() + .doInTransaction((RetryingTransactionCallback) () -> { + // initialise custom properties + initCustomMap(); return null; - } - }, AuthenticationUtil.getSystemUserName()); + }); + return null; + }); } } finally From b8847e4089c51672f7a5427cc2d7d2be3f1dd655 Mon Sep 17 00:00:00 2001 From: ehardon Date: Fri, 5 Mar 2021 13:59:52 +0200 Subject: [PATCH 5/5] - remove logger check --- .../admin/RecordsManagementAdminServiceImpl.java | 6 +----- 1 file changed, 1 insertion(+), 5 deletions(-) diff --git a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/admin/RecordsManagementAdminServiceImpl.java b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/admin/RecordsManagementAdminServiceImpl.java index bcd9e3fbe0..6fce532585 100644 --- a/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/admin/RecordsManagementAdminServiceImpl.java +++ b/rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/admin/RecordsManagementAdminServiceImpl.java @@ -228,11 +228,7 @@ public class RecordsManagementAdminServiceImpl extends RecordsManagementAdminBas } catch (LockAcquisitionException e) { - if (LOGGER.isDebugEnabled()) - { - LOGGER.debug("Lock release failed: {}: {}", LOCK_QNAME, lockToken, e); - - } + LOGGER.debug("Lock release failed: {}: {}", LOCK_QNAME, lockToken, e); } } }