001 /*
002 * CDDL HEADER START
003 *
004 * The contents of this file are subject to the terms of the
005 * Common Development and Distribution License, Version 1.0 only
006 * (the "License"). You may not use this file except in compliance
007 * with the License.
008 *
009 * You can obtain a copy of the license at
010 * trunk/opends/resource/legal-notices/OpenDS.LICENSE
011 * or https://OpenDS.dev.java.net/OpenDS.LICENSE.
012 * See the License for the specific language governing permissions
013 * and limitations under the License.
014 *
015 * When distributing Covered Code, include this CDDL HEADER in each
016 * file and include the License file at
017 * trunk/opends/resource/legal-notices/OpenDS.LICENSE. If applicable,
018 * add the following below this CDDL HEADER, with the fields enclosed
019 * by brackets "[]" replaced with your own identifying information:
020 * Portions Copyright [yyyy] [name of copyright owner]
021 *
022 * CDDL HEADER END
023 *
024 *
025 * Copyright 2008 Sun Microsystems, Inc.
026 */
027 package org.opends.server.admin.std.server;
028
029
030
031 import org.opends.server.admin.server.ConfigurationChangeListener;
032
033
034
035 /**
036 * A server-side interface for querying Traditional Work Queue
037 * settings.
038 * <p>
039 * The Traditional Work Queue is a type of work queue that uses a
040 * number of worker threads that watch a queue and pick up an operation
041 * to process whenever one becomes available.
042 */
043 public interface TraditionalWorkQueueCfg extends WorkQueueCfg {
044
045 /**
046 * Gets the configuration class associated with this Traditional Work Queue.
047 *
048 * @return Returns the configuration class associated with this Traditional Work Queue.
049 */
050 Class<? extends TraditionalWorkQueueCfg> configurationClass();
051
052
053
054 /**
055 * Register to be notified when this Traditional Work Queue is changed.
056 *
057 * @param listener
058 * The Traditional Work Queue configuration change listener.
059 */
060 void addTraditionalChangeListener(ConfigurationChangeListener<TraditionalWorkQueueCfg> listener);
061
062
063
064 /**
065 * Deregister an existing Traditional Work Queue configuration change listener.
066 *
067 * @param listener
068 * The Traditional Work Queue configuration change listener.
069 */
070 void removeTraditionalChangeListener(ConfigurationChangeListener<TraditionalWorkQueueCfg> listener);
071
072
073
074 /**
075 * Gets the "java-class" property.
076 * <p>
077 * Specifies the fully-qualified name of the Java class that
078 * provides the Traditional Work Queue implementation.
079 *
080 * @return Returns the value of the "java-class" property.
081 */
082 String getJavaClass();
083
084
085
086 /**
087 * Gets the "max-work-queue-capacity" property.
088 * <p>
089 * Specifies the maximum number of queued operations that can be in
090 * the work queue at any given time.
091 * <p>
092 * If the work queue is already full and additional requests are
093 * received by the server, the requests are rejected. A value of zero
094 * indicates that there is no limit to the size of the queue.
095 *
096 * @return Returns the value of the "max-work-queue-capacity" property.
097 */
098 Integer getMaxWorkQueueCapacity();
099
100
101
102 /**
103 * Gets the "num-worker-threads" property.
104 * <p>
105 * Specifies the number of worker threads to be used for processing
106 * operations placed in the queue.
107 * <p>
108 * If the value is increased, the additional worker threads are
109 * created immediately. If the value is reduced, the appropriate
110 * number of threads are destroyed as operations complete processing.
111 *
112 * @return Returns the value of the "num-worker-threads" property.
113 */
114 int getNumWorkerThreads();
115
116 }