Package org.nuxeo.ecm.platform.video.service

Class VideoStoryboardWork

java.lang.Object

org.nuxeo.ecm.core.work.AbstractWork

org.nuxeo.ecm.platform.video.service.VideoStoryboardWork

All Implemented Interfaces:

Serializable, Work

public class VideoStoryboardWork
extends AbstractWork

Work to process the storyboard of a Video document.

Since:

10.1

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
static String	CATEGORY_VIDEO_STORYBOARD

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
VideoStoryboardWork(String repositoryName, String docId)

Method Summary

Modifier and Type	Method	Description
protected static String	computeIdPrefix(String repositoryName, String docId)
String	getCategory()	Gets the category for this work.
String	getTitle()	Gets a human-readable name for this work instance.
boolean	isIdempotent()	Returns true if a work with a given Work.getId() should always produce the same result.
protected boolean	updatePreviews(DocumentModel doc, Blob blob)
protected boolean	updateStoryboard(DocumentModel doc, Blob blob)
void	work()	This method should implement the actual work done by the Work 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, initSession, initSession, 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 Detail

CATEGORY_VIDEO_STORYBOARD

public static final String CATEGORY_VIDEO_STORYBOARD

See Also:

Constant Field Values

Constructor Detail

VideoStoryboardWork

public VideoStoryboardWork(String repositoryName,
                           String docId)

Method Detail

computeIdPrefix

protected static String computeIdPrefix(String repositoryName,
                                        String docId)

isIdempotent

public boolean isIdempotent()

Description copied from interface: Work

Returns true if a work with a given Work.getId() should always produce the same result. The WorkManager implementation can safely skip duplicate executions of idempotent work.

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()

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 Work.cleanUp(boolean, Exception).

Specified by:

work in interface Work

Specified by:

work in class AbstractWork

See Also:

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

updateStoryboard

protected boolean updateStoryboard(DocumentModel doc,
                                   Blob blob)

updatePreviews

protected boolean updatePreviews(DocumentModel doc,
                                 Blob blob)