com.tsgrp.opencontent.transformation

Class FileSystemTransformer

java.lang.Object

com.tsgrp.opencontent.core.transformation.AbstractTransformer

com.tsgrp.opencontent.transformation.FileSystemTransformer

All Implemented Interfaces:

Transformer

public class FileSystemTransformer
extends AbstractTransformer

Constructor Summary

Constructors

Constructor and Description
FileSystemTransformer()

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.
int	getCounterTries()
java.lang.String	getDropFolderLocation()
int	getMillisBetweenTries()
java.lang.String	getOcRestEndpoint()
java.lang.String	getTransformedFolderLocation()
void	setCounterTries(int counterTries)
void	setDropFolderLocation(java.lang.String dropFolderLocation)
void	setMillisBetweenTries(int millisBetweenTries)
void	setOcRestEndpoint(java.lang.String ocRestEndpoint)
void	setTransformedFolderLocation(java.lang.String transformedFolderLocation)
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

isTransformable, setSupportedSourceMimetypes, setSupportedTargetMimetypes

Methods inherited from class java.lang.Object

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

Constructor Detail

FileSystemTransformer

public FileSystemTransformer()

Method Detail

setDropFolderLocation

public void setDropFolderLocation(java.lang.String dropFolderLocation)

getDropFolderLocation

public java.lang.String getDropFolderLocation()

setTransformedFolderLocation

public void setTransformedFolderLocation(java.lang.String transformedFolderLocation)

getTransformedFolderLocation

public java.lang.String getTransformedFolderLocation()

setCounterTries

public void setCounterTries(int counterTries)

getOcRestEndpoint

public java.lang.String getOcRestEndpoint()

setOcRestEndpoint

public void setOcRestEndpoint(java.lang.String ocRestEndpoint)

getCounterTries

public int getCounterTries()

setMillisBetweenTries

public void setMillisBetweenTries(int millisBetweenTries)

getMillisBetweenTries

public int getMillisBetweenTries()

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.

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

Overrides:

getAsyncTransformedContent in class AbstractTransformer

Returns:

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