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 legal-notices/CDDLv1_0.txt
010 * or http://forgerock.org/license/CDDLv1.0.html.
011 * See the License for the specific language governing permissions
012 * and limitations under the License.
013 *
014 * When distributing Covered Code, include this CDDL HEADER in each
015 * file and include the License file at legal-notices/CDDLv1_0.txt.
016 * If applicable, add the following below this CDDL HEADER, with the
017 * fields enclosed by brackets "[]" replaced with your own identifying
018 * information:
019 *      Portions Copyright [yyyy] [name of copyright owner]
020 *
021 * CDDL HEADER END
022 *
023 *
024 *      Copyright 2008 Sun Microsystems, Inc.
025 */
026package org.opends.server.admin.std.server;
027
028
029
030import org.opends.server.admin.server.ConfigurationChangeListener;
031
032
033
034/**
035 * A server-side interface for querying Traditional Work Queue
036 * settings.
037 * <p>
038 * The Traditional Work Queue is a type of work queue that uses a
039 * number of worker threads that watch a queue and pick up an operation
040 * to process whenever one becomes available.
041 */
042public interface TraditionalWorkQueueCfg extends WorkQueueCfg {
043
044  /**
045   * Gets the configuration class associated with this Traditional Work Queue.
046   *
047   * @return Returns the configuration class associated with this Traditional Work Queue.
048   */
049  Class<? extends TraditionalWorkQueueCfg> configurationClass();
050
051
052
053  /**
054   * Register to be notified when this Traditional Work Queue is changed.
055   *
056   * @param listener
057   *          The Traditional Work Queue configuration change listener.
058   */
059  void addTraditionalChangeListener(ConfigurationChangeListener<TraditionalWorkQueueCfg> listener);
060
061
062
063  /**
064   * Deregister an existing Traditional Work Queue configuration change listener.
065   *
066   * @param listener
067   *          The Traditional Work Queue configuration change listener.
068   */
069  void removeTraditionalChangeListener(ConfigurationChangeListener<TraditionalWorkQueueCfg> listener);
070
071
072
073  /**
074   * Gets the "java-class" property.
075   * <p>
076   * Specifies the fully-qualified name of the Java class that
077   * provides the Traditional Work Queue implementation.
078   *
079   * @return Returns the value of the "java-class" property.
080   */
081  String getJavaClass();
082
083
084
085  /**
086   * Gets the "max-work-queue-capacity" property.
087   * <p>
088   * Specifies the maximum number of queued operations that can be in
089   * the work queue at any given time.
090   * <p>
091   * If the work queue is already full and additional requests are
092   * received by the server, then the server front end, and possibly
093   * the client, will be blocked until the work queue has available
094   * capacity.
095   *
096   * @return Returns the value of the "max-work-queue-capacity" property.
097   */
098  int 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  Integer getNumWorkerThreads();
115
116}