Class BinaryMetadataUpdateWork
java.lang.Object
org.nuxeo.ecm.core.work.AbstractWork
org.nuxeo.binary.metadata.internals.BinaryMetadataUpdateWork
- All Implemented Interfaces:
Serializable
,Work
- Since:
- 2021.13
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from interface org.nuxeo.ecm.core.work.api.Work
Work.Progress, Work.State
-
Field Summary
Modifier and TypeFieldDescriptionprotected static final String
protected static final String
protected final List<MetadataMappingUpdate>
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
ConstructorDescriptionBinaryMetadataUpdateWork
(String repositoryName, String docId, List<MetadataMappingUpdate> metadataUpdates) -
Method Summary
Modifier and TypeMethodDescriptionGets the category for this work.getTitle()
Gets a human-readable name for this work instance.boolean
Returns true if a work with a givenWork.getId()
should always produce the same result.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, cleanUp, closeSession, commitOrRollbackTransaction, equals, getCompletionTime, getDocument, getDocuments, getId, getOriginatingUsername, getPartitionKey, getProgress, getRetryCount, getSchedulePath, getSchedulingTime, getSpanFromContext, getStartTime, getStatus, getWorkInstanceState, hashCode, isDocumentTree, isSuspending, isWorkInstanceSuspended, newDocumentLocation, openSystemSession, openUserSession, run, runWorkWithTransaction, setCompletionTime, setDocument, setDocument, setDocuments, setOriginatingUsername, setProgress, setSchedulePath, setStartTime, setStatus, setWorkInstanceState, setWorkInstanceSuspending, startTransaction, suspended, toString, 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, onGroupJoinCompletion
-
Field Details
-
BINARY_METADATA_WORK
- See Also:
-
BINARY_METADATA_WORK_TITLE
- See Also:
-
metadataUpdates
-
-
Constructor Details
-
BinaryMetadataUpdateWork
public BinaryMetadataUpdateWork(String repositoryName, String docId, List<MetadataMappingUpdate> metadataUpdates)
-
-
Method Details
-
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
Description copied from interface:Work
Gets a human-readable name for this work instance.- Returns:
- a human-readable name
-
isIdempotent
public boolean isIdempotent()Description copied from interface:Work
Returns true if a work with a givenWork.getId()
should always produce the same result. The WorkManager implementation can safely skip duplicate executions of idempotent 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:
-