com.tsgrp.opencontent.core.transformation

Interface ITransformation

All Known Implementing Classes:

TransformationImpl

public interface ITransformation

An interface for transforming content.

Method Summary

Modifier and Type	Method and Description
boolean	canAsyncTransform(java.lang.String ticket, java.lang.String sourceMimetype, java.lang.String targetMimetype) Returns true if an asynchronous transformer exists for the given mimetypes.
java.io.File	getAsyncTransformedContent(java.lang.String ticket, java.lang.String fileId) Verifies the ticket, and then gets the async transformed content with the given FileId.
void	transform(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.
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.

Method Detail

transformAsync

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

Parameters:

ticket -

content -

sourceMimetype -

targetMimetype -

options -

Returns:

URL that the content will be available at once the transformation has completed on the server. Callers of this method are responsible for pulling the content from this URL on their own, as nothing is done with the content.

Throws:

java.lang.Exception - if the document was unable to be queued.

transform

void transform(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.

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.

getAsyncTransformedContent

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

Verifies the ticket, and then gets the async transformed content with the given FileId. Only implemented in implementations which support async transformation.

Parameters:

ticket -

fileId -

Returns:

canAsyncTransform

boolean canAsyncTransform(java.lang.String ticket,
                          java.lang.String sourceMimetype,
                          java.lang.String targetMimetype)

Returns true if an asynchronous transformer exists for the given mimetypes. False otherwise.

Parameters:

ticket -

sourceMimetype -

targetMimetype -