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.management.geronimo.stats;
018    
019    import javax.management.j2ee.statistics.BoundedRangeStatistic;
020    import javax.management.j2ee.statistics.CountStatistic;
021    import javax.management.j2ee.statistics.Stats;
022    
023    /**
024     * Statistics expected for a Thread Pool implementation
025     *
026     * @version $Rev: 476049 $ $Date: 2006-11-16 23:35:17 -0500 (Thu, 16 Nov 2006) $
027     */
028    public interface ThreadPoolStats extends Stats {
029        /**
030         * Gets the min and max pool size, as well as the most, least, and current
031         * number of threads in use.
032         */
033        public BoundedRangeStatistic getThreadsInUse();
034    
035        /**
036         * Gets a list of the known consumers of threads from this pool.  This may
037         * not be all consumers, because they won't necessarily identify themselves,
038         * but it's a start when tracking down what's using threads in a pool.
039         */
040        public String[] getThreadConsumers();
041    
042        /**
043         * For each consumer listed by getThreadConsumers(), this can be used to
044         * find out how many threads that consumer is consuming at the time these
045         * statistics were generated.
046         *
047         * @param consumer The consumer you're inquiring about
048         */
049        public CountStatistic getCountForConsumer(String consumer);
050    }