org.nuxeo.ecm.platform.picture

Class PictureViewsGenerationWork

java.lang.Object

org.nuxeo.ecm.core.work.AbstractWork

org.nuxeo.ecm.platform.picture.PictureViewsGenerationWork

All Implemented Interfaces:

Serializable, Work

public class PictureViewsGenerationWork
extends AbstractWork

Work generating the different picture views for a Picture.

Since:

5.7

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_PICTURE_GENERATION
static String	PICTURE_VIEWS_GENERATION_DONE_EVENT
protected String	xpath

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

callerThread, completionTime, docId, docIds, FAILURE_EXCEPTION, FAILURE_MSG, id, isTree, loginContext, originatingUsername, progress, RANDOM, repositoryName, schedulePath, schedulingTime, session, startTime, state, status, suspended, suspending, WORK_FAILED_EVENT, WORK_INSTANCE

Constructor Summary

Constructors

Constructor and Description
PictureViewsGenerationWork(String repositoryName, String docId, String xpath)

Method Summary

Modifier and Type	Method and Description
protected void	firePictureViewsGenerationDoneEvent(DocumentModel doc) Fire a PICTURE_VIEWS_GENERATION_DONE_EVENT event when no other PictureViewsGenerationWork is scheduled for this document.
String	getCategory() Gets the category for this work.
int	getRetryCount() Gets the number of times that this Work instance can be retried in case of concurrent update exceptions.
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

buildWorkFailureEventProps, cleanUp, closeSession, commitOrRollbackTransaction, equals, getCompletionTime, getDocument, getDocuments, getId, getOriginatingUsername, getPartitionKey, getProgress, 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, 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, isIdempotent

Field Detail

CATEGORY_PICTURE_GENERATION

public static final String CATEGORY_PICTURE_GENERATION

See Also:

Constant Field Values

PICTURE_VIEWS_GENERATION_DONE_EVENT

public static final String PICTURE_VIEWS_GENERATION_DONE_EVENT

See Also:

Constant Field Values

xpath

protected final String xpath

Constructor Detail

PictureViewsGenerationWork

public PictureViewsGenerationWork(String repositoryName,
                                  String docId,
                                  String xpath)

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

getRetryCount

public int getRetryCount()

Description copied from class: AbstractWork

Gets the number of times that this Work instance can be retried in case of concurrent update exceptions.

Overrides:

getRetryCount in class AbstractWork

Returns:

0 for no retry, or more if some retries are possible

See Also:

AbstractWork.work()

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)

firePictureViewsGenerationDoneEvent

protected void firePictureViewsGenerationDoneEvent(DocumentModel doc)

Fire a PICTURE_VIEWS_GENERATION_DONE_EVENT event when no other PictureViewsGenerationWork is scheduled for this document.

Since:

5.8