org.nuxeo.ecm.platform.video.service

Class VideoConversionWork

java.lang.Object

org.nuxeo.ecm.core.work.AbstractWork

org.nuxeo.ecm.platform.video.service.VideoConversionWork

All Implemented Interfaces:

Serializable, Work

public class VideoConversionWork
extends AbstractWork

Work running a defined video conversion.

Since:

5.6

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
static String	CATEGORY_VIDEO_CONVERSION
static String	VIDEO_CONVERSIONS_DONE_EVENT

Constructor Summary

Constructors

Constructor and Description
VideoConversionWork(String repositoryName, String docId, String conversionName)

Method Summary

Methods

Modifier and Type	Method and Description
String	getCategory() Gets the category for this work.
String	getTitle() Gets a human-readable name for this work instance.
void	work() This method should implement the actual work done by the Work instance.

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

cleanUp, closeSession, commitOrRollbackTransaction, equals, getCompletionTime, getDocument, getDocuments, getId, getProgress, getRetryCount, getSchedulePath, getSchedulingTime, getStartTime, getState, getStatus, getUserId, getWorkInstanceState, hashCode, initSession, initSession, isDocumentTree, isSuspending, isWorkInstanceSuspended, retryableWork, rollbackAndRetryTransaction, setDocument, setDocument, setDocuments, setProgress, setSchedulePath, setStatus, setWorkInstanceState, setWorkInstanceSuspending, startTransaction, suspended, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

CATEGORY_VIDEO_CONVERSION

public static final String CATEGORY_VIDEO_CONVERSION

See Also:

Constant Field Values

VIDEO_CONVERSIONS_DONE_EVENT

public static final String VIDEO_CONVERSIONS_DONE_EVENT

See Also:

Constant Field Values

Constructor Detail

VideoConversionWork

public VideoConversionWork(String repositoryName,
                   String docId,
                   String conversionName)

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

work

public void work()
          throws Exception

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

Overrides:

work in class AbstractWork

Throws:

Exception

See Also:

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