001    /**
002     *  Licensed to the Apache Software Foundation (ASF) under one or more
003     *  contributor license agreements.  See the NOTICE file distributed with
004     *  this work for additional information regarding copyright ownership.
005     *  The ASF licenses this file to You under the Apache License, Version 2.0
006     *  (the "License"); you may not use this file except in compliance with
007     *  the License.  You may obtain a copy of the License at
008     *
009     *     http://www.apache.org/licenses/LICENSE-2.0
010     *
011     *  Unless required by applicable law or agreed to in writing, software
012     *  distributed under the License is distributed on an "AS IS" BASIS,
013     *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014     *  See the License for the specific language governing permissions and
015     *  limitations under the License.
016     */
017    package org.apache.geronimo.system.threads;
018    
019    import java.util.concurrent.TimeUnit;
020    
021    /**
022     * Management interface for thread pools
023     *
024     * @version $Rev: 543715 $ $Date: 2007-06-02 04:10:16 -0400 (Sat, 02 Jun 2007) $
025     */
026    public interface ThreadPool {
027    
028        int getPoolSize();
029    
030        /**
031         * Gets the maximum number of threads allowed for this thread pool
032         */
033        int getMaximumPoolSize();
034    
035        int getActiveCount();
036    
037        boolean awaitTermination(long timeout, TimeUnit unit) throws InterruptedException;
038    
039        /**
040         * Executes work on behalf of a named client.  This helps the thread pool
041         * track who's using its threads.
042         * @param consumerName  A name identifying the caller, to be used in
043         *                      the management statistics for this pool, etc.
044         * @param runnable      The work to be done by a thread in the pool
045         */
046        void execute(String consumerName, Runnable runnable) throws InterruptedException;
047    }