diff --git a/rm-server/config/alfresco/module/org_alfresco_module_rm/rm-webscript-context.xml b/rm-server/config/alfresco/module/org_alfresco_module_rm/rm-webscript-context.xml
index da41dd3d0e..bf87988d70 100644
--- a/rm-server/config/alfresco/module/org_alfresco_module_rm/rm-webscript-context.xml
+++ b/rm-server/config/alfresco/module/org_alfresco_module_rm/rm-webscript-context.xml
@@ -596,6 +596,7 @@
+
diff --git a/rm-server/config/alfresco/templates/webscripts/org/alfresco/repository/roles/rm-dynamicauthorities.get.desc.xml b/rm-server/config/alfresco/templates/webscripts/org/alfresco/repository/roles/rm-dynamicauthorities.get.desc.xml
index bd4aee74a0..49b7ca51a0 100644
--- a/rm-server/config/alfresco/templates/webscripts/org/alfresco/repository/roles/rm-dynamicauthorities.get.desc.xml
+++ b/rm-server/config/alfresco/templates/webscripts/org/alfresco/repository/roles/rm-dynamicauthorities.get.desc.xml
@@ -4,9 +4,10 @@
Removes dynamic authorities from in place records created in previous verssions.
URL parameter batchsize is mandatory, and represents the number of records that are processed in one transaction.
URL parameter maxProcessedRecords is optional, and represents the maximum number of records that will be processed in one request.
+ URL parameter export is optional, and if the it's value is true, will export the processed records into a csv file.
]]>
- /api/rm/rm-dynamicauthorities?batchsize={batchsize}&maxProcessedRecords={maxProcessedRecords?}
+ /api/rm/rm-dynamicauthorities?batchsize={batchsize}&maxProcessedRecords={maxProcessedRecords?}&export={export?}
argument
admin
required
diff --git a/rm-server/source/java/org/alfresco/repo/web/scripts/roles/DynamicAuthoritiesGet.java b/rm-server/source/java/org/alfresco/repo/web/scripts/roles/DynamicAuthoritiesGet.java
index b023dcf45e..c7da809e5c 100644
--- a/rm-server/source/java/org/alfresco/repo/web/scripts/roles/DynamicAuthoritiesGet.java
+++ b/rm-server/source/java/org/alfresco/repo/web/scripts/roles/DynamicAuthoritiesGet.java
@@ -16,14 +16,24 @@
* You should have received a copy of the GNU Lesser General Public License
* along with Alfresco. If not, see .
*/
+
package org.alfresco.repo.web.scripts.roles;
+import java.io.BufferedWriter;
+import java.io.File;
+import java.io.FileWriter;
+import java.io.IOException;
+import java.io.PrintWriter;
+import java.io.StringWriter;
+import java.io.Writer;
import java.text.MessageFormat;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
+import javax.servlet.http.HttpServletResponse;
+
import org.alfresco.model.ContentModel;
import org.alfresco.module.org_alfresco_module_rm.model.RecordsManagementModel;
import org.alfresco.module.org_alfresco_module_rm.security.ExtendedReaderDynamicAuthority;
@@ -33,19 +43,24 @@ import org.alfresco.repo.domain.node.NodeDAO;
import org.alfresco.repo.domain.patch.PatchDAO;
import org.alfresco.repo.domain.qname.QNameDAO;
import org.alfresco.repo.transaction.RetryingTransactionHelper.RetryingTransactionCallback;
+import org.alfresco.repo.web.scripts.content.ContentStreamer;
import org.alfresco.service.cmr.repository.NodeRef;
import org.alfresco.service.cmr.repository.NodeService;
import org.alfresco.service.cmr.security.PermissionService;
import org.alfresco.service.namespace.QName;
import org.alfresco.service.transaction.TransactionService;
import org.alfresco.util.Pair;
+import org.alfresco.util.TempFileProvider;
import org.apache.commons.lang.StringUtils;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
+import org.springframework.extensions.webscripts.AbstractWebScript;
import org.springframework.extensions.webscripts.Cache;
-import org.springframework.extensions.webscripts.DeclarativeWebScript;
+import org.springframework.extensions.webscripts.Format;
import org.springframework.extensions.webscripts.Status;
+import org.springframework.extensions.webscripts.WebScriptException;
import org.springframework.extensions.webscripts.WebScriptRequest;
+import org.springframework.extensions.webscripts.WebScriptResponse;
/**
* Webscript used for removing dynamic authorities from the records.
@@ -54,7 +69,7 @@ import org.springframework.extensions.webscripts.WebScriptRequest;
* @since 2.3.0.7
*/
@SuppressWarnings("deprecation")
-public class DynamicAuthoritiesGet extends DeclarativeWebScript implements RecordsManagementModel
+public class DynamicAuthoritiesGet extends AbstractWebScript implements RecordsManagementModel
{
private static final String MESSAGE_PARAMETER_BATCHSIZE_GREATER_THAN_ZERO = "Parameter batchsize should be a number greater than 0.";
private static final String MESSAGE_PROCESSING_BEGIN = "Processing - BEGIN";
@@ -64,20 +79,19 @@ public class DynamicAuthoritiesGet extends DeclarativeWebScript implements Recor
private static final String MESSAGE_BATCHSIZE_IS_INVALID = "Parameter batchsize is invalid.";
private static final String MESSAGE_BATCHSIZE_IS_MANDATORY = "Parameter batchsize is mandatory";
private static final String SUCCESS_STATUS = "success";
- private static final String FAILED_STATUS = "failed";
/**
* The logger
*/
private static Log logger = LogFactory.getLog(DynamicAuthoritiesGet.class);
private static final String BATCH_SIZE = "batchsize";
private static final String TOTAL_NUMBER_TO_PROCESS = "maxProcessedRecords";
+ private static final String PARAM_EXPORT = "export";
private static final String MODEL_STATUS = "responsestatus";
private static final String MODEL_MESSAGE = "message";
private static final String MESSAGE_ALL_TEMPLATE = "Processed {0} records.";
private static final String MESSAGE_PARTIAL_TEMPLATE = "Processed first {0} records.";
private static final String MESSAGE_NO_RECORDS_TO_PROCESS = "There where no records to be processed.";
-
/** services */
private PatchDAO patchDAO;
private NodeDAO nodeDAO;
@@ -86,54 +100,57 @@ public class DynamicAuthoritiesGet extends DeclarativeWebScript implements Recor
private PermissionService permissionService;
private ExtendedSecurityService extendedSecurityService;
private TransactionService transactionService;
-
+ /** Content Streamer */
+ protected ContentStreamer contentStreamer;
/** service setters */
- public void setPatchDAO(PatchDAO patchDAO) { this.patchDAO = patchDAO; }
- public void setNodeDAO(NodeDAO nodeDAO) { this.nodeDAO = nodeDAO; }
- public void setQnameDAO(QNameDAO qnameDAO) { this.qnameDAO = qnameDAO; }
- public void setNodeService(NodeService nodeService) { this.nodeService = nodeService; }
- public void setPermissionService(PermissionService permissionService) { this.permissionService = permissionService; }
- public void setExtendedSecurityService(ExtendedSecurityService extendedSecurityService) { this.extendedSecurityService = extendedSecurityService; }
- public void setTransactionService(TransactionService transactionService) { this.transactionService = transactionService; }
+ public void setPatchDAO(PatchDAO patchDAO)
+ {
+ this.patchDAO = patchDAO;
+ }
- @Override
- protected Map executeImpl(WebScriptRequest req, Status status, Cache cache)
+ public void setNodeDAO(NodeDAO nodeDAO)
+ {
+ this.nodeDAO = nodeDAO;
+ }
+
+ public void setQnameDAO(QNameDAO qnameDAO)
+ {
+ this.qnameDAO = qnameDAO;
+ }
+
+ public void setNodeService(NodeService nodeService)
+ {
+ this.nodeService = nodeService;
+ }
+
+ public void setPermissionService(PermissionService permissionService)
+ {
+ this.permissionService = permissionService;
+ }
+
+ public void setExtendedSecurityService(ExtendedSecurityService extendedSecurityService)
+ {
+ this.extendedSecurityService = extendedSecurityService;
+ }
+
+ public void setTransactionService(TransactionService transactionService)
+ {
+ this.transactionService = transactionService;
+ }
+
+ public void setContentStreamer(ContentStreamer contentStreamer)
+ {
+ this.contentStreamer = contentStreamer;
+ }
+
+ protected Map buildModel(WebScriptRequest req, WebScriptResponse res) throws IOException
{
Map model = new HashMap();
- String batchSizeStr = req.getParameter(BATCH_SIZE);
- String totalToBeProcessedRecordsStr = req.getParameter(TOTAL_NUMBER_TO_PROCESS);
-
- Long size = 0L;
- if (StringUtils.isBlank(batchSizeStr))
- {
- model.put(MODEL_STATUS, FAILED_STATUS);
- model.put(MODEL_MESSAGE, MESSAGE_BATCHSIZE_IS_MANDATORY);
- logger.info(MESSAGE_BATCHSIZE_IS_MANDATORY);
- return model;
- }
- try
- {
- size = Long.parseLong(batchSizeStr);
- if(size <= 0)
- {
- model.put(MODEL_STATUS, FAILED_STATUS);
- model.put(MODEL_MESSAGE, MESSAGE_PARAMETER_BATCHSIZE_GREATER_THAN_ZERO);
- logger.info(MESSAGE_PARAMETER_BATCHSIZE_GREATER_THAN_ZERO);
- return model;
- }
- }
- catch(NumberFormatException ex)
- {
- model.put(MODEL_STATUS, FAILED_STATUS);
- model.put(MODEL_MESSAGE, MESSAGE_BATCHSIZE_IS_INVALID);
- logger.info(MESSAGE_BATCHSIZE_IS_INVALID);
- return model;
- }
- final Long batchSize = size;
+ final Long batchSize = getBatchSizeParameter(req);
// get the max node id and the extended security aspect
Long maxNodeId = patchDAO.getMaxAdmNodeID();
final Pair recordAspectPair = qnameDAO.getQName(ASPECT_EXTENDED_SECURITY);
- if(recordAspectPair == null)
+ if (recordAspectPair == null)
{
model.put(MODEL_STATUS, SUCCESS_STATUS);
model.put(MODEL_MESSAGE, MESSAGE_NO_RECORDS_TO_PROCESS);
@@ -141,64 +158,29 @@ public class DynamicAuthoritiesGet extends DeclarativeWebScript implements Recor
return model;
}
- //default total number of records to be processed to batch size value
- Long totalNumberOfRecordsToProcess = batchSize;
- if (StringUtils.isNotBlank(totalToBeProcessedRecordsStr))
+ Long totalNumberOfRecordsToProcess = getMaxToProccessParameter(req, batchSize);
+
+ boolean attach = getExportParameter(req);
+
+ File file = TempFileProvider.createTempFile("processedNodes_", ".csv");
+ FileWriter writer = new FileWriter(file);
+ BufferedWriter out = new BufferedWriter(writer);
+ List processedNodes = new ArrayList();
+ try
{
- try
- {
- totalNumberOfRecordsToProcess = Long.parseLong(totalToBeProcessedRecordsStr);
- }
- catch(NumberFormatException ex)
- {
- //do nothing here, the value will remain 0L in this case
- }
+ processedNodes = processNodes(batchSize, maxNodeId, recordAspectPair, totalNumberOfRecordsToProcess, out,
+ attach);
+ }
+ finally
+ {
+ out.close();
}
- final Long maxRecordsToProcess = totalNumberOfRecordsToProcess;
- final List processedNodes = new ArrayList();
- logger.info(MESSAGE_PROCESSING_BEGIN);
- // by batch size
- for (Long i = 0L; i < maxNodeId; i+=batchSize)
- {
- if(maxRecordsToProcess != 0 && processedNodes.size() >= maxRecordsToProcess)
- {
- break;
- }
- final Long currentIndex = i;
-
- transactionService.getRetryingTransactionHelper().doInTransaction(new RetryingTransactionCallback()
- {
- public Void execute() throws Throwable
- {
- // get the nodes with the extended security aspect applied
- List nodeIds = patchDAO.getNodesByAspectQNameId(recordAspectPair.getFirst(), currentIndex, currentIndex + batchSize);
-
- // process each one
- for (Long nodeId : nodeIds)
- {
- if(maxRecordsToProcess != 0 && processedNodes.size() >= maxRecordsToProcess)
- {
- break;
- }
- NodeRef record = nodeDAO.getNodePair(nodeId).getSecond();
- String recordName = (String) nodeService.getProperty(record, ContentModel.PROP_NAME);
- logger.info(MessageFormat.format(MESSAGE_PROCESSING_RECORD_BEGIN_TEMPLATE, recordName));
- processNode(record);
- logger.info(MessageFormat.format(MESSAGE_PROCESSING_RECORD_END_TEMPLATE, recordName));
- processedNodes.add(record);
- }
-
- return null;
- }
- },
- false, // read only
- true); // requires new
- }
- logger.info(MESSAGE_PROCESSING_END);
int processedNodesSize = processedNodes.size();
+
String message = "";
- if(totalNumberOfRecordsToProcess == 0 || (totalNumberOfRecordsToProcess > 0 && processedNodesSize < totalNumberOfRecordsToProcess))
+ if (totalNumberOfRecordsToProcess == 0
+ || (totalNumberOfRecordsToProcess > 0 && processedNodesSize < totalNumberOfRecordsToProcess))
{
message = MessageFormat.format(MESSAGE_ALL_TEMPLATE, processedNodesSize);
}
@@ -209,20 +191,284 @@ public class DynamicAuthoritiesGet extends DeclarativeWebScript implements Recor
model.put(MODEL_STATUS, SUCCESS_STATUS);
model.put(MODEL_MESSAGE, message);
logger.info(message);
+
+ if (attach)
+ {
+ try
+ {
+ String fileName = file.getName();
+ contentStreamer.streamContent(req, res, file, null, attach, fileName, model);
+ model = null;
+ }
+ finally
+ {
+ if (file != null)
+ {
+ file.delete();
+ }
+ }
+ }
return model;
}
+ /**
+ * Get export parameter from the request
+ * @param req
+ * @return
+ */
+ protected boolean getExportParameter(WebScriptRequest req)
+ {
+ boolean attach = false;
+ String export = req.getParameter(PARAM_EXPORT);
+ if (export != null && Boolean.parseBoolean(export))
+ {
+ attach = true;
+ }
+ return attach;
+ }
+
+ /*
+ * (non-Javadoc)
+ * @see org.alfresco.repo.web.scripts.content.StreamContent#execute(org.springframework.extensions.webscripts.
+ * WebScriptRequest, org.springframework.extensions.webscripts.WebScriptResponse)
+ */
+ @Override
+ public void execute(WebScriptRequest req, WebScriptResponse res) throws IOException
+ {
+ // retrieve requested format
+ String format = req.getFormat();
+
+ try
+ {
+ String mimetype = getContainer().getFormatRegistry().getMimeType(req.getAgent(), format);
+ if (mimetype == null)
+ {
+ throw new WebScriptException("Web Script format '" + format + "' is not registered");
+ }
+
+ // construct model for script / template
+ Status status = new Status();
+ Cache cache = new Cache(getDescription().getRequiredCache());
+ Map model = buildModel(req, res);
+ if (model == null)
+ {
+ return;
+ }
+ model.put("status", status);
+ model.put("cache", cache);
+
+ Map templateModel = createTemplateParameters(req, res, model);
+
+ // render output
+ int statusCode = status.getCode();
+ if (statusCode != HttpServletResponse.SC_OK && !req.forceSuccessStatus())
+ {
+ if (logger.isDebugEnabled())
+ {
+ logger.debug("Force success status header in response: " + req.forceSuccessStatus());
+ logger.debug("Setting status " + statusCode);
+ }
+ res.setStatus(statusCode);
+ }
+
+ // apply location
+ String location = status.getLocation();
+ if (location != null && location.length() > 0)
+ {
+ if (logger.isDebugEnabled()) logger.debug("Setting location to " + location);
+ res.setHeader(WebScriptResponse.HEADER_LOCATION, location);
+ }
+
+ // apply cache
+ res.setCache(cache);
+
+ String callback = null;
+ if (getContainer().allowCallbacks())
+ {
+ callback = req.getJSONCallback();
+ }
+ if (format.equals(WebScriptResponse.JSON_FORMAT) && callback != null)
+ {
+ if (logger.isDebugEnabled()) logger.debug("Rendering JSON callback response: content type="
+ + Format.JAVASCRIPT.mimetype() + ", status=" + statusCode + ", callback=" + callback);
+
+ // NOTE: special case for wrapping JSON results in a javascript function callback
+ res.setContentType(Format.JAVASCRIPT.mimetype() + ";charset=UTF-8");
+ res.getWriter().write((callback + "("));
+ }
+ else
+ {
+ if (logger.isDebugEnabled())
+ logger.debug("Rendering response: content type=" + mimetype + ", status=" + statusCode);
+
+ res.setContentType(mimetype + ";charset=UTF-8");
+ }
+
+ // render response according to requested format
+ renderFormatTemplate(format, templateModel, res.getWriter());
+
+ if (format.equals(WebScriptResponse.JSON_FORMAT) && callback != null)
+ {
+ // NOTE: special case for wrapping JSON results in a javascript function callback
+ res.getWriter().write(")");
+ }
+ }
+ catch (Throwable e)
+ {
+ if (logger.isDebugEnabled())
+ {
+ StringWriter stack = new StringWriter();
+ e.printStackTrace(new PrintWriter(stack));
+ logger.debug("Caught exception; decorating with appropriate status template : " + stack.toString());
+ }
+
+ throw createStatusException(e, req, res);
+ }
+ }
+
+ protected void renderFormatTemplate(String format, Map model, Writer writer)
+ {
+ format = (format == null) ? "" : format;
+
+ String templatePath = getDescription().getId() + "." + format;
+
+ if (logger.isDebugEnabled()) logger.debug("Rendering template '" + templatePath + "'");
+
+ renderTemplate(templatePath, model, writer);
+ }
+
+ /**
+ * Obtain maximum of the records to be processed from the request if it is specified or bachsize value otherwise
+ *
+ * @param req
+ * @return maximum of the records to be processed from the request if it is specified or bachsize value otherwise
+ */
+ protected Long getMaxToProccessParameter(WebScriptRequest req, final Long batchSize)
+ {
+ String totalToBeProcessedRecordsStr = req.getParameter(TOTAL_NUMBER_TO_PROCESS);
+ // default total number of records to be processed to batch size value
+ Long totalNumberOfRecordsToProcess = batchSize;
+ if (StringUtils.isNotBlank(totalToBeProcessedRecordsStr))
+ {
+ try
+ {
+ totalNumberOfRecordsToProcess = Long.parseLong(totalToBeProcessedRecordsStr);
+ }
+ catch (NumberFormatException ex)
+ {
+ // do nothing here, the value will remain 0L in this case
+ }
+ }
+ return totalNumberOfRecordsToProcess;
+ }
+
+ /**
+ * Obtain batchsize parameter from the request.
+ *
+ * @param req
+ * @return batchsize parameter from the request
+ */
+ protected Long getBatchSizeParameter(WebScriptRequest req)
+ {
+ String batchSizeStr = req.getParameter(BATCH_SIZE);
+ Long size = 0L;
+ if (StringUtils.isBlank(batchSizeStr))
+ {
+ logger.info(MESSAGE_BATCHSIZE_IS_MANDATORY);
+ throw new WebScriptException(Status.STATUS_BAD_REQUEST, MESSAGE_BATCHSIZE_IS_MANDATORY);
+ }
+ try
+ {
+ size = Long.parseLong(batchSizeStr);
+ if (size <= 0)
+ {
+ logger.info(MESSAGE_PARAMETER_BATCHSIZE_GREATER_THAN_ZERO);
+ throw new WebScriptException(Status.STATUS_BAD_REQUEST, MESSAGE_PARAMETER_BATCHSIZE_GREATER_THAN_ZERO);
+ }
+ }
+ catch (NumberFormatException ex)
+ {
+ logger.info(MESSAGE_BATCHSIZE_IS_INVALID);
+ throw new WebScriptException(Status.STATUS_BAD_REQUEST, MESSAGE_BATCHSIZE_IS_INVALID);
+ }
+ return size;
+ }
+
+ /**
+ * Process nodes all nodes or the maximum number of nodes specified by batchsize or totalNumberOfRecordsToProcess
+ * parameters
+ *
+ * @param batchSize
+ * @param maxNodeId
+ * @param recordAspectPair
+ * @param totalNumberOfRecordsToProcess
+ * @return the list of processed nodes
+ */
+ protected List processNodes(final Long batchSize, Long maxNodeId, final Pair recordAspectPair,
+ Long totalNumberOfRecordsToProcess, final BufferedWriter out, final boolean attach)
+ {
+ final Long maxRecordsToProcess = totalNumberOfRecordsToProcess;
+ final List processedNodes = new ArrayList();
+ logger.info(MESSAGE_PROCESSING_BEGIN);
+ // by batch size
+ for (Long i = 0L; i < maxNodeId; i += batchSize)
+ {
+ if (maxRecordsToProcess != 0 && processedNodes.size() >= maxRecordsToProcess)
+ {
+ break;
+ }
+ final Long currentIndex = i;
+
+ transactionService.getRetryingTransactionHelper().doInTransaction(new RetryingTransactionCallback()
+ {
+ public Void execute() throws Throwable
+ {
+ // get the nodes with the extended security aspect applied
+ List nodeIds = patchDAO.getNodesByAspectQNameId(recordAspectPair.getFirst(), currentIndex,
+ currentIndex + batchSize);
+
+ // process each one
+ for (Long nodeId : nodeIds)
+ {
+ if (maxRecordsToProcess != 0 && processedNodes.size() >= maxRecordsToProcess)
+ {
+ break;
+ }
+ NodeRef record = nodeDAO.getNodePair(nodeId).getSecond();
+ String recordName = (String) nodeService.getProperty(record, ContentModel.PROP_NAME);
+ logger.info(MessageFormat.format(MESSAGE_PROCESSING_RECORD_BEGIN_TEMPLATE, recordName));
+ processNode(record);
+ logger.info(MessageFormat.format(MESSAGE_PROCESSING_RECORD_END_TEMPLATE, recordName));
+ processedNodes.add(record);
+ if (attach)
+ {
+ out.write(recordName);
+ out.write(",");
+ out.write(record.toString());
+ out.write("\n");
+ }
+ }
+
+ return null;
+ }
+ }, false, // read only
+ true); // requires new
+ }
+ logger.info(MESSAGE_PROCESSING_END);
+ return processedNodes;
+ }
+
/**
* Process each node
*
* @param nodeRef
*/
- @SuppressWarnings({ "unchecked"})
+ @SuppressWarnings({ "unchecked" })
private void processNode(NodeRef nodeRef)
{
// get the reader/writer data
- Map readers = (Map)nodeService.getProperty(nodeRef, PROP_READERS);
- Map writers = (Map)nodeService.getProperty(nodeRef, PROP_WRITERS);
+ Map readers = (Map) nodeService.getProperty(nodeRef, PROP_READERS);
+ Map writers = (Map) nodeService.getProperty(nodeRef, PROP_WRITERS);
// remove extended security aspect
nodeService.removeAspect(nodeRef, ASPECT_EXTENDED_SECURITY);
@@ -232,7 +478,7 @@ public class DynamicAuthoritiesGet extends DeclarativeWebScript implements Recor
permissionService.clearPermission(nodeRef, ExtendedWriterDynamicAuthority.EXTENDED_WRITER);
// if record then ...
- if (nodeService.hasAspect(nodeRef, ASPECT_RECORD))
+ if (nodeService.hasAspect(nodeRef, ASPECT_RECORD) && readers != null && writers != null)
{
// re-set extended security via API
extendedSecurityService.set(nodeRef, readers.keySet(), writers.keySet());
diff --git a/rm-server/unit-test/java/org/alfresco/module/org_alfresco_module_rm/test/util/BaseWebScriptUnitTest.java b/rm-server/unit-test/java/org/alfresco/module/org_alfresco_module_rm/test/util/BaseWebScriptUnitTest.java
index 2a0f18a927..79f9843585 100644
--- a/rm-server/unit-test/java/org/alfresco/module/org_alfresco_module_rm/test/util/BaseWebScriptUnitTest.java
+++ b/rm-server/unit-test/java/org/alfresco/module/org_alfresco_module_rm/test/util/BaseWebScriptUnitTest.java
@@ -31,8 +31,8 @@ import org.json.JSONObject;
import org.mockito.invocation.InvocationOnMock;
import org.mockito.stubbing.Answer;
import org.springframework.extensions.surf.util.Content;
+import org.springframework.extensions.webscripts.AbstractWebScript;
import org.springframework.extensions.webscripts.Container;
-import org.springframework.extensions.webscripts.DeclarativeWebScript;
import org.springframework.extensions.webscripts.Description;
import org.springframework.extensions.webscripts.Description.RequiredCache;
import org.springframework.extensions.webscripts.DescriptionExtension;
@@ -68,8 +68,8 @@ public abstract class BaseWebScriptUnitTest extends BaseUnitTest
/**
* @return declarative webscript
*/
- protected abstract DeclarativeWebScript getWebScript();
-
+ protected abstract AbstractWebScript getWebScript();
+
/**
* @return classpath location of webscript template
*/
@@ -136,7 +136,7 @@ public abstract class BaseWebScriptUnitTest extends BaseUnitTest
*/
protected String executeWebScript(Map parameters, String content) throws Exception
{
- DeclarativeWebScript webScript = getWebScript();
+ AbstractWebScript webScript = getWebScript();
String template = getWebScriptTemplate();
// initialise webscript
@@ -158,7 +158,7 @@ public abstract class BaseWebScriptUnitTest extends BaseUnitTest
* @return {@link WebScriptRequest} mocked web script request
*/
@SuppressWarnings("rawtypes")
- protected WebScriptRequest getMockedWebScriptRequest(DeclarativeWebScript webScript, final Map parameters, String content) throws Exception
+ protected WebScriptRequest getMockedWebScriptRequest(AbstractWebScript webScript, final Map parameters, String content) throws Exception
{
Match match = new Match(null, parameters, null, webScript);
org.springframework.extensions.webscripts.Runtime mockedRuntime = mock(org.springframework.extensions.webscripts.Runtime.class);
diff --git a/rm-server/unit-test/java/org/alfresco/repo/web/scripts/roles/DynamicAuthoritiesGetUnitTest.java b/rm-server/unit-test/java/org/alfresco/repo/web/scripts/roles/DynamicAuthoritiesGetUnitTest.java
index c18ed9c9cf..80e65f5984 100644
--- a/rm-server/unit-test/java/org/alfresco/repo/web/scripts/roles/DynamicAuthoritiesGetUnitTest.java
+++ b/rm-server/unit-test/java/org/alfresco/repo/web/scripts/roles/DynamicAuthoritiesGetUnitTest.java
@@ -23,6 +23,7 @@ import static java.util.Collections.emptyMap;
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertNotNull;
+import static org.junit.Assert.fail;
import static org.mockito.Matchers.any;
import static org.mockito.Matchers.anyBoolean;
import static org.mockito.Matchers.anyLong;
@@ -55,6 +56,7 @@ import org.alfresco.repo.domain.patch.PatchDAO;
import org.alfresco.repo.domain.qname.QNameDAO;
import org.alfresco.repo.transaction.RetryingTransactionHelper;
import org.alfresco.repo.transaction.RetryingTransactionHelper.RetryingTransactionCallback;
+import org.alfresco.repo.web.scripts.content.ContentStreamer;
import org.alfresco.service.cmr.repository.NodeRef;
import org.alfresco.service.cmr.repository.NodeService;
import org.alfresco.service.cmr.security.PermissionService;
@@ -69,7 +71,9 @@ import org.mockito.Mock;
import org.mockito.MockitoAnnotations;
import org.mockito.invocation.InvocationOnMock;
import org.mockito.stubbing.Answer;
-import org.springframework.extensions.webscripts.DeclarativeWebScript;
+import org.springframework.extensions.webscripts.AbstractWebScript;
+import org.springframework.extensions.webscripts.Status;
+import org.springframework.extensions.webscripts.WebScriptException;
/**
* DynamicAuthoritiesGet Unit Test
@@ -100,13 +104,15 @@ public class DynamicAuthoritiesGetUnitTest extends BaseWebScriptUnitTest impleme
private TransactionService mockedTransactionService;
@Mock
private RetryingTransactionHelper mockedRetryingTransactionHelper;
+ @Mock
+ private ContentStreamer contentStreamer;
/** test component */
@InjectMocks
private DynamicAuthoritiesGet webScript;
@Override
- protected DeclarativeWebScript getWebScript()
+ protected AbstractWebScript getWebScript()
{
return webScript;
}
@@ -255,7 +261,6 @@ public class DynamicAuthoritiesGetUnitTest extends BaseWebScriptUnitTest impleme
.thenReturn((Serializable) Collections.emptyMap());
when(mockedNodeService.getProperty(nodeRef, PROP_WRITERS))
.thenReturn((Serializable) Collections.emptyMap());
-
});
// Set up parameters.
@@ -281,39 +286,50 @@ public class DynamicAuthoritiesGetUnitTest extends BaseWebScriptUnitTest impleme
@Test
public void missingBatchSizeParameter() throws Exception
{
- JSONObject json = executeJSONWebScript(emptyMap());
- assertNotNull(json);
- String actualJSONString = json.toString();
- ObjectMapper mapper = new ObjectMapper();
- String expectedJSONString = "{\"responsestatus\":\"failed\",\"message\":\"Parameter batchsize is mandatory\"}";
- assertEquals(mapper.readTree(expectedJSONString), mapper.readTree(actualJSONString));
+ try
+ {
+ executeJSONWebScript(emptyMap());
+ fail("Expected exception as parameter batchsize is mandatory.");
+ }
+ catch (WebScriptException e)
+ {
+ assertEquals("If parameter batchsize is not provided then 'Bad request' should be returned.",
+ Status.STATUS_BAD_REQUEST, e.getStatus());
+ }
}
@Test
public void invalidBatchSizeParameter() throws Exception
{
- // Set up parameters.
- Map parameters = ImmutableMap.of("batchsize", "dd");
- JSONObject json = executeJSONWebScript(parameters);
- assertNotNull(json);
- String actualJSONString = json.toString();
- ObjectMapper mapper = new ObjectMapper();
- String expectedJSONString = "{\"responsestatus\":\"failed\",\"message\":\"Parameter batchsize is invalid.\"}";
- assertEquals(mapper.readTree(expectedJSONString), mapper.readTree(actualJSONString));
+ try
+ {
+ // Set up parameters.
+ Map parameters = ImmutableMap.of("batchsize", "dd");
+ executeJSONWebScript(parameters);
+ fail("Expected exception as parameter batchsize is invalid.");
+ }
+ catch (WebScriptException e)
+ {
+ assertEquals("If parameter batchsize is invalid then 'Bad request' should be returned.",
+ Status.STATUS_BAD_REQUEST, e.getStatus());
+ }
}
@Test
public void batchSizeShouldBeGraterThanZero() throws Exception
{
- when(mockedQnameDAO.getQName(ASPECT_EXTENDED_SECURITY)).thenReturn(null);
- // Set up parameters.
- Map parameters = ImmutableMap.of("batchsize", "0");
- JSONObject json = executeJSONWebScript(parameters);
- assertNotNull(json);
- String actualJSONString = json.toString();
- ObjectMapper mapper = new ObjectMapper();
- String expectedJSONString = "{\"responsestatus\":\"failed\",\"message\":\"Parameter batchsize should be a number greater than 0.\"}";
- assertEquals(mapper.readTree(expectedJSONString), mapper.readTree(actualJSONString));
+ try
+ {
+ // Set up parameters.
+ Map parameters = ImmutableMap.of("batchsize", "0");
+ executeJSONWebScript(parameters);
+ fail("Expected exception as parameter batchsize is not a number greater than 0.");
+ }
+ catch (WebScriptException e)
+ {
+ assertEquals("If parameter batchsize is not a number greater than 0 then 'Bad request' should be returned.",
+ Status.STATUS_BAD_REQUEST, e.getStatus());
+ }
}
@Test
@@ -389,4 +405,45 @@ public class DynamicAuthoritiesGetUnitTest extends BaseWebScriptUnitTest impleme
String expectedJSONString = "{\"responsestatus\":\"success\",\"message\":\"Processed first 4 records.\"}";
assertEquals(mapper.readTree(expectedJSONString), mapper.readTree(actualJSONString));
}
+
+ @SuppressWarnings("unchecked")
+ @Test
+ public void recordsWithExtendedSecurityAspectAndNullWritersAndReaders() throws Exception
+ {
+ List ids = Stream.of(1l, 2l, 3l).collect(Collectors.toList());
+
+ when(mockedPatchDAO.getNodesByAspectQNameId(eq(ASPECT_ID), anyLong(), anyLong()))
+ .thenReturn(ids)
+ .thenReturn(Collections.emptyList());
+
+ ids.stream().forEach((i) -> {
+ NodeRef nodeRef = AlfMock.generateNodeRef(mockedNodeService);
+ when(mockedNodeDAO.getNodePair(i)).thenReturn(new Pair(i, nodeRef));
+ when(mockedNodeService.hasAspect(nodeRef, ASPECT_RECORD)).thenReturn(true);
+ when(mockedNodeService.getProperty(nodeRef, PROP_READERS))
+ .thenReturn(null);
+ when(mockedNodeService.getProperty(nodeRef, PROP_WRITERS))
+ .thenReturn(null);
+
+ });
+
+ // Set up parameters.
+ Map parameters = ImmutableMap.of("batchsize", "10", "maxProcessedRecords", "4");
+ JSONObject json = executeJSONWebScript(parameters);
+ assertNotNull(json);
+ String actualJSONString = json.toString();
+ ObjectMapper mapper = new ObjectMapper();
+ String expectedJSONString = "{\"responsestatus\":\"success\",\"message\":\"Processed 3 records.\"}";
+ assertEquals(mapper.readTree(expectedJSONString), mapper.readTree(actualJSONString));
+
+
+ verify(mockedNodeService, times(3)).getProperty(any(NodeRef.class), eq(PROP_READERS));
+ verify(mockedNodeService, times(3)).getProperty(any(NodeRef.class), eq(PROP_WRITERS));
+ verify(mockedNodeService, times(3)).removeAspect(any(NodeRef.class), eq(ASPECT_EXTENDED_SECURITY));
+ verify(mockedPermissionService, times(3)).clearPermission(any(NodeRef.class),
+ eq(ExtendedReaderDynamicAuthority.EXTENDED_READER));
+ verify(mockedPermissionService, times(3)).clearPermission(any(NodeRef.class),
+ eq(ExtendedWriterDynamicAuthority.EXTENDED_WRITER));
+ verify(mockedExtendedSecurityService, never()).set(any(NodeRef.class), any(Set.class), any(Set.class));
+ }
}
\ No newline at end of file