Package 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 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, FAILURE_EXCEPTION, FAILURE_MSG, GLOBAL_DLQ_COUNT_REGISTRY_NAME, id, isTree, loginContext, originatingUsername, progress, RANDOM, repositoryName, schedulePath, schedulingTime, session, startTime, state, status, suspended, suspending, traceContext, WORK_FAILED_EVENT, WORK_INSTANCE
-
-
Constructor Summary
Constructors Constructor Description ListenerWork(EventListenerDescriptor listener, EventBundle bundle)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
cleanUp(boolean ok, Exception e)
This method is called afterAbstractWork.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 theWork
instance.-
Methods inherited from class org.nuxeo.ecm.core.work.AbstractWork
appendWorkToDeadLetterQueue, buildWorkFailureEventProps, closeSession, commitOrRollbackTransaction, equals, getCompletionTime, getDocument, getDocuments, getId, getOriginatingUsername, getPartitionKey, getProgress, getSchedulePath, getSchedulingTime, getSpanFromContext, 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, workFailed
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface org.nuxeo.ecm.core.work.api.Work
isCoalescing, isGroupJoin, isIdempotent, onGroupJoinCompletion
-
-
-
-
Field Detail
-
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 interfaceWork
- Overrides:
getCategory
in classAbstractWork
- 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 classAbstractWork
- 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 theWork
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 callWork.isSuspending()
, and iftrue
callWork.suspended()
return early with saved state data.Clean up can by implemented by
Work.cleanUp(boolean, Exception)
.- Specified by:
work
in interfaceWork
- Specified by:
work
in classAbstractWork
- 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 afterAbstractWork.work()
is done in a finally block, whether work completed normally or was in error or was interrupted.- Specified by:
cleanUp
in interfaceWork
- Overrides:
cleanUp
in classAbstractWork
- Parameters:
ok
-true
if the work completed normallye
- the exception, if available
-
toString
public String toString()
- Overrides:
toString
in classAbstractWork
-
-