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.ParallelWorkQueueCfg; 023 024 025 026/** 027 * A client-side interface for reading and modifying Parallel Work 028 * Queue settings. 029 * <p> 030 * The Parallel Work Queue is a type of work queue that uses a number 031 * of worker threads that watch a queue and pick up an operation to 032 * process whenever one becomes available. 033 */ 034public interface ParallelWorkQueueCfgClient extends WorkQueueCfgClient { 035 036 /** 037 * Get the configuration definition associated with this Parallel Work Queue. 038 * 039 * @return Returns the configuration definition associated with this Parallel Work Queue. 040 */ 041 ManagedObjectDefinition<? extends ParallelWorkQueueCfgClient, ? extends ParallelWorkQueueCfg> 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 Parallel 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 Parallel 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 "num-worker-threads" property. 073 * <p> 074 * Specifies the number of worker threads to be used for processing 075 * operations placed in the queue. 076 * <p> 077 * If the value is increased, the additional worker threads are 078 * created immediately. If the value is reduced, the appropriate 079 * number of threads are destroyed as operations complete processing. 080 * 081 * @return Returns the value of the "num-worker-threads" property. 082 */ 083 Integer getNumWorkerThreads(); 084 085 086 087 /** 088 * Sets the "num-worker-threads" property. 089 * <p> 090 * Specifies the number of worker threads to be used for processing 091 * operations placed in the queue. 092 * <p> 093 * If the value is increased, the additional worker threads are 094 * created immediately. If the value is reduced, the appropriate 095 * number of threads are destroyed as operations complete processing. 096 * 097 * @param value The value of the "num-worker-threads" property. 098 * @throws PropertyException 099 * If the new value is invalid. 100 */ 101 void setNumWorkerThreads(Integer value) throws PropertyException; 102 103}