public abstract class AbstractRenditionBuilderWork extends TransientStoreWork
Work.Progress, Work.State
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 |
entryKey, KEY_SUFFIX, STORE_NAME
callerThread, completionTime, docId, docIds, id, isTree, loginContext, originatingUsername, progress, RANDOM, schedulePath, schedulingTime, session, startTime, state, status, suspended, suspending
Constructor and Description |
---|
AbstractRenditionBuilderWork(String key,
DocumentModel doc,
RenditionDefinition def) |
Modifier and Type | Method and Description |
---|---|
void |
cleanUp(boolean ok,
Exception e)
This method is called after
AbstractWork.work() is done in a finally block, whether work completed normally or was in
error or was interrupted. |
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. |
computeEntryKey, containsBlobHolder, getBlobHolder, getEntryKey, getStore, putBlobHolder, putBlobHolder, removeBlobHolder
closeSession, commitOrRollbackTransaction, equals, getCategory, getCompletionTime, getDocument, getDocuments, getOriginatingUsername, getProgress, getRetryCount, getSchedulePath, getSchedulingTime, getStartTime, getState, getStatus, 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
protected final DocumentRef docRef
protected final String repositoryName
protected final String renditionName
protected static org.apache.commons.logging.Log log
public AbstractRenditionBuilderWork(String key, DocumentModel doc, RenditionDefinition def)
public String getId()
Work
The id is used for equality comparisons, and as a key in persistent queues.
getId
in interface Work
getId
in class AbstractWork
null
public String getTitle()
Work
protected String getTransientStoreName()
public void work()
Work
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()
.
work
in interface Work
work
in class AbstractWork
Work.isSuspending()
,
Work.suspended()
,
Work.cleanUp(boolean, java.lang.Exception)
public void cleanUp(boolean ok, Exception e)
AbstractWork
AbstractWork.work()
is done in a finally block, whether work completed normally or was in
error or was interrupted.cleanUp
in interface Work
cleanUp
in class AbstractWork
ok
- true
if the work completed normallye
- the exception, if availableprotected abstract List<Blob> doComputeRendition(CoreSession session, DocumentModel doc, RenditionDefinition def)
session
- doc
- def
- Copyright © 2016 Nuxeo SA. All rights reserved.