org.nuxeo.ecm.quota

Class QuotaStatsInitialWork

java.lang.Object

org.nuxeo.ecm.core.work.AbstractWork

org.nuxeo.ecm.quota.QuotaStatsInitialWork

All Implemented Interfaces:

Serializable, Work

public class QuotaStatsInitialWork
extends AbstractWork

Work doing an initial statistics computation for a defined QuotaStatsUpdater.

Since:

5.6

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_QUOTA_INITIAL

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

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

Constructor Summary

Constructors

Constructor and Description
QuotaStatsInitialWork(String updaterName, String repositoryName)

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	notifyProgress(float percent)
void	notifyProgress(long current, long total)
String	toString()
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, getProgress, getRetryCount, getSchedulePath, getSchedulingTime, getStartTime, getState, getStatus, getWorkInstanceState, hashCode, initSession, initSession, isDocumentTree, isSuspending, isWorkInstanceSuspended, newDocumentLocation, openSystemSession, openUserSession, run, runWorkWithTransaction, runWorkWithTransactionAndCheckExceptions, setCompletionTime, setDocument, setDocument, setDocuments, setOriginatingUsername, setProgress, setSchedulePath, setStartTime, setStatus, setWorkInstanceState, setWorkInstanceSuspending, startTransaction, suspended

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

CATEGORY_QUOTA_INITIAL

public static final String CATEGORY_QUOTA_INITIAL

See Also:

Constant Field Values

Constructor Detail

QuotaStatsInitialWork

public QuotaStatsInitialWork(String updaterName,
                             String repositoryName)

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

notifyProgress

public void notifyProgress(float percent)

notifyProgress

public void notifyProgress(long current,
                           long total)

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)

toString

public String toString()

Overrides:

toString in class AbstractWork