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.client;
027
028
029
030import org.opends.server.admin.ManagedObjectDefinition;
031import org.opends.server.admin.PropertyException;
032import org.opends.server.admin.std.server.ParallelWorkQueueCfg;
033
034
035
036/**
037 * A client-side interface for reading and modifying Parallel Work
038 * Queue settings.
039 * <p>
040 * The Parallel Work Queue is a type of work queue that uses a number
041 * of worker threads that watch a queue and pick up an operation to
042 * process whenever one becomes available.
043 */
044public interface ParallelWorkQueueCfgClient extends WorkQueueCfgClient {
045
046  /**
047   * Get the configuration definition associated with this Parallel Work Queue.
048   *
049   * @return Returns the configuration definition associated with this Parallel Work Queue.
050   */
051  ManagedObjectDefinition<? extends ParallelWorkQueueCfgClient, ? extends ParallelWorkQueueCfg> definition();
052
053
054
055  /**
056   * Gets the "java-class" property.
057   * <p>
058   * Specifies the fully-qualified name of the Java class that
059   * provides the Parallel Work Queue implementation.
060   *
061   * @return Returns the value of the "java-class" property.
062   */
063  String getJavaClass();
064
065
066
067  /**
068   * Sets the "java-class" property.
069   * <p>
070   * Specifies the fully-qualified name of the Java class that
071   * provides the Parallel Work Queue implementation.
072   *
073   * @param value The value of the "java-class" property.
074   * @throws PropertyException
075   *           If the new value is invalid.
076   */
077  void setJavaClass(String value) throws PropertyException;
078
079
080
081  /**
082   * Gets the "num-worker-threads" property.
083   * <p>
084   * Specifies the number of worker threads to be used for processing
085   * operations placed in the queue.
086   * <p>
087   * If the value is increased, the additional worker threads are
088   * created immediately. If the value is reduced, the appropriate
089   * number of threads are destroyed as operations complete processing.
090   *
091   * @return Returns the value of the "num-worker-threads" property.
092   */
093  Integer getNumWorkerThreads();
094
095
096
097  /**
098   * Sets the "num-worker-threads" property.
099   * <p>
100   * Specifies the number of worker threads to be used for processing
101   * operations placed in the queue.
102   * <p>
103   * If the value is increased, the additional worker threads are
104   * created immediately. If the value is reduced, the appropriate
105   * number of threads are destroyed as operations complete processing.
106   *
107   * @param value The value of the "num-worker-threads" property.
108   * @throws PropertyException
109   *           If the new value is invalid.
110   */
111  void setNumWorkerThreads(Integer value) throws PropertyException;
112
113}