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

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

Browse Source 
+review RM-43

git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/modules/recordsmanagement/HEAD@103502 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261
This commit is contained in:
Tuna Aksoy
2015-05-01 16:46:18 +00:00
parent e76ea15a2c
commit ef7046ab14
2 changed files with 40 additions and 38 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

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

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

@@ -18,9 +18,9 @@
*/ */
package org.alfresco.module.org_alfresco_module_rm.script.classification; package org.alfresco.module.org_alfresco_module_rm.script.classification;
import static java.lang.Boolean.parseBoolean;
import static java.lang.Integer.parseInt; import static java.lang.Integer.parseInt;
import static org.apache.commons.lang.StringUtils.isNotBlank; import static org.apache.commons.lang.StringUtils.isNotBlank;
import static org.springframework.extensions.webscripts.Status.STATUS_INTERNAL_SERVER_ERROR;
import java.util.HashMap; import java.util.HashMap;
import java.util.List; import java.util.List;
@@ -28,12 +28,13 @@ import java.util.Map;
import org.alfresco.module.org_alfresco_module_rm.classification.SecurityClearance; import org.alfresco.module.org_alfresco_module_rm.classification.SecurityClearance;
import org.alfresco.module.org_alfresco_module_rm.classification.SecurityClearanceService; import org.alfresco.module.org_alfresco_module_rm.classification.SecurityClearanceService;
import org.alfresco.module.org_alfresco_module_rm.classification.UserQueryParams;
import org.alfresco.module.org_alfresco_module_rm.script.AbstractRmWebScript; import org.alfresco.module.org_alfresco_module_rm.script.AbstractRmWebScript;
import org.alfresco.query.PagingRequest;
import org.alfresco.query.PagingResults; import org.alfresco.query.PagingResults;
import org.alfresco.util.Pair; import org.alfresco.util.Pair;
import org.springframework.extensions.webscripts.Cache; import org.springframework.extensions.webscripts.Cache;
import org.springframework.extensions.webscripts.Status; import org.springframework.extensions.webscripts.Status;
import org.springframework.extensions.webscripts.WebScriptException;
import org.springframework.extensions.webscripts.WebScriptRequest; import org.springframework.extensions.webscripts.WebScriptRequest;
/** /**
@@ -46,17 +47,12 @@ public class UserSecurityClearanceGet extends AbstractRmWebScript
{ {
/** Constants */ /** Constants */
private static final String TOTAL = "total"; private static final String TOTAL = "total";
private static final String SORT_BY = "sortBy"; private static final String SKIP_COUNT = "startIndex";
private static final String START_INDEX = "startIndex"; private static final String MAX_ITEMS = "pageSize";
private static final String PAGE_SIZE = "pageSize";
private static final String ITEM_COUNT = "itemCount"; private static final String ITEM_COUNT = "itemCount";
private static final String ITEMS = "items"; private static final String ITEMS = "items";
private static final String DATA = "data"; private static final String DATA = "data";
private static final String FILTER = "filter"; private static final String NAME_FILTER = "nameFilter";
private static final int TOTAL_INT = -1;
private static final int START_INDEX_INT = 0;
private static final int PAGE_SIZE_INT = 10;
private static final boolean SORT_BY_ASC_BOOL = true;
/** Security clearance service */ /** Security clearance service */
private SecurityClearanceService securityClearanceService; private SecurityClearanceService securityClearanceService;
@@ -85,17 +81,18 @@ public class UserSecurityClearanceGet extends AbstractRmWebScript
@Override @Override
protected Map<String, Object> executeImpl(WebScriptRequest req, Status status, Cache cache) protected Map<String, Object> executeImpl(WebScriptRequest req, Status status, Cache cache)
{ {
String filter = getFilter(req); String nameFilter = getNameFilter(req);
boolean sortAscending = isSortAscending(req); UserQueryParams userQueryParams = new UserQueryParams(nameFilter);
PagingRequest pagingRequest = getPagingRequest(req); setMaxItems(userQueryParams, req);
setSkipCount(userQueryParams, req);
PagingResults<SecurityClearance> usersSecurityClearance = getSecurityClearanceService().getUsersSecurityClearance(filter, sortAscending, pagingRequest); PagingResults<SecurityClearance> usersSecurityClearance = getSecurityClearanceService().getUsersSecurityClearance(userQueryParams);
List<SecurityClearance> securityClearanceItems = getSecurityClearanceItems(usersSecurityClearance); List<SecurityClearance> securityClearanceItems = getSecurityClearanceItems(usersSecurityClearance);
Map<String, Object> securityClearanceData = new HashMap<>(); Map<String, Object> securityClearanceData = new HashMap<>();
securityClearanceData.put(TOTAL, getTotal(usersSecurityClearance)); securityClearanceData.put(TOTAL, getTotal(usersSecurityClearance));
securityClearanceData.put(PAGE_SIZE, pagingRequest.getMaxItems()); securityClearanceData.put(MAX_ITEMS, userQueryParams.getMaxItems());
securityClearanceData.put(START_INDEX, pagingRequest.getSkipCount()); securityClearanceData.put(SKIP_COUNT, userQueryParams.getSkipCount());
securityClearanceData.put(ITEM_COUNT, securityClearanceItems.size()); securityClearanceData.put(ITEM_COUNT, securityClearanceItems.size());
securityClearanceData.put(ITEMS, securityClearanceItems); securityClearanceData.put(ITEMS, securityClearanceItems);
@@ -111,10 +108,14 @@ public class UserSecurityClearanceGet extends AbstractRmWebScript
* @param usersSecurityClearance {@link PagingResults} The security clearance results * @param usersSecurityClearance {@link PagingResults} The security clearance results
* @return The total number of security clearance items * @return The total number of security clearance items
*/ */
private int getTotal(PagingResults<SecurityClearance> usersSecurityClearance) private Integer getTotal(PagingResults<SecurityClearance> usersSecurityClearance)
{ {
Pair<Integer, Integer> totalResultCount = usersSecurityClearance.getTotalResultCount(); Pair<Integer, Integer> totalResultCount = usersSecurityClearance.getTotalResultCount();
return totalResultCount != null ? totalResultCount.getFirst() : TOTAL_INT; if (totalResultCount == null)
{
throw new WebScriptException(STATUS_INTERNAL_SERVER_ERROR, "Total result count cannot be determined.");
}
return totalResultCount.getFirst();
} }
/** /**
@@ -129,42 +130,43 @@ public class UserSecurityClearanceGet extends AbstractRmWebScript
} }
/** /**
* Gets the sort direction from the webscript request * Gets the name filter from the webscript request
* *
* @param req {@link WebScriptRequest} The webscript request * @param req {@link WebScriptRequest} The webscript request
* @return <code>true</code> if the sort direction is ascending, <code>false</code> otherwise * @return {@link String} The name filter (can be null)
*/ */
private boolean isSortAscending(WebScriptRequest req) private String getNameFilter(WebScriptRequest req)
{ {
String sortBy = req.getParameter(SORT_BY); return req.getParameter(NAME_FILTER);
return isNotBlank(sortBy) ? parseBoolean(sortBy) : SORT_BY_ASC_BOOL;
} }
/** /**
* Gets the filter from the webscript request * Helper method to set the max index for the request query object
* *
* @param userQueryParams {@link UserQueryParams} The request query object
* @param req {@link WebScriptRequest} The webscript request * @param req {@link WebScriptRequest} The webscript request
* @return {@link String} The filter
*/ */
private String getFilter(WebScriptRequest req) private void setMaxItems(UserQueryParams userQueryParams, WebScriptRequest req)
{ {
return req.getParameter(FILTER); String maxItems = req.getParameter(MAX_ITEMS);
if (isNotBlank(maxItems))
{
userQueryParams.withMaxItems(parseInt(maxItems));
}
} }
/** /**
* Helper method to create the paging request from the webscript request * Helper method to set the skip count for the query object
* *
* @param userQueryParams {@link UserQueryParams} The request query object
* @param req {@link WebScriptRequest} The webscript request * @param req {@link WebScriptRequest} The webscript request
* @return {@link PagingRequest} The paging request
*/ */
private PagingRequest getPagingRequest(WebScriptRequest req) private void setSkipCount(UserQueryParams userQueryParams, WebScriptRequest req)
{ {
String startIndexAsString = req.getParameter(START_INDEX); String skipCount = req.getParameter(SKIP_COUNT);
String pageSizeAsString = req.getParameter(PAGE_SIZE); if (isNotBlank(skipCount))
{
int startIndex = isNotBlank(startIndexAsString) ? parseInt(startIndexAsString) : START_INDEX_INT; userQueryParams.withSkipCount(parseInt(skipCount));
int pageSize = isNotBlank(pageSizeAsString) ? parseInt(pageSizeAsString) : PAGE_SIZE_INT; }
return new PagingRequest(startIndex, pageSize, null);
} }
} }