Package org.nuxeo.ecm.core.work.api

Class WorkQueueDescriptor

java.lang.Object

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

All Implemented Interfaces:

Descriptor

public class WorkQueueDescriptor
extends Object
implements Descriptor

Descriptor for a WorkManager queue configuration.

Since:

5.6

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ALL_QUEUES
Integer	capacity	When specified, make the blocking queue bounded, so submission will block until space become available.
Set<String>	categories
static final int	DEFAULT_CAPACITY
static final int	DEFAULT_CLEAR_COMPLETED_AFTER_SECONDS
static final int	DEFAULT_MAX_THREADS
String	id
Integer	maxThreads
String	name
Boolean	processing
Boolean	queuing

Fields inherited from interface org.nuxeo.runtime.model.Descriptor

UNIQUE_DESCRIPTOR_ID

Constructor Summary

Constructors

Constructor	Description
WorkQueueDescriptor()

Method Summary

Modifier and Type	Method	Description
int	getCapacity()
String	getId()	The descriptor id, descriptors with same id are merged.
int	getMaxThreads()
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.
Descriptor	merge(Descriptor o)	Returns a descriptor representing other merged into this
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.nuxeo.runtime.model.Descriptor

doesRemove

Field Details

ALL_QUEUES

public static final String ALL_QUEUES

See Also:

• Constant Field Values

DEFAULT_MAX_THREADS

public static final int DEFAULT_MAX_THREADS

See Also:

• Constant Field Values

DEFAULT_CLEAR_COMPLETED_AFTER_SECONDS

public static final int DEFAULT_CLEAR_COMPLETED_AFTER_SECONDS

See Also:

• Constant Field Values

DEFAULT_CAPACITY

public static final int DEFAULT_CAPACITY

See Also:

• Constant Field Values

id

public String id

queuing

public Boolean queuing

processing

public Boolean processing

name

public String name

maxThreads

public Integer maxThreads

categories

public Set<String> categories

capacity

public Integer 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 Details

WorkQueueDescriptor

public WorkQueueDescriptor()

Method Details

getId

public String getId()

Description copied from interface: Descriptor

The descriptor id, descriptors with same id are merged.

To forbid multiple descriptors use UNIQUE_DESCRIPTOR_ID.

To forbid merge use a unique value, non-overriden toString() for exemple.

Specified by:

getId in interface Descriptor

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.

getMaxThreads

public int getMaxThreads()

getCapacity

public int getCapacity()

merge

public Descriptor merge(Descriptor o)

Description copied from interface: Descriptor

Returns a descriptor representing other merged into this

Default implementation returns other.

Specified by:

merge in interface Descriptor

Returns:

the merged descriptor

toString

public String toString()

Overrides:

toString in class Object