org.nuxeo.ecm.core.transientstore.work

Class TransientStoreWork

java.lang.Object

org.nuxeo.ecm.core.work.AbstractWork

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

All Implemented Interfaces:

Serializable, Work

Direct Known Subclasses:

ConversionWork

public abstract class TransientStoreWork
extends AbstractWork

A work allowing to store a result in the TransientStore.

Since:

7.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 and Description
protected String	entryKey
static String	KEY_SUFFIX
static String	STORE_NAME

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

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

Constructor Summary

Constructors

Constructor and Description
TransientStoreWork()
TransientStoreWork(String id)

Method Summary

Modifier and Type	Method and Description
protected void	computeEntryKey()
static BlobHolder	getBlobHolder(String key) Returns a BlobHolder representing the entry with the given key in the transient store used by the TransientStoreWork or null if the entry doesn't exist.
protected static TransientStore	getStore()
String	getWorkInstanceResult() CALLED BY THE WORK MANAGER (not user code) to get this work instance's result.
protected void	putBlobHolder(BlobHolder bh)
static void	putBlobHolder(String key, BlobHolder bh) Stores the given BlobHolder as an entry with the given key in the transient store used by the TransientStoreWork.
static void	removeBlobHolder(String key)

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

cleanUp, closeSession, commitOrRollbackTransaction, equals, getCategory, getCompletionTime, getDocument, getDocuments, getId, getProgress, getRetryCount, getSchedulePath, getSchedulingTime, getStartTime, getState, getStatus, getUserId, getWorkInstanceState, hashCode, initSession, initSession, isDocumentTree, isSuspending, isWorkInstanceSuspended, newDocumentLocation, run, runWorkWithTransaction, runWorkWithTransactionAndCheckExceptions, setCompletionTime, setDocument, setDocument, setDocuments, setProgress, setSchedulePath, setStartTime, setStatus, setWorkInstanceState, setWorkInstanceSuspending, startTransaction, suspended, toString, work

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

getTitle

Field Detail

STORE_NAME

public static final String STORE_NAME

See Also:

Constant Field Values

KEY_SUFFIX

public static final String KEY_SUFFIX

See Also:

Constant Field Values

entryKey

protected String entryKey

Constructor Detail

TransientStoreWork

public TransientStoreWork()

TransientStoreWork

public TransientStoreWork(String id)

Method Detail

putBlobHolder

public static void putBlobHolder(String key,
                                 BlobHolder bh)

Stores the given BlobHolder as an entry with the given key in the transient store used by the TransientStoreWork.

getBlobHolder

public static BlobHolder getBlobHolder(String key)

Returns a BlobHolder representing the entry with the given key in the transient store used by the TransientStoreWork or null if the entry doesn't exist.

removeBlobHolder

public static void removeBlobHolder(String key)

getStore

protected static TransientStore getStore()

computeEntryKey

protected void computeEntryKey()

putBlobHolder

protected void putBlobHolder(BlobHolder bh)

getWorkInstanceResult

public String getWorkInstanceResult()

Description copied from interface: Work

CALLED BY THE WORK MANAGER (not user code) to get this work instance's result.

Specified by:

getWorkInstanceResult in interface Work

Overrides:

getWorkInstanceResult in class AbstractWork