<?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
|
! trunk/opends/resource/legal-notices/OpenDS.LICENSE
|
! or https://OpenDS.dev.java.net/OpenDS.LICENSE.
|
! 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
|
! trunk/opends/resource/legal-notices/OpenDS.LICENSE. 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
|
!
|
!
|
! Portions Copyright 2007 Sun Microsystems, Inc.
|
! -->
|
<adm:managed-object name="traditional-work-queue"
|
plural-name="traditional-work-queues" extends="work-queue"
|
package="org.opends.server.admin.std"
|
xmlns:adm="http://www.opends.org/admin"
|
xmlns:ldap="http://www.opends.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 named that because its implementation
|
is similar to that used by the Sun Java System Directory Server.
|
The traditional work queue is a FIFO queue serviced by a fixed
|
number of worker threads. However, there are a couple of notable
|
differences in its design: 1) The number of worker threads is fixed,
|
but it can be changed on the fly and those changes take effect
|
immediately. In the Sun Java System Directory Server, changes to the
|
number of worker threads require a server restart to take effect.
|
2) The work queue in the Sun Java System Directory Server is
|
unbounded. If all threads are busy processing existing operations
|
and new requests arrive, they continue to accumulate in the work
|
queue and the server appears to be frozen. In the OpenDS Directory
|
Server, it is possible to place a size limit on the work queue.
|
When this number of operations are in the queue, waiting to be
|
picked up by threads, any new requests received 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 name="num-worker-threads" mandatory="true">
|
<adm:synopsis>
|
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.
|
</adm:synopsis>
|
<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, the requests are rejected.
|
A value of zero indicates that there is no limit to the size
|
of the queue.
|
</adm:description>
|
<adm:requires-admin-action>
|
<adm:server-restart />
|
</adm:requires-admin-action>
|
<adm:default-behavior>
|
<adm:alias>
|
<adm:synopsis>
|
The work queue does not impose any limit on the number of
|
operations that can be enqueued at any one time.
|
</adm:synopsis>
|
</adm:alias>
|
</adm:default-behavior>
|
<adm:syntax>
|
<adm:integer lower-limit="0" 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>
|
