Refactored FreezeService after adding the HoldService

git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/modules/recordsmanagement/HEAD@63769 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261
This commit is contained in:
Tuna Aksoy
2014-03-07 15:27:40 +00:00
parent 90c40688ec
commit e5abd6fb99
9 changed files with 205 additions and 181 deletions

View File

@@ -953,9 +953,8 @@
<property name="dictionaryService" ref="DictionaryService" />
<property name="recordService" ref="RecordService" />
<property name="filePlanService" ref="FilePlanService" />
<property name="permissionService" ref="PermissionService" />
<property name="filePlanRoleService" ref="FilePlanRoleService" />
<property name="recordFolderService" ref="RecordFolderService" />
<property name="holdService" ref="HoldService" />
</bean>
<bean id="FreezeService" class="org.springframework.aop.framework.ProxyFactoryBean">
@@ -1643,6 +1642,8 @@
class="org.alfresco.module.org_alfresco_module_rm.fileplan.hold.HoldServiceImpl">
<property name="filePlanService" ref="FilePlanService" />
<property name="nodeService" ref="NodeService" />
<property name="recordService" ref="RecordService" />
<property name="recordFolderService" ref="RecordFolderService" />
</bean>
<bean id="HoldService"

View File

@@ -42,31 +42,31 @@ public interface HoldService
* Adds the record to the given hold
*
* @param hold The {@link NodeRef} of the hold
* @param record The {@link NodeRef} of the record which will be added to the given hold
* @param nodeRef The {@link NodeRef} of the record / record folder which will be added to the given hold
*/
void addToHoldContainer(NodeRef hold, NodeRef record);
void addToHoldContainer(NodeRef hold, NodeRef nodeRef);
/**
* Adds the record to the given list of holds
*
* @param holds The list of {@link NodeRef}s of the holds
* @param record The {@link NodeRef} of the record which will be added to the given holds
* @param nodeRef The {@link NodeRef} of the record / record folder which will be added to the given holds
*/
void addToHoldContainers(List<NodeRef> holds, NodeRef record);
void addToHoldContainers(List<NodeRef> holds, NodeRef nodeRef);
/**
* Removes the record from the given hold
*
* @param hold The {@link NodeRef} of the hold
* @param record The {@link NodeRef} of the record which will be removed from the given hold
* @param nodeRef The {@link NodeRef} of the record / record folder which will be removed from the given hold
*/
void removeFromHoldContainer(NodeRef hold, NodeRef record);
void removeFromHoldContainer(NodeRef hold, NodeRef nodeRef);
/**
* Removes the record from the given list of hold
*
* @param holds The list {@link NodeRef}s of the holds
* @param record The {@link NodeRef} of the record which will be removed from the given holds
* @param nodeRef The {@link NodeRef} of the record / record folder which will be removed from the given holds
*/
void removeFromHoldContainers(List<NodeRef> holds, NodeRef record);
void removeFromHoldContainers(List<NodeRef> holds, NodeRef nodeRef);
}

View File

@@ -18,18 +18,28 @@
*/
package org.alfresco.module.org_alfresco_module_rm.fileplan.hold;
import java.io.Serializable;
import java.util.ArrayList;
import java.util.Collections;
import java.util.Date;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import org.alfresco.model.ContentModel;
import org.alfresco.module.org_alfresco_module_rm.fileplan.FilePlanService;
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.repo.security.authentication.AuthenticationUtil;
import org.alfresco.service.cmr.repository.ChildAssociationRef;
import org.alfresco.service.cmr.repository.NodeRef;
import org.alfresco.service.cmr.repository.NodeService;
import org.alfresco.service.namespace.NamespaceService;
import org.alfresco.service.namespace.QName;
import org.alfresco.service.namespace.RegexQNamePattern;
import org.alfresco.util.ParameterCheck;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
/**
* Hold service implementation
@@ -37,14 +47,23 @@ import org.alfresco.util.ParameterCheck;
* @author Tuna Aksoy
* @since 2.2
*/
public class HoldServiceImpl implements HoldService
public class HoldServiceImpl implements HoldService, RecordsManagementModel
{
/** Logger */
private static Log logger = LogFactory.getLog(HoldServiceImpl.class);
/** File Plan Service */
private FilePlanService filePlanService;
/** Node Service */
private NodeService nodeService;
/** Record Service */
private RecordService recordService;
/** Record Folder Service */
private RecordFolderService recordFolderService;
/**
* Set the file plan service
*
@@ -65,6 +84,26 @@ public class HoldServiceImpl implements HoldService
this.nodeService = nodeService;
}
/**
* Set the record service
*
* @param recordService the record service
*/
public void setRecordService(RecordService recordService)
{
this.recordService = recordService;
}
/**
* Set the record folder service
*
* @param recordFolderService the record folder service
*/
public void setRecordFolderService(RecordFolderService recordFolderService)
{
this.recordFolderService = recordFolderService;
}
/**
* @see org.alfresco.module.org_alfresco_module_rm.fileplan.hold.HoldService#getHolds(org.alfresco.service.cmr.repository.NodeRef)
*/
@@ -74,12 +113,15 @@ public class HoldServiceImpl implements HoldService
ParameterCheck.mandatory("filePlan", filePlan);
NodeRef holdContainer = filePlanService.getHoldContainer(filePlan);
List<ChildAssociationRef> holdsAssocs = nodeService.getChildAssocs(holdContainer);
List<ChildAssociationRef> holdsAssocs = nodeService.getChildAssocs(holdContainer, ContentModel.ASSOC_CONTAINS, RegexQNamePattern.MATCH_ALL);
List<NodeRef> holds = new ArrayList<NodeRef>(holdsAssocs.size());
if (holdsAssocs != null && !holdsAssocs.isEmpty())
{
for (ChildAssociationRef holdAssoc : holdsAssocs)
{
holds.add(holdAssoc.getChildRef());
}
}
return holds;
}
@@ -88,32 +130,64 @@ public class HoldServiceImpl implements HoldService
* @see org.alfresco.module.org_alfresco_module_rm.fileplan.hold.HoldService#addToHoldContainer(org.alfresco.service.cmr.repository.NodeRef, org.alfresco.service.cmr.repository.NodeRef)
*/
@Override
public void addToHoldContainer(NodeRef hold, NodeRef record)
public void addToHoldContainer(NodeRef hold, NodeRef nodeRef)
{
ParameterCheck.mandatory("hold", hold);
ParameterCheck.mandatory("record", record);
ParameterCheck.mandatory("nodeRef", nodeRef);
List<NodeRef> holds = new ArrayList<NodeRef>(1);
holds.add(hold);
addToHoldContainers(Collections.unmodifiableList(holds), record);
addToHoldContainers(Collections.unmodifiableList(holds), nodeRef);
}
/**
* @see org.alfresco.module.org_alfresco_module_rm.fileplan.hold.HoldService#addToHoldContainers(java.util.List, org.alfresco.service.cmr.repository.NodeRef)
*/
@Override
public void addToHoldContainers(List<NodeRef> holds, NodeRef record)
public void addToHoldContainers(List<NodeRef> holds, NodeRef nodeRef)
{
ParameterCheck.mandatoryCollection("holds", holds);
ParameterCheck.mandatory("record", record);
String recordName = (String) nodeService.getProperty(record, ContentModel.PROP_NAME);
String validLocalName = QName.createValidLocalName(recordName);
QName name = QName.createQName(NamespaceService.CONTENT_MODEL_1_0_URI, validLocalName);
ParameterCheck.mandatory("nodeRef", nodeRef);
for (NodeRef hold : holds)
{
nodeService.addChild(hold, record, ContentModel.ASSOC_CONTAINS, name);
// Link the record to the hold
nodeService.addChild(hold, nodeRef, ASSOC_FROZEN_RECORDS, ASSOC_FROZEN_RECORDS);
// Apply the freeze aspect
Map<QName, Serializable> props = new HashMap<QName, Serializable>(2);
props.put(PROP_FROZEN_AT, new Date());
props.put(PROP_FROZEN_BY, AuthenticationUtil.getFullyAuthenticatedUser());
nodeService.addAspect(nodeRef, ASPECT_FROZEN, props);
// Log a message about applying the the frozen aspect
if (logger.isDebugEnabled())
{
StringBuilder msg = new StringBuilder();
msg.append("Frozen aspect applied to '").append(nodeRef).append("'.");
logger.debug(msg.toString());
}
// Mark all the folders contents as frozen
if (recordFolderService.isRecordFolder(nodeRef))
{
List<NodeRef> records = recordService.getRecords(nodeRef);
for (NodeRef record : records)
{
// no need to freeze if already frozen!
if (nodeService.hasAspect(record, ASPECT_FROZEN) == false)
{
nodeService.addAspect(record, ASPECT_FROZEN, props);
if (logger.isDebugEnabled())
{
StringBuilder msg = new StringBuilder();
msg.append("Frozen aspect applied to '").append(record).append("'.");
logger.debug(msg.toString());
}
}
}
}
}
}
@@ -121,28 +195,28 @@ public class HoldServiceImpl implements HoldService
* @see org.alfresco.module.org_alfresco_module_rm.fileplan.hold.HoldService#removeFromHoldContainer(org.alfresco.service.cmr.repository.NodeRef, org.alfresco.service.cmr.repository.NodeRef)
*/
@Override
public void removeFromHoldContainer(NodeRef hold, NodeRef record)
public void removeFromHoldContainer(NodeRef hold, NodeRef nodeRef)
{
ParameterCheck.mandatory("hold", hold);
ParameterCheck.mandatory("record", record);
ParameterCheck.mandatory("nodeRef", nodeRef);
List<NodeRef> holds = new ArrayList<NodeRef>(1);
holds.add(hold);
removeFromHoldContainers(Collections.unmodifiableList(holds), record);
removeFromHoldContainers(Collections.unmodifiableList(holds), nodeRef);
}
/**
* @see org.alfresco.module.org_alfresco_module_rm.fileplan.hold.HoldService#removeFromHoldContainers(java.util.List, org.alfresco.service.cmr.repository.NodeRef)
*/
@Override
public void removeFromHoldContainers(List<NodeRef> holds, NodeRef record)
public void removeFromHoldContainers(List<NodeRef> holds, NodeRef nodeRef)
{
ParameterCheck.mandatory("holds", holds);
ParameterCheck.mandatory("record", record);
ParameterCheck.mandatory("nodeRef", nodeRef);
for (NodeRef hold : holds)
{
nodeService.removeChild(hold, record);
nodeService.removeChild(hold, nodeRef);
}
}
}

View File

@@ -21,6 +21,7 @@ package org.alfresco.module.org_alfresco_module_rm.freeze;
import java.util.Date;
import java.util.Set;
import org.alfresco.module.org_alfresco_module_rm.fileplan.hold.HoldService;
import org.alfresco.service.cmr.repository.NodeRef;
/**
@@ -75,7 +76,10 @@ public interface FreezeService
*
* @param hold hold node reference
* @param nodeRef node reference
*
* @deprecated as of 2.2, use {@link HoldService#addToHoldContainer(NodeRef, NodeRef)} instead
*/
@Deprecated
void freeze(NodeRef hold, NodeRef nodeRef);
/**
@@ -144,7 +148,10 @@ public interface FreezeService
*
* @param filePlan file plan for which the hold nodes will be retrieved
* @return Set<NodeRef> hold node references
*
* @deprecated as of 2.2, use {@link HoldService#getHolds(NodeRef)} instead
*/
@Deprecated
Set<NodeRef> getHolds(NodeRef filePlan);
/**

View File

@@ -29,16 +29,14 @@ import java.util.Set;
import org.alfresco.error.AlfrescoRuntimeException;
import org.alfresco.model.ContentModel;
import org.alfresco.module.org_alfresco_module_rm.fileplan.FilePlanService;
import org.alfresco.module.org_alfresco_module_rm.fileplan.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.role.FilePlanRoleService;
import org.alfresco.module.org_alfresco_module_rm.util.ServiceBaseImpl;
import org.alfresco.repo.security.authentication.AuthenticationUtil;
import org.alfresco.repo.transaction.AlfrescoTransactionSupport;
import org.alfresco.service.cmr.repository.ChildAssociationRef;
import org.alfresco.service.cmr.repository.NodeRef;
import org.alfresco.service.cmr.security.PermissionService;
import org.alfresco.service.namespace.QName;
import org.alfresco.service.namespace.RegexQNamePattern;
import org.alfresco.util.ParameterCheck;
@@ -74,15 +72,12 @@ public class FreezeServiceImpl extends ServiceBaseImpl
/** File Plan Service */
protected FilePlanService filePlanService;
/** Permission service */
protected PermissionService permissionService;
/** File plan role service */
protected FilePlanRoleService filePlanRoleService;
/** Record folder service */
protected RecordFolderService recordFolderService;
/** Hold service */
protected HoldService holdService;
/**
* @param recordService record service
*/
@@ -99,22 +94,6 @@ public class FreezeServiceImpl extends ServiceBaseImpl
this.filePlanService = filePlanService;
}
/**
* @param permissionService permission service
*/
public void setPermissionService(PermissionService permissionService)
{
this.permissionService = permissionService;
}
/**
* @param filePlanRoleService file plan role service
*/
public void setFilePlanRoleService(FilePlanRoleService filePlanRoleService)
{
this.filePlanRoleService = filePlanRoleService;
}
/**
* @param recordFolderService record folder service
*/
@@ -123,6 +102,14 @@ public class FreezeServiceImpl extends ServiceBaseImpl
this.recordFolderService = recordFolderService;
}
/**
* @param holdService hold service
*/
public void setHoldService(HoldService holdService)
{
this.holdService = holdService;
}
/**
* @see org.alfresco.module.org_alfresco_module_rm.freeze.FreezeService#isHold(org.alfresco.service.cmr.repository.NodeRef)
*/
@@ -227,43 +214,7 @@ public class FreezeServiceImpl extends ServiceBaseImpl
ParameterCheck.mandatory("hold", hold);
ParameterCheck.mandatory("nodeRef", nodeRef);
// Link the record to the hold
nodeService.addChild(hold, nodeRef, ASSOC_FROZEN_RECORDS, ASSOC_FROZEN_RECORDS);
// Apply the freeze aspect
Map<QName, Serializable> props = new HashMap<QName, Serializable>(2);
props.put(PROP_FROZEN_AT, new Date());
props.put(PROP_FROZEN_BY, AuthenticationUtil.getFullyAuthenticatedUser());
nodeService.addAspect(nodeRef, ASPECT_FROZEN, props);
// Log a message about applying the the frozen aspect
if (logger.isDebugEnabled())
{
StringBuilder msg = new StringBuilder();
msg.append("Frozen aspect applied to '").append(nodeRef).append("'.");
logger.debug(msg.toString());
}
// Mark all the folders contents as frozen
if (recordFolderService.isRecordFolder(nodeRef))
{
List<NodeRef> records = recordService.getRecords(nodeRef);
for (NodeRef record : records)
{
// no need to freeze if already frozen!
if (nodeService.hasAspect(record, ASPECT_FROZEN) == false)
{
nodeService.addAspect(record, ASPECT_FROZEN, props);
if (logger.isDebugEnabled())
{
StringBuilder msg = new StringBuilder();
msg.append("Frozen aspect applied to '").append(record).append("'.");
logger.debug(msg.toString());
}
}
}
}
holdService.addToHoldContainer(hold, nodeRef);
}
/**
@@ -430,18 +381,7 @@ public class FreezeServiceImpl extends ServiceBaseImpl
{
ParameterCheck.mandatory("filePlan", filePlan);
Set<NodeRef> holds = new HashSet<NodeRef>();
NodeRef holdContainer = filePlanService.getHoldContainer(filePlan);
List<ChildAssociationRef> childAssocs = nodeService.getChildAssocs(holdContainer, ContentModel.ASSOC_CONTAINS, RegexQNamePattern.MATCH_ALL);
if (childAssocs != null && !childAssocs.isEmpty())
{
for (ChildAssociationRef childAssoc : childAssocs)
{
holds.add(childAssoc.getChildRef());
}
}
return holds;
return new HashSet<NodeRef>(holdService.getHolds(filePlan));
}
/**

View File

@@ -22,7 +22,6 @@ import java.io.Serializable;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Set;
import org.alfresco.model.ContentModel;
import org.alfresco.module.org_alfresco_module_rm.capability.Capability;
@@ -128,7 +127,7 @@ public class RM1008Test extends BaseRMTestCase
{
// create hold object
freezeService.freeze("test", rmFolder);
Set<NodeRef> holds = freezeService.getHolds(filePlan);
List<NodeRef> holds = holdService.getHolds(filePlan);
return holds.iterator().next();
}
}, rmAdminName);

View File

@@ -18,7 +18,7 @@
*/
package org.alfresco.module.org_alfresco_module_rm.test.issue;
import java.util.Set;
import java.util.List;
import org.alfresco.module.org_alfresco_module_rm.test.util.BaseRMTestCase;
import org.alfresco.service.cmr.repository.NodeRef;
@@ -46,7 +46,7 @@ public class RM1030Test extends BaseRMTestCase
public NodeRef run()
{
// show there are no holds when we start
Set<NodeRef> holds = freezeService.getHolds(filePlan);
List<NodeRef> holds = holdService.getHolds(filePlan);
assertNotNull(holds);
assertEquals(0, holds.size());
@@ -64,7 +64,7 @@ public class RM1030Test extends BaseRMTestCase
assertTrue(freezeService.isFrozen(recordOne));
// count the number of holds
Set<NodeRef> holds = freezeService.getHolds(filePlan);
List<NodeRef> holds = holdService.getHolds(filePlan);
assertNotNull(holds);
assertEquals(1, holds.size());
}
@@ -91,7 +91,7 @@ public class RM1030Test extends BaseRMTestCase
assertTrue(freezeService.isFrozen(rmFolder));
// count the number of holds
Set<NodeRef> holds = freezeService.getHolds(filePlan);
List<NodeRef> holds = holdService.getHolds(filePlan);
assertNotNull(holds);
assertEquals(2, holds.size());
}
@@ -113,7 +113,7 @@ public class RM1030Test extends BaseRMTestCase
assertTrue(freezeService.isFrozen(recordOne));
assertFalse(freezeService.isFrozen(rmFolder));
Set<NodeRef> holds = freezeService.getHolds(filePlan);
List<NodeRef> holds = holdService.getHolds(filePlan);
assertNotNull(holds);
assertEquals(1, holds.size());
}
@@ -135,7 +135,7 @@ public class RM1030Test extends BaseRMTestCase
assertFalse(freezeService.isFrozen(recordOne));
assertFalse(freezeService.isFrozen(rmFolder));
Set<NodeRef> holds = freezeService.getHolds(filePlan);
List<NodeRef> holds = holdService.getHolds(filePlan);
assertNotNull(holds);
assertEquals(0, holds.size());
}

View File

@@ -65,7 +65,7 @@ public class FreezeServiceImplTest extends BaseRMTestCase
assertTrue(freezeService.hasFrozenChildren(rmFolder));
// Check the hold exists
Set<NodeRef> holdAssocs = freezeService.getHolds(filePlan);
List<NodeRef> holdAssocs = holdService.getHolds(filePlan);
assertNotNull(holdAssocs);
assertEquals(1, holdAssocs.size());
NodeRef holdNodeRef = holdAssocs.iterator().next();
@@ -98,7 +98,7 @@ public class FreezeServiceImplTest extends BaseRMTestCase
assertTrue(freezeService.isHold(newHold));
// Check the holds exist
holdAssocs = freezeService.getHolds(filePlan);
holdAssocs = holdService.getHolds(filePlan);
assertNotNull(holdAssocs);
assertEquals(2, holdAssocs.size());
for (NodeRef hold : holdAssocs)
@@ -136,7 +136,7 @@ public class FreezeServiceImplTest extends BaseRMTestCase
freezeService.unFreeze(recordThree);
// Check the holds
holdAssocs = freezeService.getHolds(filePlan);
holdAssocs = holdService.getHolds(filePlan);
assertNotNull(holdAssocs);
assertEquals(2, holdAssocs.size());
for (NodeRef hold : holdAssocs)
@@ -175,7 +175,7 @@ public class FreezeServiceImplTest extends BaseRMTestCase
freezeService.relinquish(holdNodeRef);
// Check the existing hold
holdAssocs = freezeService.getHolds(filePlan);
holdAssocs = holdService.getHolds(filePlan);
assertNotNull(holdAssocs);
assertEquals(1, holdAssocs.size());
@@ -184,7 +184,7 @@ public class FreezeServiceImplTest extends BaseRMTestCase
freezeService.unFreeze(freezeService.getFrozen(holdNodeRef));
// All holds should be deleted
holdAssocs = freezeService.getHolds(filePlan);
holdAssocs = holdService.getHolds(filePlan);
assertEquals(0, holdAssocs.size());
// Check the nodes are unfrozen
@@ -196,7 +196,7 @@ public class FreezeServiceImplTest extends BaseRMTestCase
// Test freezing nodes, adding them to an existing hold
NodeRef hold = freezeService.freeze("AnotherFreezeReason", recordFour);
freezeService.freeze(hold, recordOne);
holdService.addToHoldContainer(hold, recordOne);
Set<NodeRef> nodes = new HashSet<NodeRef>();
nodes.add(recordTwo);
nodes.add(recordThree);
@@ -204,7 +204,7 @@ public class FreezeServiceImplTest extends BaseRMTestCase
assertTrue(freezeService.hasFrozenChildren(rmFolder));
// Check the hold
holdAssocs = freezeService.getHolds(filePlan);
holdAssocs = holdService.getHolds(filePlan);
assertNotNull(holdAssocs);
assertEquals(1, holdAssocs.size());

View File

@@ -20,8 +20,8 @@ package org.alfresco.module.org_alfresco_module_rm.test.util;
import java.io.Serializable;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Set;
import org.alfresco.model.ContentModel;
import org.alfresco.module.org_alfresco_module_rm.action.RecordsManagementActionService;
@@ -34,6 +34,7 @@ import org.alfresco.module.org_alfresco_module_rm.disposition.DispositionSchedul
import org.alfresco.module.org_alfresco_module_rm.disposition.DispositionService;
import org.alfresco.module.org_alfresco_module_rm.event.RecordsManagementEventService;
import org.alfresco.module.org_alfresco_module_rm.fileplan.FilePlanService;
import org.alfresco.module.org_alfresco_module_rm.fileplan.hold.HoldService;
import org.alfresco.module.org_alfresco_module_rm.freeze.FreezeService;
import org.alfresco.module.org_alfresco_module_rm.identifier.IdentifierService;
import org.alfresco.module.org_alfresco_module_rm.model.RecordsManagementModel;
@@ -146,6 +147,7 @@ public abstract class BaseRMTestCase extends RetryingTransactionHelperTestCase
protected ReportService reportService;
protected RecordsManagementAuditService rmAuditService;
protected IdentifierService identifierService;
protected HoldService holdService;
/** test data */
protected String siteId;
@@ -395,6 +397,7 @@ public abstract class BaseRMTestCase extends RetryingTransactionHelperTestCase
reportService = (ReportService) applicationContext.getBean("ReportService");
rmAuditService = (RecordsManagementAuditService) applicationContext.getBean("RecordsManagementAuditService");
identifierService = (IdentifierService) applicationContext.getBean("recordsManagementIdentifierService");
holdService = (HoldService) applicationContext.getBean("HoldService");
}
/**
@@ -430,7 +433,7 @@ public abstract class BaseRMTestCase extends RetryingTransactionHelperTestCase
{
if (filePlan != null && nodeService.exists(filePlan) == true)
{
Set<NodeRef> holds = freezeService.getHolds(filePlan);
List<NodeRef> holds = holdService.getHolds(filePlan);
for (NodeRef hold : holds)
{
freezeService.relinquish(hold);