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 branch 'feature/RM-6318_SearchUpdatesForCert' into 'release/V2.7.0.x'

Browse Source 
RM-6318 SearchDerivedByJavaAPI

See merge request records-management/records-management!996
This commit is contained in:
Sara Aspery
2018-05-22 13:26:30 +01:00
parent 933904a15c c68ce588bb
commit d4721683f6
5 changed files with 339 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

86
rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/script/slingshot/ClassificationReasonsUtil.java Normal file
View File

@@ -0,0 +1,86 @@
/*
* #%L
* Alfresco Records Management Module
* %%
* Copyright (C) 2005 - 2018 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.script.slingshot;
import static org.alfresco.model.ContentModel.PROP_NAME;
import static org.alfresco.service.namespace.QName.createQName;
import java.io.Serializable;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
import java.util.Map;
import org.alfresco.service.cmr.repository.NodeRef;
import org.alfresco.service.cmr.repository.StoreRef;
import org.alfresco.service.namespace.QName;
/**
* Method to replace the plain text classification reason id with the correct nodeRef during record search
* @author Ross Gale
* @since 2.7
*/
public class ClassificationReasonsUtil extends SearchUtil
{
public static final String CR_URI = "http://www.alfresco.org/model/securitymarks/1.0";
public static final QName CLASSIFICATION_REASONS_CONTAINER = createQName(CR_URI,"classificationReasonsContainer");
public static final QName PROP_CLASSIFICATION_REASON_CODE = createQName(CR_URI, "classificationReasonCode");
public static final String REASONS_KEY = "clf:classificationReasons:";
/**
* Replace plain text reason id with nodeRef
* @param searchQuery String e.g. clf:classificationReasons:1.4(a)
* @return String e.g. clf:classificationReasons:5cc6d344-fa94-4370-9c81-d947b7e8f2ac
*/
public String replaceReasonWithNodeRef(String searchQuery)
{
List<String> queries = new ArrayList<>(Arrays.asList(searchQuery.split(" ")));
StringBuilder stringBuilder = new StringBuilder();
for (String queryToEdit : queries)
{
if(queryToEdit.contains(REASONS_KEY))
{
for (String reasonId : retrieveAllNodeIds(getRootContainer(CLASSIFICATION_REASONS_CONTAINER)))
{
NodeRef reasonNodeRef = new NodeRef(StoreRef.STORE_REF_WORKSPACE_SPACESSTORE, reasonId);
Map<QName, Serializable> properties = nodeService.getProperties(reasonNodeRef);
if (queryToEdit.equals(REASONS_KEY + properties.get(PROP_CLASSIFICATION_REASON_CODE).toString()) ||
queryToEdit.equals(REASONS_KEY +"\""+ properties.get(PROP_CLASSIFICATION_REASON_CODE).toString() + "\""))
{
queryToEdit = REASONS_KEY + properties.get(PROP_NAME).toString();
break;
}
}
}
stringBuilder.append(queryToEdit).append(" ");
}
return stringBuilder.toString();
}
}

16
rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/script/slingshot/RMSearchGet.java
View File

@@ -27,6 +27,8 @@
package org.alfresco.module.org_alfresco_module_rm.script.slingshot;
import static org.alfresco.module.org_alfresco_module_rm.script.slingshot.ClassificationReasonsUtil.REASONS_KEY;
import java.io.Serializable;
import java.io.UnsupportedEncodingException;
import java.net.URLEncoder;
@@ -103,6 +105,9 @@ public class RMSearchGet extends DeclarativeWebScript
/** Utility class for record categories */
private RecordCategoryUtil recordCategoryUtil;
/** Utility class for classification reasons (enterprise only) */
private ClassificationReasonsUtil classificationReasonsUtil;
/**
* @param recordsManagementSearchService records management search service
*/
@@ -159,6 +164,11 @@ public class RMSearchGet extends DeclarativeWebScript
this.recordCategoryUtil = recordCategoryUtil;
}
public void setClassificationReasonsUtil(ClassificationReasonsUtil classificationReasonsUtil)
{
this.classificationReasonsUtil = classificationReasonsUtil;
}
/**
* @param personService person service
*/
@@ -198,6 +208,12 @@ public class RMSearchGet extends DeclarativeWebScript
String filters = req.getParameter(PARAM_FILTERS);
// TODO this is optional
//Replace any plain text reason ids with the appropriate node reference
if(query.contains(REASONS_KEY))
{
query = classificationReasonsUtil.replaceReasonWithNodeRef(query);
}
// Convert into a rm search parameter object
RecordsManagementSearchParameters searchParameters =
SavedSearchDetailsCompatibility.createSearchParameters(filters, new String[]{",", "/"}, sortby, namespaceService);

103
rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/script/slingshot/SearchUtil.java Normal file
View File

@@ -0,0 +1,103 @@
/*
* #%L
* Alfresco Records Management Module
* %%
* Copyright (C) 2005 - 2018 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.script.slingshot;
import static org.alfresco.model.ContentModel.ASSOC_CHILDREN;
import static org.alfresco.model.ContentModel.TYPE_CONTAINER;
import static org.alfresco.service.cmr.repository.StoreRef.STORE_REF_WORKSPACE_SPACESSTORE;
import java.util.List;
import java.util.Set;
import java.util.stream.Collectors;
import org.alfresco.error.AlfrescoRuntimeException;
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.QName;
/**
* Parent class for records search utilities
*
* @author Ross Gale
* @since 2.7
*/
public class SearchUtil
{
/**
* Node service
*/
protected NodeService nodeService;
/**
* Setter for node service
*
* @param nodeService Node service
*/
public void setNodeService(NodeService nodeService)
{
this.nodeService = nodeService;
}
/**
* Use a container node ref and return the nodeIds of the contents
*
* @param nodeRef container
* @return list of nodeIds
*/
protected Set<String> retrieveAllNodeIds(NodeRef nodeRef)
{
List<ChildAssociationRef> childAssocRefs = nodeService.getChildAssocs(nodeRef);
return childAssocRefs.stream().map(assoc -> assoc.getChildRef().getId()).collect(Collectors.toSet());
}
/**
* Helper method to get the classification reason root container.
* The method creates the container if it doesn't already exist.
*
* @return reference to the classification reason root container
*/
protected NodeRef getRootContainer(QName container)
{
NodeRef rootNodeRef = nodeService.getRootNode(STORE_REF_WORKSPACE_SPACESSTORE);
List<ChildAssociationRef> assocRefs = nodeService.getChildAssocs(rootNodeRef, ASSOC_CHILDREN, container);
if (assocRefs.isEmpty())
{
return nodeService.createNode(rootNodeRef, ASSOC_CHILDREN, container, TYPE_CONTAINER).getChildRef();
}
else if (assocRefs.size() != 1)
{
throw new AlfrescoRuntimeException("Only one container is allowed.");
}
else
{
return assocRefs.iterator().next().getChildRef();
}
}
}