org.nuxeo.ecm.core.event.impl

Class AsyncEventExecutor.ListenerWork

java.lang.Object

org.nuxeo.ecm.core.work.AbstractWork

org.nuxeo.ecm.core.event.impl.AsyncEventExecutor.ListenerWork

All Implemented Interfaces:

Serializable, Work

Enclosing class:

AsyncEventExecutor

protected static class AsyncEventExecutor.ListenerWork
extends AbstractWork

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface org.nuxeo.ecm.core.work.api.Work

Work.Progress, Work.State

Field Summary

Fields

Modifier and Type	Field and Description
protected ReconnectedEventBundle	bundle
protected EventListenerDescriptor	listener
protected String	listenerName
protected int	retryCount
protected String	title

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

callerThread, completionTime, docId, docIds, id, isTree, loginContext, originatingUsername, progress, RANDOM, repositoryName, schedulePath, schedulingTime, session, startTime, state, status, suspended, suspending

Constructor Summary

Constructors

Constructor and Description
ListenerWork(EventListenerDescriptor listener, EventBundle bundle)

Method Summary

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.
String	getCategory() Gets the category for this work.
int	getRetryCount() Gets the number of times that this Work instance can be retried in case of concurrent update exceptions.
String	getTitle() Gets a human-readable name for this work instance.
String	toString()
void	work() This method should implement the actual work done by the Work instance.

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

closeSession, commitOrRollbackTransaction, equals, getCompletionTime, getDocument, getDocuments, getId, getOriginatingUsername, getPartitionKey, getProgress, 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

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

title

protected final String title

bundle

protected ReconnectedEventBundle bundle

listenerName

protected String listenerName

retryCount

protected int retryCount

listener

protected transient EventListenerDescriptor listener

Constructor Detail

ListenerWork

public ListenerWork(EventListenerDescriptor listener,
                    EventBundle bundle)

Method Detail

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

getTitle

public String getTitle()

Description copied from interface: Work

Gets a human-readable name for this work instance.

Returns:

a human-readable name

getRetryCount

public int getRetryCount()

Description copied from class: AbstractWork

Gets the number of times that this Work instance can be retried in case of concurrent update exceptions.

Overrides:

getRetryCount in class AbstractWork

Returns:

0 for no retry, or more if some retries are possible

See Also:

AbstractWork.work()

work

public void work()

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

See Also:

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

cleanUp

public void cleanUp(boolean ok,
                    Exception e)

Description copied from class: AbstractWork

This method is called after AbstractWork.work() is done in a finally block, whether work completed normally or was in error or was interrupted.

Specified by:

cleanUp in interface Work

Overrides:

cleanUp in class AbstractWork

Parameters:

ok - true if the work completed normally

e - the exception, if available

toString

public String toString()

Overrides:

toString in class AbstractWork