com.tsgrp.opencontent.transformation

Class ImageMagickTransformer

java.lang.Object

com.tsgrp.opencontent.core.transformation.AbstractTransformer

com.tsgrp.opencontent.transformation.ImageMagickTransformer

All Implemented Interfaces:

Transformer

public class ImageMagickTransformer
extends AbstractTransformer

A transformation implementation using ImageMagick as the transformation engine.

Constructor Summary

Constructors

Constructor and Description
ImageMagickTransformer()

Method Summary

Modifier and Type	Method and Description
void	setImageMagickDebugMode(boolean imageMagickDebugMode)
void	setImageMagickPath(java.lang.String imageMagickPath)
void	setImageMagickTransformationTimeout(java.lang.String imageMagickTransformationTimeout)
boolean	supportsAsynchronous() Returns true if the transformer is capible of performing its transformations in an aysnchronous manner, false if the transformer is synchronous.
java.lang.String	transformAsync(java.lang.String ticket, java.io.InputStream content, java.lang.String sourceMimetype, java.lang.String targetMimetype, TransformationOptions options) Transform the content of the byte[] passed in with the sourceMimeType into the targetMimeType.
void	transformSync(java.lang.String ticket, java.io.InputStream content, java.io.OutputStream output, java.lang.String sourceMimetype, java.lang.String targetMimetype, TransformationOptions options) Transforms the given byte[] of content (with the given 'sourceMimeType') into the targetMimeType with the given arguments.

Methods inherited from class com.tsgrp.opencontent.core.transformation.AbstractTransformer

getAsyncTransformedContent, isTransformable, setSupportedSourceMimetypes, setSupportedTargetMimetypes

Methods inherited from class java.lang.Object

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

Constructor Detail

ImageMagickTransformer

public ImageMagickTransformer()

Method Detail

setImageMagickPath

public void setImageMagickPath(java.lang.String imageMagickPath)

setImageMagickDebugMode

public void setImageMagickDebugMode(boolean imageMagickDebugMode)

setImageMagickTransformationTimeout

public void setImageMagickTransformationTimeout(java.lang.String imageMagickTransformationTimeout)

transformSync

public void transformSync(java.lang.String ticket,
                          java.io.InputStream content,
                          java.io.OutputStream output,
                          java.lang.String sourceMimetype,
                          java.lang.String targetMimetype,
                          TransformationOptions options)

Description copied from interface: Transformer

Transforms the given byte[] of content (with the given 'sourceMimeType') into the targetMimeType with the given arguments.

Specified by:

transformSync in interface Transformer

Specified by:

transformSync in class AbstractTransformer

Parameters:

ticket - A valid OC ticket.

content - A byte[] containing the content to transform.

sourceMimetype - The mimetype of the content that is being transformed.

targetMimetype - The mimetype that the transformed content should be.

options - The TransformationOptions to use for transforming the content.

supportsAsynchronous

public boolean supportsAsynchronous()

Description copied from interface: Transformer

Returns true if the transformer is capible of performing its transformations in an aysnchronous manner, false if the transformer is synchronous.

Specified by:

supportsAsynchronous in interface Transformer

Specified by:

supportsAsynchronous in class AbstractTransformer

Returns:

True if the transformer performs its transformations in an aysnchronous manner, false if the transformer is synchronous.

transformAsync

public java.lang.String transformAsync(java.lang.String ticket,
                                       java.io.InputStream content,
                                       java.lang.String sourceMimetype,
                                       java.lang.String targetMimetype,
                                       TransformationOptions options)

Description copied from interface: Transformer

Transform the content of the byte[] passed in with the sourceMimeType into the targetMimeType. This method performs an asynchronous transformation. If you need a synchronous transformation use the ITransformation#transform(String, byte[], String, String, TransformationOptions) method. For proper functionality an asynchronous transformer must be configured for use. Callers of this method are responsible for pulling the content from this URL on their own, as nothing is done with the content.

Specified by:

transformAsync in interface Transformer

Specified by:

transformAsync in class AbstractTransformer

Returns:

URL that the content will be available at once the transformation has completed on the server.