org.nuxeo.ecm.platform.rendition.lazy

Class AbstractRenditionBuilderWork

java.lang.Object

org.nuxeo.ecm.core.work.AbstractWork

org.nuxeo.ecm.platform.rendition.lazy.AbstractRenditionBuilderWork

All Implemented Interfaces:

Serializable, Work

Direct Known Subclasses:

AutomationRenditionBuilder

public abstract class AbstractRenditionBuilderWork
extends AbstractWork
implements Work, Serializable

Since:

7.2

Author:

Tiry

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface org.nuxeo.ecm.core.work.api.Work

Work.Progress, Work.State

Field Summary

Fields

Modifier and Type	Field and Description
protected DocumentRef	docRef
protected String	key
protected static org.apache.commons.logging.Log	log
protected String	renditionName
protected String	repositoryName

Fields inherited from class org.nuxeo.ecm.core.work.AbstractWork

callerThread, completionTime, docId, docIds, id, isTree, loginContext, originatingUsername, progress, RANDOM, schedulePath, schedulingTime, session, startTime, state, status, suspended, suspending

Constructor Summary

Constructors

Constructor and Description
AbstractRenditionBuilderWork(String key, DocumentModel doc, RenditionDefinition def)

Method Summary

Modifier and Type	Method and Description
protected abstract List<Blob>	doComputeRendition(CoreSession session, DocumentModel doc, RenditionDefinition def) Does the actual Rendition Computation : this code will be called from inside an Asynchronous Work
String	getId() The work id.
String	getTitle() Gets a human-readable name for this work instance.
protected String	getTransientStoreName()
void	work() This method should implement the actual work done by the Work instance.

Methods inherited from class org.nuxeo.ecm.core.work.AbstractWork

cleanUp, closeSession, commitOrRollbackTransaction, equals, getCategory, getCompletionTime, getDocument, getDocuments, getOriginatingUsername, getProgress, getRetryCount, getSchedulePath, getSchedulingTime, getStartTime, getState, getStatus, getWorkInstanceResult, getWorkInstanceState, hashCode, initSession, initSession, isDocumentTree, isSuspending, isWorkInstanceSuspended, newDocumentLocation, openSystemSession, openUserSession, run, runWorkWithTransaction, runWorkWithTransactionAndCheckExceptions, setCompletionTime, setDocument, setDocument, setDocuments, setOriginatingUsername, setProgress, setSchedulePath, setStartTime, setStatus, setWorkInstanceState, setWorkInstanceSuspending, startTransaction, suspended, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.nuxeo.ecm.core.work.api.Work

cleanUp, getCategory, getCompletionTime, getDocument, getDocuments, getOriginatingUsername, getProgress, getSchedulePath, getSchedulingTime, getStartTime, getState, getStatus, getWorkInstanceResult, getWorkInstanceState, isDocumentTree, isSuspending, isWorkInstanceSuspended, run, setProgress, setSchedulePath, setStartTime, setWorkInstanceState, setWorkInstanceSuspending, suspended

Field Detail

key

protected final String key

docRef

protected final DocumentRef docRef

repositoryName

protected final String repositoryName

renditionName

protected final String renditionName

log

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

Constructor Detail

AbstractRenditionBuilderWork

public AbstractRenditionBuilderWork(String key,
                                    DocumentModel doc,
                                    RenditionDefinition def)

Method Detail

getId

public String getId()

Description copied from interface: Work

The work id.

The id is used for equality comparisons, and as a key in persistent queues.

Specified by:

getId in interface Work

Overrides:

getId in class AbstractWork

Returns:

the work id, which must not be null

getTitle

public String getTitle()

Description copied from interface: Work

Gets a human-readable name for this work instance.

Specified by:

getTitle in interface Work

Returns:

a human-readable name

getTransientStoreName

protected String getTransientStoreName()

work

public void work()

Description copied from interface: Work

This method should implement the actual work done by the Work instance.

It should periodically update its progress through Work.setProgress(org.nuxeo.ecm.core.work.api.Work.Progress).

To allow for suspension by the WorkManager, it should periodically call Work.isSuspending(), and if true call Work.suspended() return early with saved state data.

Clean up can by implemented by #cleanUp().

Specified by:

work in interface Work

Specified by:

work in class AbstractWork

See Also:

Work.isSuspending(), Work.suspended(), Work.cleanUp(boolean, java.lang.Exception)

doComputeRendition

protected abstract List<Blob> doComputeRendition(CoreSession session,
                                                 DocumentModel doc,
                                                 RenditionDefinition def)

Does the actual Rendition Computation : this code will be called from inside an Asynchronous Work

Parameters:

session -

doc -

def -

Returns: