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 Parallel Work Queue settings.
036 * <p>
037 * The Parallel Work Queue is a type of work queue that uses a number
038 * of worker threads that watch a queue and pick up an operation to
039 * process whenever one becomes available.
040 */
041public interface ParallelWorkQueueCfg extends WorkQueueCfg {
042
043  /**
044   * Gets the configuration class associated with this Parallel Work Queue.
045   *
046   * @return Returns the configuration class associated with this Parallel Work Queue.
047   */
048  Class<? extends ParallelWorkQueueCfg> configurationClass();
049
050
051
052  /**
053   * Register to be notified when this Parallel Work Queue is changed.
054   *
055   * @param listener
056   *          The Parallel Work Queue configuration change listener.
057   */
058  void addParallelChangeListener(ConfigurationChangeListener<ParallelWorkQueueCfg> listener);
059
060
061
062  /**
063   * Deregister an existing Parallel Work Queue configuration change listener.
064   *
065   * @param listener
066   *          The Parallel Work Queue configuration change listener.
067   */
068  void removeParallelChangeListener(ConfigurationChangeListener<ParallelWorkQueueCfg> listener);
069
070
071
072  /**
073   * Gets the "java-class" property.
074   * <p>
075   * Specifies the fully-qualified name of the Java class that
076   * provides the Parallel Work Queue implementation.
077   *
078   * @return Returns the value of the "java-class" property.
079   */
080  String getJavaClass();
081
082
083
084  /**
085   * Gets the "num-worker-threads" property.
086   * <p>
087   * Specifies the number of worker threads to be used for processing
088   * operations placed in the queue.
089   * <p>
090   * If the value is increased, the additional worker threads are
091   * created immediately. If the value is reduced, the appropriate
092   * number of threads are destroyed as operations complete processing.
093   *
094   * @return Returns the value of the "num-worker-threads" property.
095   */
096  Integer getNumWorkerThreads();
097
098}