Package org.alfresco.repo.rendition2

Class TransformDefinition

java.lang.Object

org.alfresco.repo.rendition2.RenditionDefinition2Impl

org.alfresco.repo.rendition2.TransformDefinition

All Implemented Interfaces:

RenditionDefinition2

public class TransformDefinition
extends RenditionDefinition2Impl

A TransformDefinition is a transient RenditionDefinition2 that provides a target mimetype and transform options just like a RenditionDefinition2. However one should be created for each transform request, so that additional client supplied data can be included and returned in the response to the client. It also identifies the reply queue to be used.

When it is known that the same target mimetype and transform options are being supplied many times a transform name should be supplied so that the transform registry is able to use the name as a key into a cache used to work out if the transform is possible. The transform name is prefixed TRANSFORM_NAMESPACE to avoid clashes with rendition names.

Author:

adavis

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	TRANSFORM_NAMESPACE

Fields inherited from interface org.alfresco.repo.rendition2.RenditionDefinition2

ALLOW_ENLARGEMENT, ALLOW_PDF_ENLARGEMENT, ALPHA_REMOVE, AUTO_ORIENT, CROP_GRAVITY, CROP_HEIGHT, CROP_PERCENTAGE, CROP_WIDTH, CROP_X_OFFSET, CROP_Y_OFFSET, DURATION, END_PAGE, FLASH_VERSION, HEIGHT, INCLUDE_CONTENTS, MAINTAIN_ASPECT_RATIO, MAINTAIN_PDF_ASPECT_RATIO, MAX_SOURCE_SIZE_K_BYTES, OFFSET, PAGE, RESIZE_HEIGHT, RESIZE_PERCENTAGE, RESIZE_WIDTH, SOURCE_ENCODING, SOURCE_NODE_REF, START_PAGE, TARGET_ENCODING, THUMBNAIL, TIMEOUT, WIDTH

Constructor Summary

Constructors

Constructor	Description
TransformDefinition(java.lang.String transformName, java.lang.String targetMimetype, java.util.Map<java.lang.String,java.lang.String> transformOptions, java.lang.String clientData, java.lang.String replyQueue, java.lang.String requestId)	Constructor where the same targetMimetype and transformOptions are used in multiple calls.
TransformDefinition(java.lang.String targetMimetype, java.util.Map<java.lang.String,java.lang.String> transformOptions, java.lang.String clientData, java.lang.String replyQueue, java.lang.String requestId)	Constructor where the targetMimetype and transformOptions are unlikely to be repeated.

Method Summary

Modifier and Type	Method	Description
java.lang.String	getClientData()
java.lang.String	getErrorMessage()
java.lang.String	getReplyQueue()
java.lang.String	getRequestId()
java.lang.String	getTransformName()
static java.lang.String	getTransformName(java.lang.String renditionName)
void	setErrorMessage(java.lang.String errorMessage)

Methods inherited from class org.alfresco.repo.rendition2.RenditionDefinition2Impl

equals, getRenditionName, getTargetMimetype, getTransformOptions, hashCode, isDynamicallyLoaded

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

TRANSFORM_NAMESPACE

public static final java.lang.String TRANSFORM_NAMESPACE

See Also:

Constant Field Values

Constructor Detail

TransformDefinition

public TransformDefinition(java.lang.String transformName,
                           java.lang.String targetMimetype,
                           java.util.Map<java.lang.String,java.lang.String> transformOptions,
                           java.lang.String clientData,
                           java.lang.String replyQueue,
                           java.lang.String requestId)

Constructor where the same targetMimetype and transformOptions are used in multiple calls. In such a case, how or if the transform will take place, will be cached against the transformName.

TransformDefinition

public TransformDefinition(java.lang.String targetMimetype,
                           java.util.Map<java.lang.String,java.lang.String> transformOptions,
                           java.lang.String clientData,
                           java.lang.String replyQueue,
                           java.lang.String requestId)

Constructor where the targetMimetype and transformOptions are unlikely to be repeated.

Method Detail

getTransformName

public java.lang.String getTransformName()

getTransformName

public static java.lang.String getTransformName(java.lang.String renditionName)

getClientData

public java.lang.String getClientData()

getReplyQueue

public java.lang.String getReplyQueue()

getRequestId

public java.lang.String getRequestId()

getErrorMessage

public java.lang.String getErrorMessage()

setErrorMessage

public void setErrorMessage(java.lang.String errorMessage)