RM-2114 (REST API to GET users security clearance)

+review RM-43

git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/modules/recordsmanagement/HEAD@103667 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261

rm-server/config/alfresco/templates/webscripts/org/alfresco/rma/classification/usersecurityclearance.get.desc.xml

@@ -1,7 +1,7 @@
 <webscript>
    <shortname>Users security clearance</shortname>
    <description>REST API to GET users security clearance</description>
-   <url>/api/classification/clearance?nameFilter={nameFilter?}&amp;startIndex={startIndex?}&amp;pageSize={pageSize?}</url>
+   <url>/api/classification/clearance?nameFilter={nameFilter?}&amp;startIndex={startIndex?}&amp;pageSize={pageSize?}&amp;sortField={sortField?}&amp;sortAscending={sortAscending?}</url>
    <format default="json">argument</format>
    <authentication>admin</authentication>
    <transaction allow="readonly">required</transaction>

rm-server/config/alfresco/templates/webscripts/org/alfresco/rma/classification/usersecurityclearance.get.json.ftl

@@ -1,5 +1,18 @@
 <#import "/org/alfresco/repository/generic-paged-results.lib.ftl" as gen/>
-<#import "./usersecurityclearance.lib.ftl" as usersecurityclearanceLib/>
+
+<#macro usersecurityclearanceJSON item>
+   <#local cl=item.classificationLevel>
+   <#local pi=item.personInfo>
+   <#escape x as jsonUtils.encodeJSONString(x)>
+      "classificationId": "${cl.id}",
+      "classificationLabel": "${cl.displayLabel}",
+      "userName": <#if pi.userName??>"${pi.userName}"<#else>null</#if>,
+      "firstName": <#if pi.firstName??>"${pi.firstName}"<#else>null</#if>,
+      "lastName": <#if pi.lastName??>"${pi.lastName}"<#else>null</#if>,
+      "fullName": <#if pi.firstName?? && pi.lastName??>"${pi.firstName} ${pi.lastName}"<#else>"${pi.userName}"</#if>,
+      "completeName": <#if pi.firstName?? && pi.lastName?? && pi.userName??>"${pi.firstName} ${pi.lastName} (${pi.userName})"<#else>"${pi.userName}"</#if>
+   </#escape>
+</#macro>
 
 <#escape x as jsonUtils.encodeJSONString(x)>
 {
@@ -7,7 +20,7 @@
    {
    <@gen.pagedResults data=data ; item>
       {
-      <@usersecurityclearanceLib.usersecurityclearanceJSON item=item />
+      <@usersecurityclearanceJSON item=item />
       }
    </@gen.pagedResults>
    }

rm-server/config/alfresco/templates/webscripts/org/alfresco/rma/classification/usersecurityclearance.lib.ftl

@@ -1,13 +0,0 @@
-<#macro usersecurityclearanceJSON item>
-   <#local cl=item.classificationLevel>
-   <#local pi=item.personInfo>
-   <#escape x as jsonUtils.encodeJSONString(x)>
-      "classificationId": "${cl.id}",
-      "classificationLabel": "${cl.displayLabel}",
-      "userName": <#if pi.userName??>"${pi.userName}"<#else>null</#if>,
-      "firstName": <#if pi.firstName??>"${pi.firstName}"<#else>null</#if>,
-      "lastName": <#if pi.lastName??>"${pi.lastName}"<#else>null</#if>,
-      "fullName": <#if pi.firstName?? && pi.lastName??>"${pi.firstName} ${pi.lastName}"<#else>"${pi.userName}"</#if>,
-      "completeName": <#if pi.firstName?? && pi.lastName?? && pi.userName??>"${pi.firstName} ${pi.lastName} (${pi.userName})"<#else>"${pi.userName}"</#if>
-   </#escape>
-</#macro>

rm-server/source/java/org/alfresco/module/org_alfresco_module_rm/script/classification/UserSecurityClearanceGet.java

@@ -18,6 +18,7 @@
  */
 package org.alfresco.module.org_alfresco_module_rm.script.classification;
 
+import static java.lang.Boolean.parseBoolean;
 import static java.lang.Integer.parseInt;
 import static org.apache.commons.lang.StringUtils.isNotBlank;
 import static org.springframework.extensions.webscripts.Status.STATUS_INTERNAL_SERVER_ERROR;
@@ -31,6 +32,7 @@ import org.alfresco.module.org_alfresco_module_rm.classification.SecurityClearan
 import org.alfresco.module.org_alfresco_module_rm.classification.UserQueryParams;
 import org.alfresco.module.org_alfresco_module_rm.script.AbstractRmWebScript;
 import org.alfresco.query.PagingResults;
+import org.alfresco.service.namespace.QName;
 import org.alfresco.util.Pair;
 import org.springframework.extensions.webscripts.Cache;
 import org.springframework.extensions.webscripts.Status;
@@ -49,6 +51,8 @@ public class UserSecurityClearanceGet extends AbstractRmWebScript
     private static final String TOTAL = "total";
     private static final String SKIP_COUNT = "startIndex";
     private static final String MAX_ITEMS = "pageSize";
+    private static final String SORT_FIELD = "sortField";
+    private static final String SORT_ASCENDING = "sortAscending";
     private static final String ITEM_COUNT = "itemCount";
     private static final String ITEMS = "items";
     private static final String DATA = "data";
@@ -85,6 +89,7 @@ public class UserSecurityClearanceGet extends AbstractRmWebScript
         UserQueryParams userQueryParams = new UserQueryParams(nameFilter);
         setMaxItems(userQueryParams, req);
         setSkipCount(userQueryParams, req);
+        setSortProps(userQueryParams, req);
 
         PagingResults<SecurityClearance> usersSecurityClearance = getSecurityClearanceService().getUsersSecurityClearance(userQueryParams);
         List<SecurityClearance> securityClearanceItems = getSecurityClearanceItems(usersSecurityClearance);
@@ -169,4 +174,22 @@ public class UserSecurityClearanceGet extends AbstractRmWebScript
             userQueryParams.withSkipCount(parseInt(skipCount));
         }
     }
+
+    /**
+     * Helper method to set sort properties for the query object
+     *
+     * @param userQueryParams {@link UserQueryParams} The request query object
+     * @param req {@link WebScriptRequest} The webscript request
+     */
+    @SuppressWarnings("unchecked")
+    private void setSortProps(UserQueryParams userQueryParams, WebScriptRequest req)
+    {
+        String sortField = req.getParameter(SORT_FIELD);
+        String sortAscending = req.getParameter(SORT_ASCENDING);
+
+        if (isNotBlank(sortField) && isNotBlank(sortAscending))
+        {
+            userQueryParams.withSortProps(new Pair<>(QName.createQName(sortField, getNamespaceService()), parseBoolean(sortAscending)));
+        }
+    }
 }