inteligr8/alfresco-community-repo
1
0
Fork 0
mirror of https://github.com/Alfresco/alfresco-community-repo.git synced 2025-08-07 17:49:17 +00:00
Code Issues Packages Projects Releases Wiki Activity

RM-6860: Add hold service policies

Browse Source 
- Added HoldServicePolicies interface
This commit is contained in:
Ramona Popa
2019-11-03 06:47:29 +00:00
parent 775ca13f2c
commit a1be193a3f
6 changed files with 347 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

111
rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/hold/HoldServiceImpl.java
View File

@@ -28,6 +28,7 @@
package org.alfresco.module.org_alfresco_module_rm.hold;
import static org.alfresco.model.ContentModel.ASPECT_LOCKABLE;
import static org.alfresco.model.ContentModel.PROP_NAME;
import java.io.Serializable;
import java.util.ArrayList;
@@ -46,6 +47,10 @@ import org.alfresco.module.org_alfresco_module_rm.audit.event.AuditEvent;
import org.alfresco.module.org_alfresco_module_rm.capability.CapabilityService;
import org.alfresco.module.org_alfresco_module_rm.capability.RMPermissionModel;
import org.alfresco.module.org_alfresco_module_rm.fileplan.FilePlanService;
import org.alfresco.module.org_alfresco_module_rm.hold.HoldServicePolicies.BeforeCreateHoldPolicy;
import org.alfresco.module.org_alfresco_module_rm.hold.HoldServicePolicies.BeforeDeleteHoldPolicy;
import org.alfresco.module.org_alfresco_module_rm.hold.HoldServicePolicies.OnCreateHoldPolicy;
import org.alfresco.module.org_alfresco_module_rm.hold.HoldServicePolicies.OnDeleteHoldPolicy;
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;
@@ -53,6 +58,8 @@ import org.alfresco.module.org_alfresco_module_rm.util.ServiceBaseImpl;
import org.alfresco.repo.node.NodeServicePolicies;
import org.alfresco.repo.node.integrity.IntegrityException;
import org.alfresco.repo.policy.Behaviour.NotificationFrequency;
import org.alfresco.repo.policy.ClassPolicyDelegate;
import org.alfresco.repo.policy.PolicyComponent;
import org.alfresco.repo.policy.annotation.Behaviour;
import org.alfresco.repo.policy.annotation.BehaviourBean;
import org.alfresco.repo.policy.annotation.BehaviourKind;
@@ -113,6 +120,9 @@ public class HoldServiceImpl extends ServiceBaseImpl
/** Capability service */
private CapabilityService capabilityService;
/** Policy component */
private PolicyComponent policyComponent;
/**
* Set the file plan service
*
@@ -169,6 +179,34 @@ public class HoldServiceImpl extends ServiceBaseImpl
this.capabilityService = capabilityService;
}
/**
* Gets the policy component instance
*
* @return The policy component instance
*/
protected PolicyComponent getPolicyComponent()
{
return this.policyComponent;
}
/**
* Sets the policy component instance
*
* @param policyComponent The policy component instance
*/
public void setPolicyComponent(PolicyComponent policyComponent)
{
this.policyComponent = policyComponent;
}
/**
* Policy delegates
*/
private ClassPolicyDelegate<BeforeCreateHoldPolicy> beforeCreateHoldPolicyDelegate;
private ClassPolicyDelegate<OnCreateHoldPolicy> onCreateHoldPolicyDelegate;
private ClassPolicyDelegate<BeforeDeleteHoldPolicy> beforeDeleteHoldPolicyDelegate;
private ClassPolicyDelegate<OnDeleteHoldPolicy> onDeleteHoldPolicyDelegate;
/**
* Initialise hold service
*/
@@ -184,6 +222,12 @@ public class HoldServiceImpl extends ServiceBaseImpl
return null;
}
});
// Register the policies
beforeCreateHoldPolicyDelegate = getPolicyComponent().registerClassPolicy(BeforeCreateHoldPolicy.class);
onCreateHoldPolicyDelegate = getPolicyComponent().registerClassPolicy(OnCreateHoldPolicy.class);
beforeDeleteHoldPolicyDelegate = getPolicyComponent().registerClassPolicy(BeforeDeleteHoldPolicy.class);
onDeleteHoldPolicyDelegate = getPolicyComponent().registerClassPolicy(OnDeleteHoldPolicy.class);
}
/**
@@ -209,7 +253,6 @@ public class HoldServiceImpl extends ServiceBaseImpl
transactionalResourceHelper.getSet("frozen").add(frozenNode);
removeFreezeAspect(frozenNode, 1);
}
return null;
}
};
@@ -417,6 +460,8 @@ public class HoldServiceImpl extends ServiceBaseImpl
// get the root hold container
NodeRef holdContainer = filePlanService.getHoldContainer(filePlan);
invokeBeforeCreateHold(holdContainer, name, reason);
// create map of properties
Map<QName, Serializable> properties = new HashMap<>(3);
properties.put(ContentModel.PROP_NAME, name);
@@ -432,7 +477,11 @@ public class HoldServiceImpl extends ServiceBaseImpl
// create hold
ChildAssociationRef childAssocRef = nodeService.createNode(holdContainer, ContentModel.ASSOC_CONTAINS, assocName, TYPE_HOLD, properties);
return childAssocRef.getChildRef();
NodeRef holdNodeRef = childAssocRef.getChildRef();
invokeOnCreateHold(holdNodeRef);
return holdNodeRef;
}
/**
@@ -520,8 +569,15 @@ public class HoldServiceImpl extends ServiceBaseImpl
throw new AlfrescoRuntimeException("Can't delete hold, because filing permissions for the following items are needed: " + sb.toString());
}
invokeBeforeDeleteHold(hold);
String holdName = (String) nodeService.getProperty(hold, PROP_NAME);
Set<QName> classQNames = getTypeAndApsects(hold);
// delete the hold node
nodeService.deleteNode(hold);
invokeOnDeleteHold(holdName, classQNames);
}
/**
@@ -809,4 +865,55 @@ public class HoldServiceImpl extends ServiceBaseImpl
removeFromAllHolds(nodeRef);
}
}
/**
* Invoke beforeCreateHold policy
*
* @param nodeRef node reference
* @param name hold name
* @param reason hold reason
*/
protected void invokeBeforeCreateHold(NodeRef nodeRef, String name, String reason)
{
// execute policy for node type and aspects
BeforeCreateHoldPolicy policy = beforeCreateHoldPolicyDelegate.get(getTypeAndApsects(nodeRef));
policy.beforeCreateHold(name, reason);
}
/**
* Invoke onCreateHold policy
*
* @param nodeRef node reference
*/
protected void invokeOnCreateHold(NodeRef nodeRef)
{
OnCreateHoldPolicy policy = onCreateHoldPolicyDelegate.get(getTypeAndApsects(nodeRef));
policy.onCreateHold(nodeRef);
}
/**
* Invoke beforeDeleteHold policy
*
* @param nodeRef node reference
*/
protected void invokeBeforeDeleteHold(NodeRef nodeRef)
{
BeforeDeleteHoldPolicy policy = beforeDeleteHoldPolicyDelegate.get(getTypeAndApsects(nodeRef));
policy.beforeDeleteHold(nodeRef);
}
/**
* Invoke onDeleteHold policy
*
* @param holdName name of the hold
* @param classQNames hold types and aspects
*/
protected void invokeOnDeleteHold(String holdName, Set<QName> classQNames)
{
// execute policy for node type and aspects
OnDeleteHoldPolicy policy = onDeleteHoldPolicyDelegate.get(classQNames);
policy.onDeleteHold(holdName);
}
}

89
rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/hold/HoldServicePolicies.java Normal file
View File

@@ -0,0 +1,89 @@
/*
* #%L
* Alfresco Records Management Module
* %%
* Copyright (C) 2005 - 2019 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 <http://www.gnu.org/licenses/>.
* #L%
*/
package org.alfresco.module.org_alfresco_module_rm.hold;
import org.alfresco.repo.policy.ClassPolicy;
import org.alfresco.service.cmr.repository.NodeRef;
import org.alfresco.service.namespace.NamespaceService;
import org.alfresco.service.namespace.QName;
/**
* Hold Service Policies
*
* @author Ramona Popa
* @since 3.3
*/
public interface HoldServicePolicies
{
interface BeforeCreateHoldPolicy extends ClassPolicy
{
public static final QName QNAME = QName.createQName(NamespaceService.ALFRESCO_URI, "beforeCreateHold");
/**
* Called before a hold is created.
*
* @param name name of the hold to be created
* @param reason reason for the hold to be created
*/
void beforeCreateHold(String name, String reason);
}
interface OnCreateHoldPolicy extends ClassPolicy
{
public static final QName QNAME = QName.createQName(NamespaceService.ALFRESCO_URI, "onCreateHold");
/**
* Called when a hold is created.
*
* @param hold node reference
*/
void onCreateHold(NodeRef hold);
}
interface BeforeDeleteHoldPolicy extends ClassPolicy
{
public static final QName QNAME = QName.createQName(NamespaceService.ALFRESCO_URI, "beforeDeleteHold");
/**
* Called before a hold is deleted.
*
* @param hold node reference
*/
void beforeDeleteHold(NodeRef hold);
}
interface OnDeleteHoldPolicy extends ClassPolicy
{
public static final QName QNAME = QName.createQName(NamespaceService.ALFRESCO_URI, "onDeleteHold");
/**
* Called when a hold is deleted.
*
* @param holdname name of the deleted hold
*/
void onDeleteHold(String holdname);
}
}