result = getCheckResult();
return result;
}
@@ -242,7 +245,7 @@ public class RemoteTransformerClient
if (logger.isDebugEnabled())
{
- logger.debug(name+' '+" check" +url);
+ logger.debug("Remote "+name+' '+" check" +url);
}
try
@@ -254,7 +257,7 @@ public class RemoteTransformerClient
StatusLine statusLine = response.getStatusLine();
if (statusLine == null)
{
- throw new AlfrescoRuntimeException(name+" check returned no status " + url);
+ throw new AlfrescoRuntimeException("Remote "+name+" check returned no status " + url);
}
HttpEntity resEntity = response.getEntity();
if (resEntity != null)
@@ -271,7 +274,7 @@ public class RemoteTransformerClient
long responseContentLength = resEntity.getContentLength();
Header responseContentType = resEntity.getContentType();
Header responseContentEncoding = resEntity.getContentEncoding();
- logger.debug(name +
+ logger.debug("Remote " + name +
" check returned. length=" + responseContentLength +
" type=" + responseContentType +
" encoding=" + responseContentEncoding+
@@ -286,28 +289,28 @@ public class RemoteTransformerClient
}
catch (IOException e)
{
- throw new AlfrescoRuntimeException(name + " check failed to read the returned content", e);
+ throw new AlfrescoRuntimeException("Remote " + name + " check failed to read the returned content", e);
}
}
else
{
String message = getErrorMessage(resEntity);
- throw new AlfrescoRuntimeException(name + " check returned a " + statusCode + " status " + message + ' ' + url);
+ throw new AlfrescoRuntimeException("Remote " + name + " check returned a " + statusCode + " status " + message + ' ' + url);
}
}
else
{
- throw new AlfrescoRuntimeException(name + " check did not return an entity " + url);
+ throw new AlfrescoRuntimeException("Remote " + name + " check did not return an entity " + url);
}
}
catch (IOException e)
{
- throw new AlfrescoRuntimeException(name + " check failed to connect or to read the response", e);
+ throw new AlfrescoRuntimeException("Remote " + name + " check failed to connect or to read the response", e);
}
}
catch (IOException e)
{
- throw new AlfrescoRuntimeException(name + " check failed to create an HttpClient", e);
+ throw new AlfrescoRuntimeException("Remote " + name + " check failed to create an HttpClient", e);
}
}
catch (AlfrescoRuntimeException e)
diff --git a/src/main/java/org/alfresco/repo/content/transform/TransformerDebug.java b/src/main/java/org/alfresco/repo/content/transform/TransformerDebug.java
index c7377eb382..6ffabb4cc9 100644
--- a/src/main/java/org/alfresco/repo/content/transform/TransformerDebug.java
+++ b/src/main/java/org/alfresco/repo/content/transform/TransformerDebug.java
@@ -25,37 +25,8 @@
*/
package org.alfresco.repo.content.transform;
-import org.alfresco.model.ContentModel;
-import org.alfresco.repo.content.filestore.FileContentWriter;
-import org.alfresco.repo.model.Repository;
-import org.alfresco.repo.rendition2.RenditionDefinition2;
-import org.alfresco.repo.rendition2.RenditionDefinition2Impl;
-import org.alfresco.repo.rendition2.RenditionDefinitionRegistry2Impl;
-import org.alfresco.repo.rendition2.TransformClient;
-import org.alfresco.repo.transaction.RetryingTransactionHelper;
-import org.alfresco.service.cmr.repository.ContentData;
-import org.alfresco.service.cmr.repository.ContentService;
-import org.alfresco.service.cmr.repository.ContentWriter;
-import org.alfresco.service.cmr.repository.MimetypeService;
-import org.alfresco.service.cmr.repository.NodeRef;
-import org.alfresco.service.cmr.repository.NodeService;
-import org.alfresco.service.cmr.repository.TransformationOptions;
-import org.alfresco.service.namespace.NamespaceService;
-import org.alfresco.service.namespace.QName;
-import org.alfresco.service.transaction.TransactionService;
-import org.alfresco.util.EqualsHelper;
-import org.alfresco.util.LogTee;
-import org.alfresco.util.PropertyCheck;
-import org.alfresco.util.TempFileProvider;
-import org.apache.commons.logging.Log;
-import org.apache.commons.logging.LogFactory;
-import org.springframework.beans.BeansException;
-import org.springframework.context.ApplicationContext;
-import org.springframework.context.ApplicationContextAware;
-
import java.io.File;
-import java.io.Serializable;
-import java.net.URI;
+import java.io.IOException;
import java.net.URL;
import java.util.ArrayDeque;
import java.util.ArrayList;
@@ -63,11 +34,8 @@ import java.util.Collection;
import java.util.Collections;
import java.util.Comparator;
import java.util.Deque;
-import java.util.HashMap;
import java.util.Iterator;
-import java.util.LinkedList;
import java.util.List;
-import java.util.Map;
import java.util.Set;
import java.util.SortedMap;
import java.util.TreeMap;
@@ -75,7 +43,24 @@ import java.util.TreeSet;
import java.util.concurrent.atomic.AtomicInteger;
import java.util.regex.Pattern;
-import static org.alfresco.repo.rendition2.RenditionService2Impl.SOURCE_HAS_NO_CONTENT;
+import org.alfresco.api.AlfrescoPublicApi;
+import org.alfresco.error.AlfrescoRuntimeException;
+import org.alfresco.model.ContentModel;
+import org.alfresco.repo.content.filestore.FileContentReader;
+import org.alfresco.repo.content.filestore.FileContentWriter;
+import org.alfresco.service.cmr.repository.ContentReader;
+import org.alfresco.service.cmr.repository.ContentService;
+import org.alfresco.service.cmr.repository.ContentWriter;
+import org.alfresco.service.cmr.repository.MimetypeService;
+import org.alfresco.service.cmr.repository.NodeRef;
+import org.alfresco.service.cmr.repository.NodeService;
+import org.alfresco.service.cmr.repository.TransformationOptions;
+import org.alfresco.util.EqualsHelper;
+import org.alfresco.util.LogTee;
+import org.alfresco.util.TempFileProvider;
+import org.apache.commons.io.FileUtils;
+import org.apache.commons.logging.Log;
+import org.apache.commons.logging.LogFactory;
/**
* Debugs transformers selection and activity.
@@ -94,26 +79,21 @@ import static org.alfresco.repo.rendition2.RenditionService2Impl.SOURCE_HAS_NO_C
* transformers) and {@link #popAvailable} are called.
*
* @author Alan Davis
+ *
+ * @deprecated The transformations code is being moved out of the codebase and replaced by the new async RenditionService2 or other external libraries.
*/
-public class TransformerDebug implements ApplicationContextAware
+@Deprecated
+@AlfrescoPublicApi
+public class TransformerDebug
{
private static final String FINISHED_IN = "Finished in ";
private static final String NO_TRANSFORMERS = "No transformers";
- private Log info;
- private Log logger;
- private NodeService nodeService;
- private MimetypeService mimetypeService;
- private ContentTransformerRegistry transformerRegistry;
- private TransformerConfig transformerConfig;
-
- private ApplicationContext applicationContext;
- private ContentService contentService;
- private TransformClient transformClient;
- private Repository repositoryHelper;
- private TransactionService transactionService;
- private RenditionDefinitionRegistry2Impl renditionDefinitionRegistry2;
+ private final Log logger;
+ private final Log info;
+ @Deprecated
+ @AlfrescoPublicApi
private enum Call
{
AVAILABLE,
@@ -121,6 +101,8 @@ public class TransformerDebug implements ApplicationContextAware
AVAILABLE_AND_TRANSFORM
};
+ @Deprecated
+ @AlfrescoPublicApi
private static class ThreadInfo
{
private static final ThreadLocal threadInfo = new ThreadLocal()
@@ -171,6 +153,8 @@ public class TransformerDebug implements ApplicationContextAware
}
}
+ @Deprecated
+ @AlfrescoPublicApi
private static class Frame
{
private static final AtomicInteger uniqueId = new AtomicInteger(0);
@@ -179,8 +163,7 @@ public class TransformerDebug implements ApplicationContextAware
private final String fromUrl;
private final String sourceMimetype;
private final String targetMimetype;
- private final NodeRef sourceNodeRef;
- private final String renditionName;
+ private final TransformationOptions options;
private final boolean origDebugOutput;
private long start;
@@ -193,7 +176,7 @@ public class TransformerDebug implements ApplicationContextAware
private String transformerName;
private Frame(Frame parent, String transformerName, String fromUrl, String sourceMimetype, String targetMimetype,
- long sourceSize, String renditionName, NodeRef sourceNodeRef, Call pushCall, boolean origDebugOutput)
+ long sourceSize, TransformationOptions options, Call pushCall, boolean origDebugOutput)
{
this.id = -1;
this.parent = parent;
@@ -202,8 +185,7 @@ public class TransformerDebug implements ApplicationContextAware
this.sourceMimetype = sourceMimetype;
this.targetMimetype = targetMimetype;
this.sourceSize = sourceSize;
- this.renditionName = renditionName;
- this.sourceNodeRef = sourceNodeRef;
+ this.options = options;
this.callType = pushCall;
this.origDebugOutput = origDebugOutput;
start = System.currentTimeMillis();
@@ -250,6 +232,7 @@ public class TransformerDebug implements ApplicationContextAware
}
@Deprecated
+ @AlfrescoPublicApi
private class UnavailableTransformer implements Comparable
{
private final String name;
@@ -299,50 +282,27 @@ public class TransformerDebug implements ApplicationContextAware
return name.compareTo(o.name);
}
}
-
- public void setTransformerLog(Log transformerLog)
- {
- info = new LogTee(LogFactory.getLog(TransformerLog.class), transformerLog);
- }
-
- public void setTransformerDebugLog(Log transformerDebugLog)
- {
- logger = new LogTee(LogFactory.getLog(TransformerDebug.class), transformerDebugLog);
- }
-
- public void setNodeService(NodeService nodeService)
+
+ private final NodeService nodeService;
+ private final MimetypeService mimetypeService;
+ private final ContentTransformerRegistry transformerRegistry;
+ private final TransformerConfig transformerConfig;
+ private ContentService contentService;
+
+ /**
+ * Constructor
+ */
+ public TransformerDebug(NodeService nodeService, MimetypeService mimetypeService,
+ ContentTransformerRegistry transformerRegistry, TransformerConfig transformerConfig,
+ Log transformerLog, Log transformerDebugLog)
{
this.nodeService = nodeService;
- }
-
- public void setMimetypeService(MimetypeService mimetypeService)
- {
this.mimetypeService = mimetypeService;
- }
-
- public void setTransformerRegistry(ContentTransformerRegistry transformerRegistry)
- {
this.transformerRegistry = transformerRegistry;
- }
-
- public void setTransformerConfig(TransformerConfig transformerConfig)
- {
this.transformerConfig = transformerConfig;
- }
-
- @Override
- public void setApplicationContext(ApplicationContext applicationContext) throws BeansException
- {
- this.applicationContext = applicationContext;
- }
-
- private ContentService getContentService()
- {
- if (contentService == null)
- {
- contentService = (ContentService) applicationContext.getBean("contentService");
- }
- return contentService;
+
+ logger = new LogTee(LogFactory.getLog(TransformerDebug.class), transformerDebugLog);
+ info = new LogTee(LogFactory.getLog(TransformerLog.class), transformerLog);
}
public void setContentService(ContentService contentService)
@@ -350,138 +310,40 @@ public class TransformerDebug implements ApplicationContextAware
this.contentService = contentService;
}
- private TransformClient getTransformClient()
- {
- if (transformClient == null)
- {
- transformClient = (TransformClient) applicationContext.getBean("transformClient");
- }
- return transformClient;
- }
-
- public void setTransformClient(TransformClient transformClient)
- {
- this.transformClient = transformClient;
- }
-
- public Repository getRepositoryHelper()
- {
- if (repositoryHelper == null)
- {
- repositoryHelper = (Repository) applicationContext.getBean("repositoryHelper");
- }
- return repositoryHelper;
- }
-
- public void setRepositoryHelper(Repository repositoryHelper)
- {
- this.repositoryHelper = repositoryHelper;
- }
-
- public TransactionService getTransactionService()
- {
- if (transactionService == null)
- {
- transactionService = (TransactionService) applicationContext.getBean("transactionService");
- }
- return transactionService;
- }
-
- public void setTransactionService(TransactionService transactionService)
- {
- this.transactionService = transactionService;
- }
-
- public RenditionDefinitionRegistry2Impl getRenditionDefinitionRegistry2Impl()
- {
- if (renditionDefinitionRegistry2 == null)
- {
- renditionDefinitionRegistry2 = (RenditionDefinitionRegistry2Impl) applicationContext.getBean("renditionDefinitionRegistry2");
- }
- return renditionDefinitionRegistry2;
- }
-
- public void setRenditionDefinitionRegistry2(RenditionDefinitionRegistry2Impl renditionDefinitionRegistry2)
- {
- this.renditionDefinitionRegistry2 = renditionDefinitionRegistry2;
- }
-
- public void afterPropertiesSet() throws Exception
- {
- PropertyCheck.mandatory(this, "transformerLog", info);
- PropertyCheck.mandatory(this, "transformerDebugLog", logger);
- PropertyCheck.mandatory(this, "nodeService", nodeService);
- PropertyCheck.mandatory(this, "mimetypeService", mimetypeService);
- PropertyCheck.mandatory(this, "transformerRegistry", transformerRegistry);
- PropertyCheck.mandatory(this, "transformerConfig", transformerConfig);
- }
-
- @Deprecated
- public void pushAvailable(String fromUrl, String sourceMimetype, String targetMimetype,
- TransformationOptions options)
- {
- String renditionName = options == null ? null : options.getUse();
- NodeRef sourceNodeRef = options == null ? null : options.getSourceNodeRef();
- pushAvailable(fromUrl, sourceMimetype, targetMimetype, renditionName, sourceNodeRef);
- }
-
/**
* Called prior to working out what transformers are available.
*/
- @Deprecated
public void pushAvailable(String fromUrl, String sourceMimetype, String targetMimetype,
- String renditionName, NodeRef sourceNodeRef)
+ TransformationOptions options)
{
if (isEnabled())
{
- push(null, fromUrl, sourceMimetype, targetMimetype, -1, renditionName,
- sourceNodeRef, Call.AVAILABLE);
+ push(null, fromUrl, sourceMimetype, targetMimetype, -1, options, Call.AVAILABLE);
}
}
/**
* Called when a transformer has been ignored because of a blacklist entry.
*/
- @Deprecated
public void blacklistTransform(ContentTransformer transformer, String sourceMimetype,
String targetMimetype, TransformationOptions options)
{
log("Blacklist "+getName(transformer)+" "+getMimetypeExt(sourceMimetype)+getMimetypeExt(targetMimetype));
}
-
- @Deprecated
- public void pushTransform(ContentTransformer transformer, String fromUrl, String sourceMimetype,
- String targetMimetype, long sourceSize, TransformationOptions options)
- {
- String renditionName = options == null ? null : options.getUse();
- NodeRef sourceNodeRef = options == null ? null : options.getSourceNodeRef();
- pushTransform(transformer, fromUrl, sourceMimetype, targetMimetype, sourceSize, renditionName, sourceNodeRef);
- }
-
+
/**
* Called prior to performing a transform.
*/
- @Deprecated
public void pushTransform(ContentTransformer transformer, String fromUrl, String sourceMimetype,
- String targetMimetype, long sourceSize, String renditionName, NodeRef sourceNodeRef)
+ String targetMimetype, long sourceSize, TransformationOptions options)
{
if (isEnabled())
{
push(getName(transformer), fromUrl, sourceMimetype, targetMimetype, sourceSize,
- renditionName, sourceNodeRef, Call.TRANSFORM);
+ options, Call.TRANSFORM);
}
}
-
- public void pushTransform(String transformerName, String fromUrl, String sourceMimetype,
- String targetMimetype, long sourceSize, String renditionName, NodeRef sourceNodeRef)
- {
- if (isEnabled())
- {
- push(transformerName, fromUrl, sourceMimetype, targetMimetype, sourceSize,
- renditionName, sourceNodeRef, Call.TRANSFORM);
- }
- }
-
+
/**
* Adds a new level to the stack to get a new request number or nesting number.
* Called prior to working out what transformers are active
@@ -491,14 +353,13 @@ public class TransformerDebug implements ApplicationContextAware
{
if (isEnabled())
{
- push(null, null, null, null, -1, null, null, Call.AVAILABLE);
+ push(null, null, null, null, -1, null, Call.AVAILABLE);
}
}
/**
* Called prior to calling a nested isTransformable.
*/
- @Deprecated
public void pushIsTransformableSize(ContentTransformer transformer)
{
if (isEnabled())
@@ -508,7 +369,7 @@ public class TransformerDebug implements ApplicationContextAware
}
private void push(String transformerName, String fromUrl, String sourceMimetype, String targetMimetype,
- long sourceSize, String renditionName, NodeRef sourceNodeRef, Call callType)
+ long sourceSize, TransformationOptions options, Call callType)
{
Deque ourStack = ThreadInfo.getStack();
Frame frame = ourStack.peek();
@@ -522,14 +383,13 @@ public class TransformerDebug implements ApplicationContextAware
// Create a new frame. Logging level is set to trace if the file size is 0
boolean origDebugOutput = ThreadInfo.setDebugOutput(ThreadInfo.getDebugOutput() && sourceSize != 0);
- frame = new Frame(frame, transformerName, fromUrl, sourceMimetype, targetMimetype, sourceSize, renditionName,
- sourceNodeRef, callType, origDebugOutput);
+ frame = new Frame(frame, transformerName, fromUrl, sourceMimetype, targetMimetype, sourceSize, options, callType, origDebugOutput);
ourStack.push(frame);
if (callType == Call.TRANSFORM)
{
// Log the basic info about this transformation
- logBasicDetails(frame, sourceSize, renditionName, transformerName, (ourStack.size() == 1));
+ logBasicDetails(frame, sourceSize, options.getUse(), transformerName, (ourStack.size() == 1));
}
}
@@ -537,7 +397,6 @@ public class TransformerDebug implements ApplicationContextAware
* Called to identify a transformer that cannot be used during working out
* available transformers.
*/
- @Deprecated
public void unavailableTransformer(ContentTransformer transformer, String sourceMimetype, String targetMimetype, long maxSourceSizeKBytes)
{
if (isEnabled())
@@ -562,21 +421,11 @@ public class TransformerDebug implements ApplicationContextAware
}
}
- @Deprecated
- public void availableTransformers(List transformers, long sourceSize,
- TransformationOptions options, String calledFrom)
- {
- String renditionName = options == null ? null : options.getUse();
- NodeRef sourceNodeRef = options == null ? null : options.getSourceNodeRef();
- availableTransformers(transformers, sourceSize, renditionName, sourceNodeRef, calledFrom);
- }
-
/**
* Called once all available transformers have been identified.
*/
- @Deprecated
public void availableTransformers(List transformers, long sourceSize,
- String renditionName, NodeRef sourceNodeRef, String calledFrom)
+ TransformationOptions options, String calledFrom)
{
if (isEnabled())
{
@@ -598,7 +447,7 @@ public class TransformerDebug implements ApplicationContextAware
frame.setSourceSize(sourceSize);
// Log the basic info about this transformation
- logBasicDetails(frame, sourceSize, renditionName,
+ logBasicDetails(frame, sourceSize, options.getUse(),
calledFrom + ((transformers.size() == 0) ? " NO transformers" : ""), firstLevel);
// Report available and unavailable transformers
@@ -608,11 +457,7 @@ public class TransformerDebug implements ApplicationContextAware
{
String name = getName(trans);
int padName = longestNameLength - name.length() + 1;
- // TODO replace with call to RenditionService2 or leave as a deprecated method using ContentService.
- TransformationOptions options = new TransformationOptions();
- options.setUse(frame.renditionName);
- options.setSourceNodeRef(frame.sourceNodeRef);
- long maxSourceSizeKBytes = trans.getMaxSourceSizeKBytes(frame.sourceMimetype, frame.targetMimetype, options);
+ long maxSourceSizeKBytes = trans.getMaxSourceSizeKBytes(frame.sourceMimetype, frame.targetMimetype, frame.options);
String size = maxSourceSizeKBytes > 0 ? "< "+fileSize(maxSourceSizeKBytes*1024) : "";
int padSize = 10 - size.length();
String priority = gePriority(trans, frame.sourceMimetype, frame.targetMimetype);
@@ -646,13 +491,11 @@ public class TransformerDebug implements ApplicationContextAware
return priority;
}
- @Deprecated
public void inactiveTransformer(ContentTransformer transformer)
{
log(getName(transformer)+' '+ms(transformer.getTransformationTime(null, null))+" INACTIVE");
}
- @Deprecated
public void activeTransformer(int mimetypePairCount, ContentTransformer transformer, String sourceMimetype,
String targetMimetype, long maxSourceSizeKBytes, boolean firstMimetypePair)
{
@@ -667,9 +510,8 @@ public class TransformerDebug implements ApplicationContextAware
' '+fileSize((maxSourceSizeKBytes > 0) ? maxSourceSizeKBytes*1024 : maxSourceSizeKBytes)+
(maxSourceSizeKBytes == 0 ? " disabled" : ""));
}
-
- @Deprecated
- public void activeTransformer(String sourceMimetype, String targetMimetype,
+
+ public void activeTransformer(String sourceMimetype, String targetMimetype,
int transformerCount, ContentTransformer transformer, long maxSourceSizeKBytes,
boolean firstTransformer)
{
@@ -706,7 +548,7 @@ public class TransformerDebug implements ApplicationContextAware
return longestNameLength;
}
- private void logBasicDetails(Frame frame, long sourceSize, String renditionName, String message, boolean firstLevel)
+ private void logBasicDetails(Frame frame, long sourceSize, String use, String message, boolean firstLevel)
{
// Log the source URL, but there is no point if the parent has logged it
if (frame.fromUrl != null && (firstLevel || frame.id != 1))
@@ -715,14 +557,14 @@ public class TransformerDebug implements ApplicationContextAware
}
log(frame.sourceMimetype+' '+frame.targetMimetype, false);
- String fileName = getFileName(frame.sourceNodeRef, firstLevel, sourceSize);
+ String fileName = getFileName(frame.options, firstLevel, sourceSize);
log(getMimetypeExt(frame.sourceMimetype)+getMimetypeExt(frame.targetMimetype) +
((fileName != null) ? fileName+' ' : "")+
((sourceSize >= 0) ? fileSize(sourceSize)+' ' : "") +
- (firstLevel && renditionName != null ? "-- "+renditionName+" -- " : "") + message);
+ (firstLevel && use != null ? "-- "+use+" -- " : "") + message);
if (firstLevel)
{
- String nodeRef = getNodeRef(frame.sourceNodeRef, firstLevel, sourceSize);
+ String nodeRef = getNodeRef(frame.options, firstLevel, sourceSize);
if (!nodeRef.isEmpty())
{
log(nodeRef);
@@ -817,7 +659,7 @@ public class TransformerDebug implements ApplicationContextAware
boolean firstLevel = size == 1;
String sourceExt = getMimetypeExt(frame.sourceMimetype);
String targetExt = getMimetypeExt(frame.targetMimetype);
- String fileName = getFileName(frame.sourceNodeRef, firstLevel, frame.sourceSize);
+ String fileName = getFileName(frame.options, firstLevel, frame.sourceSize);
long sourceSize = frame.getSourceSize();
String transformerName = frame.getTransformerName();
String level = null;
@@ -1051,11 +893,9 @@ public class TransformerDebug implements ApplicationContextAware
* @param toString indicates that a String value should be returned in addition to any debug.
* @param format42 indicates the old 4.1.4 format should be used which did not order the transformers
* and only included top level transformers.
- * @param renditionName to which the transformation will be put (such as "Index", "Preview", null).
- * @deprecated The transformations code is being moved out of the codebase and replaced by the new async RenditionService2 or other external libraries.
+ * @param use to which the transformation will be put (such as "Index", "Preview", null).
*/
- @Deprecated
- public String transformationsByTransformer(String transformerName, boolean toString, boolean format42, String renditionName)
+ public String transformationsByTransformer(String transformerName, boolean toString, boolean format42, String use)
{
// Do not generate this type of debug if already generating other debug to a StringBuilder
// (for example a test transform).
@@ -1075,7 +915,7 @@ public class TransformerDebug implements ApplicationContextAware
: mimetypeService.getMimetypes();
TransformationOptions options = new TransformationOptions();
- options.setUse(renditionName);
+ options.setUse(use);
StringBuilder sb = null;
try
{
@@ -1137,12 +977,10 @@ public class TransformerDebug implements ApplicationContextAware
* level transformers.
* @param onlyNonDeterministic if true only report transformations where there is more than
* one transformer available with the same priority.
- * @param renditionName to which the transformation will be put (such as "Index", "Preview", null).
- * @deprecated The transformations code is being moved out of the codebase and replaced by the new async RenditionService2 or other external libraries.
+ * @param use to which the transformation will be put (such as "Index", "Preview", null).
*/
- @Deprecated
public String transformationsByExtension(String sourceExtension, String targetExtension, boolean toString,
- boolean format42, boolean onlyNonDeterministic, String renditionName)
+ boolean format42, boolean onlyNonDeterministic, String use)
{
// Do not generate this type of debug if already generating other debug to a StringBuilder
// (for example a test transform).
@@ -1162,7 +1000,7 @@ public class TransformerDebug implements ApplicationContextAware
: mimetypeService.getMimetypes();
TransformationOptions options = new TransformationOptions();
- options.setUse(renditionName);
+ options.setUse(use);
StringBuilder sb = null;
try
{
@@ -1410,30 +1248,24 @@ public class TransformerDebug implements ApplicationContextAware
return !transformerRegistry.getTransformers().contains(transformer);
}
- @Deprecated
public String getFileName(TransformationOptions options, boolean firstLevel, long sourceSize)
{
- NodeRef sourceNodeRef = options == null ? null : options.getSourceNodeRef();
- return getFileName(sourceNodeRef, firstLevel, sourceSize);
- }
-
- public String getFileName(NodeRef sourceNodeRef, boolean firstLevel, long sourceSize)
- {
- return getFileNameOrNodeRef(sourceNodeRef, firstLevel, sourceSize, true);
- }
-
- private String getNodeRef(NodeRef sourceNodeRef, boolean firstLevel, long sourceSize)
- {
- return getFileNameOrNodeRef(sourceNodeRef, firstLevel, sourceSize, false);
+ return getFileNameOrNodeRef(options, firstLevel, sourceSize, true);
}
- private String getFileNameOrNodeRef(NodeRef sourceNodeRef, boolean firstLevel, long sourceSize, boolean getName)
+ private String getNodeRef(TransformationOptions options, boolean firstLevel, long sourceSize)
+ {
+ return getFileNameOrNodeRef(options, firstLevel, sourceSize, false);
+ }
+
+ private String getFileNameOrNodeRef(TransformationOptions options, boolean firstLevel, long sourceSize, boolean getName)
{
String result = getName ? null : "";
- if (sourceNodeRef != null)
+ if (options != null)
{
try
{
+ NodeRef sourceNodeRef = options.getSourceNodeRef();
result = getName
? (String)nodeService.getProperty(sourceNodeRef, ContentModel.PROP_NAME)
: sourceNodeRef.toString()+" ";
@@ -1536,9 +1368,7 @@ public class TransformerDebug implements ApplicationContextAware
* @param transformerName to restrict the collection to one entry
* @return a new Collection of sorted transformers
* @throws IllegalArgumentException if transformerName is not found.
- * @deprecated The transformations code is being moved out of the codebase and replaced by the new async RenditionService2 or other external libraries.
*/
- @Deprecated
public Collection sortTransformersByName(String transformerName)
{
Collection transformers = (transformerName != null)
@@ -1559,14 +1389,13 @@ public class TransformerDebug implements ApplicationContextAware
* Debugs a request to the Transform Service
*/
public int debugTransformServiceRequest(String sourceMimetype, long sourceSize, NodeRef sourceNodeRef,
- int contentHashcode, String fileName, String targetMimetype,
- String renditionName)
+ int contentHashcode, String fileName, String targetMimetype, String use)
{
pushMisc();
debug(getMimetypeExt(sourceMimetype)+getMimetypeExt(targetMimetype) +
((fileName != null) ? fileName+' ' : "")+
((sourceSize >= 0) ? fileSize(sourceSize)+' ' : "") +
- (renditionName != null ? "-- "+renditionName+" -- " : "") + " RenditionService2");
+ (use != null ? "-- "+use+" -- " : "") + " RenditionService2");
debug(sourceNodeRef.toString() + ' ' +contentHashcode);
debug(" **a) [01] TransformService");
return pop(Call.AVAILABLE, true, false);
@@ -1597,19 +1426,35 @@ public class TransformerDebug implements ApplicationContextAware
pop(Call.AVAILABLE, suppressFinish, true);
}
- public String testTransform(String sourceExtension, String targetExtension, String renditionName)
+ public String testTransform(String sourceExtension, String targetExtension, String use)
{
- return new TestTransform().run(sourceExtension, targetExtension, renditionName);
+ return new TestTransform()
+ {
+ protected void transform(ContentReader reader, ContentWriter writer, TransformationOptions options)
+ {
+ contentService.transform(reader, writer, options);
+ }
+ }.run(sourceExtension, targetExtension, use);
}
-
- /**
- * @deprecated The transformations code is being moved out of the codebase and replaced by the new async RenditionService2 or other external libraries.
- */
- @Deprecated
+
public String testTransform(final String transformerName, String sourceExtension,
- String targetExtension, String renditionName)
+ String targetExtension, String use)
{
- return "The testTransform operation for a specific transformer is no longer supported.";
+ final ContentTransformer transformer = transformerRegistry.getTransformer(transformerName);
+ return new TestTransform()
+ {
+ protected String isTransformable(String sourceMimetype, long sourceSize, String targetMimetype, TransformationOptions options)
+ {
+ return transformer.isTransformable(sourceMimetype, sourceSize, targetMimetype, options)
+ ? null
+ : transformerName+" does not support this transformation.";
+ }
+
+ protected void transform(ContentReader reader, ContentWriter writer, TransformationOptions options)
+ {
+ transformer.transform(reader, writer, options);
+ }
+ }.run(sourceExtension, targetExtension, use);
}
public String[] getTestFileExtensionsAndMimetypes()
@@ -1654,58 +1499,68 @@ public class TransformerDebug implements ApplicationContextAware
}
@Deprecated
- private class TestTransform
+ @AlfrescoPublicApi
+ private abstract class TestTransform
{
- protected LinkedList nodesToDeleteAfterTest = new LinkedList();
-
- String run(String sourceExtension, String targetExtension, String renditionName)
+ String run(String sourceExtension, String targetExtension, String use)
{
- RenditionDefinitionRegistry2Impl renditionDefinitionRegistry2 = getRenditionDefinitionRegistry2Impl();
-
+ String debug;
+
String targetMimetype = getMimetype(targetExtension, false);
String sourceMimetype = getMimetype(sourceExtension, true);
+ URL sourceURL = loadQuickTestFile(sourceExtension);
+ if (sourceURL == null)
+ {
+ throw new IllegalArgumentException("There is no test file with a "+sourceExtension+" extension.");
+ }
+
+ // This URL may point to a file on the filesystem or to an entry in a jar.
+ // To use the transform method below, we need the content to be accessible from a ContentReader.
+ // This is possible for a File but not a (non-file) URL.
+ //
+ // Therefore, we'll always copy the URL content to a temporary local file.
+ final File sourceFile = TempFileProvider.createTempFile(TransformerDebug.class.getSimpleName() + "-tmp-", "");
+
+ try { FileUtils.copyURLToFile(sourceURL, sourceFile); }
+ catch (IOException shouldNeverHappen)
+ {
+ // The sourceURL should always be readable as we're reading data that Alfresco is distributing.
+ // But just in case...
+ throw new IllegalArgumentException("Cannot read content of test file with a " +
+ sourceExtension + " extension.", shouldNeverHappen);
+ }
+
+ ContentReader reader = new FileContentReader(sourceFile);
+ reader.setMimetype(sourceMimetype);
File tempFile = TempFileProvider.createTempFile(
"TestTransform_" + sourceExtension + "_", "." + targetExtension);
ContentWriter writer = new FileContentWriter(tempFile);
writer.setMimetype(targetMimetype);
- String testRenditionName = "testTransform"+System.currentTimeMillis();
- NodeRef sourceNodeRef = null;
- StringBuilder sb = new StringBuilder();
- try
- {
- setStringBuilder(sb);
- RenditionDefinition2 renditionDefinition = new RenditionDefinition2Impl(testRenditionName, targetMimetype,
- Collections.emptyMap(), renditionDefinitionRegistry2);
+ long sourceSize = reader.getSize();
+ TransformationOptions options = new TransformationOptions();
+ options.setUse(use);
- sourceNodeRef = createSourceNode(sourceExtension, sourceMimetype);
- ContentData contentData = (ContentData) nodeService.getProperty(sourceNodeRef, ContentModel.PROP_CONTENT);
- if (contentData != null)
+ debug = isTransformable(sourceMimetype, sourceSize, targetMimetype, options);
+ if (debug == null)
+ {
+ StringBuilder sb = new StringBuilder();
+ try
{
- String contentUrl = contentData.getContentUrl();
- if (contentUrl != null)
- {
- long size = contentData.getSize();
- int sourceContentHashCode = SOURCE_HAS_NO_CONTENT;
- String contentString = contentData.getContentUrl()+contentData.getMimetype();
- if (contentString != null)
- {
- sourceContentHashCode = contentString.hashCode();
- }
-
- TransformClient transformClient = getTransformClient();
- transformClient.checkSupported(sourceNodeRef, renditionDefinition, sourceMimetype, size, contentUrl);
- transformClient.transform(sourceNodeRef, renditionDefinition, "testTransform", sourceContentHashCode);
- }
+ setStringBuilder(sb);
+ transform(reader, writer, options);
}
+ catch (AlfrescoRuntimeException e)
+ {
+ sb.append(e.getMessage());
+ }
+ finally
+ {
+ setStringBuilder(null);
+ }
+ debug = sb.toString();
}
- finally
- {
- setStringBuilder(null);
- renditionDefinitionRegistry2.unregister(testRenditionName);
- deleteSourceNode(sourceNodeRef);
- }
- return sb.toString();
+ return debug;
}
private String getMimetype(String extension, boolean isSource)
@@ -1726,57 +1581,11 @@ public class TransformerDebug implements ApplicationContextAware
return mimetype;
}
- public NodeRef createSourceNode(String extension, String sourceMimetype)
+ protected String isTransformable(String sourceMimetype, long sourceSize, String targetMimetype, TransformationOptions options)
{
- // Create a content node which will serve as test data for our transformations.
- RetryingTransactionHelper.RetryingTransactionCallback makeNodeCallback = new RetryingTransactionHelper.RetryingTransactionCallback()
- {
- public NodeRef execute() throws Throwable
- {
- // Create a source node loaded with a quick file.
- URL url = loadQuickTestFile(extension);
- URI uri = url.toURI();
- File sourceFile = new File(uri);
-
- final NodeRef companyHome = getRepositoryHelper().getCompanyHome();
-
- Map props = new HashMap();
- String localName = "TestTransform." + extension;
- props.put(ContentModel.PROP_NAME, localName);
- NodeRef node = nodeService.createNode(
- companyHome,
- ContentModel.ASSOC_CONTAINS,
- QName.createQName(NamespaceService.CONTENT_MODEL_1_0_URI, localName),
- ContentModel.TYPE_CONTENT,
- props).getChildRef();
-
- ContentWriter writer = getContentService().getWriter(node, ContentModel.PROP_CONTENT, true);
- writer.setMimetype(sourceMimetype);
- writer.setEncoding("UTF-8");
- writer.putContent(sourceFile);
-
- return node;
- }
- };
- NodeRef contentNodeRef = getTransactionService().getRetryingTransactionHelper().doInTransaction(makeNodeCallback);
- this.nodesToDeleteAfterTest.add(contentNodeRef);
- return contentNodeRef;
- }
-
- public void deleteSourceNode(NodeRef sourceNodeRef)
- {
- if (sourceNodeRef != null)
- {
- getTransactionService().getRetryingTransactionHelper().doInTransaction(
- (RetryingTransactionHelper.RetryingTransactionCallback) () ->
- {
- if (nodeService.exists(sourceNodeRef))
- {
- nodeService.deleteNode(sourceNodeRef);
- }
- return null;
- });
- }
+ return null;
}
+
+ protected abstract void transform(ContentReader reader, ContentWriter writer, TransformationOptions options);
}
}
diff --git a/src/main/java/org/alfresco/repo/content/transform/UnsupportedTransformationException.java b/src/main/java/org/alfresco/repo/content/transform/UnsupportedTransformationException.java
index cf614de863..6fcb7b2e2d 100644
--- a/src/main/java/org/alfresco/repo/content/transform/UnsupportedTransformationException.java
+++ b/src/main/java/org/alfresco/repo/content/transform/UnsupportedTransformationException.java
@@ -30,12 +30,16 @@ import org.alfresco.error.AlfrescoRuntimeException;
/**
* Exception indicates that a transformer is unable to transform a requested
- * transformation. Normally the transformer is a component of a pipeline transformer
- * and has been asked to transform a file that is too large as the
+ * transformation. Normally the transformer is a component of a complex (compound) transformer
+ * and has been asked to transform a file that is too large (see transformation limits) as the
* size of the intermediate file is unknown at the start.
*
* @author Alan Davis
+ *
+ * @deprecated The transformations code is being moved out of the codebase and replaced by the new async RenditionService2 or other external libraries.
*/
+@Deprecated
+@AlfrescoPublicApi
public class UnsupportedTransformationException extends AlfrescoRuntimeException
{
private static final long serialVersionUID = 9039331287661301086L;
diff --git a/src/main/java/org/alfresco/repo/content/transform/magick/ImageMagickContentTransformerWorker.java b/src/main/java/org/alfresco/repo/content/transform/magick/ImageMagickContentTransformerWorker.java
index 3a16537a78..b9779b16da 100644
--- a/src/main/java/org/alfresco/repo/content/transform/magick/ImageMagickContentTransformerWorker.java
+++ b/src/main/java/org/alfresco/repo/content/transform/magick/ImageMagickContentTransformerWorker.java
@@ -81,14 +81,12 @@ public class ImageMagickContentTransformerWorker extends AbstractImageMagickCont
/** the system command executer */
private RuntimeExec executer;
- private boolean enabled = true;
-
/** the check command executer */
private RuntimeExec checkCommand;
-
+
/** the output from the check command */
private String versionString;
-
+
/**
* Default constructor
*/
@@ -118,11 +116,6 @@ public class ImageMagickContentTransformerWorker extends AbstractImageMagickCont
this.executer = executer;
}
- public void setEnabled(boolean enabled)
- {
- this.enabled = enabled;
- }
-
/**
* Sets the command that must be executed in order to retrieve version information from the converting executable
* and thus test that the executable itself is present.
@@ -134,7 +127,7 @@ public class ImageMagickContentTransformerWorker extends AbstractImageMagickCont
{
this.checkCommand = checkCommand;
}
-
+
/**
* Gets the version string captured from the check command.
*
@@ -153,57 +146,54 @@ public class ImageMagickContentTransformerWorker extends AbstractImageMagickCont
@Override
public void afterPropertiesSet()
{
- if (enabled)
+ if (!remoteTransformerClientConfigured() && executer == null)
{
- if (!remoteTransformerClientConfigured() && executer == null)
+ throw new AlfrescoRuntimeException("System runtime executer not set");
+ }
+ super.afterPropertiesSet();
+ if (!remoteTransformerClientConfigured())
+ {
+ if (isAvailable())
{
- throw new AlfrescoRuntimeException("System runtime executer not set");
- }
- super.afterPropertiesSet();
- if (!remoteTransformerClientConfigured())
- {
- if (isAvailable())
+ try
{
- try
- {
- // On some platforms / versions, the -version command seems to return an error code whilst still
- // returning output, so let's not worry about the exit code!
- ExecutionResult result = this.checkCommand.execute();
- this.versionString = result.getStdOut().trim();
- }
- catch (Throwable e)
- {
- setAvailable(false);
- logger.error(getClass().getSimpleName() + " not available: "
- + (e.getMessage() != null ? e.getMessage() : ""));
- // debug so that we can trace the issue if required
- logger.debug(e);
- }
+ // On some platforms / versions, the -version command seems to return an error code whilst still
+ // returning output, so let's not worry about the exit code!
+ ExecutionResult result = this.checkCommand.execute();
+ this.versionString = result.getStdOut().trim();
}
+ catch (Throwable e)
+ {
+ setAvailable(false);
+ logger.error(getClass().getSimpleName() + " not available: "
+ + (e.getMessage() != null ? e.getMessage() : ""));
+ // debug so that we can trace the issue if required
+ logger.debug(e);
+ }
+ }
+ }
+ else
+ {
+ Pair result = remoteTransformerClient.check(logger);
+ Boolean isAvailable = result.getFirst();
+ if (isAvailable != null && isAvailable)
+ {
+ setAvailable(true);
+ versionString = result.getSecond().trim();
+ logger.info("Using remote ImageMagick: "+versionString);
}
else
{
- Pair result = remoteTransformerClient.check(logger);
- Boolean isAvailable = result.getFirst();
- if (isAvailable != null && isAvailable)
+ setAvailable(false);
+ versionString = "unknown";
+ String message = "Remote ImageMagick is not available for transformations. " + result.getSecond();
+ if (isAvailable == null)
{
- setAvailable(true);
- versionString = result.getSecond().trim();
- logger.info("Using legacy local ImageMagick: " + versionString);
+ logger.debug(message);
}
else
{
- setAvailable(false);
- versionString = "unknown";
- String message = "Leacy remote ImageMagick is not available for transformations. " + result.getSecond();
- if (isAvailable == null)
- {
- logger.debug(message);
- }
- else
- {
- logger.error(message);
- }
+ logger.error(message);
}
}
}
diff --git a/src/main/java/org/alfresco/repo/content/transform/pdfrenderer/AlfrescoPdfRendererContentTransformerWorker.java b/src/main/java/org/alfresco/repo/content/transform/pdfrenderer/AlfrescoPdfRendererContentTransformerWorker.java
index a722bb53b8..4c97cc2a9e 100644
--- a/src/main/java/org/alfresco/repo/content/transform/pdfrenderer/AlfrescoPdfRendererContentTransformerWorker.java
+++ b/src/main/java/org/alfresco/repo/content/transform/pdfrenderer/AlfrescoPdfRendererContentTransformerWorker.java
@@ -77,8 +77,6 @@ public class AlfrescoPdfRendererContentTransformerWorker extends ContentTransfor
/** the system command executer */
private RuntimeExec executer;
- private boolean enabled = true;
-
/** the check command executer */
private RuntimeExec checkCommand;
@@ -112,11 +110,6 @@ public class AlfrescoPdfRendererContentTransformerWorker extends ContentTransfor
this.executer = executer;
}
- public void setEnabled(boolean enabled)
- {
- this.enabled = enabled;
- }
-
/**
* Sets the optional remote transformer client which will be used in preference to a local command if available.
*
@@ -148,44 +141,41 @@ public class AlfrescoPdfRendererContentTransformerWorker extends ContentTransfor
@Override
public void afterPropertiesSet()
{
- if (enabled)
+ PropertyCheck.mandatory(this, "executer", executer);
+ PropertyCheck.mandatory(this, "isAvailable", checkCommand);
+ // check availability
+ try
{
- PropertyCheck.mandatory(this, "executer", executer);
- PropertyCheck.mandatory(this, "isAvailable", checkCommand);
- // check availability
- try
+ Pair result = remoteTransformerClientConfigured()
+ ? remoteTransformerClient.check(logger)
+ : remoteTransformerClient.check(checkCommand);
+ Boolean isAvailable = result.getFirst();
+ if (isAvailable != null && isAvailable)
{
- Pair result = remoteTransformerClientConfigured()
- ? remoteTransformerClient.check(logger)
- : remoteTransformerClient.check(checkCommand);
- Boolean isAvailable = result.getFirst();
- if (isAvailable != null && isAvailable)
+ versionString = result.getSecond();
+ setAvailable(true);
+ logger.info("Using remote Alfresco PDF Renderer: "+versionString);
+ }
+ else
+ {
+ setAvailable(false);
+ String message = "Remote Alfresco PDF Renderer is not available for transformations. " + result.getSecond();
+ if (isAvailable == null)
{
- versionString = result.getSecond();
- setAvailable(true);
- logger.info("Using legacy local Alfresco PDF Renderer: " + versionString);
+ logger.debug(message);
}
else
{
- setAvailable(false);
- String message = "Legacy local Alfresco PDF Renderer is not available for transformations. " + result.getSecond();
- if (isAvailable == null)
- {
- logger.debug(message);
- }
- else
- {
- logger.error(message);
- }
+ logger.error(message);
}
}
- catch (Throwable e)
- {
- setAvailable(false);
- logger.error("Remote Alfresco PDF Renderer is not available: " + (e.getMessage() != null ? e.getMessage() : ""));
- // debug so that we can trace the issue if required
- logger.debug(e);
- }
+ }
+ catch (Throwable e)
+ {
+ setAvailable(false);
+ logger.error("Remote Alfresco PDF Renderer is not available: " + (e.getMessage() != null ? e.getMessage() : ""));
+ // debug so that we can trace the issue if required
+ logger.debug(e);
}
}
diff --git a/src/test/java/org/alfresco/repo/rendition2/LegacyRenditionTest.java b/src/main/java/org/alfresco/repo/rendition2/AbstractTransformClient.java
similarity index 61%
rename from src/test/java/org/alfresco/repo/rendition2/LegacyRenditionTest.java
rename to src/main/java/org/alfresco/repo/rendition2/AbstractTransformClient.java
index 0b82424607..f8ce1d6f6c 100644
--- a/src/test/java/org/alfresco/repo/rendition2/LegacyRenditionTest.java
+++ b/src/main/java/org/alfresco/repo/rendition2/AbstractTransformClient.java
@@ -25,28 +25,30 @@
*/
package org.alfresco.repo.rendition2;
-import org.junit.AfterClass;
-import org.junit.BeforeClass;
+import org.alfresco.model.ContentModel;
+import org.alfresco.service.cmr.repository.ContentData;
+import org.alfresco.service.cmr.repository.NodeRef;
+import org.alfresco.service.cmr.repository.NodeService;
+import org.alfresco.util.PropertyCheck;
+import org.springframework.beans.factory.InitializingBean;
/**
- * Repeats quick file rendition tests with local transforms disabled but legacy transformers enabled.
- * The Transform Service does not exist for the Community edition.
- * Should be the same result as with local transforms.
+ * Contains common code used in TransformClients.
*
* @author adavis
*/
-public class LegacyRenditionTest extends AbstractRenditionTest
+public abstract class AbstractTransformClient implements InitializingBean
{
- @BeforeClass
- public static void before()
+ protected NodeService nodeService;
+
+ public void setNodeService(NodeService nodeService)
{
- AbstractRenditionIntegrationTest.before();
- legacy();
+ this.nodeService = nodeService;
}
- @AfterClass
- public static void after()
+ @Override
+ public void afterPropertiesSet() throws Exception
{
- AbstractRenditionIntegrationTest.after();
+ PropertyCheck.mandatory(this, "nodeService", nodeService);
}
}
diff --git a/src/main/java/org/alfresco/repo/rendition2/LegacyTransformClient.java b/src/main/java/org/alfresco/repo/rendition2/LegacyLocalTransformClient.java
similarity index 91%
rename from src/main/java/org/alfresco/repo/rendition2/LegacyTransformClient.java
rename to src/main/java/org/alfresco/repo/rendition2/LegacyLocalTransformClient.java
index c1a9418ac7..dccfa89c70 100644
--- a/src/main/java/org/alfresco/repo/rendition2/LegacyTransformClient.java
+++ b/src/main/java/org/alfresco/repo/rendition2/LegacyLocalTransformClient.java
@@ -37,7 +37,6 @@ import org.alfresco.service.transaction.TransactionService;
import org.alfresco.util.PropertyCheck;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
-import org.springframework.beans.factory.InitializingBean;
import java.io.InputStream;
import java.util.Map;
@@ -53,9 +52,9 @@ import java.util.concurrent.Executors;
* @author adavis
*/
@Deprecated
-public class LegacyTransformClient implements TransformClient, InitializingBean
+public class LegacyLocalTransformClient extends AbstractTransformClient implements TransformClient
{
- private static Log logger = LogFactory.getLog(LegacyTransformClient.class);
+ private static Log logger = LogFactory.getLog(LegacyLocalTransformClient.class);
private TransactionService transactionService;
@@ -95,7 +94,7 @@ public class LegacyTransformClient implements TransformClient, InitializingBean
@Override
public void afterPropertiesSet() throws Exception
{
- PropertyCheck.mandatory(this, "transactionService", transactionService);
+ super.afterPropertiesSet();
PropertyCheck.mandatory(this, "contentService", contentService);
PropertyCheck.mandatory(this, "renditionService2", renditionService2);
PropertyCheck.mandatory(this, "converter", converter);
@@ -118,13 +117,13 @@ public class LegacyTransformClient implements TransformClient, InitializingBean
ContentTransformer transformer = contentService.getTransformer(contentUrl, sourceMimetype, size, targetMimetype, transformationOptions);
if (transformer == null)
{
- String message = "Unsupported rendition " + renditionName + " from " + sourceMimetype + " size: " + size + " using legacy transform";
+ String message = "Unsupported rendition " + renditionName + " from " + sourceMimetype + " size: " + size;
logger.debug(message);
throw new UnsupportedOperationException(message);
}
if (logger.isDebugEnabled())
{
- logger.debug("Rendition of " + renditionName + " from " + sourceMimetype + " will use legacy transform " + transformer.getName());
+ logger.debug("Rendition of " + renditionName + " from " + sourceMimetype + " will use " + transformer.getName());
}
}
@@ -145,7 +144,7 @@ public class LegacyTransformClient implements TransformClient, InitializingBean
TransformationOptions transformationOptions = converter.getTransformationOptions(renditionName, options);
transformationOptions.setSourceNodeRef(sourceNodeRef);
- ContentReader reader = LegacyTransformClient.this.contentService.getReader(sourceNodeRef, ContentModel.PROP_CONTENT);
+ ContentReader reader = LegacyLocalTransformClient.this.contentService.getReader(sourceNodeRef, ContentModel.PROP_CONTENT);
if (null == reader || !reader.exists())
{
throw new IllegalArgumentException("The supplied sourceNodeRef "+sourceNodeRef+" has no content.");
diff --git a/src/main/java/org/alfresco/repo/rendition2/LegacyTransformServiceRegistry.java b/src/main/java/org/alfresco/repo/rendition2/LegacyLocalTransformServiceRegistry.java
similarity index 82%
rename from src/main/java/org/alfresco/repo/rendition2/LegacyTransformServiceRegistry.java
rename to src/main/java/org/alfresco/repo/rendition2/LegacyLocalTransformServiceRegistry.java
index 18aaffcb9a..0ddd2e9993 100644
--- a/src/main/java/org/alfresco/repo/rendition2/LegacyTransformServiceRegistry.java
+++ b/src/main/java/org/alfresco/repo/rendition2/LegacyLocalTransformServiceRegistry.java
@@ -41,7 +41,7 @@ import java.util.Map;
* @author adavis
*/
@Deprecated
-public class LegacyTransformServiceRegistry extends AbstractTransformServiceRegistry implements InitializingBean
+public class LegacyLocalTransformServiceRegistry extends AbstractTransformServiceRegistry implements InitializingBean
{
private ContentService contentService;
private TransformationOptionsConverter converter;
@@ -85,21 +85,14 @@ public class LegacyTransformServiceRegistry extends AbstractTransformServiceRegi
if (firstTime)
{
firstTime = false;
- transformerDebug.debug("Legacy transforms are " + (enabled ? "enabled" : "disabled"));
+ transformerDebug.debug("Local legacy transformers are " + (enabled ? "enabled" : "disabled"));
}
long maxSize = 0;
if (enabled)
{
- try
- {
- TransformationOptions transformationOptions = converter.getTransformationOptions(renditionName, options);
- maxSize = contentService.getMaxSourceSizeBytes(sourceMimetype, targetMimetype, transformationOptions);
- }
- catch (IllegalArgumentException ignore)
- {
- // Typically if the mimetype is invalid.
- }
+ TransformationOptions transformationOptions = converter.getTransformationOptions(renditionName, options);
+ maxSize = contentService.getMaxSourceSizeBytes(sourceMimetype, targetMimetype, transformationOptions);
}
return maxSize;
}
diff --git a/src/main/java/org/alfresco/repo/rendition2/LocalTransformClient.java b/src/main/java/org/alfresco/repo/rendition2/LocalTransformClient.java
deleted file mode 100644
index 519173a067..0000000000
--- a/src/main/java/org/alfresco/repo/rendition2/LocalTransformClient.java
+++ /dev/null
@@ -1,177 +0,0 @@
-/*
- * #%L
- * Alfresco Repository
- * %%
- * Copyright (C) 2019 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 .
- * #L%
- */
-package org.alfresco.repo.rendition2;
-
-import org.alfresco.model.ContentModel;
-import org.alfresco.repo.content.transform.LocalTransformer;
-import org.alfresco.repo.content.transform.LocalTransformServiceRegistry;
-import org.alfresco.repo.security.authentication.AuthenticationUtil;
-import org.alfresco.service.cmr.repository.ContentReader;
-import org.alfresco.service.cmr.repository.ContentService;
-import org.alfresco.service.cmr.repository.ContentWriter;
-import org.alfresco.service.cmr.repository.NodeRef;
-import org.alfresco.service.transaction.TransactionService;
-import org.alfresco.util.PropertyCheck;
-import org.apache.commons.logging.Log;
-import org.apache.commons.logging.LogFactory;
-import org.springframework.beans.factory.InitializingBean;
-
-import java.io.InputStream;
-import java.util.Map;
-import java.util.concurrent.ExecutorService;
-import java.util.concurrent.Executors;
-
-/**
- * Requests rendition transforms take place using transforms available on the local machine (based on
- * {@link LocalTransformer}. The transform and consumption of the
- * resulting content is linked into a single operation that will take place at some point in the future on the local
- * machine.
- *
- * @author adavis
- */
-public class LocalTransformClient implements TransformClient, InitializingBean
-{
- private static Log logger = LogFactory.getLog(LocalTransformClient.class);
-
- private LocalTransformServiceRegistry localTransformServiceRegistry;
- private TransactionService transactionService;
- private ContentService contentService;
- private RenditionService2Impl renditionService2;
-
- private ExecutorService executorService;
-
- public void setLocalTransformServiceRegistry(LocalTransformServiceRegistry localTransformServiceRegistry)
- {
- this.localTransformServiceRegistry = localTransformServiceRegistry;
- }
-
- public void setTransactionService(TransactionService transactionService)
- {
- this.transactionService = transactionService;
- }
-
- public void setContentService(ContentService contentService)
- {
- this.contentService = contentService;
- }
-
- public void setRenditionService2(RenditionService2Impl renditionService2)
- {
- this.renditionService2 = renditionService2;
- }
-
- public void setExecutorService(ExecutorService executorService)
- {
- this.executorService = executorService;
- }
-
- @Override
- public void afterPropertiesSet() throws Exception
- {
- PropertyCheck.mandatory(this, "localTransformServiceRegistry", localTransformServiceRegistry);
- PropertyCheck.mandatory(this, "transactionService", transactionService);
- PropertyCheck.mandatory(this, "contentService", contentService);
- PropertyCheck.mandatory(this, "renditionService2", renditionService2);
- if (executorService == null)
- {
- executorService = Executors.newCachedThreadPool();
- }
- }
-
- @Override
- public void checkSupported(NodeRef sourceNodeRef, RenditionDefinition2 renditionDefinition, String sourceMimetype, long size, String contentUrl)
- {
- String targetMimetype = renditionDefinition.getTargetMimetype();
- String renditionName = renditionDefinition.getRenditionName();
-
- Map options = renditionDefinition.getTransformOptions();
- if (!localTransformServiceRegistry.isSupported(sourceMimetype, size, targetMimetype, options, renditionName))
- {
- String message = "Unsupported rendition " + renditionName + " from " + sourceMimetype + " size: " + size + " using local transforms";
- logger.debug(message);
- throw new UnsupportedOperationException(message);
- }
-
- if (logger.isDebugEnabled())
- {
- logger.debug("Rendition of " + renditionName + " from " + sourceMimetype + " will use local transforms");
- }
- }
-
- @Override
- public void transform(NodeRef sourceNodeRef, RenditionDefinition2 renditionDefinition, String user, int sourceContentHashCode)
- {
- executorService.submit(() ->
- {
- AuthenticationUtil.runAs((AuthenticationUtil.RunAsWork) () ->
- transactionService.getRetryingTransactionHelper().doInTransaction(() ->
- {
- try
- {
- String targetMimetype = renditionDefinition.getTargetMimetype();
- String renditionName = renditionDefinition.getRenditionName();
- Map options = renditionDefinition.getTransformOptions();
-
- ContentReader reader = contentService.getReader(sourceNodeRef, ContentModel.PROP_CONTENT);
- if (null == reader || !reader.exists())
- {
- throw new IllegalArgumentException("The supplied sourceNodeRef "+sourceNodeRef+" has no content.");
- }
-
- ContentWriter writer = contentService.getTempWriter();
- writer.setMimetype(targetMimetype);
- if (logger.isDebugEnabled())
- {
- logger.debug("Local transform requested for rendition of " + renditionDefinition.getRenditionName());
- }
- localTransformServiceRegistry.transform(reader, writer, options, renditionName, sourceNodeRef);
-
- InputStream inputStream = writer.getReader().getContentInputStream();
- if (logger.isDebugEnabled())
- {
- logger.debug("Local transform to be consumed for rendition of " + renditionDefinition.getRenditionName());
- }
- renditionService2.consume(sourceNodeRef, inputStream, renditionDefinition, sourceContentHashCode);
- if (logger.isDebugEnabled())
- {
- logger.debug("Local transform consumed for rendition of " + renditionDefinition.getRenditionName());
- }
- }
- catch (Exception e)
- {
- if (logger.isDebugEnabled())
- {
- String renditionName = renditionDefinition.getRenditionName();
- logger.error("Rendition of "+renditionName+" failed", e);
- }
- renditionService2.failure(sourceNodeRef, renditionDefinition, sourceContentHashCode);
- throw e;
- }
- return null;
- }), user);
- });
- }
-}
diff --git a/src/main/java/org/alfresco/repo/rendition2/RenditionDefinitionRegistry2Impl.java b/src/main/java/org/alfresco/repo/rendition2/RenditionDefinitionRegistry2Impl.java
index 5890440539..12e9f92f18 100644
--- a/src/main/java/org/alfresco/repo/rendition2/RenditionDefinitionRegistry2Impl.java
+++ b/src/main/java/org/alfresco/repo/rendition2/RenditionDefinitionRegistry2Impl.java
@@ -49,18 +49,16 @@ public class RenditionDefinitionRegistry2Impl implements RenditionDefinitionRegi
public void setTransformServiceRegistry(TransformServiceRegistry transformServiceRegistry)
{
this.transformServiceRegistry = transformServiceRegistry;
- renditionsFor.clear();
}
/**
* Obtains a {@link RenditionDefinition2} by name.
* @param renditionName to be returned
* @return the {@link RenditionDefinition2} or null if not registered.
- * @deprecated use {@link #getRenditionDefinition(String)}
*/
public RenditionDefinition2 getDefinition(String renditionName)
{
- return getRenditionDefinition(renditionName);
+ return renditionDefinitions.get(renditionName);
}
public void register(RenditionDefinition2 renditionDefinition)
diff --git a/src/main/java/org/alfresco/repo/rendition2/SwitchingTransformClient.java b/src/main/java/org/alfresco/repo/rendition2/SwitchingTransformClient.java
index 65038a476a..d1f66aba76 100644
--- a/src/main/java/org/alfresco/repo/rendition2/SwitchingTransformClient.java
+++ b/src/main/java/org/alfresco/repo/rendition2/SwitchingTransformClient.java
@@ -38,7 +38,7 @@ public class SwitchingTransformClient implements TransformClient
{
private final TransformClient primary;
private final TransformClient secondary;
- private ThreadLocal usePrimary = ThreadLocal.withInitial(()->Boolean.FALSE);
+ private ThreadLocal usePrimary = new ThreadLocal<>();
public SwitchingTransformClient(TransformClient primary, TransformClient secondary)
{
diff --git a/src/main/java/org/alfresco/repo/thumbnail/ThumbnailRegistry.java b/src/main/java/org/alfresco/repo/thumbnail/ThumbnailRegistry.java
index 1c712cf0ee..7e6f2a610f 100644
--- a/src/main/java/org/alfresco/repo/thumbnail/ThumbnailRegistry.java
+++ b/src/main/java/org/alfresco/repo/thumbnail/ThumbnailRegistry.java
@@ -166,7 +166,6 @@ public class ThumbnailRegistry implements ApplicationContextAware, ApplicationLi
public void setTransformServiceRegistry(TransformServiceRegistry transformServiceRegistry)
{
this.transformServiceRegistry = transformServiceRegistry;
- mimetypeMap.clear();
}
public void setRenditionDefinitionRegistry2(RenditionDefinitionRegistry2 renditionDefinitionRegistry2)
diff --git a/src/main/java/org/alfresco/transform/client/model/config/AbstractTransformOption.java b/src/main/java/org/alfresco/transform/client/model/config/ExtensionMap.java
similarity index 72%
rename from src/main/java/org/alfresco/transform/client/model/config/AbstractTransformOption.java
rename to src/main/java/org/alfresco/transform/client/model/config/ExtensionMap.java
index 5566128979..a8f91d0c00 100644
--- a/src/main/java/org/alfresco/transform/client/model/config/AbstractTransformOption.java
+++ b/src/main/java/org/alfresco/transform/client/model/config/ExtensionMap.java
@@ -2,7 +2,7 @@
* #%L
* Alfresco Repository
* %%
- * Copyright (C) 2005 - 2019 Alfresco Software Limited
+ * 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
@@ -26,21 +26,10 @@
package org.alfresco.transform.client.model.config;
/**
- * Abstract implementation of TransformOption.
+ * Helper class to be supplied by the client to map file extensions to mimetypes, so the json description of what
+ * is supported by the Transform Service includes file extensions rather than mmetypes, so is more readable.
*/
-public abstract class AbstractTransformOption implements TransformOption
+public interface ExtensionMap
{
- private boolean required;
-
- @Override
- public boolean isRequired()
- {
- return required;
- }
-
- @Override
- public void setRequired(boolean required)
- {
- this.required = required;
- }
+ String toMimetype(String extension);
}
diff --git a/src/main/java/org/alfresco/transform/client/model/config/JsonConverter.java b/src/main/java/org/alfresco/transform/client/model/config/JsonConverter.java
deleted file mode 100644
index 465b353971..0000000000
--- a/src/main/java/org/alfresco/transform/client/model/config/JsonConverter.java
+++ /dev/null
@@ -1,273 +0,0 @@
-/*
- * #%L
- * Alfresco Repository
- * %%
- * Copyright (C) 2019 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 .
- * #L%
- */
-package org.alfresco.transform.client.model.config;
-
-import com.fasterxml.jackson.core.type.TypeReference;
-import com.fasterxml.jackson.databind.JsonNode;
-import com.fasterxml.jackson.databind.ObjectMapper;
-import com.fasterxml.jackson.databind.node.ArrayNode;
-import com.fasterxml.jackson.databind.node.ObjectNode;
-import org.apache.commons.logging.Log;
-
-import java.io.File;
-import java.io.FileReader;
-import java.io.IOException;
-import java.io.InputStream;
-import java.io.InputStreamReader;
-import java.io.Reader;
-import java.net.URL;
-import java.util.ArrayList;
-import java.util.Arrays;
-import java.util.Collections;
-import java.util.Enumeration;
-import java.util.HashMap;
-import java.util.Iterator;
-import java.util.List;
-import java.util.Map;
-import java.util.jar.JarEntry;
-import java.util.jar.JarFile;
-
-/**
- * This class recreates the json format used in ACS 6.1 where we just had an array of transformers and each
- * transformer has a list of transform options. The idea of this code is that it replaces the references with the
- * actual transform options that have been separated out into their own section.
- *
- * The T-Router and T-Engines return the format with the transform option separated into their own section. Pipeline
- * definitions used by the LocalTransformServiceRegistry may use transform reference options defined in the json
- * returned by T-Engines. with the actual definitions from the transform options
- * reference section. It also combines multiple json sources into a single jsonNode structure that can be parsed as
- * before.
- */
-public class JsonConverter
-{
- public static final String NAME = "name";
- private final Log log;
-
- private static final String TRANSFORM_OPTIONS = "transformOptions";
- private static final String GROUP = "group";
- private static final String TRANSFORMERS = "transformers";
-
- private Map allTransformOptions = new HashMap<>();
- private List allTransforms = new ArrayList<>();
- private ObjectMapper jsonObjectMapper = new ObjectMapper();
-
- JsonConverter(Log log)
- {
- this.log = log;
- }
-
- void addJsonSource(String path) throws IOException
- {
- final File jarFile = new File(getClass().getProtectionDomain().getCodeSource().getLocation().getPath());
- if (jarFile.isFile())
- {
- JarFile jar = new JarFile(jarFile);
- Enumeration entries = jar.entries(); //gives ALL entries in jar
- String prefix = path + "/";
- List names = new ArrayList<>();
- while (entries.hasMoreElements())
- {
- final String name = entries.nextElement().getName();
- if (name.startsWith(prefix) && name.length() > prefix.length())
- {
- names.add(name);
- }
- }
- Collections.sort(names);
- for (String name : names)
- {
- log.debug("Reading resource "+name);
- addJsonSource(new InputStreamReader(getResourceAsStream(name)));
- }
-
- jar.close();
- }
- else
- {
- URL url = getClass().getClassLoader().getResource(path);
- if (url != null)
- {
- File root = new File(url.getPath());
- if (root.isDirectory())
- {
- File[] files = root.listFiles();
- Arrays.sort(files, (file1, file2) -> file1.getName().compareTo(file2.getName()));
- for (File file: files)
- {
- log.debug("Reading dir file "+file.getPath());
- addJsonSource(new FileReader(file));
- }
- }
- else
- {
- log.debug("Reading file "+root.getPath());
- addJsonSource(new FileReader(root));
- }
- }
- }
- }
-
- private InputStream getResourceAsStream(String resource)
- {
- final InputStream in = Thread.currentThread().getContextClassLoader().getResourceAsStream(resource);
- return in == null ? getClass().getResourceAsStream(resource) : in;
- }
-
- private void addJsonSource(Reader reader) throws IOException
- {
- JsonNode jsonNode = jsonObjectMapper.readValue(reader, new TypeReference() {});
-
- JsonNode transformOptions = jsonNode.get(TRANSFORM_OPTIONS);
- if (transformOptions != null && transformOptions.isObject())
- {
- Iterator> iterator = transformOptions.fields();
- while (iterator.hasNext())
- {
- Map.Entry entry = iterator.next();
-
- JsonNode options = entry.getValue();
- if (options.isArray())
- {
- String optionsName = entry.getKey();
- allTransformOptions.put(optionsName, (ArrayNode)options);
- }
- }
- }
-
- JsonNode transformers = jsonNode.get(TRANSFORMERS);
- if (transformers != null && transformers.isArray())
- {
- for (JsonNode transformer : transformers)
- {
- if (transformer.isObject())
- {
- allTransforms.add((ObjectNode)transformer);
- }
- }
- }
- }
-
- public List getTransformers() throws IOException
- {
- List transformers = new ArrayList<>();
-
- // After all json input has been loaded build the output with the options in place.
- ArrayNode transformersNode = jsonObjectMapper.createArrayNode();
- for (ObjectNode transform : allTransforms)
- {
- try
- {
- ArrayNode transformOptions = (ArrayNode) transform.get(TRANSFORM_OPTIONS);
- if (transformOptions != null)
- {
-
- ArrayNode options;
- int size = transformOptions.size();
- if (size == 1)
- {
- // If there is a single transform option reference, we can just use it.
- int i = 0;
- options = getTransformOptions(transformOptions, i, transform);
- }
- else
- {
- // If there are many transform option references (typically in a pipeline), then each element
- // has a group for each set of transform options.
- options = jsonObjectMapper.createArrayNode();
- for (int i = size - 1; i >= 0; i--)
- {
- JsonNode referencedTransformOptions = getTransformOptions(transformOptions, i, transform);
- if (referencedTransformOptions != null)
- {
- ObjectNode element = jsonObjectMapper.createObjectNode();
- options.add(element);
-
- ObjectNode group = jsonObjectMapper.createObjectNode();
- group.set(TRANSFORM_OPTIONS, referencedTransformOptions);
- element.set(GROUP, group);
- }
- }
- }
- if (options == null || options.size() == 0)
- {
- transform.remove(TRANSFORM_OPTIONS);
- }
- else
- {
- transform.set(TRANSFORM_OPTIONS, options);
- }
- }
-
- try
- {
- Transformer transformer = jsonObjectMapper.convertValue(transform, Transformer.class);
- transformers.add(transformer);
- }
- catch (IllegalArgumentException e)
- {
- log.error("Invalid transformer "+getTransformName(transform)+" "+e.getMessage());
- }
- transformersNode.add(transform);
- }
- catch (IllegalArgumentException e)
- {
- String transformString = jsonObjectMapper.writerWithDefaultPrettyPrinter().writeValueAsString(transform);
- log.error(e.getMessage()+"\n"+ transformString);
- }
- }
-
- return transformers;
- }
-
- private ArrayNode getTransformOptions(ArrayNode transformOptions, int i, ObjectNode transform)
- {
- ArrayNode options = null;
- JsonNode optionName = transformOptions.get(i);
- if (optionName.isTextual())
- {
- String name = optionName.asText();
- options = allTransformOptions.get(name);
- if (options == null)
- {
- String message = "Reference to \"transformOptions\": \"" + name + "\" not found. Transformer " +
- getTransformName(transform) + " ignored.";
- throw new IllegalArgumentException(message);
- }
- }
- return options;
- }
-
- private String getTransformName(ObjectNode transform)
- {
- String name = "Unknown";
- JsonNode nameNode = transform.get(NAME);
- if (nameNode.isTextual())
- {
- name = '"'+nameNode.asText()+'"';
- }
- return name;
- }
-}
diff --git a/src/main/java/org/alfresco/transform/client/model/config/SupportedSourceAndTarget.java b/src/main/java/org/alfresco/transform/client/model/config/SupportedSourceAndTarget.java
index 2f9860bea9..e27c29124d 100644
--- a/src/main/java/org/alfresco/transform/client/model/config/SupportedSourceAndTarget.java
+++ b/src/main/java/org/alfresco/transform/client/model/config/SupportedSourceAndTarget.java
@@ -2,7 +2,7 @@
* #%L
* Alfresco Repository
* %%
- * Copyright (C) 2005 - 2019 Alfresco Software Limited
+ * 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
@@ -31,36 +31,29 @@ package org.alfresco.transform.client.model.config;
*/
public class SupportedSourceAndTarget
{
- private String sourceMediaType;
+ private String sourceExt;
private long maxSourceSizeBytes = -1;
- private String targetMediaType;
- private int priority = 50;
+ private String targetExt;
public SupportedSourceAndTarget()
{
}
- public SupportedSourceAndTarget(String sourceMediaType, String targetMediaType, long maxSourceSizeBytes)
+ public SupportedSourceAndTarget(String sourceExt, String targetExt, long maxSourceSizeBytes)
{
- this(sourceMediaType, targetMediaType, maxSourceSizeBytes, 50);
- }
-
- public SupportedSourceAndTarget(String sourceMediaType, String targetMediaType, long maxSourceSizeBytes, int priority)
- {
- setSourceMediaType(sourceMediaType);
+ setSourceExt(sourceExt);
setMaxSourceSizeBytes(maxSourceSizeBytes);
- setTargetMediaType(targetMediaType);
- setPriority(priority);
+ setTargetExt(targetExt);
}
- public String getSourceMediaType()
+ public String getSourceExt()
{
- return sourceMediaType;
+ return sourceExt;
}
- public void setSourceMediaType(String sourceMediaType)
+ public void setSourceExt(String sourceExt)
{
- this.sourceMediaType = sourceMediaType;
+ this.sourceExt = sourceExt;
}
public long getMaxSourceSizeBytes()
@@ -73,23 +66,13 @@ public class SupportedSourceAndTarget
this.maxSourceSizeBytes = maxSourceSizeBytes;
}
- public String getTargetMediaType()
+ public String getTargetExt()
{
- return targetMediaType;
+ return targetExt;
}
- public void setTargetMediaType(String targetMediaType)
+ public void setTargetExt(String targetExt)
{
- this.targetMediaType = targetMediaType;
- }
-
- public int getPriority()
- {
- return priority;
- }
-
- public void setPriority(int priority)
- {
- this.priority = priority;
+ this.targetExt = targetExt;
}
}
diff --git a/src/test/java/org/alfresco/transform/client/model/config/TransformBuilder.java b/src/main/java/org/alfresco/transform/client/model/config/TransformBuilder.java
similarity index 67%
rename from src/test/java/org/alfresco/transform/client/model/config/TransformBuilder.java
rename to src/main/java/org/alfresco/transform/client/model/config/TransformBuilder.java
index a9d9316df9..024620fd88 100644
--- a/src/test/java/org/alfresco/transform/client/model/config/TransformBuilder.java
+++ b/src/main/java/org/alfresco/transform/client/model/config/TransformBuilder.java
@@ -29,12 +29,12 @@ import java.util.ArrayList;
import java.util.List;
/**
- * Helper class that builds a {@link Transformer} given the source and target types and a pipeline of Transformers
- * for creating intermediary content.
+ * Helper class that builds a {@link Transformer} given the source and target extensions and a pipeline of Transformers
+ * for creating intermediary content, or a set of failover transformers.
*/
public class TransformBuilder
{
- public Transformer buildPipeLine(String name, List sourceAndTargetList,
+ public Transformer buildPipeLine(String name, String version, List sourceAndTargetList,
List transformerList)
{
List options = new ArrayList<>(transformerList.size());
@@ -47,6 +47,13 @@ public class TransformBuilder
options.add(new TransformOptionGroup(t.isRequired(), t.getTransformer().getTransformOptions()));
}
});
- return new Transformer(name, options, sourceAndTargetList);
+ return new Transformer(name, version, options, sourceAndTargetList);
}
+
+ // TODO Commented out for now as it is unclear what the Transform service will support in terms of failover transformations.
+ // Note: The use of a list of Transformers rather than ChildTransformers, as the supplied actual options would have
+ // to match one or more of the transformer's options. Matching one or more options is not currently
+ // implemented by the TransformServiceRegistry
+ // public Transformer buildFailover(String name, String version, List sourceAndTargetList,
+ // List transformerList)
}
diff --git a/src/main/java/org/alfresco/transform/client/model/config/TransformOption.java b/src/main/java/org/alfresco/transform/client/model/config/TransformOption.java
index dc73be1551..85dba88f06 100644
--- a/src/main/java/org/alfresco/transform/client/model/config/TransformOption.java
+++ b/src/main/java/org/alfresco/transform/client/model/config/TransformOption.java
@@ -2,7 +2,7 @@
* #%L
* Alfresco Repository
* %%
- * Copyright (C) 2005 - 2019 Alfresco Software Limited
+ * 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
diff --git a/src/main/java/org/alfresco/transform/client/model/config/TransformOptionGroup.java b/src/main/java/org/alfresco/transform/client/model/config/TransformOptionGroup.java
index a0ad82c951..83919c3ec0 100644
--- a/src/main/java/org/alfresco/transform/client/model/config/TransformOptionGroup.java
+++ b/src/main/java/org/alfresco/transform/client/model/config/TransformOptionGroup.java
@@ -30,12 +30,11 @@ import java.util.List;
/**
* Represents a group of one or more options. If the group is optional, child options that are marked as required are
* only required if any child in the group is supplied by the client. If the group is required, child options are
- * optional or required based on their own setting alone.
- *
- * In a pipeline transformation, a group of options
+ * optional or required based on their own setting alone. The top
*/
-public class TransformOptionGroup extends AbstractTransformOption
+public class TransformOptionGroup implements TransformOption
{
+ private boolean required;
List transformOptions;
public TransformOptionGroup()
@@ -48,6 +47,18 @@ public class TransformOptionGroup extends AbstractTransformOption
setTransformOptions(transformOptions);
}
+ @Override
+ public boolean isRequired()
+ {
+ return required;
+ }
+
+ @Override
+ public void setRequired(boolean required)
+ {
+ this.required = required;
+ }
+
public List getTransformOptions()
{
return transformOptions;
diff --git a/src/main/java/org/alfresco/transform/client/model/config/TransformOptionValue.java b/src/main/java/org/alfresco/transform/client/model/config/TransformOptionValue.java
index 6962162175..6f40377109 100644
--- a/src/main/java/org/alfresco/transform/client/model/config/TransformOptionValue.java
+++ b/src/main/java/org/alfresco/transform/client/model/config/TransformOptionValue.java
@@ -28,8 +28,9 @@ package org.alfresco.transform.client.model.config;
/**
* Represents a single transformation option.
*/
-public class TransformOptionValue extends AbstractTransformOption
+public class TransformOptionValue implements TransformOption
{
+ private boolean required;
private String name;
public TransformOptionValue()
@@ -42,6 +43,18 @@ public class TransformOptionValue extends AbstractTransformOption
setName(name);
}
+ @Override
+ public boolean isRequired()
+ {
+ return required;
+ }
+
+ @Override
+ public void setRequired(boolean required)
+ {
+ this.required = required;
+ }
+
public String getName()
{
return name;
diff --git a/src/main/java/org/alfresco/transform/client/model/config/TransformServiceRegistryImpl.java b/src/main/java/org/alfresco/transform/client/model/config/TransformServiceRegistryImpl.java
index 8584394cd1..b76f548fe0 100644
--- a/src/main/java/org/alfresco/transform/client/model/config/TransformServiceRegistryImpl.java
+++ b/src/main/java/org/alfresco/transform/client/model/config/TransformServiceRegistryImpl.java
@@ -27,7 +27,6 @@ package org.alfresco.transform.client.model.config;
import com.fasterxml.jackson.core.type.TypeReference;
import com.fasterxml.jackson.databind.ObjectMapper;
-import org.apache.commons.logging.Log;
import org.springframework.beans.factory.InitializingBean;
import java.io.IOException;
@@ -45,36 +44,38 @@ import static org.alfresco.repo.rendition2.RenditionDefinition2.TIMEOUT;
/**
* Used by clients to work out if a transformation is supported by the Transform Service.
*/
-public abstract class TransformServiceRegistryImpl implements TransformServiceRegistry, InitializingBean
+public class TransformServiceRegistryImpl implements TransformServiceRegistry, InitializingBean
{
class SupportedTransform
{
TransformOptionGroup transformOptions;
- long maxSourceSizeBytes;
- private String name;
- private int priority;
+ private long maxSourceSizeBytes;
- public SupportedTransform(String name, List transformOptions, long maxSourceSizeBytes, int priority)
+ public SupportedTransform(List transformOptions, long maxSourceSizeBytes)
{
// Logically the top level TransformOptionGroup is required, so that child options are optional or required
// based on their own setting.
this.transformOptions = new TransformOptionGroup(true, transformOptions);
this.maxSourceSizeBytes = maxSourceSizeBytes;
- this.name = name;
- this.priority = priority;
}
}
private ObjectMapper jsonObjectMapper;
+ private ExtensionMap extensionMap;
ConcurrentMap>> transformers = new ConcurrentHashMap<>();
- ConcurrentMap>> cachedSupportedTransformList = new ConcurrentHashMap<>();
+ ConcurrentMap> cachedMaxSizes = new ConcurrentHashMap<>();
public void setJsonObjectMapper(ObjectMapper jsonObjectMapper)
{
this.jsonObjectMapper = jsonObjectMapper;
}
+ public void setExtensionMap(ExtensionMap extensionMap)
+ {
+ this.extensionMap = extensionMap;
+ }
+
@Override
public void afterPropertiesSet() throws Exception
{
@@ -82,21 +83,30 @@ public abstract class TransformServiceRegistryImpl implements TransformServiceRe
{
throw new IllegalStateException("jsonObjectMapper has not been set");
}
- cachedSupportedTransformList.clear();
- transformers.clear();
+ if (extensionMap == null)
+ {
+ throw new IllegalStateException("extensionMap has not been set");
+ }
}
- protected abstract Log getLog();
-
- public void register(String path) throws IOException
+ private String toMimetype(String ext)
{
- JsonConverter jsonConverter = new JsonConverter(getLog());
- jsonConverter.addJsonSource(path);
- List transformers = jsonConverter.getTransformers();
- for (Transformer transformer : transformers)
+ String mimetype = extensionMap.toMimetype(ext);
+ if (mimetype == null)
{
- register(transformer);
+ throw new IllegalArgumentException("The mimetype for the file extension "+ext+" cannot be looked up by: "+
+ extensionMap.getClass().getName());
}
+ return mimetype;
+ }
+
+ public void register(Transformer transformer)
+ {
+ transformer.getSupportedSourceAndTargetList().forEach(
+ e -> transformers.computeIfAbsent(toMimetype(e.getSourceExt()),
+ k -> new ConcurrentHashMap<>()).computeIfAbsent(toMimetype(e.getTargetExt()),
+ k -> new ArrayList<>()).add(
+ new SupportedTransform(transformer.getTransformOptions(), e.getMaxSourceSizeBytes())));
}
public void register(Reader reader) throws IOException
@@ -105,78 +115,31 @@ public abstract class TransformServiceRegistryImpl implements TransformServiceRe
transformers.forEach(t -> register(t));
}
- public void register(Transformer transformer)
- {
- transformer.getSupportedSourceAndTargetList().forEach(
- e -> transformers.computeIfAbsent(e.getSourceMediaType(),
- k -> new ConcurrentHashMap<>()).computeIfAbsent(e.getTargetMediaType(),
- k -> new ArrayList<>()).add(
- new SupportedTransform(transformer.getTransformerName(),
- transformer.getTransformOptions(), e.getMaxSourceSizeBytes(), e.getPriority())));
- }
-
@Override
public boolean isSupported(String sourceMimetype, long sourceSizeInBytes, String targetMimetype,
- Map actualOptions, String renditionName)
+ Map actualOptions, String transformName)
{
- long maxSize = getMaxSize(sourceMimetype, targetMimetype, actualOptions, renditionName);
+ long maxSize = getMaxSize(sourceMimetype, targetMimetype, actualOptions, transformName);
return maxSize != 0 && (maxSize == -1L || maxSize >= sourceSizeInBytes);
}
- /**
- * Works out the name of the transformer (might not map to an actual transformer) that will be used to transform
- * content of a given source mimetype and size into a target mimetype given a list of actual transform option names
- * and values (Strings) plus the data contained in the {@Transform} objects registered with this class.
- * @param sourceMimetype the mimetype of the source content
- * @param sourceSizeInBytes the size in bytes of the source content. Ignored if negative.
- * @param targetMimetype the mimetype of the target
- * @param actualOptions the actual name value pairs available that could be passed to the Transform Service.
- * @param renditionName (optional) name for the set of options and target mimetype. If supplied is used to cache
- * results to avoid having to work out if a given transformation is supported a second time.
- * The sourceMimetype and sourceSizeInBytes may still change. In the case of ACS this is the
- * rendition name.
- */
- protected String getTransformerName(String sourceMimetype, long sourceSizeInBytes, String targetMimetype, Map actualOptions, String renditionName)
- {
- List supportedTransforms = getTransformListBySize(sourceMimetype, targetMimetype, actualOptions, renditionName);
- for (SupportedTransform supportedTransform : supportedTransforms)
- {
- if (supportedTransform.maxSourceSizeBytes == -1 || supportedTransform.maxSourceSizeBytes >= sourceSizeInBytes)
- {
- return supportedTransform.name;
- }
- }
-
- return null;
- }
-
@Override
public long getMaxSize(String sourceMimetype, String targetMimetype,
- Map actualOptions, String renditionName)
- {
- List supportedTransforms = getTransformListBySize(sourceMimetype, targetMimetype, actualOptions, renditionName);
- return supportedTransforms.isEmpty() ? 0 : supportedTransforms.get(supportedTransforms.size()-1).maxSourceSizeBytes;
- }
-
- // Returns transformers in increasing supported size order, where lower priority transformers for the same size have
- // been discarded.
- private List getTransformListBySize(String sourceMimetype, String targetMimetype,
- Map actualOptions, String renditionName)
+ Map actualOptions, String transformName)
{
if (actualOptions == null)
{
actualOptions = Collections.EMPTY_MAP;
}
- if (renditionName != null && renditionName.trim().isEmpty())
+ if (transformName != null && transformName.trim().isEmpty())
{
- renditionName = null;
+ transformName = null;
}
- List transformListBySize = renditionName == null ? null
- : cachedSupportedTransformList.computeIfAbsent(renditionName, k -> new ConcurrentHashMap<>()).get(sourceMimetype);
- if (transformListBySize != null)
+ Long maxSize = transformName == null ? null : cachedMaxSizes.computeIfAbsent(transformName, k -> new ConcurrentHashMap<>()).get(sourceMimetype);
+ if (maxSize != null)
{
- return transformListBySize;
+ return maxSize.longValue();
}
// Remove the "timeout" property from the actualOptions as it is not used to select a transformer.
@@ -186,7 +149,7 @@ public abstract class TransformServiceRegistryImpl implements TransformServiceRe
actualOptions.remove(TIMEOUT);
}
- transformListBySize = new ArrayList<>();
+ long calculatedMaxSize = 0;
ConcurrentMap> targetMap = transformers.get(sourceMimetype);
if (targetMap != null)
{
@@ -200,66 +163,24 @@ public abstract class TransformServiceRegistryImpl implements TransformServiceRe
addToPossibleTransformOptions(possibleTransformOptions, transformOptions, true, actualOptions);
if (isSupported(possibleTransformOptions, actualOptions))
{
- addToSupportedTransformList(transformListBySize, supportedTransform);
+ if (supportedTransform.maxSourceSizeBytes < 0)
+ {
+ calculatedMaxSize = -1;
+ break;
+ }
+
+ calculatedMaxSize = Math.max(calculatedMaxSize, supportedTransform.maxSourceSizeBytes);
}
}
}
}
- if (renditionName != null)
+ if (transformName != null)
{
- cachedSupportedTransformList.get(renditionName).put(sourceMimetype, transformListBySize);
+ cachedMaxSizes.get(transformName).put(sourceMimetype, calculatedMaxSize);
}
- return transformListBySize;
- }
-
- // Add newTransform to the transformListBySize in increasing size order and discards lower priority (numerically
- // higher) transforms with a smaller or equal size.
- private void addToSupportedTransformList(List transformListBySize, SupportedTransform newTransform)
- {
- for (int i=0; i < transformListBySize.size(); i++)
- {
- SupportedTransform existingTransform = transformListBySize.get(i);
- int added = -1;
- int compare = compare(newTransform.maxSourceSizeBytes, existingTransform.maxSourceSizeBytes);
- if (compare < 0)
- {
- transformListBySize.add(i, newTransform);
- added = i;
- }
- else if (compare == 0)
- {
- if (newTransform.priority < existingTransform.priority)
- {
- transformListBySize.set(i, newTransform);
- added = i;
- }
- }
- if (added == i)
- {
- for (i--; i >= 0; i--)
- {
- existingTransform = transformListBySize.get(i);
- if (newTransform.priority <= existingTransform.priority)
- {
- transformListBySize.remove(i);
- }
- }
- return;
- }
- }
- transformListBySize.add(newTransform);
- }
-
- // compare where -1 is unlimited.
- private int compare(long a, long b)
- {
- return a == -1
- ? b == -1 ? 0 : 1
- : b == -1 ? -1
- : a == b ? 0
- : a > b ? 1 : -1;
+ return calculatedMaxSize;
}
/**
diff --git a/src/main/java/org/alfresco/transform/client/model/config/TransformStep.java b/src/main/java/org/alfresco/transform/client/model/config/TransformStep.java
deleted file mode 100644
index cd2a543174..0000000000
--- a/src/main/java/org/alfresco/transform/client/model/config/TransformStep.java
+++ /dev/null
@@ -1,66 +0,0 @@
-/*
- * #%L
- * Alfresco Repository
- * %%
- * Copyright (C) 2019 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 .
- * #L%
- */
-package org.alfresco.transform.client.model.config;
-
-/**
- * Represents a single transform step in a transform pipeline. The last step in the pipeline does not specify the
- * target type as that is based on the supported types and what has been requested.
- */
-public class TransformStep
-{
- private String transformerName;
- private String targetMediaType;
-
- public TransformStep()
- {
- }
-
- public TransformStep(String transformerName, String targetMediaType)
- {
- setTransformerName(transformerName);
- setTargetMediaType(targetMediaType);
- }
-
- public String getTransformerName()
- {
- return transformerName;
- }
-
- public void setTransformerName(String transformerName)
- {
- this.transformerName = transformerName;
- }
-
- public String getTargetMediaType()
- {
- return targetMediaType;
- }
-
- public void setTargetMediaType(String targetMediaType)
- {
- this.targetMediaType = targetMediaType;
- }
-}
diff --git a/src/main/java/org/alfresco/transform/client/model/config/Transformer.java b/src/main/java/org/alfresco/transform/client/model/config/Transformer.java
index f707d1cc95..3f18a8bf8f 100644
--- a/src/main/java/org/alfresco/transform/client/model/config/Transformer.java
+++ b/src/main/java/org/alfresco/transform/client/model/config/Transformer.java
@@ -2,7 +2,7 @@
* #%L
* Alfresco Repository
* %%
- * Copyright (C) 2005 - 2019 Alfresco Software Limited
+ * 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
@@ -26,34 +26,28 @@
package org.alfresco.transform.client.model.config;
import java.util.List;
-import org.alfresco.transform.client.model.config.TransformServiceRegistry;
+import java.util.Objects;
/**
- * Represents a set of transformations supported by the Transform Service or Local Transform Service Registry that
- * share the same transform options. Each may be an actual transformer or a pipeline of multiple transformers. It is
- * possible that more than one transformer may able to perform a transformation from one mimetype to another. The actual
- * selection of transformer is up to the Transform Service or Local Transform Service Registry to decide. Clients may
- * use {@link TransformServiceRegistry#isSupported(String, long, String, java.util.Map, String)} to decide
+ * Represents a set of transformations supported by the Transform Service that share the same transform options. Each
+ * may be an actual transformer or the amalgamation of multiple transformers. It is possible that more than one
+ * transformer may able to perform a transformation from one mimetype to another. The actual selection of transformer
+ * is up to the Transform Service to decide. Clients may use {@link TransformServiceRegistry#isSupported} to decide
* if they should send a request to the Transform Service. As a result clients have a simple generic view of
- * transformations which allows new transformations to be added without the need to change client data structures other
+ * transformations which allows new transformations to be added without the need change client data structures other
* than to define new name value pairs. For this to work the Transform Service defines unique names for each option.
*
- * - transformerName - is optional but if supplied should be unique. The client should infer nothing from the name
- * as it is simply a label, but the Local Transform Service Registry will use the name in pipelines.
+ * - name - is unique. The client should infer nothing from the name as it is simply a label.
+ * - version - of the transformer. The client should infer nothing from the value and should only use it
+ * in messages. There should only be one version supplied to the client for each name.
* - transformOptions - a grouping of individual transformer transformOptions. The group may be optional and may
* contain nested transformOptions.
*
- * For local transforms, this structure is extended when defining a pipeline transform.
- *
- * - transformerPipeline - an array of pairs of transformer name and target extension for each transformer in the
- * pipeline. The last one should not have an extension as that is defined by the request and should be in the
- * supported list.
- *
*/
public class Transformer
{
- private String transformerName;
- private List transformerPipeline;
+ private String name;
+ private String version;
private List transformOptions;
private List supportedSourceAndTargetList;
@@ -61,37 +55,32 @@ public class Transformer
{
}
- public Transformer(String transformerName, List transformOptions, List supportedSourceAndTargetList)
+ public Transformer(String name, String version, List transformOptions, List supportedSourceAndTargetList)
{
- setTransformerName(transformerName);
+ setName(name);
+ setVersion(version);
setTransformOptions(transformOptions);
setSupportedSourceAndTargetList(supportedSourceAndTargetList);
}
- public Transformer(String transformerName, List transformerPipeline, List transformOptions, List supportedSourceAndTargetList)
+ public String getName()
{
- this(transformerName, transformOptions, supportedSourceAndTargetList);
- setTransformerPipeline(transformerPipeline);
+ return name;
}
- public String getTransformerName()
+ public void setName(String name)
{
- return transformerName;
+ this.name = name;
}
- public void setTransformerName(String transformerName)
+ public String getVersion()
{
- this.transformerName = transformerName;
+ return version;
}
- public List getTransformerPipeline()
+ public void setVersion(String version)
{
- return transformerPipeline;
- }
-
- public void setTransformerPipeline(List transformerPipeline)
- {
- this.transformerPipeline = transformerPipeline;
+ this.version = version;
}
public List getTransformOptions()
diff --git a/src/main/resources/alfresco/content-services-context.xml b/src/main/resources/alfresco/content-services-context.xml
index 086fe5e1d1..0be62cb8e1 100644
--- a/src/main/resources/alfresco/content-services-context.xml
+++ b/src/main/resources/alfresco/content-services-context.xml
@@ -328,18 +328,33 @@