com.tsgrp.opencontent.transformation

Class AdlibTransformer

java.lang.Object

com.tsgrp.opencontent.core.transformation.AbstractTransformer

com.tsgrp.opencontent.transformation.AdlibTransformer

All Implemented Interfaces:

Transformer

public class AdlibTransformer
extends AbstractTransformer

A transformation implementation using the Adlib transformation engine.

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String	adlibServerOutputDirectory
protected static java.lang.String	downloadKey
protected static java.lang.String	downloadKeyPlaceholder
protected static java.lang.String	fileExtensionPlaceholder
static java.lang.String	JOB_ID
static java.lang.String	JOB_PRIORITY
static java.lang.String	OBJECT_ID
protected static java.lang.String	objectIdPlaceholder
protected static java.lang.String	ocUrl
protected static java.lang.String	ocUrlPlaceholder
protected static java.lang.String	outputDirectoryPlaceholder
protected java.lang.String	repositoryId
protected java.lang.String	repositoryWorkspaceId
static java.lang.String	RETRIES

Constructor Summary

Constructors

Constructor and Description
AdlibTransformer()

Method Summary

Modifier and Type	Method and Description
static void	cancelJob(java.lang.String jobId) Cancels and releases a job in Adlib's transformation queue
static java.lang.String	getJobStatus(java.lang.String jobId) Reaches out to the Adlib services via the jobManagementServices to get the transformation status of a jobId
void	init() Initializes all of the Adlib components, as well as the jobManagementService
void	setAdlibJobTicketMap(java.util.Map<java.lang.String,java.lang.String> adlibJobTicketMap)
void	setAdlibServerOutputDirectory(java.lang.String value)
void	setDefaultSettings(AdlibSettings defaultSettings)
void	setDownloadKeyPlaceholder(java.lang.String value)
void	setFileExtensionPlaceholder(java.lang.String value)
void	setKey(java.lang.String value)
void	setObjectIdPlaceholder(java.lang.String value)
void	setOcUrl(java.lang.String value)
void	setOcUrlPlaceholder(java.lang.String value)
void	setOutputDirectoryPlaceHolder(java.lang.String value)
void	setRepositoryId(java.lang.String value)
void	setRepositoryWorkspaceId(java.lang.String value)
static java.lang.String	submitJob(java.lang.String ticket, java.lang.String objectId, java.lang.String fileExtension, double priority) Submit jobs based on settings
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

Field Detail

downloadKey

protected static java.lang.String downloadKey

ocUrlPlaceholder

protected static java.lang.String ocUrlPlaceholder

fileExtensionPlaceholder

protected static java.lang.String fileExtensionPlaceholder

objectIdPlaceholder

protected static java.lang.String objectIdPlaceholder

downloadKeyPlaceholder

protected static java.lang.String downloadKeyPlaceholder

ocUrl

protected static java.lang.String ocUrl

repositoryId

protected java.lang.String repositoryId

repositoryWorkspaceId

protected java.lang.String repositoryWorkspaceId

adlibServerOutputDirectory

protected static java.lang.String adlibServerOutputDirectory

outputDirectoryPlaceholder

protected static java.lang.String outputDirectoryPlaceholder

OBJECT_ID

public static final java.lang.String OBJECT_ID

See Also:

Constant Field Values

JOB_ID

public static final java.lang.String JOB_ID

See Also:

Constant Field Values

JOB_PRIORITY

public static final java.lang.String JOB_PRIORITY

See Also:

Constant Field Values

RETRIES

public static final java.lang.String RETRIES

See Also:

Constant Field Values

Constructor Detail

AdlibTransformer

public AdlibTransformer()

Method Detail

setKey

@Value(value="${adlib.openContent.downloadKey}")
public void setKey(java.lang.String value)

setOcUrlPlaceholder

@Value(value="${adlib.placeholder.ocUrl}")
public void setOcUrlPlaceholder(java.lang.String value)

setFileExtensionPlaceholder

@Value(value="${adlib.placeholder.fileExtension}")
public void setFileExtensionPlaceholder(java.lang.String value)

setObjectIdPlaceholder

@Value(value="${adlib.placeholder.objectId}")
public void setObjectIdPlaceholder(java.lang.String value)

setDownloadKeyPlaceholder

@Value(value="${adlib.placeholder.downloadKey}")
public void setDownloadKeyPlaceholder(java.lang.String value)

setOcUrl

@Value(value="${adlib.openContent.ocURL}")
public void setOcUrl(java.lang.String value)

setRepositoryId

@Value(value="${adlib.repository.Id}")
public void setRepositoryId(java.lang.String value)

setRepositoryWorkspaceId

@Value(value="${adlib.repository.workspaceId}")
public void setRepositoryWorkspaceId(java.lang.String value)

setAdlibServerOutputDirectory

@Value(value="${AdlibServerOutputDirectory}")
public void setAdlibServerOutputDirectory(java.lang.String value)

setOutputDirectoryPlaceHolder

@Value(value="${adlib.placeholder.outputDirectory}")
public void setOutputDirectoryPlaceHolder(java.lang.String value)

setDefaultSettings

public void setDefaultSettings(AdlibSettings defaultSettings)

setAdlibJobTicketMap

public void setAdlibJobTicketMap(java.util.Map<java.lang.String,java.lang.String> adlibJobTicketMap)

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.

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.

init

public void init()

Initializes all of the Adlib components, as well as the jobManagementService

submitJob

public static java.lang.String submitJob(java.lang.String ticket,
                                         java.lang.String objectId,
                                         java.lang.String fileExtension,
                                         double priority)

Submit jobs based on settings

Returns:

Throws:

java.io.IOException

java.lang.Exception

getJobStatus

public static java.lang.String getJobStatus(java.lang.String jobId)

Reaches out to the Adlib services via the jobManagementServices to get the transformation status of a jobId

Parameters:

jobId -

Returns:

cancelJob

public static void cancelJob(java.lang.String jobId)

Cancels and releases a job in Adlib's transformation queue

Parameters:

jobId -