com.tsgrp.opencontent.core.transformation

Class AbstractTransformer

java.lang.Object

com.tsgrp.opencontent.core.transformation.AbstractTransformer

All Implemented Interfaces:

Transformer

Direct Known Subclasses:

AdlibTransformer, BlazonTransformer, ExternalAlfrescoTransformer, FFMPEGTransformer, FileSystemTransformer, GhostscriptTransformer, ICEpdfTransformer, ImageMagickTransformer, MuPdfTransformer, TSGCloudTransformerImpl

public abstract class AbstractTransformer
extends java.lang.Object
implements Transformer

The abstract implementation of a transformer. This contains all the common methods that a transformer must implement.

Constructor Summary

Constructors

Constructor and Description
AbstractTransformer()

Method Summary

Modifier and Type	Method and Description
java.io.File	getAsyncTransformedContent(java.lang.String ticket, java.lang.String fileId) Returns the asynchronously transformed content with the given File ID.
boolean	isTransformable(java.lang.String sourceMimetype, java.lang.String targetMimetype, TransformationOptions options) Checks if the transformer is capable of transforming the requested source mimetype to the requested target mimetype given the additional TransformationOptions.
void	setSupportedSourceMimetypes(java.util.List<java.lang.String> supportedSourceMimetypes)
void	setSupportedTargetMimetypes(java.util.List<java.lang.String> supportedTargetMimetypes)
abstract boolean	supportsAsynchronous() Returns true if the transformer is capible of performing its transformations in an aysnchronous manner, false if the transformer is synchronous.
abstract 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.
abstract 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 java.lang.Object

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

Constructor Detail

AbstractTransformer

public AbstractTransformer()

Method Detail

transformAsync

public abstract 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

Returns:

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

transformSync

public abstract 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

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 abstract 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

Returns:

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

getAsyncTransformedContent

public java.io.File getAsyncTransformedContent(java.lang.String ticket,
                                               java.lang.String fileId)

Description copied from interface: Transformer

Returns the asynchronously transformed content with the given File ID.

Specified by:

getAsyncTransformedContent in interface Transformer

Returns:

File if the given file ID exists and this transformer transforms asynchronously; false otherwise

isTransformable

public boolean isTransformable(java.lang.String sourceMimetype,
                               java.lang.String targetMimetype,
                               TransformationOptions options)

Description copied from interface: Transformer

Checks if the transformer is capable of transforming the requested source mimetype to the requested target mimetype given the additional TransformationOptions.

Specified by:

isTransformable in interface Transformer

Parameters:

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.

Returns:

True if the transformer is capable of transforming from the requested source mimetype to the requested target mimetype.

setSupportedSourceMimetypes

public void setSupportedSourceMimetypes(java.util.List<java.lang.String> supportedSourceMimetypes)

setSupportedTargetMimetypes

public void setSupportedTargetMimetypes(java.util.List<java.lang.String> supportedTargetMimetypes)