KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > sun > appserv > management > monitor > statistics > EJBPoolStats


1 /*
2  * The contents of this file are subject to the terms
3  * of the Common Development and Distribution License
4  * (the License). You may not use this file except in
5  * compliance with the License.
6  *
7  * You can obtain a copy of the license at
8  * https://glassfish.dev.java.net/public/CDDLv1.0.html or
9  * glassfish/bootstrap/legal/CDDLv1.0.txt.
10  * See the License for the specific language governing
11  * permissions and limitations under the License.
12  *
13  * When distributing Covered Code, include this CDDL
14  * Header Notice in each file and include the License file
15  * at glassfish/bootstrap/legal/CDDLv1.0.txt.
16  * If applicable, add the following below the CDDL Header,
17  * with the fields enclosed by brackets [] replaced by
18  * you own identifying information:
19  * "Portions Copyrighted [year] [name of copyright owner]"
20  *
21  * Copyright 2006 Sun Microsystems, Inc. All rights reserved.
22  */
23
24 /*
25  * $Id: EJBPoolStats.java,v 1.3 2005/12/25 03:51:14 tcfujii Exp $
26  * $Date: 2005/12/25 03:51:14 $
27  * $Revision: 1.3 $
28  */
29
30 package com.sun.appserv.management.monitor.statistics;
31 import javax.management.j2ee.statistics.Stats JavaDoc;
32 import javax.management.j2ee.statistics.CountStatistic JavaDoc;
33 import javax.management.j2ee.statistics.BoundedRangeStatistic JavaDoc;
34
35 /** A Stats interface to represent the statistical data exposed by an EJB Bean Pool.
36  * These are based on the statistics exposed in S1AS7.0.
37  * All the EJB Pool implementations should expose statistical data by implementing this interface.
38  */
39
40 public interface EJBPoolStats extends Stats JavaDoc
41 {
42
43     /** Returns the statistical information about the number of EJBs in the associated pool, as an instance of BoundedRangeStatistic.
44      * This returned value gives an idea about how the pool is changing.
45      * @return an instance of {@link BoundedRangeStatistic}
46      */
47     public BoundedRangeStatistic JavaDoc getNumBeansInPool();
48     
49     /** Returns the number of threads waiting for free Beans, as an instance of CountStatistic.
50      * This indicates the congestion of requests.
51      * @return an instance of {@link BoundedRangeStatistic}
52      */
53     public BoundedRangeStatistic JavaDoc getNumThreadsWaiting();
54     
55     /** Returns the number of Beans created in associated pool so far over time, since the gathering of data started, as a CountStatistic.
56      * @return an instance of {@link CountStatistic}
57      */
58     public CountStatistic JavaDoc getTotalBeansCreated();
59     
60     /** Returns the number of Beans destroyed from associated pool so far over time, since the gathering of data started, as a CountStatistic.
61      * @return an instance of {@link CountStatistic}
62      */
63     public CountStatistic JavaDoc getTotalBeansDestroyed();
64     
65     /** Returns the maximum number of messages to load into a JMS session, at a time, as a CountStatistic.
66      * @return an instance of {@link CountStatistic}
67      */
68     public CountStatistic JavaDoc getJMSMaxMessagesLoad();
69 }
70
Popular Tags