org.nuxeo.ecm.core.work

Class SleepWork

java.lang.Object

org.nuxeo.ecm.core.work.AbstractWork

org.nuxeo.ecm.core.work.SleepWork

All Implemented Interfaces:

Serializable, Work

public class SleepWork
extends AbstractWork

Simple work that just sleeps, mostly used for tests.

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	category
protected AtomicInteger	count
protected long	durationMillis
protected String	partitionKey

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
SleepWork(long durationMillis) Creates a work instance that does nothing but sleep.
SleepWork(long durationMillis, boolean debug) If debug is true, then the various debug* methods must be called in the proper order for the work to start and stop: #debugStart, #debugFinish.
SleepWork(long durationMillis, boolean debug, String id)
SleepWork(long durationMillis, String category, boolean debug)
SleepWork(long durationMillis, String category, boolean debug, String id)

Method Summary

Modifier and Type	Method and Description
protected void	doWork()
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.
String	getTitle() Gets a human-readable name for this work instance.
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, 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

Methods inherited from class java.lang.Object

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

Field Detail

durationMillis

protected long durationMillis

category

protected String category

count

protected AtomicInteger count

partitionKey

protected String partitionKey

Constructor Detail

SleepWork

public SleepWork(long durationMillis)

Creates a work instance that does nothing but sleep.

Parameters:

durationMillis - the sleep duration

SleepWork

public SleepWork(long durationMillis,
                 boolean debug)

If debug is true, then the various debug* methods must be called in the proper order for the work to start and stop: #debugStart, #debugFinish.

Parameters:

durationMillis - the sleep duration

debug - true for debug

SleepWork

public SleepWork(long durationMillis,
                 boolean debug,
                 String id)

SleepWork

public SleepWork(long durationMillis,
                 String category,
                 boolean debug)

SleepWork

public SleepWork(long durationMillis,
                 String category,
                 boolean debug,
                 String id)

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)

doWork

protected void doWork()
               throws InterruptedException

Throws:

InterruptedException

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

toString

public String toString()

Overrides:

toString in class AbstractWork