Package org.alfresco.repo.rendition2

Class RenditionService2Impl

java.lang.Object

org.alfresco.repo.rendition2.RenditionService2Impl

All Implemented Interfaces:

ContentServicePolicies.OnContentUpdatePolicy, ClassPolicy, Policy, RenditionService2, org.springframework.beans.factory.InitializingBean

public class RenditionService2Impl
extends Object
implements RenditionService2, org.springframework.beans.factory.InitializingBean, ContentServicePolicies.OnContentUpdatePolicy

The Async Rendition service. Replaces the original deprecated RenditionService.

Author:

adavis

Nested Class Summary

Nested classes/interfaces inherited from interface org.alfresco.repo.policy.Policy

Policy.Arg

Field Summary

Fields

Modifier and Type	Field	Description
static String	DEFAULT_ENCODING
static String	DEFAULT_MIMETYPE
static QName	DEFAULT_RENDITION_CONTENT_PROP
static int	RENDITION2_DOES_NOT_EXIST
static int	SOURCE_HAS_NO_CONTENT
static String	TRANSFORMING_ERROR_MESSAGE

Fields inherited from interface org.alfresco.repo.content.ContentServicePolicies.OnContentUpdatePolicy

QNAME

Fields inherited from interface org.alfresco.repo.policy.Policy

NAMESPACE

Constructor Summary

Constructors

Constructor	Description
RenditionService2Impl()

Method Summary

Modifier and Type	Method	Description
void	afterPropertiesSet()
void	consume(NodeRef sourceNodeRef, InputStream transformInputStream, RenditionDefinition2 renditionDefinition, int transformContentHashCode)
void	deleteRendition(NodeRef sourceNodeRef, String renditionName)
void	failure(NodeRef sourceNodeRef, RenditionDefinition2 renditionDefinition, int transformContentHashCode)
ChildAssociationRef	getRenditionByName(NodeRef sourceNodeRef, String renditionName)	This method gets the rendition of the sourceNodeRef identified by its name.
RenditionDefinitionRegistry2	getRenditionDefinitionRegistry2()
List<ChildAssociationRef>	getRenditions(NodeRef sourceNodeRef)	This method gets all the renditions of the sourceNodeRef.
boolean	isCreatedByRenditionService2(NodeRef sourceNodeRef, String renditionName)
boolean	isEnabled()	Indicates if renditions are enabled.
boolean	isRenditionAvailable(NodeRef sourceNodeRef, NodeRef renditionNode)	Indicates if the rendition is available.
boolean	isThumbnailsEnabled()
void	onContentUpdate(NodeRef sourceNodeRef, boolean newContent)
void	render(NodeRef sourceNodeRef, String renditionName)	This method asynchronously renders content as specified by the renditionName.
void	setBehaviourFilter(BehaviourFilter behaviourFilter)
void	setContentService(ContentService contentService)
void	setEnabled(boolean enabled)
void	setNodeService(NodeService nodeService)
void	setPolicyComponent(PolicyComponent policyComponent)
void	setRenditionDefinitionRegistry2(RenditionDefinitionRegistry2 renditionDefinitionRegistry2)
void	setRenditionPreventionRegistry(RenditionPreventionRegistry renditionPreventionRegistry)
void	setRenditionRequestSheduler(PostTxnCallbackScheduler renditionRequestSheduler)
void	setRuleService(RuleService ruleService)
void	setThumbnailsEnabled(boolean thumbnailsEnabled)
void	setTransactionService(TransactionService transactionService)
void	setTransformClient(TransformClient transformClient)
void	setTransformReplyProvider(TransformReplyProvider transformReplyProvider)
void	transform(NodeRef sourceNodeRef, TransformDefinition transformDefinition)	This method asynchronously transforms content to a target mimetype with transform options supplied in the transformDefinition.

Methods inherited from class java.lang.Object

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

Field Detail

TRANSFORMING_ERROR_MESSAGE

public static final String TRANSFORMING_ERROR_MESSAGE

See Also:

Constant Field Values

DEFAULT_RENDITION_CONTENT_PROP

public static final QName DEFAULT_RENDITION_CONTENT_PROP

DEFAULT_MIMETYPE

public static final String DEFAULT_MIMETYPE

See Also:

Constant Field Values

DEFAULT_ENCODING

public static final String DEFAULT_ENCODING

See Also:

Constant Field Values

SOURCE_HAS_NO_CONTENT

public static final int SOURCE_HAS_NO_CONTENT

See Also:

Constant Field Values

RENDITION2_DOES_NOT_EXIST

public static final int RENDITION2_DOES_NOT_EXIST

See Also:

Constant Field Values

Constructor Detail

RenditionService2Impl

public RenditionService2Impl()

Method Detail

setTransactionService

public void setTransactionService(TransactionService transactionService)

setNodeService

public void setNodeService(NodeService nodeService)

setContentService

public void setContentService(ContentService contentService)

setRenditionPreventionRegistry

public void setRenditionPreventionRegistry(RenditionPreventionRegistry renditionPreventionRegistry)

setRenditionDefinitionRegistry2

public void setRenditionDefinitionRegistry2(RenditionDefinitionRegistry2 renditionDefinitionRegistry2)

getRenditionDefinitionRegistry2

public RenditionDefinitionRegistry2 getRenditionDefinitionRegistry2()

Specified by:

getRenditionDefinitionRegistry2 in interface RenditionService2

Returns:

the RenditionDefinitionRegistry2 being used by the service.

setTransformClient

public void setTransformClient(TransformClient transformClient)

setPolicyComponent

public void setPolicyComponent(PolicyComponent policyComponent)

setBehaviourFilter

public void setBehaviourFilter(BehaviourFilter behaviourFilter)

setRuleService

public void setRuleService(RuleService ruleService)

setRenditionRequestSheduler

public void setRenditionRequestSheduler(PostTxnCallbackScheduler renditionRequestSheduler)

setTransformReplyProvider

public void setTransformReplyProvider(TransformReplyProvider transformReplyProvider)

setEnabled

public void setEnabled(boolean enabled)

setThumbnailsEnabled

public void setThumbnailsEnabled(boolean thumbnailsEnabled)

isThumbnailsEnabled

public boolean isThumbnailsEnabled()

afterPropertiesSet

public void afterPropertiesSet()
                        throws Exception

Specified by:

afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean

Throws:

Exception

transform

public void transform(NodeRef sourceNodeRef,
                      TransformDefinition transformDefinition)

Description copied from interface: RenditionService2

This method asynchronously transforms content to a target mimetype with transform options supplied in the transformDefinition. A response is set on a message queue once the transform is complete or fails, together with some client supplied data. The response queue and client data are also included in the transformDefinition.

This method does not create a rendition node, but uses the same code as renditions to perform the transform. The transformDefinition extends RenditionDefinition2, but is not stored in a RenditionDefinitionRegistry2, as it is transient in nature.

Specified by:

transform in interface RenditionService2

Parameters:

sourceNodeRef - the node from which the content is retrieved.

transformDefinition - which defines the transform, where to sent the response and some client specified data.

render

public void render(NodeRef sourceNodeRef,
                   String renditionName)

Description copied from interface: RenditionService2

This method asynchronously renders content as specified by the renditionName. The content to be rendered is provided by sourceNodeRef.

Specified by:

render in interface RenditionService2

Parameters:

sourceNodeRef - the node from which the content is retrieved.

renditionName - the rendition to be performed.

failure

public void failure(NodeRef sourceNodeRef,
                    RenditionDefinition2 renditionDefinition,
                    int transformContentHashCode)

consume

public void consume(NodeRef sourceNodeRef,
                    InputStream transformInputStream,
                    RenditionDefinition2 renditionDefinition,
                    int transformContentHashCode)

isCreatedByRenditionService2

public boolean isCreatedByRenditionService2(NodeRef sourceNodeRef,
                                            String renditionName)

deleteRendition

public void deleteRendition(NodeRef sourceNodeRef,
                            String renditionName)

getRenditions

public List<ChildAssociationRef> getRenditions(NodeRef sourceNodeRef)

Description copied from interface: RenditionService2

This method gets all the renditions of the sourceNodeRef.

Specified by:

getRenditions in interface RenditionService2

Returns:

a list of ChildAssociationRefs which link the sourceNodeRef to the renditions.

isRenditionAvailable

public boolean isRenditionAvailable(NodeRef sourceNodeRef,
                                    NodeRef renditionNode)

Indicates if the rendition is available. Failed renditions (there was an error) don't have a contentUrl and out of date renditions or those still being created don't have a matching contentHashCode.

getRenditionByName

public ChildAssociationRef getRenditionByName(NodeRef sourceNodeRef,
                                              String renditionName)

Description copied from interface: RenditionService2

This method gets the rendition of the sourceNodeRef identified by its name.

Specified by:

getRenditionByName in interface RenditionService2

Parameters:

sourceNodeRef - the source node for the renditions

renditionName - the renditionName used to identify a rendition.

Returns:

the ChildAssociationRef which links the source node to the rendition or null if there is no rendition or it is not up to date.

isEnabled

public boolean isEnabled()

Description copied from interface: RenditionService2

Indicates if renditions are enabled. Set using the system.thumbnail.generate value.

Specified by:

isEnabled in interface RenditionService2

onContentUpdate

public void onContentUpdate(NodeRef sourceNodeRef,
                            boolean newContent)

Specified by:

onContentUpdate in interface ContentServicePolicies.OnContentUpdatePolicy

Parameters:

sourceNodeRef - the node reference