Configuration Reference Home
OpenDS - Traditional Work Queue

Traditional Work Queue

The Traditional Work Queue is a type of work queue that uses a number of worker threads that watch a queue and pick up an operation to process whenever one becomes available.

The traditional work queue is a FIFO queue serviced by a fixed number of worker threads. This fixed number of threads can be changed on the fly, with the change taking effect as soon as it is made. You can limit the size of the work queue to a specified number of operations. When this many operations are in the queue, waiting to be picked up by threads, any new requests are rejected with an error message.

Parent Component

The Traditional Work Queue component inherits from the Work Queue




This page describes the Traditional Work Queue:


Properties

A description of each property follows.


Basic Properties: Advanced Properties:
↓ max-work-queue-capacity ↓ java-class
↓ num-worker-threads

Basic Properties

max-work-queue-capacity

Description
Specifies the maximum number of queued operations that can be in the work queue at any given time. If the work queue is already full and additional requests are received by the server, the requests are rejected. A value of zero indicates that there is no limit to the size of the queue.
Default Value
The work queue does not impose any limit on the number of operations that can be enqueued at any one time.
Allowed Values
An integer value. Lower value is 0. Upper value is 2147483647 .
Multi-valued
No
Required
No
Admin Action Required
Restart the server
Advanced Property
No
Read-only
No

num-worker-threads

Description
Specifies the number of worker threads to be used for processing operations placed in the queue. If the value is increased, the additional worker threads are created immediately. If the value is reduced, the appropriate number of threads are destroyed as operations complete processing.
Default Value
Let the server decide.
Allowed Values
An integer value. Lower value is 1. Upper value is 2147483647 .
Multi-valued
No
Required
No
Admin Action Required
None
Advanced Property
No
Read-only
No


Advanced Properties

java-class

Description
Specifies the fully-qualified name of the Java class that provides the Traditional Work Queue implementation.
Default Value
org.opends.server.extensions.TraditionalWorkQueue
Allowed Values
A java class that implements or extends the class(es) :
org.opends.server.api.WorkQueue
Multi-valued
No
Required
Yes
Admin Action Required
Restart the server
Advanced Property
Yes
Read-only
No


LDAP Mapping

Each configuration property can be mapped to a specific LDAP attribute under the "cn=config" entry. The mappings that follow are provided for information only. In general, you should avoid changing the server configuration by manipulating the LDAP attributes directly.

Base DN
cn=Work Queue,cn=config
objectclass name
ds-cfg-traditional-work-queue
objectclass superior
ds-cfg-work-queue

Property
LDAP attribute
java-class
ds-cfg-java-class
max-work-queue-capacity
ds-cfg-max-work-queue-capacity
num-worker-threads
ds-cfg-num-worker-threads