org.nuxeo.ecm.platform.rendition.lazy

Class AbstractLazyCachableRenditionProvider

java.lang.Object

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

All Implemented Interfaces:

RenditionProvider

Direct Known Subclasses:

AutomationLazyRenditionProvider

public abstract class AbstractLazyCachableRenditionProvider
extends Object
implements RenditionProvider

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	WORKERID_KEY

Constructor Summary

Constructors

Constructor and Description
AbstractLazyCachableRenditionProvider()

Method Summary

Modifier and Type	Method and Description
protected 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	getVariant(DocumentModel doc, RenditionDefinition definition) Gets the optional RENDITION_VARIANT_PROPERTY value for a given RenditionDefinition.
List<Blob>	render(DocumentModel doc, RenditionDefinition def) Generate the rendition Blobs for a given RenditionDefinition.
protected String	toHexString(byte[] data)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.nuxeo.ecm.platform.rendition.extension.RenditionProvider

isAvailable

Field Detail

WORKERID_KEY

public static final String WORKERID_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 def)

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

Parameters:

doc - the target DocumentModel

def - the RenditionDefinition to use

Returns:

The list of Blobs

getVariant

public String getVariant(DocumentModel doc,
                         RenditionDefinition definition)

Description copied from interface: RenditionProvider

Gets the optional RENDITION_VARIANT_PROPERTY value for a given RenditionDefinition.

Specified by:

getVariant in interface RenditionProvider

Parameters:

doc - the target document

definition - the rendition definition to use

Returns:

the generated RENDITION_VARIANT_PROPERTY value, or null

buildRenditionKey

protected String buildRenditionKey(DocumentModel doc,
                                   RenditionDefinition def)

getDigest

protected String getDigest(String key)

toHexString

protected String toHexString(byte[] data)

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: