org.nuxeo.ecm.core.work.api

Class WorkQueueDescriptor

java.lang.Object

org.nuxeo.ecm.core.work.api.WorkQueueDescriptor

public class WorkQueueDescriptor
extends Object

Descriptor for a WorkManager queue configuration.

Since:

5.6

Field Summary

Fields

Modifier and Type	Field and Description
static String	ALL_QUEUES
int	capacity When specified, make the blocking queue bounded, so submission will block until space become available.
Set<String>	categories
int	clearCompletedAfterSeconds
String	id
int	maxThreads
String	name
Boolean	processing
Boolean	queuing
boolean	usePriority If this is true, then a priority queue is used instead of a regular queue.

Constructor Summary

Constructors

Constructor and Description
WorkQueueDescriptor()

Method Summary

Methods

Modifier and Type	Method and Description
WorkQueueDescriptor	clone()
boolean	isProcessingEnabled() Whether processing of work instances from this queue is enabled for this Nuxeo instance.
boolean	isQueuingEnabled() Whether queuing of work instances to this queue is enabled for this Nuxeo instance.
void	merge(WorkQueueDescriptor other)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ALL_QUEUES

public static final String ALL_QUEUES

See Also:

Constant Field Values

id

public String id

queuing

public Boolean queuing

processing

public Boolean processing

name

public String name

maxThreads

public int maxThreads

usePriority

public boolean usePriority

If this is true, then a priority queue is used instead of a regular queue. In this case, the Work instances in the queue must implement Comparable and are prioritized according to their compareTo() method.

Since:

5.7

clearCompletedAfterSeconds

public int clearCompletedAfterSeconds

categories

public Set<String> categories

capacity

public int capacity

When specified, make the blocking queue bounded, so submission will block until space become available. This option can not be used with a priority queue.

Since:

5.7

Constructor Detail

WorkQueueDescriptor

public WorkQueueDescriptor()

Method Detail

isQueuingEnabled

public boolean isQueuingEnabled()

Whether queuing of work instances to this queue is enabled for this Nuxeo instance.

isProcessingEnabled

public boolean isProcessingEnabled()

Whether processing of work instances from this queue is enabled for this Nuxeo instance.

clone

public WorkQueueDescriptor clone()

Overrides:

clone in class Object

merge

public void merge(WorkQueueDescriptor other)