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.ConfigurationClient;
031import org.opends.server.admin.ManagedObjectDefinition;
032import org.opends.server.admin.PropertyException;
033import org.opends.server.admin.std.server.WorkQueueCfg;
034
035
036
037/**
038 * A client-side interface for reading and modifying Work Queue
039 * settings.
040 * <p>
041 * The Work Queue provides the configuration for the server work queue
042 * and is responsible for ensuring that requests received from clients
043 * are processed in a timely manner.
044 */
045public interface WorkQueueCfgClient extends ConfigurationClient {
046
047  /**
048   * Get the configuration definition associated with this Work Queue.
049   *
050   * @return Returns the configuration definition associated with this Work Queue.
051   */
052  ManagedObjectDefinition<? extends WorkQueueCfgClient, ? extends WorkQueueCfg> definition();
053
054
055
056  /**
057   * Gets the "java-class" property.
058   * <p>
059   * Specifies the fully-qualified name of the Java class that
060   * provides the Work Queue implementation.
061   *
062   * @return Returns the value of the "java-class" property.
063   */
064  String getJavaClass();
065
066
067
068  /**
069   * Sets the "java-class" property.
070   * <p>
071   * Specifies the fully-qualified name of the Java class that
072   * provides the Work Queue implementation.
073   *
074   * @param value The value of the "java-class" property.
075   * @throws PropertyException
076   *           If the new value is invalid.
077   */
078  void setJavaClass(String value) throws PropertyException;
079
080}