org.nuxeo.ecm.platform.rendition.lazy

Class AbstractLazyCachableRenditionProvider

java.lang.Object

org.nuxeo.ecm.platform.rendition.extension.DefaultAutomationRenditionProvider

org.nuxeo.ecm.platform.rendition.lazy.AbstractLazyCachableRenditionProvider

All Implemented Interfaces:

RenditionProvider

Direct Known Subclasses:

AutomationLazyRenditionProvider

public abstract class AbstractLazyCachableRenditionProvider
extends DefaultAutomationRenditionProvider

Default implementation of an asynchronous RenditionProvider

Since:

7.2

Author:

Tiry

Field Summary

Fields

Modifier and Type	Field and Description
static String	CACHE_NAME
protected static org.apache.commons.logging.Log	log
static String	SOURCE_DOCUMENT_MODIFICATION_DATE_KEY

Fields inherited from class org.nuxeo.ecm.platform.rendition.extension.DefaultAutomationRenditionProvider

VARIANT_POLICY_USER

Constructor Summary

Constructors

Constructor and Description
AbstractLazyCachableRenditionProvider()

Method Summary

Modifier and Type	Method and Description
String	buildRenditionKey(DocumentModel doc, RenditionDefinition def)
protected String	getDigest(String key)
protected abstract Work	getRenditionWork(String key, DocumentModel doc, RenditionDefinition def) Return the Work that will compute the Rendition.
String	getSourceDocumentModificationDate(DocumentModel doc, RenditionDefinition definition)
protected TransientStore	getTransientStore()
protected void	handleCompletedRendition(String key, DocumentModel doc, RenditionDefinition definition, String sourceDocumentModificationDate, String storedSourceDocumentModificationDate, List<Blob> blobs)
protected void	handleIncompleteRendition(String key, DocumentModel doc, RenditionDefinition definition, String sourceDocumentModificationDate, String storedSourceDocumentModificationDate)
protected List<Blob>	handleNewRendition(String key, DocumentModel doc, RenditionDefinition definition, String sourceDocumentModificationDate)
List<Blob>	render(DocumentModel doc, RenditionDefinition definition) Generate the rendition Blobs for a given RenditionDefinition.
protected String	toHexString(byte[] data)

Methods inherited from class org.nuxeo.ecm.platform.rendition.extension.DefaultAutomationRenditionProvider

getVariant, isAvailable

Methods inherited from class java.lang.Object

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

Field Detail

SOURCE_DOCUMENT_MODIFICATION_DATE_KEY

public static final String SOURCE_DOCUMENT_MODIFICATION_DATE_KEY

See Also:

Constant Field Values

CACHE_NAME

public static final String CACHE_NAME

See Also:

Constant Field Values

log

protected static org.apache.commons.logging.Log log

Constructor Detail

AbstractLazyCachableRenditionProvider

public AbstractLazyCachableRenditionProvider()

Method Detail

render

public List<Blob> render(DocumentModel doc,
                         RenditionDefinition definition)

Description copied from interface: RenditionProvider

Generate the rendition Blobs for a given RenditionDefinition. Return is a List of Blob for bigger flexibility (typically HTML rendition with resources)

Specified by:

render in interface RenditionProvider

Overrides:

render in class DefaultAutomationRenditionProvider

Parameters:

doc - the target DocumentModel

definition - the RenditionDefinition to use

Returns:

The list of Blobs

buildRenditionKey

public String buildRenditionKey(DocumentModel doc,
                                RenditionDefinition def)

getSourceDocumentModificationDate

public String getSourceDocumentModificationDate(DocumentModel doc,
                                                RenditionDefinition definition)

getDigest

protected String getDigest(String key)

toHexString

protected String toHexString(byte[] data)

getTransientStore

protected TransientStore getTransientStore()

handleNewRendition

protected List<Blob> handleNewRendition(String key,
                                        DocumentModel doc,
                                        RenditionDefinition definition,
                                        String sourceDocumentModificationDate)

handleCompletedRendition

protected void handleCompletedRendition(String key,
                                        DocumentModel doc,
                                        RenditionDefinition definition,
                                        String sourceDocumentModificationDate,
                                        String storedSourceDocumentModificationDate,
                                        List<Blob> blobs)

handleIncompleteRendition

protected void handleIncompleteRendition(String key,
                                         DocumentModel doc,
                                         RenditionDefinition definition,
                                         String sourceDocumentModificationDate,
                                         String storedSourceDocumentModificationDate)

getRenditionWork

protected abstract Work getRenditionWork(String key,
                                         DocumentModel doc,
                                         RenditionDefinition def)

Return the Work that will compute the Rendition. AbstractRenditionBuilderWork can be used as a base class

Parameters:

key - the key used to rendition

doc - the target DocumentModel

def - the RenditionDefinition

Returns: