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.server; 017 018 019 020import org.forgerock.opendj.config.server.ConfigurationChangeListener; 021 022 023 024/** 025 * A server-side interface for querying Parallel Work Queue settings. 026 * <p> 027 * The Parallel Work Queue is a type of work queue that uses a number 028 * of worker threads that watch a queue and pick up an operation to 029 * process whenever one becomes available. 030 */ 031public interface ParallelWorkQueueCfg extends WorkQueueCfg { 032 033 /** 034 * Gets the configuration class associated with this Parallel Work Queue. 035 * 036 * @return Returns the configuration class associated with this Parallel Work Queue. 037 */ 038 Class<? extends ParallelWorkQueueCfg> configurationClass(); 039 040 041 042 /** 043 * Register to be notified when this Parallel Work Queue is changed. 044 * 045 * @param listener 046 * The Parallel Work Queue configuration change listener. 047 */ 048 void addParallelChangeListener(ConfigurationChangeListener<ParallelWorkQueueCfg> listener); 049 050 051 052 /** 053 * Deregister an existing Parallel Work Queue configuration change listener. 054 * 055 * @param listener 056 * The Parallel Work Queue configuration change listener. 057 */ 058 void removeParallelChangeListener(ConfigurationChangeListener<ParallelWorkQueueCfg> listener); 059 060 061 062 /** 063 * Gets the "java-class" property. 064 * <p> 065 * Specifies the fully-qualified name of the Java class that 066 * provides the Parallel Work Queue implementation. 067 * 068 * @return Returns the value of the "java-class" property. 069 */ 070 String getJavaClass(); 071 072 073 074 /** 075 * Gets the "num-worker-threads" property. 076 * <p> 077 * Specifies the number of worker threads to be used for processing 078 * operations placed in the queue. 079 * <p> 080 * If the value is increased, the additional worker threads are 081 * created immediately. If the value is reduced, the appropriate 082 * number of threads are destroyed as operations complete processing. 083 * 084 * @return Returns the value of the "num-worker-threads" property. 085 */ 086 Integer getNumWorkerThreads(); 087 088}