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.client;
017
018
019
020import org.forgerock.opendj.config.ManagedObjectDefinition;
021import org.forgerock.opendj.config.PropertyException;
022import org.forgerock.opendj.server.config.server.TraditionalWorkQueueCfg;
023
024
025
026/**
027 * A client-side interface for reading and modifying Traditional Work
028 * Queue settings.
029 * <p>
030 * The Traditional Work Queue is a type of work queue that uses a
031 * number of worker threads that watch a queue and pick up an operation
032 * to process whenever one becomes available.
033 */
034public interface TraditionalWorkQueueCfgClient extends WorkQueueCfgClient {
035
036  /**
037   * Get the configuration definition associated with this Traditional Work Queue.
038   *
039   * @return Returns the configuration definition associated with this Traditional Work Queue.
040   */
041  ManagedObjectDefinition<? extends TraditionalWorkQueueCfgClient, ? extends TraditionalWorkQueueCfg> definition();
042
043
044
045  /**
046   * Gets the "java-class" property.
047   * <p>
048   * Specifies the fully-qualified name of the Java class that
049   * provides the Traditional Work Queue implementation.
050   *
051   * @return Returns the value of the "java-class" property.
052   */
053  String getJavaClass();
054
055
056
057  /**
058   * Sets the "java-class" property.
059   * <p>
060   * Specifies the fully-qualified name of the Java class that
061   * provides the Traditional Work Queue implementation.
062   *
063   * @param value The value of the "java-class" property.
064   * @throws PropertyException
065   *           If the new value is invalid.
066   */
067  void setJavaClass(String value) throws PropertyException;
068
069
070
071  /**
072   * Gets the "max-work-queue-capacity" property.
073   * <p>
074   * Specifies the maximum number of queued operations that can be in
075   * the work queue at any given time.
076   * <p>
077   * If the work queue is already full and additional requests are
078   * received by the server, then the server front end, and possibly
079   * the client, will be blocked until the work queue has available
080   * capacity.
081   *
082   * @return Returns the value of the "max-work-queue-capacity" property.
083   */
084  int getMaxWorkQueueCapacity();
085
086
087
088  /**
089   * Sets the "max-work-queue-capacity" property.
090   * <p>
091   * Specifies the maximum number of queued operations that can be in
092   * the work queue at any given time.
093   * <p>
094   * If the work queue is already full and additional requests are
095   * received by the server, then the server front end, and possibly
096   * the client, will be blocked until the work queue has available
097   * capacity.
098   *
099   * @param value The value of the "max-work-queue-capacity" property.
100   * @throws PropertyException
101   *           If the new value is invalid.
102   */
103  void setMaxWorkQueueCapacity(Integer value) throws PropertyException;
104
105
106
107  /**
108   * Gets the "num-worker-threads" property.
109   * <p>
110   * Specifies the number of worker threads to be used for processing
111   * operations placed in the queue.
112   * <p>
113   * If the value is increased, the additional worker threads are
114   * created immediately. If the value is reduced, the appropriate
115   * number of threads are destroyed as operations complete processing.
116   *
117   * @return Returns the value of the "num-worker-threads" property.
118   */
119  Integer getNumWorkerThreads();
120
121
122
123  /**
124   * Sets the "num-worker-threads" property.
125   * <p>
126   * Specifies the number of worker threads to be used for processing
127   * operations placed in the queue.
128   * <p>
129   * If the value is increased, the additional worker threads are
130   * created immediately. If the value is reduced, the appropriate
131   * number of threads are destroyed as operations complete processing.
132   *
133   * @param value The value of the "num-worker-threads" property.
134   * @throws PropertyException
135   *           If the new value is invalid.
136   */
137  void setNumWorkerThreads(Integer value) throws PropertyException;
138
139}