TraditionalWorkQueueConfiguration.xml revision d70586b00b9530ab99ab4b8f003e9a54793e419f
<?xml version="1.0" encoding="utf-8"?>
<!--
! CDDL HEADER START
!
! The contents of this file are subject to the terms of the
! Common Development and Distribution License, Version 1.0 only
! (the "License"). You may not use this file except in compliance
! with the License.
!
! You can obtain a copy of the license at legal-notices/CDDLv1_0.txt
! See the License for the specific language governing permissions
! and limitations under the License.
!
! When distributing Covered Code, include this CDDL HEADER in each
! file and include the License file at legal-notices/CDDLv1_0.txt.
! If applicable, add the following below this CDDL HEADER, with the
! fields enclosed by brackets "[]" replaced with your own identifying
! information:
! Portions Copyright [yyyy] [name of copyright owner]
!
! CDDL HEADER END
!
!
! Copyright 2007-2010 Sun Microsystems, Inc.
! -->
<adm:managed-object name="traditional-work-queue"
plural-name="traditional-work-queues" extends="work-queue"
package="org.forgerock.opendj.server.config"
xmlns:adm="http://opendj.forgerock.org/admin"
xmlns:ldap="http://opendj.forgerock.org/admin-ldap">
<adm:synopsis>
The
<adm:user-friendly-name />
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.
</adm:synopsis>
<adm:description>
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.
</adm:description>
<adm:profile name="ldap">
<ldap:object-class>
<ldap:name>ds-cfg-traditional-work-queue</ldap:name>
<ldap:superior>ds-cfg-work-queue</ldap:superior>
</ldap:object-class>
</adm:profile>
<adm:property-override name="java-class" advanced="true">
<adm:default-behavior>
<adm:defined>
<adm:value>
</adm:value>
</adm:defined>
</adm:default-behavior>
</adm:property-override>
<adm:property name="num-worker-threads">
<adm:synopsis>
Specifies the number of worker threads to be used for processing
operations placed in the queue.
</adm:synopsis>
<adm:description>
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.
</adm:description>
<adm:default-behavior>
<adm:alias>
<adm:synopsis>
Let the server decide.
</adm:synopsis>
</adm:alias>
</adm:default-behavior>
<adm:syntax>
<adm:integer lower-limit="1" upper-limit="2147483647" />
</adm:syntax>
<adm:profile name="ldap">
<ldap:attribute>
<ldap:name>ds-cfg-num-worker-threads</ldap:name>
</ldap:attribute>
</adm:profile>
</adm:property>
<adm:property name="max-work-queue-capacity">
<adm:synopsis>
Specifies the maximum number of queued operations that can be in the work
queue at any given time.
</adm:synopsis>
<adm:description>
If the work queue is already full and additional requests are
received by the server, then the server front end, and possibly the
client, will be blocked until the work queue has available capacity.
</adm:description>
<adm:default-behavior>
<adm:defined>
<adm:value>1000</adm:value>
</adm:defined>
</adm:default-behavior>
<adm:syntax>
<adm:integer lower-limit="1" upper-limit="2147483647"/>
</adm:syntax>
<adm:profile name="ldap">
<ldap:attribute>
<ldap:name>ds-cfg-max-work-queue-capacity</ldap:name>
</ldap:attribute>
</adm:profile>
</adm:property>
</adm:managed-object>