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

Merge RM-3227 from V2.3 to V2.4

Browse Source
This commit is contained in:
Roy Wetherall
2016-06-29 10:15:13 +10:00
parent 30d3b3aad6 3cc614d3d3
commit 850783b64a
9 changed files with 450 additions and 185 deletions
Download Patch File Download Diff File Expand all files Collapse all files

31
rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/admin/RecordsManagementAdminService.java
View File

@@ -54,11 +54,6 @@ import org.alfresco.service.namespace.RegexQNamePattern;
*/
public interface RecordsManagementAdminService
{
/**
* Initialise the custom model
*/
void initialiseCustomModel();
/**
* Get a list of all registered customisable types and aspects.
*
@@ -226,9 +221,9 @@ public interface RecordsManagementAdminService
* @return the propId.
*/
QName removeCustomPropertyDefinitionConstraints(QName propQName);
/**
* Remove custom property definition
* Remove custom property definition
*
* @param propQName
*/
@@ -352,16 +347,16 @@ public interface RecordsManagementAdminService
* @deprecated as of RM 2.3, please use {@link RelationshipService#updateRelationshipDefinition(String, org.alfresco.module.org_alfresco_module_rm.relationship.RelationshipDisplayName)} instead.
*/
QName updateCustomAssocDefinition(QName refQName, String newLabel);
/**
* This method returns ConstraintDefinition objects defined in the given model
* This method returns ConstraintDefinition objects defined in the given model
* (note: not property references or in-line defs)
* The custom constraint definitions are retrieved from the dictionaryService
* which is notified of any newly created definitions on transaction commit.
* Therefore custom constraints created in the current transaction will not appear
* in the results.
*/
List<ConstraintDefinition> getCustomConstraintDefinitions(QName modelQName);
List<ConstraintDefinition> getCustomConstraintDefinitions(QName modelQName);
/**
* This method adds a Constraint definition to the custom model.
@@ -374,22 +369,22 @@ public interface RecordsManagementAdminService
* @param title the human-readable title e.g. My foo list
* @param caseSensitive
* @param allowedValues the allowed values list
* @param matchLogic AND (all values must match), OR (at least one values must match)
* @param matchLogic AND (all values must match), OR (at least one values must match)
*/
void addCustomConstraintDefinition(QName constraintName, String title, boolean caseSensitive, List<String> allowedValues, MatchLogic matchLogic);
void addCustomConstraintDefinition(QName constraintName, String title, boolean caseSensitive, List<String> allowedValues, MatchLogic matchLogic);
/**
* Remove custom constraint definition - if not referenced (by any properties)
* Remove custom constraint definition - if not referenced (by any properties)
*
*
* @param constraintName the name e.g. rmc:foo
* @param constraintName the name e.g. rmc:foo
*/
void removeCustomConstraintDefinition(QName constraintName);
/**
* Update custom constraint definition with new list of values (replaces existing list, if any)
* Update custom constraint definition with new list of values (replaces existing list, if any)
*
* @param constraintName the name e.g. rmc:foo
* @param constraintName the name e.g. rmc:foo
* @param newValues
*/
void changeCustomConstraintValues(QName constraintName, List<String> newValues);
@@ -409,7 +404,7 @@ public interface RecordsManagementAdminService
* @return the QName of the property, association definition which matches, or null.
*/
QName getQNameForClientId(String localName);
/**
* Given a compound id for source and target strings (as used with parent/child
* custom references), this method splits the String and returns an array containing
@@ -419,7 +414,7 @@ public interface RecordsManagementAdminService
* @return a String array, where result[0] == sourceId and result[1] == targetId.
*/
String[] splitSourceTargetId(String sourceTargetId);
/**
* This method retrieves a compound ID (client-side) for the specified
* sourceId and targetId.

369
rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/admin/RecordsManagementAdminServiceImpl.java
View File

@@ -24,7 +24,6 @@
* along with Alfresco. If not, see <http://www.gnu.org/licenses/>.
* #L%
*/
package org.alfresco.module.org_alfresco_module_rm.admin;
import static org.springframework.extensions.surf.util.ParameterCheck.mandatory;
@@ -61,6 +60,7 @@ import org.alfresco.repo.policy.annotation.BehaviourBean;
import org.alfresco.repo.policy.annotation.BehaviourKind;
import org.alfresco.repo.security.authentication.AuthenticationUtil;
import org.alfresco.repo.security.authentication.AuthenticationUtil.RunAsWork;
import org.alfresco.repo.transaction.RetryingTransactionHelper.RetryingTransactionCallback;
import org.alfresco.service.cmr.dictionary.AspectDefinition;
import org.alfresco.service.cmr.dictionary.AssociationDefinition;
import org.alfresco.service.cmr.dictionary.Constraint;
@@ -73,7 +73,11 @@ import org.alfresco.service.cmr.repository.ChildAssociationRef;
import org.alfresco.service.cmr.repository.NodeRef;
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.springframework.context.ApplicationListener;
import org.springframework.context.event.ContextRefreshedEvent;
import org.springframework.core.Ordered;
import org.springframework.extensions.surf.util.I18NUtil;
import org.springframework.extensions.surf.util.URLDecoder;
@@ -83,10 +87,14 @@ import org.springframework.extensions.surf.util.URLDecoder;
* @author Neil McErlean, janv
*/
@BehaviourBean
public class RecordsManagementAdminServiceImpl extends RecordsManagementAdminBase implements RecordsManagementAdminService,
NodeServicePolicies.OnAddAspectPolicy,
NodeServicePolicies.OnRemoveAspectPolicy,
NodeServicePolicies.OnCreateNodePolicy
public class RecordsManagementAdminServiceImpl extends RecordsManagementAdminBase
implements RecordsManagementAdminService,
RecordsManagementCustomModel,
NodeServicePolicies.OnAddAspectPolicy,
NodeServicePolicies.OnRemoveAspectPolicy,
NodeServicePolicies.OnCreateNodePolicy,
ApplicationListener<ContextRefreshedEvent>,
Ordered
{
/** I18N messages*/
private static final String MSG_SERVICE_NOT_INIT = "rm.admin.service-not-init";
@@ -107,14 +115,26 @@ public class RecordsManagementAdminServiceImpl extends RecordsManagementAdminBas
/** Relationship service */
private RelationshipService relationshipService;
/** Transaction service */
private TransactionService transactionService;
/** List of types that can be customisable */
private List<QName> pendingCustomisableTypes;
private Map<QName, QName> customisableTypes;
/** indicates whether the custom map has been initialised or not */
private boolean isCustomMapInit = false;
/**
* @param transactionService transaction service
*/
public void setTransactionService(TransactionService transactionService)
{
this.transactionService = transactionService;
}
/**
* Sets the relationship instance
*
* @param relationshipService The relationship service instance
*/
public void setRelationshipService(RelationshipService relationshipService)
@@ -132,6 +152,48 @@ public class RecordsManagementAdminServiceImpl extends RecordsManagementAdminBas
return this.relationshipService;
}
/**
* Indicate that this application content listener must be executed with the lowest
* precedence. (ie last)
*
* @see Ordered#getOrder()
*/
@Override
public int getOrder()
{
return Ordered.LOWEST_PRECEDENCE;
}
/**
* Load the custom properties map
*
* @see ApplicationListener#onApplicationEvent(org.springframework.context.ApplicationEvent)
*/
@Override
public void onApplicationEvent(ContextRefreshedEvent event)
{
transactionService.getRetryingTransactionHelper().doInTransaction(new RetryingTransactionCallback<Void>()
{
public Void execute() throws Throwable
{
// initialise custom properties
initCustomMap();
return null;
}
});
}
/**
* Helper method to indicate whether the custom map is initialised or not.
*
* @return boolean true if initialised, false otherwise
*/
public boolean isCustomMapInit()
{
return isCustomMapInit;
}
/**
* @see org.alfresco.repo.node.NodeServicePolicies.OnAddAspectPolicy#onAddAspect(org.alfresco.service.cmr.repository.NodeRef, org.alfresco.service.namespace.QName)
*/
@@ -144,25 +206,25 @@ public class RecordsManagementAdminServiceImpl extends RecordsManagementAdminBas
)
public void onAddAspect(final NodeRef nodeRef, final QName aspectTypeQName)
{
mandatory("nodeRef", nodeRef);
mandatory("aspectTypeQName", aspectTypeQName);
AuthenticationUtil.runAs(new RunAsWork<Void>()
if (isCustomMapInit)
{
@Override
public Void doWork()
AuthenticationUtil.runAs(new RunAsWork<Void>()
{
if (getNodeService().exists(nodeRef) &&
getDictionaryService().getAllModels().contains(RM_CUSTOM_MODEL) &&
isCustomisable(aspectTypeQName))
@Override
public Void doWork()
{
QName customPropertyAspect = getCustomAspect(aspectTypeQName);
getNodeService().addAspect(nodeRef, customPropertyAspect, null);
if (getNodeService().exists(nodeRef) &&
getDictionaryService().getAllModels().contains(RM_CUSTOM_MODEL) &&
isCustomisable(aspectTypeQName))
{
QName customPropertyAspect = getCustomAspect(aspectTypeQName);
getNodeService().addAspect(nodeRef, customPropertyAspect, null);
}
return null;
}
return null;
}
}, AuthenticationUtil.getSystemUserName());
}, AuthenticationUtil.getSystemUserName());
}
}
/**
@@ -177,24 +239,24 @@ public class RecordsManagementAdminServiceImpl extends RecordsManagementAdminBas
)
public void onRemoveAspect(final NodeRef nodeRef, final QName aspectTypeQName)
{
mandatory("nodeRef", nodeRef);
mandatory("aspectTypeQName", aspectTypeQName);
AuthenticationUtil.runAs(new RunAsWork<Void>()
if (isCustomMapInit)
{
@Override
public Void doWork()
AuthenticationUtil.runAs(new RunAsWork<Void>()
{
if (getNodeService().exists(nodeRef) &&
isCustomisable(aspectTypeQName))
@Override
public Void doWork()
{
QName customPropertyAspect = getCustomAspect(aspectTypeQName);
getNodeService().removeAspect(nodeRef, customPropertyAspect);
if (getNodeService().exists(nodeRef) &&
isCustomisable(aspectTypeQName))
{
QName customPropertyAspect = getCustomAspect(aspectTypeQName);
getNodeService().removeAspect(nodeRef, customPropertyAspect);
}
return null;
}
return null;
}
}, AuthenticationUtil.getSystemUserName());
}, AuthenticationUtil.getSystemUserName());
}
}
/**
@@ -211,49 +273,41 @@ public class RecordsManagementAdminServiceImpl extends RecordsManagementAdminBas
)
public void onCreateNode(final ChildAssociationRef childAssocRef)
{
mandatory("nodeRef", childAssocRef);
AuthenticationUtil.runAs(new RunAsWork<Void>()
{
@Override
public Void doWork()
if (isCustomMapInit)
{
AuthenticationUtil.runAs(new RunAsWork<Void>()
{
if (getDictionaryService().getAllModels().contains(RecordsManagementCustomModel.RM_CUSTOM_MODEL))
@Override
public Void doWork()
{
NodeRef nodeRef = childAssocRef.getChildRef();
QName type = getNodeService().getType(nodeRef);
while (type != null && !ContentModel.TYPE_CMOBJECT.equals(type))
if (getDictionaryService().getAllModels().contains(RecordsManagementCustomModel.RM_CUSTOM_MODEL))
{
if (isCustomisable(type))
NodeRef nodeRef = childAssocRef.getChildRef();
QName type = getNodeService().getType(nodeRef);
while (type != null && !ContentModel.TYPE_CMOBJECT.equals(type))
{
QName customPropertyAspect = getCustomAspect(type);
getNodeService().addAspect(nodeRef, customPropertyAspect, null);
}
TypeDefinition def = getDictionaryService().getType(type);
if (def != null)
{
type = def.getParentName();
}
else
{
type = null;
if (isCustomisable(type))
{
QName customPropertyAspect = getCustomAspect(type);
getNodeService().addAspect(nodeRef, customPropertyAspect, null);
}
TypeDefinition def = getDictionaryService().getType(type);
if (def != null)
{
type = def.getParentName();
}
else
{
type = null;
}
}
}
return null;
}
return null;
}
}, AuthenticationUtil.getSystemUserName());
}
/**
* @see org.alfresco.module.org_alfresco_module_rm.RecordsManagementAdminService#initialiseCustomModel()
*/
public void initialiseCustomModel()
{
// Initialise the map
getCustomisableMap();
}, AuthenticationUtil.getSystemUserName());
}
}
/**
@@ -338,6 +392,92 @@ public class RecordsManagementAdminServiceImpl extends RecordsManagementAdminBas
return result;
}
/**
* Initialise custom type map
*/
private void initCustomMap()
{
customisableTypes = new HashMap<QName, QName>(7);
Collection<QName> aspects = getDictionaryService().getAspects(RM_CUSTOM_MODEL);
for (QName aspect : aspects)
{
AspectDefinition aspectDef = getDictionaryService().getAspect(aspect);
String name = aspectDef.getName().getLocalName();
if (name.endsWith("Properties"))
{
QName type = null;
String prefixString = aspectDef.getDescription(getDictionaryService());
if (prefixString == null)
{
// Backward compatibility from previous RM V1.0 custom models
if (CompatibilityModel.NAME_CUSTOM_RECORD_PROPERTIES.equals(name))
{
type = RecordsManagementModel.ASPECT_RECORD;
}
else if (CompatibilityModel.NAME_CUSTOM_RECORD_FOLDER_PROPERTIES.equals(name))
{
type = RecordsManagementModel.TYPE_RECORD_FOLDER;
}
else if (CompatibilityModel.NAME_CUSTOM_RECORD_CATEGORY_PROPERTIES.equals(name))
{
type = RecordsManagementModel.TYPE_RECORD_CATEGORY;
}
else if (CompatibilityModel.NAME_CUSTOM_RECORD_SERIES_PROPERTIES.equals(name) &&
// Only add the deprecated record series type as customisable if
// a v1.0 installation has added custom properties
aspectDef.getProperties().size() != 0)
{
type = CompatibilityModel.TYPE_RECORD_SERIES;
}
}
else
{
type = QName.createQName(prefixString, getNamespaceService());
}
// Add the customisable type to the map
if (type != null)
{
customisableTypes.put(type, aspect);
// Remove customisable type from the pending list
if (pendingCustomisableTypes != null && pendingCustomisableTypes.contains(type))
{
pendingCustomisableTypes.remove(type);
}
}
}
}
// Deal with any pending types left over
if (pendingCustomisableTypes != null && pendingCustomisableTypes.size() != 0)
{
NodeRef modelRef = getCustomModelRef(RecordsManagementModel.RM_CUSTOM_URI);
M2Model model = readCustomContentModel(modelRef);
try
{
for (QName customisableType : pendingCustomisableTypes)
{
QName customAspect = getCustomAspectImpl(customisableType);
// Create the new aspect to hold the custom properties
M2Aspect aspect = model.createAspect(customAspect.toPrefixString(getNamespaceService()));
aspect.setDescription(customisableType.toPrefixString(getNamespaceService()));
// Make a record of the customisable type
customisableTypes.put(customisableType, customAspect);
}
}
finally
{
writeCustomContentModel(modelRef, model);
}
}
// indicate map is initialised
isCustomMapInit = true;
}
/**
* Gets a map containing all the customisable types
@@ -346,86 +486,11 @@ public class RecordsManagementAdminServiceImpl extends RecordsManagementAdminBas
*/
private Map<QName, QName> getCustomisableMap()
{
if (customisableTypes == null)
{
customisableTypes = new HashMap<QName, QName>(7);
Collection<QName> aspects = getDictionaryService().getAspects(RM_CUSTOM_MODEL);
for (QName aspect : aspects)
{
AspectDefinition aspectDef = getDictionaryService().getAspect(aspect);
String name = aspectDef.getName().getLocalName();
if (name.endsWith("Properties"))
{
QName type = null;
String prefixString = aspectDef.getDescription(getDictionaryService());
if (prefixString == null)
{
// Backward compatibility from previous RM V1.0 custom models
if (CompatibilityModel.NAME_CUSTOM_RECORD_PROPERTIES.equals(name))
{
type = RecordsManagementModel.ASPECT_RECORD;
}
else if (CompatibilityModel.NAME_CUSTOM_RECORD_FOLDER_PROPERTIES.equals(name))
{
type = RecordsManagementModel.TYPE_RECORD_FOLDER;
}
else if (CompatibilityModel.NAME_CUSTOM_RECORD_CATEGORY_PROPERTIES.equals(name))
{
type = RecordsManagementModel.TYPE_RECORD_CATEGORY;
}
else if (CompatibilityModel.NAME_CUSTOM_RECORD_SERIES_PROPERTIES.equals(name) &&
// Only add the deprecated record series type as customisable if
// a v1.0 installation has added custom properties
aspectDef.getProperties().size() != 0)
{
type = CompatibilityModel.TYPE_RECORD_SERIES;
}
}
else
{
type = QName.createQName(prefixString, getNamespaceService());
}
// Add the customisable type to the map
if (type != null)
{
customisableTypes.put(type, aspect);
// Remove customisable type from the pending list
if (pendingCustomisableTypes != null && pendingCustomisableTypes.contains(type))
{
pendingCustomisableTypes.remove(type);
}
}
}
}
// Deal with any pending types left over
if (pendingCustomisableTypes != null && pendingCustomisableTypes.size() != 0)
{
NodeRef modelRef = getCustomModelRef(RecordsManagementModel.RM_CUSTOM_URI);
M2Model model = readCustomContentModel(modelRef);
try
{
for (QName customisableType : pendingCustomisableTypes)
{
QName customAspect = getCustomAspectImpl(customisableType);
// Create the new aspect to hold the custom properties
M2Aspect aspect = model.createAspect(customAspect.toPrefixString(getNamespaceService()));
aspect.setDescription(customisableType.toPrefixString(getNamespaceService()));
// Make a record of the customisable type
customisableTypes.put(customisableType, customAspect);
}
}
finally
{
writeCustomContentModel(modelRef, model);
}
}
}
return customisableTypes;
if (customisableTypes == null)
{
throw AlfrescoRuntimeException.create("Customisable map has not been initialised correctly.");
}
return customisableTypes;
}
/**

10
rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/bootstrap/RecordsManagementBootstrap.java
View File

@@ -28,7 +28,6 @@
package org.alfresco.module.org_alfresco_module_rm.bootstrap;
import org.alfresco.module.org_alfresco_module_rm.action.impl.SplitEmailAction;
import org.alfresco.module.org_alfresco_module_rm.admin.RecordsManagementAdminService;
import org.alfresco.module.org_alfresco_module_rm.caveat.RMCaveatConfigService;
import org.alfresco.module.org_alfresco_module_rm.email.CustomEmailMappingService;
import org.alfresco.repo.action.parameter.NodeParameterSuggesterBootstrap;
@@ -50,7 +49,6 @@ public class RecordsManagementBootstrap extends AbstractLifecycleBean
private TransactionService transactionService;
private RMCaveatConfigService caveatConfigService;
private CustomEmailMappingService customEmailMappingService;
private RecordsManagementAdminService adminService;
private NodeParameterSuggesterBootstrap suggesterBootstrap;
public NodeParameterSuggesterBootstrap getSuggesterBootstrap()
@@ -78,11 +76,6 @@ public class RecordsManagementBootstrap extends AbstractLifecycleBean
this.customEmailMappingService = customEmailMappingService;
}
public void setRecordsManagementAdminService(RecordsManagementAdminService adminService)
{
this.adminService = adminService;
}
public CustomEmailMappingService getCustomEmailMappingService()
{
return customEmailMappingService;
@@ -102,9 +95,6 @@ public class RecordsManagementBootstrap extends AbstractLifecycleBean
{
// initialise caveat config
caveatConfigService.init();
// Initialise the custom model
adminService.initialiseCustomModel();
// Initialize the suggester after the model
// in case it contains namespaces from custom models