Compare commits

...

28 Commits

Author SHA1 Message Date
mohit-singh4
d1cb0f98c6 [APPS-3242] Fix for facet field aggregation 2025-03-12 20:00:16 +05:30
mohit-singh4
9877b8a9f1 Merge branch 'master' of github.com:Alfresco/alfresco-community-repo into fix/MNT-24172-fixRecreationOfRendition2 2025-03-10 11:56:06 +05:30
mohit-singh4
ac74222562 [fix/MNT-24172-fixRecreationOfRendition2] Test case for recreation of rendition2 2025-02-19 21:58:01 +05:30
mohit-singh4
6b959f8901 [fix/MNT-24172-fixRecreationOfRendition2] Test case for recreation of rendition2 2025-02-19 21:40:46 +05:30
mohit-singh4
1fac054c08 [fix/MNT-24172-fixRecreationOfRendition2] Test case for recreation of rendition2 2025-02-19 14:36:12 +05:30
mohit-singh4
eaf18d3b9d [fix/MNT-24172-fixRecreationOfRendition2] Test case for recreation of rendition2 2025-02-19 14:07:48 +05:30
mohit-singh4
05195d84e7 [fix/MNT-24172-fixRecreationOfRendition2] Test case for recreation of rendition2 2025-02-19 11:02:56 +05:30
mohit-singh4
2e2b41f879 [fix/MNT-24172-fixRecreationOfRendition2] Test case for recreation of rendition2 2025-02-19 11:01:11 +05:30
mohit-singh4
cf0463a24d [fix/MNT-24172-fixRecreationOfRendition2] Test case for Recreation of Rendition2 2025-02-19 08:56:21 +05:30
mohit-singh4
ed80663a07 [fix/MNT-24172-fixRecreationOfRendition2] Test Case for recreation of Rendition2 2025-02-17 14:49:10 +05:30
mohit-singh4
31343c5177 [fix/MNT-24172-fixRecreationOfRendition2] Test Case for recreation of Rendition2 2025-02-17 13:55:11 +05:30
mohit-singh4
f3492d16cf [fix/MNT-24172-fixRecreationOfRendition2] Test Case for recreation of Rendition2 2025-02-17 09:52:22 +05:30
mohit-singh4
5fb5e19434 [fix/MNT-24172-fixRecreationOfRendition2] Test Case for recreation of Rendition2 2025-02-13 12:27:00 +05:30
mohit-singh4
49d346a5c4 [fix/MNT-24172-fixRecreationOfRendition2] Test Case for recreation of Rendition2 2025-02-13 11:41:17 +05:30
mohit-singh4
ae699b37d0 [fix/MNT-24172-fixRecreationOfRendition2] Test Case for recreation of Rendition2 2025-02-13 09:20:41 +05:30
mohit-singh4
cc078037f7 [fix/MNT-24172-fixRecreationOfRendition2] Test Case for recreation of Rendition2 2025-02-13 08:49:25 +05:30
mohit-singh4
9b7eb95463 [fix/MNT-24172-fixRecreationOfRendition2] Test Case for recreation of Rendition2 2025-02-12 14:42:32 +05:30
mohit-singh4
5e560213bb [fix/MNT-24172-fixRecreationOfRendition2] Test Case for recreation of Rendition2 2025-02-12 13:57:03 +05:30
mohit-singh4
a1d8aa7b48 [fix/MNT-24172-fixRecreationOfRendition2] Test Case for recreation of Rendition2 2025-02-12 13:32:12 +05:30
mohit-singh4
b7e1daaac9 [fix/MNT-24172-fixRecreationOfRendition2] Test Case for recreation of Rendition2 2025-02-12 13:27:24 +05:30
mohit-singh4
d70295a8de [fix/MNT-24172-fixRecreationOfRendition2] Test Case for recreation of Rendition2 2025-02-12 12:47:54 +05:30
mohit-singh4
082770d73d [fix/MNT-24172-fixRecreationOfRendition2] Test Case for recreation of Rendition2 2025-02-10 12:46:26 +05:30
mohit-singh4
2f81d382fd Merge branch 'master' of github.com:Alfresco/alfresco-community-repo into fix/MNT-24172-fixRecreationOfRendition2 2025-02-10 11:49:55 +05:30
mohit-singh4
70438d4a51 [fix/MNT-24172-fixRecreationOfRendition2] Test Case for recreation of Rendition2 2025-02-10 11:47:48 +05:30
mohit-singh4
91aaee9f78 Merge branch 'master' of github.com:Alfresco/alfresco-community-repo into fix/MNT-24172-fixRecreationOfRendition2 2025-02-07 10:43:55 +05:30
mohit-singh4
d46162de7a [fix/MNT-24172-fixRecreationOfRendition2] Fix for recreation of rendition2 along with PR changes 2025-01-30 10:49:03 +05:30
mohit-singh4
ba0c9e471a Merge branch 'master' of github.com:Alfresco/alfresco-community-repo into fix/MNT-24172-fixRecreationOfRendition2 2025-01-30 10:11:33 +05:30
mohit-singh4
40deb11173 [fix/MNT-24172-fixRecreationOfRendition2] fix for recreation of rendition2 2025-01-16 23:56:56 +05:30
3 changed files with 1294 additions and 1215 deletions

View File

@@ -2,7 +2,7 @@
* #%L
* Alfresco Remote API
* %%
* Copyright (C) 2005 - 2020 Alfresco Software Limited
* Copyright (C) 2005 - 2025 Alfresco Software Limited
* %%
* This file is part of the Alfresco software.
* If the software was purchased under a paid Alfresco license, the terms of
@@ -26,17 +26,38 @@
package org.alfresco.rest.api.tests;
import static org.alfresco.rest.api.tests.util.RestApiUtil.toJsonAsString;
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertFalse;
import static org.junit.Assert.assertNotEquals;
import static org.junit.Assert.assertNotNull;
import static org.junit.Assert.assertNull;
import static org.junit.Assert.assertTrue;
import static org.alfresco.rest.api.tests.util.RestApiUtil.toJsonAsString;
import java.io.ByteArrayInputStream;
import java.io.File;
import java.io.InputStream;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.UUID;
import com.google.common.collect.Ordering;
import org.junit.After;
import org.junit.Before;
import org.junit.Test;
import org.alfresco.model.ContentModel;
import org.alfresco.repo.content.MimetypeMap;
import org.alfresco.repo.content.transform.swf.SWFTransformationOptions;
import org.alfresco.repo.rendition2.RenditionService2Impl;
import org.alfresco.repo.rendition2.SynchronousTransformClient;
import org.alfresco.repo.security.authentication.AuthenticationUtil;
import org.alfresco.repo.transaction.RetryingTransactionHelper;
import org.alfresco.rest.api.model.Site;
import org.alfresco.rest.api.nodes.NodesEntityResource;
import org.alfresco.rest.api.tests.RepoService.TestNetwork;
@@ -54,23 +75,11 @@ import org.alfresco.rest.api.tests.util.MultiPartBuilder.FileData;
import org.alfresco.rest.api.tests.util.MultiPartBuilder.MultiPartRequest;
import org.alfresco.rest.api.tests.util.RestApiUtil;
import org.alfresco.service.cmr.repository.ContentService;
import org.alfresco.service.cmr.repository.NodeRef;
import org.alfresco.service.cmr.repository.StoreRef;
import org.alfresco.service.cmr.site.SiteVisibility;
import org.alfresco.service.cmr.thumbnail.ThumbnailService;
import org.alfresco.util.TempFileProvider;
import org.junit.After;
import org.junit.Before;
import org.junit.Test;
import java.io.ByteArrayInputStream;
import java.io.File;
import java.io.InputStream;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.UUID;
/**
* V1 REST API tests for Renditions
@@ -98,12 +107,15 @@ public class RenditionsTest extends AbstractBaseApiTest
protected static ContentService contentService;
private static SynchronousTransformClient synchronousTransformClient;
private RetryingTransactionHelper transactionHelper;
@Before
public void setup() throws Exception
{
contentService = applicationContext.getBean("contentService", ContentService.class);
synchronousTransformClient = applicationContext.getBean("synchronousTransformClient", SynchronousTransformClient.class);
transactionHelper = (RetryingTransactionHelper) this.applicationContext
.getBean("retryingTransactionHelper");
networkN1 = repoService.createNetworkWithAlias("ping", true);
networkN1.create();
userOneN1 = networkN1.createUser();
@@ -123,7 +135,9 @@ public class RenditionsTest extends AbstractBaseApiTest
/**
* Tests get node renditions.
* <p>GET:</p>
* <p>
* GET:
* </p>
* {@literal <host>:<port>/alfresco/api/<networkId>/public/alfresco/versions/1/nodes/<nodeId>/renditions}
*/
@Test
@@ -263,7 +277,9 @@ public class RenditionsTest extends AbstractBaseApiTest
/**
* Tests get node rendition.
* <p>GET:</p>
* <p>
* GET:
* </p>
* {@literal <host>:<port>/alfresco/api/<networkId>/public/alfresco/versions/1/nodes/<nodeId>/renditions/<renditionId>}
*/
@Test
@@ -352,7 +368,9 @@ public class RenditionsTest extends AbstractBaseApiTest
/**
* Tests create rendition.
* <p>POST:</p>
* <p>
* POST:
* </p>
* {@literal <host>:<port>/alfresco/api/<networkId>/public/alfresco/versions/1/nodes/<nodeId>/renditions}
*/
@Test
@@ -563,7 +581,9 @@ public class RenditionsTest extends AbstractBaseApiTest
/**
* Tests create rendition when on upload/create of a file
*
* <p>POST:</p>
* <p>
* POST:
* </p>
* {@literal <host>:<port>/alfresco/api/<networkId>/public/alfresco/versions/1/nodes/<nodeId>/children}
*/
@Test
@@ -619,25 +639,11 @@ public class RenditionsTest extends AbstractBaseApiTest
assertRenditionCreatedWithWait(contentNodeId, renditionName);
}
/* RA-834: commented-out since not currently applicable for empty file
Document d1 = new Document();
d1.setName("d1.txt");
d1.setNodeType("cm:content");
ContentInfo ci = new ContentInfo();
ci.setMimeType(MimetypeMap.MIMETYPE_TEXT_PLAIN);
d1.setContent(ci);
// create empty file including request to generate a thumbnail
renditionName = "doclib";
response = post(getNodeChildrenUrl(folder_Id), userId, toJsonAsStringNonNull(d1), "?renditions="+renditionName, 201);
Document documentResp = RestApiUtil.parseRestApiEntry(response.getJsonResponse(), Document.class);
String d1Id = documentResp.getId();
// wait and check that rendition is created ...
rendition = waitAndGetRendition(userId, d1Id, renditionName);
assertNotNull(rendition);
assertEquals(RenditionStatus.CREATED, rendition.getStatus());
*/
/* RA-834: commented-out since not currently applicable for empty file Document d1 = new Document(); d1.setName("d1.txt"); d1.setNodeType("cm:content"); ContentInfo ci = new ContentInfo(); ci.setMimeType(MimetypeMap.MIMETYPE_TEXT_PLAIN); d1.setContent(ci);
*
* // create empty file including request to generate a thumbnail renditionName = "doclib"; response = post(getNodeChildrenUrl(folder_Id), userId, toJsonAsStringNonNull(d1), "?renditions="+renditionName, 201); Document documentResp = RestApiUtil.parseRestApiEntry(response.getJsonResponse(), Document.class); String d1Id = documentResp.getId();
*
* // wait and check that rendition is created ... rendition = waitAndGetRendition(userId, d1Id, renditionName); assertNotNull(rendition); assertEquals(RenditionStatus.CREATED, rendition.getStatus()); */
// Multiple renditions requested
reqBody = MultiPartBuilder.create()
@@ -802,7 +808,9 @@ public class RenditionsTest extends AbstractBaseApiTest
/**
* Tests download rendition.
* <p>GET:</p>
* <p>
* GET:
* </p>
* {@literal <host>:<port>/alfresco/api/<networkId>/public/alfresco/versions/1/nodes/<nodeId>/renditions/<renditionId>/content}
*/
@Test
@@ -981,6 +989,72 @@ public class RenditionsTest extends AbstractBaseApiTest
getSingle(getNodeRenditionsUrl(emptyContentNodeId), "doclib/content", params, 200);
}
/**
* Test recreation of rendition2 aspect.
* <p>
* POST:
* </p>
* <p>
* DELETE:
* </p>
* {@literal <host>:<port>/alfresco/api/<networkId>/public/alfresco/versions/1/nodes/<nodeId>/renditions} {@literal <host>:<port>/alfresco/api/<networkId>/public/alfresco/versions/1/nodes/<nodeId>/renditions/{renditionID}
*/
@Test
public void testRecreationOfRendition2() throws Exception
{
setRequestContext(networkN1.getId(), userOneN1.getId(), null);
// Create a folder within the site document's library
String folderName = "folder" + System.currentTimeMillis();
String folderId = addToDocumentLibrary(userOneN1Site, folderName, TYPE_CM_FOLDER, userOneN1.getId());
// Create multipart request.
String renditionName = "pdf";
String fileName = "quick.pdf";
File file = getResourceFile(fileName);
MultiPartRequest reqBody = MultiPartBuilder.create()
.setFileData(new FileData(fileName, file))
.setRenditions(Collections.singletonList(renditionName))
.build();
// Upload quick.pdf file into 'folder'
HttpResponse response = post(getNodeChildrenUrl(folderId), reqBody.getBody(), null, reqBody.getContentType(), 201);
Document document = RestApiUtil.parseRestApiEntry(response.getJsonResponse(), Document.class);
String contentNodeId = document.getId();
// wait and check that rendition is created ...
Rendition rendition = waitAndGetRendition(contentNodeId, null, renditionName);
assertNotNull(rendition);
assertEquals(Rendition.RenditionStatus.CREATED, rendition.getStatus());
Thread.sleep(DELAY_IN_MS);
delete(getNodeRenditionIdUrl(contentNodeId, renditionName), null, null, null, null, 204);
// retry to double-check deletion
delete(getNodeRenditionIdUrl(contentNodeId, renditionName), null, null, null, null, 404);
AuthenticationUtil.setFullyAuthenticatedUser(AuthenticationUtil.getAdminUserName());
ThumbnailService thumbnailService = applicationContext.getBean("thumbnailService", ThumbnailService.class);
SWFTransformationOptions swfTransformationOptions = new SWFTransformationOptions();
swfTransformationOptions.setUse("pdf");
NodeRef thumbNode = transactionHelper
.doInTransaction(
() -> thumbnailService.createThumbnail(getFolderNodeRef(contentNodeId), ContentModel.PROP_CONTENT,
MimetypeMap.MIMETYPE_PDF, swfTransformationOptions, "pdf"));
assertNotNull(thumbNode);
assertNotEquals("Both, we are getting same rendition Id's", rendition.getId(), thumbNode.getId());
}
private NodeRef getFolderNodeRef(String folderId)
{
return new NodeRef(StoreRef.STORE_REF_WORKSPACE_SPACESSTORE, folderId);
}
private String addToDocumentLibrary(Site testSite, String name, String nodeType, String userId) throws Exception
{
String parentId = getSiteContainerNodeId(testSite.getId(), "documentLibrary");

View File

@@ -57,7 +57,7 @@ public class NodeSizeDetailsServiceImpl implements NodeSizeDetailsService, Initi
{
private static final Logger LOG = LoggerFactory.getLogger(NodeSizeDetailsServiceImpl.class);
private static final String FIELD_FACET = "content.size";
private static final String FACET_QUERY = "{!afts}content.size:[0 TO " + Integer.MAX_VALUE + "]";
private static final String FACET_QUERY = "{!afts key='extra large'}content.size:[0 TO " + Integer.MAX_VALUE + "]";
private SearchService searchService;
private SimpleCache<Serializable, NodeSizeDetails> simpleCache;
private TransactionService transactionService;

View File

@@ -2,7 +2,7 @@
* #%L
* Alfresco Repository
* %%
* Copyright (C) 2005 - 2016 Alfresco Software Limited
* Copyright (C) 2005 - 2025 Alfresco Software Limited
* %%
* This file is part of the Alfresco software.
* If the software was purchased under a paid Alfresco license, the terms of
@@ -37,6 +37,10 @@ import java.util.HashMap;
import java.util.List;
import java.util.Map;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.springframework.extensions.surf.util.I18NUtil;
import org.alfresco.error.AlfrescoRuntimeException;
import org.alfresco.model.ContentModel;
import org.alfresco.model.RenditionModel;
@@ -76,13 +80,9 @@ import org.alfresco.service.namespace.NamespaceException;
import org.alfresco.service.namespace.NamespaceService;
import org.alfresco.service.namespace.QName;
import org.alfresco.util.GUID;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.springframework.extensions.surf.util.I18NUtil;
/**
* This class adds some new behaviour to the standard ActionExecuterAbstractBase
* in order to support the RenditionService.
* This class adds some new behaviour to the standard ActionExecuterAbstractBase in order to support the RenditionService.
*
* @author Neil McErlean
* @author Nick Smith
@@ -112,28 +112,24 @@ public abstract class AbstractRenderingEngine extends ActionExecuterAbstractBase
// for the two params
/**
* This is the default default node type for renditions - used if no value
* is injected from spring.
* This is the default default node type for renditions - used if no value is injected from spring.
*/
private static final QName DEFAULT_DEFAULT_RENDITION_NODE_TYPE = ContentModel.TYPE_CONTENT;
/**
* This is the default default property used to specify where rendition
* content is stored - used if no value is injected from spring.
* This is the default default property used to specify where rendition content is stored - used if no value is injected from spring.
*/
private static final QName DEFAULT_DEFAULT_RENDITION_CONTENT_PROP = RenditionService2Impl.DEFAULT_RENDITION_CONTENT_PROP;
private static final String DEFAULT_MIMETYPE = RenditionService2Impl.DEFAULT_MIMETYPE;
private static final String DEFAULT_ENCODING = RenditionService2Impl.DEFAULT_ENCODING;
/**
* This is the default node type that is used when creating rendition
* objects.
* This is the default node type that is used when creating rendition objects.
*/
private QName defaultRenditionNodeType = DEFAULT_DEFAULT_RENDITION_NODE_TYPE;
/**
* This is the default property that is used to store rendition objects'
* content.
* This is the default property that is used to store rendition objects' content.
*/
private QName defaultRenditionContentProp = DEFAULT_DEFAULT_RENDITION_CONTENT_PROP;
@@ -150,55 +146,39 @@ public abstract class AbstractRenderingEngine extends ActionExecuterAbstractBase
/* Parameter names common to all Rendering Actions */
/**
* This optional {@link String} parameter specifies the location of a
* classpath resource which can be used as a placeholder while a rendition
* is being generated. For example, this might be a simple icon to indicate
* a rendition is not yet available. This is intended to be used in
* conjunction with asynchronous generation of renditions.
* This optional {@link String} parameter specifies the location of a classpath resource which can be used as a placeholder while a rendition is being generated. For example, this might be a simple icon to indicate a rendition is not yet available. This is intended to be used in conjunction with asynchronous generation of renditions.
*/
public static final String PARAM_PLACEHOLDER_RESOURCE_PATH = "placeHolderResourcePath";
/**
* This optional {@link QName} parameter specifies which property the
* Rendering Engine uses to read content from the source node in order to
* create a rendition. By default this property will be cm:content.
* This optional {@link QName} parameter specifies which property the Rendering Engine uses to read content from the source node in order to create a rendition. By default this property will be cm:content.
*/
public static final String PARAM_SOURCE_CONTENT_PROPERTY = "sourceContentProperty";
/**
* This optional {@link QName} parameter specifies which property the
* Rendering Engine uses to write content to the rendition node. By default
* the property used is cm:content.
* This optional {@link QName} parameter specifies which property the Rendering Engine uses to write content to the rendition node. By default the property used is cm:content.
*/
public static final String PARAM_TARGET_CONTENT_PROPERTY = "targetContentProperty";
/**
* This optional {@link Boolean} flag property specifies whether a rendition
* should be updated automatically if the source node changes. If set to
* <code>true</code> then the rendition will be re-rendered any time any
* property changes occur on the source node. This parameter defaults to
* <code>false</code>.
* This optional {@link Boolean} flag property specifies whether a rendition should be updated automatically if the source node changes. If set to <code>true</code> then the rendition will be re-rendered any time any property changes occur on the source node. This parameter defaults to <code>false</code>.
*/
public static final String PARAM_UPDATE_RENDITIONS_ON_ANY_PROPERTY_CHANGE = "update-renditions-on-any-property-change";
/**
* This optional {@link String} parameter specifies what user permissions
* are used when creating a rendition. By default the system user is used.
* This optional {@link String} parameter specifies what user permissions are used when creating a rendition. By default the system user is used.
*/
public static final String PARAM_RUN_AS = "runAs";
// mime-type is not a common parameter on all Rendering Actions, but it is
// common to many and is used in some common handling code in this class.
/**
* This optional {@link String} parameter specifies the mime type of the
* rendition content. This defaults to the mime type of the source node
* content.
* This optional {@link String} parameter specifies the mime type of the rendition content. This defaults to the mime type of the source node content.
*/
public static final String PARAM_MIME_TYPE = "mime-type";
/**
* This optional {@link String} paramter specifies the encoding used to
* create the rendition content. The derfault encoding is UTF-8.
* This optional {@link String} paramter specifies the encoding used to create the rendition content. The derfault encoding is UTF-8.
*/
public static final String PARAM_ENCODING = "encoding";
@@ -207,9 +187,7 @@ public abstract class AbstractRenderingEngine extends ActionExecuterAbstractBase
*/
private final static NodeLocator defaultNodeLocator = new SelfNodeLocator();
/*
* Injected beans
*/
/* Injected beans */
private RenditionLocationResolver renditionLocationResolver;
protected NodeService nodeService;
private RenditionService renditionService;
@@ -232,7 +210,8 @@ public abstract class AbstractRenderingEngine extends ActionExecuterAbstractBase
/**
* Injects the renditionService bean.
*
* @param renditionService RenditionService
* @param renditionService
* RenditionService
*/
public void setRenditionService(RenditionService renditionService)
{
@@ -240,7 +219,8 @@ public abstract class AbstractRenderingEngine extends ActionExecuterAbstractBase
}
/**
* @param behaviourFilter policy behaviour filter
* @param behaviourFilter
* policy behaviour filter
*/
public void setBehaviourFilter(BehaviourFilter behaviourFilter)
{
@@ -271,12 +251,11 @@ public abstract class AbstractRenderingEngine extends ActionExecuterAbstractBase
this(null, null);
}
/**
* Sets the default rendition-node type.
*
* @param type String
* @param type
* String
*/
public void setDefaultRenditionNodeType(String type)
{
@@ -304,8 +283,7 @@ public abstract class AbstractRenderingEngine extends ActionExecuterAbstractBase
/**
* This method returns the type of the default rendition node type.
*
* @return the QName representing the type of the default rendition node
* type.
* @return the QName representing the type of the default rendition node type.
*/
protected QName getDefaultRenditionNodeType()
{
@@ -325,7 +303,8 @@ public abstract class AbstractRenderingEngine extends ActionExecuterAbstractBase
/**
* Sets the default rendition content property.
*
* @param prop String
* @param prop
* String
*/
public void setDefaultRenditionContentProp(String prop)
{
@@ -351,11 +330,9 @@ public abstract class AbstractRenderingEngine extends ActionExecuterAbstractBase
}
/**
* This method returns the QName of the property that defines the location
* of the rendition content. An example would be cm:content.
* This method returns the QName of the property that defines the location of the rendition content. An example would be cm:content.
*
* @return the QName the property defining the location of the rendition
* content.
* @return the QName the property defining the location of the rendition content.
*/
protected QName getDefaultRenditionContentProp()
{
@@ -365,7 +342,8 @@ public abstract class AbstractRenderingEngine extends ActionExecuterAbstractBase
/**
* Set the content service
*
* @param contentService the content service
* @param contentService
* the content service
*/
public void setContentService(ContentService contentService)
{
@@ -448,8 +426,7 @@ public abstract class AbstractRenderingEngine extends ActionExecuterAbstractBase
// permissions to create content under that node.
// For that reason, we execute all rendition actions as system
// by default.
AuthenticationUtil.runAs(new AuthenticationUtil.RunAsWork<Void>()
{
AuthenticationUtil.runAs(new AuthenticationUtil.RunAsWork<Void>() {
@Override
public Void doWork() throws Exception
{
@@ -484,7 +461,8 @@ public abstract class AbstractRenderingEngine extends ActionExecuterAbstractBase
// Grab a link to the rendition node - it's been saved as a parameter for us
// (Wait until now to fetch in case it was moved)
result = (ChildAssociationRef) renditionDef.getParameterValue(PARAM_RESULT);
} catch (Throwable t)
}
catch (Throwable t)
{
notifyCallbackOfException(renditionDef, t);
throwWrappedException(t);
@@ -499,16 +477,14 @@ public abstract class AbstractRenderingEngine extends ActionExecuterAbstractBase
}
/**
* Is this a standalone rendition, or is it a sub-component of
* a composite rendition?
* This is false for standalone renditions, AND ALSO false for
* the main part of a composite rendition.
* This only returns true if we're currently processing a
* component of a composite rendition.
* @param action Action
* Is this a standalone rendition, or is it a sub-component of a composite rendition? This is false for standalone renditions, AND ALSO false for the main part of a composite rendition. This only returns true if we're currently processing a component of a composite rendition.
*
* @param action
* Action
* @return boolean
*/
private boolean isComponentRendition(Action action) {
private boolean isComponentRendition(Action action)
{
Serializable s = action.getParameterValue(PARAM_IS_COMPONENT_RENDITION);
boolean result = s == null ? false : (Boolean) s;
return result;
@@ -541,10 +517,7 @@ public abstract class AbstractRenderingEngine extends ActionExecuterAbstractBase
}
/**
* This method can be overridden by subclasses to provide checking of parameter
* values.
* If a parameter value is illegal or inappropriate, an exception
* should be thrown.
* This method can be overridden by subclasses to provide checking of parameter values. If a parameter value is illegal or inappropriate, an exception should be thrown.
*/
protected void checkParameterValues(Action action)
{
@@ -552,7 +525,8 @@ public abstract class AbstractRenderingEngine extends ActionExecuterAbstractBase
}
/**
* @param renditionDefinition RenditionDefinition
* @param renditionDefinition
* RenditionDefinition
* @return QName
*/
protected QName getRenditionContentProperty(RenditionDefinition renditionDefinition)
@@ -563,7 +537,8 @@ public abstract class AbstractRenderingEngine extends ActionExecuterAbstractBase
protected abstract void render(RenderingContext context);
/**
* @param actionedUponNodeRef NodeRef
* @param actionedUponNodeRef
* NodeRef
*/
protected void checkSourceNodeExists(NodeRef actionedUponNodeRef)
{
@@ -576,7 +551,8 @@ public abstract class AbstractRenderingEngine extends ActionExecuterAbstractBase
}
/**
* @param action Action
* @param action
* Action
*/
protected RenditionDefinition checkActionIsRenditionDefinition(Action action)
{
@@ -593,7 +569,8 @@ public abstract class AbstractRenderingEngine extends ActionExecuterAbstractBase
/**
* If no rendition node type is specified, then the default is used
*
* @param renditionDefinition RenditionDefinition
* @param renditionDefinition
* RenditionDefinition
* @return QName
*/
private QName getRenditionNodeType(RenditionDefinition renditionDefinition)
@@ -608,12 +585,10 @@ public abstract class AbstractRenderingEngine extends ActionExecuterAbstractBase
}
/**
* This method gets the parameter definition display label from the properties file.
* It looks first for a property whose key has a fixed rendition service-specific
* prefix and if that gets null, it then delegates to the standard bean name-based
* approach.
* This method gets the parameter definition display label from the properties file. It looks first for a property whose key has a fixed rendition service-specific prefix and if that gets null, it then delegates to the standard bean name-based approach.
*
* @param paramName the name of the parameter
* @param paramName
* the name of the parameter
* @return the display label of the parameter
*/
@Override
@@ -712,14 +687,14 @@ public abstract class AbstractRenderingEngine extends ActionExecuterAbstractBase
}
/**
* Gets the value for the named parameter. Checks the type of the parameter
* is correct and throws a {@link RenditionServiceException} if it isn't.
* Returns <code>null</code> if the parameter value is <code>null</code>
* Gets the value for the named parameter. Checks the type of the parameter is correct and throws a {@link RenditionServiceException} if it isn't. Returns <code>null</code> if the parameter value is <code>null</code>
*
* @param paramName the name of the parameter being checked.
* @param clazz the expected {@link Class} of the parameter value.
* @param definition the {@link RenditionDefinition} containing the
* parameters.
* @param paramName
* the name of the parameter being checked.
* @param clazz
* the expected {@link Class} of the parameter value.
* @param definition
* the {@link RenditionDefinition} containing the parameters.
* @return the parameter value or <code>null</code>.
*/
@SuppressWarnings("unchecked")
@@ -744,15 +719,16 @@ public abstract class AbstractRenderingEngine extends ActionExecuterAbstractBase
}
/**
* Gets the value for the named parameter. Checks the type of the parameter
* is the same as the type of <code>defaultValue</code> and throws a
* {@link RenditionServiceException} if it isn't. Returns
* <code>defaultValue</code> if the parameter value is <code>null</code>
* Gets the value for the named parameter. Checks the type of the parameter is the same as the type of <code>defaultValue</code> and throws a {@link RenditionServiceException} if it isn't. Returns <code>defaultValue</code> if the parameter value is <code>null</code>
*
* @param paramName String
* @param defaultValue T
* @param definition RenditionDefinition
* @param <T> T
* @param paramName
* String
* @param defaultValue
* T
* @param definition
* RenditionDefinition
* @param <T>
* T
* @return T
*/
@SuppressWarnings("unchecked")
@@ -776,9 +752,12 @@ public abstract class AbstractRenderingEngine extends ActionExecuterAbstractBase
private ChildAssociationRef caNodeRef;
/**
* @param sourceNode NodeRef
* @param definition RenditionDefinition
* @param renditionContentProperty QName
* @param sourceNode
* NodeRef
* @param definition
* RenditionDefinition
* @param renditionContentProperty
* QName
*/
public RenderingContext(NodeRef sourceNode, //
RenditionDefinition definition, //
@@ -799,6 +778,7 @@ public abstract class AbstractRenderingEngine extends ActionExecuterAbstractBase
/**
* Lazily instantiation of the ChildAssociationRef
*
* @return ChildAssociationRef
*/
public synchronized ChildAssociationRef getChildAssociationRef()
@@ -870,7 +850,6 @@ public abstract class AbstractRenderingEngine extends ActionExecuterAbstractBase
}
}
protected void tagSourceNodeAsRenditioned(final RenditionDefinition renditionDef, final NodeRef actionedUponNodeRef)
{
// Adds the 'Renditioned' aspect to the source node if it
@@ -924,7 +903,8 @@ public abstract class AbstractRenderingEngine extends ActionExecuterAbstractBase
if (t instanceof AlfrescoRuntimeException)
{
throw (AlfrescoRuntimeException) t;
} else
}
else
{
throw new RenditionServiceException(t.getMessage(), t);
}
@@ -944,11 +924,12 @@ public abstract class AbstractRenderingEngine extends ActionExecuterAbstractBase
}
/**
* This method sets the temporary rendition parent node and the rendition assocType on the
* rendition definition.
* This method sets the temporary rendition parent node and the rendition assocType on the rendition definition.
*
* @param sourceNode NodeRef
* @param definition the rendition definition.
* @param sourceNode
* NodeRef
* @param definition
* the rendition definition.
*/
private void setTemporaryRenditionProperties(NodeRef sourceNode, RenditionDefinition definition)
{
@@ -969,11 +950,12 @@ public abstract class AbstractRenderingEngine extends ActionExecuterAbstractBase
/**
*
* @param sourceNode The node that has been rendered
* @param tempRendition The relationship between the node and its rendition
* @param renditionDefinition The definition of the rendition that has just been performed.
* In the case of a composite rendition, this parameter refers
* to that CompositeRendition and not to any of its component renditions.
* @param sourceNode
* The node that has been rendered
* @param tempRendition
* The relationship between the node and its rendition
* @param renditionDefinition
* The definition of the rendition that has just been performed. In the case of a composite rendition, this parameter refers to that CompositeRendition and not to any of its component renditions.
* @return ChildAssociationRef
*/
private ChildAssociationRef createOrUpdateRendition(NodeRef sourceNode, ChildAssociationRef tempRendition,
@@ -1012,16 +994,36 @@ public abstract class AbstractRenderingEngine extends ActionExecuterAbstractBase
{
String msg = "A rendition of name: " + renditionQName + " should have been created for source node: "
+ sourceNode;
throw new RenditionServiceException(msg);
if (logger.isDebugEnabled())
{
logger.debug(msg);
}
// Check if the node has the applied renditioned aspect, and if it does,
// remove the existing rendition node and assign the newly created rendition node.
if (nodeService.hasAspect(sourceNode, RenditionModel.ASPECT_RENDITIONED))
{
List<ChildAssociationRef> renditions = nodeService.getChildAssocs(sourceNode, RenditionModel.ASSOC_RENDITION, renditionQName);
if (!renditions.isEmpty())
{
ChildAssociationRef existingRendition = renditions.get(0);
nodeService.removeChild(sourceNode, existingRendition.getChildRef());
renditionAssoc = renditionNode;
if (logger.isDebugEnabled())
{
logger.debug("Removing the existing rendition node that doesn't have contentData and "
+ "assigning the newly created rendition node: " + renditionNode);
}
}
}
}
// Return the link between the source and the new, final rendition
return renditionAssoc;
}
/**
* This method manages the <code>rn:rendition</code> aspects on the rendition node. It applies the
* correct rendition aspect based on the rendition node's location and removes any out-of-date rendition
* aspect.
* This method manages the <code>rn:rendition</code> aspects on the rendition node. It applies the correct rendition aspect based on the rendition node's location and removes any out-of-date rendition aspect.
*/
private void manageRenditionAspects(NodeRef sourceNode, ChildAssociationRef renditionParentAssoc)
{
@@ -1046,7 +1048,8 @@ public abstract class AbstractRenderingEngine extends ActionExecuterAbstractBase
// We remove the other aspect to cover the potential case where a
// rendition
// has been updated in a different location.
} else
}
else
{
// Renditions stored underneath any node other than their source are
// 'visible'.
@@ -1064,17 +1067,19 @@ public abstract class AbstractRenderingEngine extends ActionExecuterAbstractBase
}
/**
* This method calculates the name for a rendition node. The following approaches are attempted in
* the order given below.
* This method calculates the name for a rendition node. The following approaches are attempted in the order given below.
* <ol>
* <li>If a name is defined in the {@link RenditionLocation} then that is used.</li>
* <li>If the temporary rendition has a <code>cm:name</code> value, then that is used.</li>
* <li>Otherwise use the rendition definition's rendition name.</li>
* </ol>
*
* @param tempRenditionNode the temporary rendition node.
* @param location a RenditionLocation struct.
* @param renditionDefinition the rendition definition.
* @param tempRenditionNode
* the temporary rendition node.
* @param location
* a RenditionLocation struct.
* @param renditionDefinition
* the rendition definition.
* @return the name for the rendition.
*/
private String getRenditionName(NodeRef tempRenditionNode, RenditionLocation location,
@@ -1097,8 +1102,7 @@ public abstract class AbstractRenderingEngine extends ActionExecuterAbstractBase
}
/**
* Given a rendition definition, a source node and a temporary rendition node, this method uses a
* {@link RenditionLocationResolver} to calculate the {@link RenditionLocation} of the rendition.
* Given a rendition definition, a source node and a temporary rendition node, this method uses a {@link RenditionLocationResolver} to calculate the {@link RenditionLocation} of the rendition.
*/
protected RenditionLocation resolveRenditionLocation(NodeRef sourceNode, RenditionDefinition definition,
NodeRef tempRendition)
@@ -1107,11 +1111,12 @@ public abstract class AbstractRenderingEngine extends ActionExecuterAbstractBase
}
/**
* Gets the <code>ExecutionSummary</code> for the given <code>renderingContext</code>
* from the {@link ActionTrackingService}.
* Gets the <code>ExecutionSummary</code> for the given <code>renderingContext</code> from the {@link ActionTrackingService}.
* <p>
* Note that multiple summaries of the same action instance are not currently supported.
* @param renderingContext the rendering context
*
* @param renderingContext
* the rendering context
* @return the found summary or null
*/
protected ExecutionSummary getExecutionSummary(RenderingContext renderingContext)