org.nuxeo.ecm.automation.core.work

Class BlobListZipWork

java.lang.Object

org.nuxeo.ecm.core.work.AbstractWork

org.nuxeo.ecm.core.transientstore.work.TransientStoreWork

org.nuxeo.ecm.automation.core.work.BlobListZipWork

All Implemented Interfaces:

Serializable, Work

public class BlobListZipWork
extends TransientStoreWork

Work to zip a list of document default blob and store the produced zip into the TransientStore.

Since:

9.3

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	CACHE_NAME
static String	CATEGORY
protected List<String>	docIds
protected String	filename
protected String	key
protected String	storeName

Fields inherited from class org.nuxeo.ecm.core.transientstore.work.TransientStoreWork

entryKey, KEY_SUFFIX, STORE_NAME

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

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

Constructor Summary

Constructors

Constructor and Description
BlobListZipWork(String transientStoreKey, String originatingUsername, String filename, List<String> docIds)
BlobListZipWork(String transientStoreKey, String originatingUsername, String filename, List<String> docIds, String storeName)

Method Summary

Modifier and Type	Method and Description
void	cleanUp(boolean ok, Exception e) This method is called after AbstractWork.work() is done in a finally block, whether work completed normally or was in error or was interrupted.
String	getCategory() Gets the category for this work.
String	getTitle() Gets a human-readable name for this work instance.
TransientStore	getTransientStore()
protected void	updateAndCompleteStoreEntry(List<Blob> blobs)
void	work() This method should implement the actual work done by the Work instance.

Methods inherited from class org.nuxeo.ecm.core.transientstore.work.TransientStoreWork

computeEntryKey, computeEntryKey, containsBlobHolder, getBlobHolder, getEntryKey, getStore, putBlobHolder, putBlobHolder, removeBlobHolder

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

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

CATEGORY

public static final String CATEGORY

See Also:

Constant Field Values

CACHE_NAME

public static final String CACHE_NAME

See Also:

Constant Field Values

docIds

protected List<String> docIds

filename

protected String filename

key

protected final String key

storeName

protected final String storeName

Constructor Detail

BlobListZipWork

public BlobListZipWork(String transientStoreKey,
                       String originatingUsername,
                       String filename,
                       List<String> docIds)

BlobListZipWork

public BlobListZipWork(String transientStoreKey,
                       String originatingUsername,
                       String filename,
                       List<String> docIds,
                       String storeName)

Method Detail

cleanUp

public void cleanUp(boolean ok,
                    Exception e)

Description copied from class: AbstractWork

This method is called after AbstractWork.work() is done in a finally block, whether work completed normally or was in error or was interrupted.

Specified by:

cleanUp in interface Work

Overrides:

cleanUp in class AbstractWork

Parameters:

ok - true if the work completed normally

e - the exception, if available

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

getTransientStore

public TransientStore getTransientStore()

updateAndCompleteStoreEntry

protected void updateAndCompleteStoreEntry(List<Blob> blobs)

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)