org.nuxeo.elasticsearch.work

Class AbstractIndexingWorker

java.lang.Object

org.nuxeo.ecm.core.work.AbstractWork

org.nuxeo.elasticsearch.work.AbstractIndexingWorker

All Implemented Interfaces:

Serializable, Work

Direct Known Subclasses:

ChildrenIndexingWorker, IndexingWorker

public abstract class AbstractIndexingWorker
extends AbstractWork

Abstract class for sharing code between ElasticSearch related workers

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

Constructor Summary

Constructors

Constructor and Description
AbstractIndexingWorker(IndexingCommand cmd)

Method Summary

Methods

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.

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

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

getTitle

Constructor Detail

AbstractIndexingWorker

public AbstractIndexingWorker(IndexingCommand cmd)

Method Detail

getRunningWorkers

public static int getRunningWorkers()

getCategory

public String getCategory()

Description copied from interface: Work

Gets the category for this work.

Used to choose an execution queue.

Specified by:

getCategory in interface Work

Overrides:

getCategory in class AbstractWork

Returns:

the category, or null for the default

work

public void work()
          throws Exception

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

Throws:

Exception

See Also:

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