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