org.nuxeo.ecm.core.convert.service

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

public class ConversionWork
extends TransientStoreWork

Work executing a given conversion.

Since:

7.4

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 String	converterName
protected String	destinationMimeType
protected String	inputEntryKey
protected Map<String,Serializable>	parameters

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, id, isTree, loginContext, originatingUsername, progress, RANDOM, repositoryName, schedulePath, schedulingTime, session, startTime, state, status, suspended, suspending

Constructor Summary

Constructors

Constructor and Description
ConversionWork(String converterName, String destinationMimeType, BlobHolder blobHolder, Map<String,Serializable> parameters)

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	getTitle() Gets a human-readable name for this work instance.
protected BlobHolder	retrieveInputBlobHolder()
protected void	storeInputBlobHolder(BlobHolder blobHolder)
void	work() This method should implement the actual work done by the Work instance.

Methods inherited from class org.nuxeo.ecm.core.transientstore.work.TransientStoreWork

computeEntryKey, computeEntryKey, containsBlobHolder, getBlobHolder, getEntryKey, getStore, putBlobHolder, putBlobHolder, removeBlobHolder

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

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

Methods inherited from class java.lang.Object

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

Field Detail

converterName

protected String converterName

destinationMimeType

protected String destinationMimeType

parameters

protected Map<String,Serializable> parameters

inputEntryKey

protected String inputEntryKey

Constructor Detail

ConversionWork

public ConversionWork(String converterName,
                      String destinationMimeType,
                      BlobHolder blobHolder,
                      Map<String,Serializable> parameters)

Method Detail

storeInputBlobHolder

protected void storeInputBlobHolder(BlobHolder blobHolder)

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)

retrieveInputBlobHolder

protected BlobHolder retrieveInputBlobHolder()

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

getTitle

public String getTitle()

Description copied from interface: Work

Gets a human-readable name for this work instance.

Returns:

a human-readable name