Class ConversionWork
java.lang.Object
org.nuxeo.ecm.core.work.AbstractWork
org.nuxeo.ecm.core.transientstore.work.TransientStoreWork
org.nuxeo.ecm.core.convert.service.ConversionWork
- All Implemented Interfaces:
Serializable
,Work
Work executing a given conversion.
- Since:
- 7.4
- 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 String
protected String
protected String
protected ManagedBlob
protected Map<String,
Serializable> Fields inherited from class org.nuxeo.ecm.core.transientstore.work.TransientStoreWork
entryKey, KEY_SUFFIX, STORE_NAME
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
ConstructorDescriptionConversionWork
(String converterName, String destinationMimeType, BlobHolder blobHolder, Map<String, Serializable> parameters) -
Method Summary
Modifier and TypeMethodDescriptionvoid
This method is called afterAbstractWork.work()
is done in a finally block, whether work completed normally or was in error or was interrupted.getTitle()
Gets a human-readable name for this work instance.protected BlobHolder
protected void
storeInputBlobHolder
(BlobHolder blobHolder) protected boolean
storeManagedBlob
(BlobHolder blobHolder) void
work()
This method should implement the actual work done by theWork
instance.Methods inherited from class org.nuxeo.ecm.core.transientstore.work.TransientStoreWork
computeEntryKey, computeEntryKey, containsBlobHolder, getBlobHolder, getEntryKey, getStore, isIdempotent, putBlobHolder, putBlobHolder, removeBlobHolder
Methods inherited from class org.nuxeo.ecm.core.work.AbstractWork
appendWorkToDeadLetterQueue, buildWorkFailureEventProps, closeSession, commitOrRollbackTransaction, equals, getCategory, 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
-
converterName
-
destinationMimeType
-
parameters
-
inputEntryKey
-
managedBlob
- Since:
- 10.1
-
-
Constructor Details
-
ConversionWork
public ConversionWork(String converterName, String destinationMimeType, BlobHolder blobHolder, Map<String, Serializable> parameters)
-
-
Method Details
-
storeInputBlobHolder
-
storeManagedBlob
- Since:
- 10.1
-
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:
-
retrieveInputBlobHolder
-
cleanUp
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
-
getTitle
Description copied from interface:Work
Gets a human-readable name for this work instance.- Returns:
- a human-readable name
-