public abstract class AbstractIndexingWorker extends AbstractWork
Work.Progress, Work.State
Constructor and Description |
---|
AbstractIndexingWorker(IndexingCommand cmd) |
Modifier and Type | Method and Description |
---|---|
String |
getCategory()
Gets the category for this work.
|
static int |
getRunningWorkers() |
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, getWorkInstanceState, hashCode, initSession, initSession, isDocumentTree, isSuspending, isWorkInstanceSuspended, run, setDocument, setDocument, setDocuments, setProgress, setSchedulePath, setStartTime, setStatus, setWorkInstanceState, setWorkInstanceSuspending, startTransaction, suspended, toString
public AbstractIndexingWorker(IndexingCommand cmd)
public static int getRunningWorkers()
public String getCategory()
Work
Used to choose an execution queue.
getCategory
in interface Work
getCategory
in class AbstractWork
null
for the defaultpublic void work() throws Exception
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
Exception
Work.isSuspending()
,
Work.suspended()
,
Work.cleanUp(boolean, java.lang.Exception)
Copyright © 2014 Nuxeo SA. All rights reserved.