public class BinaryMetadataWork extends AbstractWork
Work.Progress, Work.State
Modifier and Type | Field and Description |
---|---|
static String |
BINARY_METADATA_WORK_TITLE |
protected DocumentEventContext |
docCtx |
protected String |
docId |
protected LinkedList<MetadataMappingDescriptor> |
mappingDescriptors |
completionTime, docIds, id, isTree, progress, RANDOM, repositoryName, schedulePath, schedulingTime, session, startTime, state, status, suspended, suspending
Constructor and Description |
---|
BinaryMetadataWork(String repositoryName,
String docId,
LinkedList<MetadataMappingDescriptor> mappingDescriptors,
DocumentEventContext docCtx) |
Modifier and Type | Method and Description |
---|---|
String |
getCategory()
Gets the category for this work.
|
String |
getTitle()
Gets a human-readable name for this work instance.
|
void |
work()
This method should implement the actual work done by the
Work instance. |
cleanUp, closeSession, commitOrRollbackTransaction, equals, getCompletionTime, getDocument, getDocuments, getId, getProgress, getRetryCount, getSchedulePath, getSchedulingTime, getStartTime, getState, getStatus, getUserId, getWorkInstanceResult, getWorkInstanceState, hashCode, initSession, initSession, isDocumentTree, isSuspending, isWorkInstanceSuspended, newDocumentLocation, run, runWorkWithTransaction, runWorkWithTransactionAndCheckExceptions, setCompletionTime, setDocument, setDocument, setDocuments, setProgress, setSchedulePath, setStartTime, setStatus, setWorkInstanceState, setWorkInstanceSuspending, startTransaction, suspended, toString
public static final String BINARY_METADATA_WORK_TITLE
protected final LinkedList<MetadataMappingDescriptor> mappingDescriptors
protected final DocumentEventContext docCtx
public BinaryMetadataWork(String repositoryName, String docId, LinkedList<MetadataMappingDescriptor> mappingDescriptors, DocumentEventContext docCtx)
public String getCategory()
Work
Used to choose an execution queue.
getCategory
in interface Work
getCategory
in class AbstractWork
null
for the defaultpublic String getTitle()
Work
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)
Copyright © 2015 Nuxeo SA. All rights reserved.