Package org.alfresco.repo.content.transform

Interface LocalTransform

All Known Implementing Classes:

AbstractLocalTransform, LocalFailoverTransform, LocalPassThroughTransform, LocalPipelineTransform, LocalTransformImpl

public interface LocalTransform

Interface of a local transformer using flat transform options.

Method Summary

Modifier and Type	Method	Description
String	getName()
void	transform(ContentReader reader, ContentWriter writer, Map<String,String> transformOptions, String renditionName, NodeRef sourceNodeRef)	Requests a synchronous transform.

Method Details

transform

void transform(ContentReader reader,
 ContentWriter writer,
 Map<String,String> transformOptions,
 String renditionName,
 NodeRef sourceNodeRef)
        throws UnsupportedTransformationException,
ContentIOException

Requests a synchronous transform.

Parameters:

reader - of the source content

writer - to the target node's content

transformOptions - the actual name value pairs available that could be passed to the Transform Service.

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.

sourceNodeRef - the source node

Throws:

UnsupportedTransformationException - if there is an unexpected failure to transform, normally in a pipeline, where an intermediate transform may not be performed after all because an intermediate converion is too big.

ContentIOException - there is an unexpected communication or transformation failure.

getName

String getName()

Returns:

the name of the transform.