com.tsgrp.opencontent.alfresco.rendition

Class AlfrescoEmbRenditionImpl

java.lang.Object

com.tsgrp.opencontent.core.rendition.AbstractRenditionImpl

com.tsgrp.opencontent.alfresco.rendition.AlfrescoEmbRenditionImpl

All Implemented Interfaces:

IRendition

Direct Known Subclasses:

AdlibAlfrescoEmbRenditionImpl, AlfrescoEmbInternalRenditionImpl, AlfrescoEmbQueueRenditionImpl

public class AlfrescoEmbRenditionImpl
extends AbstractRenditionImpl

Rendition implementaton for AlfrescoEmb which doesn't itself do any renditioning but instead delegates to the transformers which are configured in OC to transform the content and then place it into the tsg:rendition property

Field Summary

Fields

Modifier and Type	Field and Description
protected org.alfresco.repo.policy.BehaviourFilter	behaviorFilter
protected java.util.List<java.lang.String>	reditioningAspectsToIgnore (Optional) Inject a list of Aspects (Fully qualified QName Strings).

Fields inherited from class com.tsgrp.opencontent.core.rendition.AbstractRenditionImpl

priorityUpgradeValue, renditionPriorityValues

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AlfrescoEmbRenditionImpl()

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.
java.util.List<java.lang.String>	getReditioningAspectsToIgnore()
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	setReditioningAspectsToIgnore(java.util.List<java.lang.String> reditioningAspectsToIgnore)
void	setRenditioningPriority(java.lang.String ticket, java.lang.String objectId, java.lang.Integer priority) Sets the renditioning priority on the given objectId.

Methods inherited from class com.tsgrp.opencontent.core.rendition.AbstractRenditionImpl

getPriorityUpgradeValue, getRenditionPriorityValues, setPriorityUpgradeValue, setRenditionPriorityValues

Methods inherited from class java.lang.Object

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

Field Detail

reditioningAspectsToIgnore

protected java.util.List<java.lang.String> reditioningAspectsToIgnore

(Optional) Inject a list of Aspects (Fully qualified QName Strings). If a document has one of the listed aspects the isRenditioning call will automatically return false

behaviorFilter

protected org.alfresco.repo.policy.BehaviourFilter behaviorFilter

Constructor Detail

AlfrescoEmbRenditionImpl

protected AlfrescoEmbRenditionImpl()

Method Detail

getReditioningAspectsToIgnore

public java.util.List<java.lang.String> getReditioningAspectsToIgnore()

setReditioningAspectsToIgnore

public void setReditioningAspectsToIgnore(java.util.List<java.lang.String> reditioningAspectsToIgnore)

generateRendition

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

Description copied from interface: IRendition

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.

generateRenditionAsync

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

Description copied from interface: IRendition

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

addRendition

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

Description copied from interface: IRendition

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

removeRendition

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

Description copied from interface: IRendition

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

generateRenditionSync

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

Description copied from interface: IRendition

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

Throws:

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

checkIfRenditioningAndUpgradePriority

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

Description copied from interface: IRendition

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

Returns:

isRenditioning

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

Description copied from interface: IRendition

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

Returns:

setRenditioningPriority

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

Description copied from interface: IRendition

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

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

renditioningFailed

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

Description copied from interface: IRendition

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

Returns:

canBeRenditioned

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

Description copied from interface: IRendition

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