org.nuxeo.binary.metadata.internals

Class BinaryMetadataWork

java.lang.Object

org.nuxeo.ecm.core.work.AbstractWork

org.nuxeo.binary.metadata.internals.BinaryMetadataWork

All Implemented Interfaces:

Serializable, Work

public class BinaryMetadataWork
extends AbstractWork

Work handling binary metadata updates.

Since:

7.2

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	BINARY_METADATA_WORK_TITLE
protected String	docId
protected List<MetadataMappingDescriptor>	mappingDescriptors

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

callerThread, completionTime, docIds, id, isTree, loginContext, originatingUsername, progress, RANDOM, repositoryName, schedulePath, schedulingTime, session, startTime, state, status, suspended, suspending

Constructor Summary

Constructors

Constructor and Description
BinaryMetadataWork(String repositoryName, String docId, List<MetadataMappingDescriptor> mappingDescriptors)

Method Summary

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, 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

BINARY_METADATA_WORK_TITLE

public static final String BINARY_METADATA_WORK_TITLE

See Also:

Constant Field Values

mappingDescriptors

protected final List<MetadataMappingDescriptor> mappingDescriptors

docId

protected final String docId

Constructor Detail

BinaryMetadataWork

public BinaryMetadataWork(String repositoryName,
                          String docId,
                          List<MetadataMappingDescriptor> mappingDescriptors)

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

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)