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.TraditionalWorkQueueCfg;
033
034
035
036/**
037 * A client-side interface for reading and modifying Traditional Work
038 * Queue settings.
039 * <p>
040 * The Traditional Work Queue is a type of work queue that uses a
041 * number of worker threads that watch a queue and pick up an operation
042 * to process whenever one becomes available.
043 */
044public interface TraditionalWorkQueueCfgClient extends WorkQueueCfgClient {
045
046  /**
047   * Get the configuration definition associated with this Traditional Work Queue.
048   *
049   * @return Returns the configuration definition associated with this Traditional Work Queue.
050   */
051  ManagedObjectDefinition<? extends TraditionalWorkQueueCfgClient, ? extends TraditionalWorkQueueCfg> 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 Traditional 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 Traditional 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 "max-work-queue-capacity" property.
083   * <p>
084   * Specifies the maximum number of queued operations that can be in
085   * the work queue at any given time.
086   * <p>
087   * If the work queue is already full and additional requests are
088   * received by the server, then the server front end, and possibly
089   * the client, will be blocked until the work queue has available
090   * capacity.
091   *
092   * @return Returns the value of the "max-work-queue-capacity" property.
093   */
094  int getMaxWorkQueueCapacity();
095
096
097
098  /**
099   * Sets the "max-work-queue-capacity" property.
100   * <p>
101   * Specifies the maximum number of queued operations that can be in
102   * the work queue at any given time.
103   * <p>
104   * If the work queue is already full and additional requests are
105   * received by the server, then the server front end, and possibly
106   * the client, will be blocked until the work queue has available
107   * capacity.
108   *
109   * @param value The value of the "max-work-queue-capacity" property.
110   * @throws PropertyException
111   *           If the new value is invalid.
112   */
113  void setMaxWorkQueueCapacity(Integer value) throws PropertyException;
114
115
116
117  /**
118   * Gets the "num-worker-threads" property.
119   * <p>
120   * Specifies the number of worker threads to be used for processing
121   * operations placed in the queue.
122   * <p>
123   * If the value is increased, the additional worker threads are
124   * created immediately. If the value is reduced, the appropriate
125   * number of threads are destroyed as operations complete processing.
126   *
127   * @return Returns the value of the "num-worker-threads" property.
128   */
129  Integer getNumWorkerThreads();
130
131
132
133  /**
134   * Sets the "num-worker-threads" property.
135   * <p>
136   * Specifies the number of worker threads to be used for processing
137   * operations placed in the queue.
138   * <p>
139   * If the value is increased, the additional worker threads are
140   * created immediately. If the value is reduced, the appropriate
141   * number of threads are destroyed as operations complete processing.
142   *
143   * @param value The value of the "num-worker-threads" property.
144   * @throws PropertyException
145   *           If the new value is invalid.
146   */
147  void setNumWorkerThreads(Integer value) throws PropertyException;
148
149}