org.apache.sling.cms.transformer

Interface FileThumbnailTransformer

All Known Implementing Classes:

FileThumbnailTransformerImpl

public interface FileThumbnailTransformer

Transforms a Sling File into thumbnails using the registered TransformationHandlers to invoke Thumbnails transformations on the file.

Method Summary

Modifier and Type	Method and Description
TransformationHandler	getTransformationHandler(java.lang.String command) Gets the transformation handler for the specified command
void	transformFile(org.apache.sling.cms.File file, java.lang.String[] commands, OutputFileFormat format, java.io.OutputStream out) Transforms the file into a thumbnail using the specified commands.
void	transformFile(org.apache.sling.api.SlingHttpServletRequest request, java.io.OutputStream out) Transforms the file from the resource path into a thumbnail using the specified commands from the suffix.

Method Detail

getTransformationHandler

TransformationHandler getTransformationHandler(java.lang.String command)

Gets the transformation handler for the specified command

Parameters:

command - the command string to use to look up the transformation handler.

Returns:

the TransformationHandler from the command string or null if none found

transformFile

void transformFile(org.apache.sling.cms.File file,
                   java.lang.String[] commands,
                   OutputFileFormat format,
                   java.io.OutputStream out)
            throws java.io.IOException

Transforms the file into a thumbnail using the specified commands.

Parameters:

commands - the commands to execute

format - the format of the file to return

out - the Outputstream to write the thumbnail to

Throws:

java.io.IOException - an exception occurs transforming the file

transformFile

void transformFile(org.apache.sling.api.SlingHttpServletRequest request,
                   java.io.OutputStream out)
            throws java.io.IOException

Transforms the file from the resource path into a thumbnail using the specified commands from the suffix.

Parameters:

request - the request to parse the file and commands from

out - the Outputstream to write the thumbnail to

Throws:

java.io.IOException - an exception occurs transforming the file