Package org.nuxeo.ecm.platform.threed.service

Class ThreeDBatchUpdateWork

java.lang.Object

org.nuxeo.ecm.core.work.AbstractWork

org.nuxeo.ecm.platform.threed.service.ThreeDBatchUpdateWork

All Implemented Interfaces:

Serializable, Work

public class ThreeDBatchUpdateWork
extends AbstractWork

Work running batch conversions to update 3D document type preview assets

Since:

8.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	Description
static final String	CATEGORY_THREED_CONVERSION
protected static final String	STATUS_DONE
static final String	THREED_CONVERSIONS_DONE_EVENT

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

Method Summary

Modifier and Type	Method	Description
protected static String	computeIdPrefix(String repositoryName, String docId)
protected void	fireThreeDConversionsDoneEvent(DocumentModel doc)	Fire a THREED_CONVERSIONS_DONE_EVENT
String	getCategory()	Gets the category for this work.
String	getPartitionKey()	Returns a key that can be used by the WorkManager implementation to guarantee that works with the same partition key will be executed in the order they are submitted.
protected ThreeD	getThreeDToConvert(DocumentModel doc)
String	getTitle()	Gets a human-readable name for this work instance.
boolean	isGroupJoin()	When true the Work is part of a group, Works of the group have the same Work.getPartitionKey().
boolean	isIdempotent()	Returns true if a work with a given Work.getId() should always produce the same result.
void	onGroupJoinCompletion()	Called when Work.isGroupJoin() returns true and after the last Work of the group.
protected void	saveMainInfo(DocumentModel doc, ThreeDInfo info)
protected void	saveNewProperties(DocumentModel doc, Serializable properties, String schema)
protected void	saveNewRenderViews(DocumentModel doc, List<ThreeDRenderView> threeDRenderViews)
protected void	saveNewTransmissionThreeDs(DocumentModel doc, List<TransmissionThreeD> transmissionThreeDs)
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, 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

Field Details

CATEGORY_THREED_CONVERSION

public static final String CATEGORY_THREED_CONVERSION

See Also:

• Constant Field Values

THREED_CONVERSIONS_DONE_EVENT

public static final String THREED_CONVERSIONS_DONE_EVENT

See Also:

• Constant Field Values

STATUS_DONE

protected static final String STATUS_DONE

See Also:

• Constant Field Values

Constructor Details

ThreeDBatchUpdateWork

public ThreeDBatchUpdateWork(String repositoryName,
 String docId)

Method Details

computeIdPrefix

protected static String computeIdPrefix(String repositoryName,
 String docId)

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

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.

isGroupJoin

public boolean isGroupJoin()

Description copied from interface: Work

When true the Work is part of a group, Works of the group have the same Work.getPartitionKey(). When all Works of the group are done the Work.onGroupJoinCompletion() hook is called.

getPartitionKey

public String getPartitionKey()

Description copied from interface: Work

Returns a key that can be used by the WorkManager implementation to guarantee that works with the same partition key will be executed in the order they are submitted.

Specified by:

getPartitionKey in interface Work

Overrides:

getPartitionKey in class AbstractWork

onGroupJoinCompletion

public void onGroupJoinCompletion()

Description copied from interface: Work

Called when Work.isGroupJoin() returns true and after the last Work of the group.

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)

getThreeDToConvert

protected ThreeD getThreeDToConvert(DocumentModel doc)

saveNewProperties

protected void saveNewProperties(DocumentModel doc,
 Serializable properties,
 String schema)

saveMainInfo

protected void saveMainInfo(DocumentModel doc,
 ThreeDInfo info)

saveNewTransmissionThreeDs

protected void saveNewTransmissionThreeDs(DocumentModel doc,
 List<TransmissionThreeD> transmissionThreeDs)

saveNewRenderViews

protected void saveNewRenderViews(DocumentModel doc,
 List<ThreeDRenderView> threeDRenderViews)

fireThreeDConversionsDoneEvent

protected void fireThreeDConversionsDoneEvent(DocumentModel doc)

Fire a THREED_CONVERSIONS_DONE_EVENT