com.tsgrp.opencontent.core.rendition

Interface IRendition

All Known Implementing Classes:

AbstractRenditionImpl, AdlibAlfrescoEmbRenditionImpl, AdlibDynamoRenditionImpl, AlfrescoEmbInternalRenditionImpl, AlfrescoEmbQueueRenditionImpl, AlfrescoEmbRenditionImpl, DCTMRenditionImpl, DynamoRenditionImpl, HBaseRenditionImpl

public interface IRendition

An interface for working with renditions.

Method Summary

Modifier and Type	Method and Description
void	addRendition(java.lang.String ticket, java.lang.String objectId, java.io.InputStream rendition, java.lang.String renditionMimetype) This adds the given rendition in the inputstream to the document.
boolean	canBeRenditioned(java.lang.String ticket, java.lang.String objectId, java.lang.String targetMimetype) Returns true if a rendition of the given document to the target is possible; false otherwise.
boolean	checkIfRenditioningAndUpgradePriority(java.lang.String ticket, java.lang.String objectId) Returns true if the object is currently renditioning; false otherwise, and increases the priority if it is renditioning
void	generateRendition(java.lang.String ticket, java.lang.String objectId, java.lang.String sourceMimetype, java.lang.String targetMimetype) This rendition attempts to transform a document using any asynchronous transformer which exists for these mimetypes, and defers to synchronous transformers if none are available.
void	generateRenditionAsync(java.lang.String ticket, java.lang.String objectId, java.lang.String sourceMimetype, java.lang.String targetMimetype) Attempts to generate a rendition asynchronously, using the given objectId, sourceMimetype, and targetMimetype.
void	generateRenditionSync(java.lang.String ticket, java.lang.String objectId, java.lang.String sourceMimetype, java.lang.String targetMimetype) Generates a rendition synchronously, not returning until a rendition exists on the given objectId.
int	getPriorityUpgradeValue() Returns the value we want to upgrade the rendition priority to when we check if a doc is renditioning by calling checkIfRenditioningAndUpgradePriority
java.util.List<java.lang.Integer>	getRenditionPriorityValues() Returns a List of the possible rendition priority values
boolean	isRenditioning(java.lang.String ticket, java.lang.String objectId) Returns true if the object is currently renditioning; false otherwise.
void	removeRendition(java.lang.String ticket, java.lang.String objectId, java.lang.String mimeType) This removes the rendition with the given mimetype from the document.
boolean	renditioningFailed(java.lang.String ticket, java.lang.String objectId) Returns true if the given objectId has failed to receive a rendition; false otherwise.
void	setPriorityUpgradeValue(int priorityUpgradeValue)
void	setRenditioningPriority(java.lang.String ticket, java.lang.String objectId, java.lang.Integer priority) Sets the renditioning priority on the given objectId.

Method Detail

generateRendition

void generateRendition(java.lang.String ticket,
                       java.lang.String objectId,
                       java.lang.String sourceMimetype,
                       java.lang.String targetMimetype)

This rendition attempts to transform a document using any asynchronous transformer which exists for these mimetypes, and defers to synchronous transformers if none are available.

Parameters:

ticket -

objectId -

sourceMimetype -

targetMimetype -

generateRenditionAsync

void generateRenditionAsync(java.lang.String ticket,
                            java.lang.String objectId,
                            java.lang.String sourceMimetype,
                            java.lang.String targetMimetype)

Attempts to generate a rendition asynchronously, using the given objectId, sourceMimetype, and targetMimetype. If no asynchronous transformer exists, throws an error.

Parameters:

ticket -

objectId -

sourceMimetype -

targetMimetype -

generateRenditionSync

void generateRenditionSync(java.lang.String ticket,
                           java.lang.String objectId,
                           java.lang.String sourceMimetype,
                           java.lang.String targetMimetype)
                    throws OCRuntimeException

Generates a rendition synchronously, not returning until a rendition exists on the given objectId.

Parameters:

ticket -

objectId -

sourceMimetype -

targetMimetype -

Throws:

OCRuntimeException - if no configured synchronous transformer is available for these mimetypes

addRendition

void addRendition(java.lang.String ticket,
                  java.lang.String objectId,
                  java.io.InputStream rendition,
                  java.lang.String renditionMimetype)

This adds the given rendition in the inputstream to the document.

Parameters:

ticket -

objectId -

rendition -

renditionMimetype -

removeRendition

void removeRendition(java.lang.String ticket,
                     java.lang.String objectId,
                     java.lang.String mimeType)

This removes the rendition with the given mimetype from the document.

Parameters:

ticket -

objectId -

mimeType -

checkIfRenditioningAndUpgradePriority

boolean checkIfRenditioningAndUpgradePriority(java.lang.String ticket,
                                              java.lang.String objectId)

Returns true if the object is currently renditioning; false otherwise, and increases the priority if it is renditioning

Parameters:

ticket -

objectId -

Returns:

isRenditioning

boolean isRenditioning(java.lang.String ticket,
                       java.lang.String objectId)

Returns true if the object is currently renditioning; false otherwise.

Parameters:

ticket -

objectId -

Returns:

setRenditioningPriority

void setRenditioningPriority(java.lang.String ticket,
                             java.lang.String objectId,
                             java.lang.Integer priority)

Sets the renditioning priority on the given objectId. Can be extended to cover other business logic Currently only works for alfresco's async renditioning queue. To set reditioning priority use the queue.priority.values property: Examples: queue.priority.values=1-5 // this will allow renditions to have priorities from 1 to 5 queue.priority.values=6 // this will set the default rendition priority to 6 Not setting queue.priority.values will result in the default rendition priority resulting in zero

Parameters:

ticket -

objectId -

priority - If null then priority will be set to the lowest priority available

getRenditionPriorityValues

java.util.List<java.lang.Integer> getRenditionPriorityValues()

Returns a List of the possible rendition priority values

getPriorityUpgradeValue

int getPriorityUpgradeValue()

Returns the value we want to upgrade the rendition priority to when we check if a doc is renditioning by calling checkIfRenditioningAndUpgradePriority

setPriorityUpgradeValue

void setPriorityUpgradeValue(int priorityUpgradeValue)

canBeRenditioned

boolean canBeRenditioned(java.lang.String ticket,
                         java.lang.String objectId,
                         java.lang.String targetMimetype)

Returns true if a rendition of the given document to the target is possible; false otherwise.

renditioningFailed

boolean renditioningFailed(java.lang.String ticket,
                           java.lang.String objectId)

Returns true if the given objectId has failed to receive a rendition; false otherwise.

Parameters:

ticket -

objectId -

Returns: