public abstract class RemovedAbstractWork extends AbstractWork
Work.Progress, Work.State
Modifier and Type | Field and Description |
---|---|
protected long |
offset |
callerThread, completionTime, docId, docIds, FAILURE_EXCEPTION, FAILURE_MSG, id, isTree, loginContext, originatingUsername, progress, RANDOM, repositoryName, schedulePath, schedulingTime, session, startTime, state, status, suspended, suspending, WORK_FAILED_EVENT, WORK_INSTANCE
Modifier | Constructor and Description |
---|---|
|
RemovedAbstractWork() |
protected |
RemovedAbstractWork(long offset) |
Modifier and Type | Method and Description |
---|---|
String |
getId()
The work id.
|
protected abstract String |
getQuery() |
protected abstract void |
updateDocument(DocumentModel d) |
void |
work()
This method should implement the actual work done by the
Work instance. |
buildWorkFailureEventProps, cleanUp, closeSession, commitOrRollbackTransaction, equals, getCategory, getCompletionTime, getDocument, getDocuments, getOriginatingUsername, getPartitionKey, getProgress, getRetryCount, getSchedulePath, getSchedulingTime, getStartTime, getStatus, getWorkInstanceState, hashCode, initSession, initSession, isDocumentTree, isSuspending, isWorkInstanceSuspended, newDocumentLocation, openSystemSession, openUserSession, run, runWorkWithTransaction, setCompletionTime, setDocument, setDocument, setDocuments, setOriginatingUsername, setProgress, setSchedulePath, setStartTime, setStatus, setWorkInstanceState, setWorkInstanceSuspending, startTransaction, suspended, toString, workFailed
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
getTitle, isCoalescing, isIdempotent
protected long offset
public RemovedAbstractWork()
protected RemovedAbstractWork(long offset)
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 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)
protected abstract void updateDocument(DocumentModel d)
Copyright © 2019 Nuxeo. All rights reserved.