org.alfresco.repo.rendition2

Interface TransformClient

All Known Implementing Classes:

LocalTransformClient

public interface TransformClient

Request rendition transforms.

Author:

adavis

Method Summary

Modifier and Type	Method and Description
Object	checkSupported(org.alfresco.service.cmr.repository.NodeRef sourceNodeRef, RenditionDefinition2 renditionDefinition) Checks the transformation required for the rendition is supported.
void	transform(org.alfresco.service.cmr.repository.NodeRef sourceNodeRef, RenditionDefinition2 renditionDefinition, Object transformInfo, String user, int sourceContentUrlHashCode) Requests an asynchronous transform and the subsequent linkage of that transform as a rendition.

Method Detail

checkSupported

Object checkSupported(org.alfresco.service.cmr.repository.NodeRef sourceNodeRef,
                      RenditionDefinition2 renditionDefinition)

Checks the transformation required for the rendition is supported.

Parameters:

sourceNodeRef - the source node

renditionDefinition - which rendition to perform

Returns:

and object that contains information that will be passed to transform(NodeRef, RenditionDefinition2, Object, String, int) as the transformInfo parameter to avoid having to work it out again.

Throws:

UnsupportedOperationException - if the transform is not supported.

transform

void transform(org.alfresco.service.cmr.repository.NodeRef sourceNodeRef,
               RenditionDefinition2 renditionDefinition,
               Object transformInfo,
               String user,
               int sourceContentUrlHashCode)

Requests an asynchronous transform and the subsequent linkage of that transform as a rendition.

Parameters:

sourceNodeRef - the source node

renditionDefinition - which rendition to perform

transformInfo - the object returned by checkSupported(NodeRef, RenditionDefinition2).

user - that requested the transform.

sourceContentUrlHashCode - the hash code of the source node's content URL. Used to check the transform result still matches the source node, before it is used as a rendition.