KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > sun > enterprise > admin > monitor > stats > 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  * Copyright 2004-2005 Sun Microsystems, Inc. All rights reserved.
26  * Use is subject to license terms.
27  */
28
29 /*
30  * $Id: EJBPoolStats.java,v 1.2 2005/12/25 03:52:13 tcfujii Exp $
31  * $Date: 2005/12/25 03:52:13 $
32  * $Revision: 1.2 $
33  */
34
35 package com.sun.enterprise.admin.monitor.stats;
36 import javax.management.j2ee.statistics.Stats JavaDoc;
37 import javax.management.j2ee.statistics.CountStatistic JavaDoc;
38 import javax.management.j2ee.statistics.BoundedRangeStatistic JavaDoc;
39
40 /** A Stats interface to represent the statistical data exposed by an EJB Bean Pool.
41  * These are based on the statistics exposed in S1AS7.0.
42  * All the EJB Pool implementations should expose statistical data by implementing this interface.
43  * @author Muralidhar Vempaty
44  * @author Kedar Mhaswade
45  * @since S1AS8.0
46  * @version 1.0
47  */
48
49 public interface EJBPoolStats extends Stats JavaDoc {
50
51     /** Returns the statistical information about the number of EJBs in the associated pool, as an instance of BoundedRangeStatistic.
52      * This returned value gives an idea about how the pool is changing.
53      * @return an instance of {@link BoundedRangeStatistic}
54      */
55     public BoundedRangeStatistic JavaDoc getNumBeansInPool();
56     
57     /** Returns the number of threads waiting for free Beans, as an instance of CountStatistic.
58      * This indicates the congestion of requests.
59      * @return an instance of {@link BoundedRangeStatistic}
60      */
61     public BoundedRangeStatistic JavaDoc getNumThreadsWaiting();
62     
63     /** Returns the number of Beans created in associated pool so far over time, since the gathering of data started, as a CountStatistic.
64      * @return an instance of {@link CountStatistic}
65      */
66     public CountStatistic JavaDoc getTotalBeansCreated();
67     
68     /** Returns the number of Beans destroyed from associated pool so far over time, since the gathering of data started, as a CountStatistic.
69      * @return an instance of {@link CountStatistic}
70      */
71     public CountStatistic JavaDoc getTotalBeansDestroyed();
72     
73     /** Returns the maximum number of messages to load into a JMS session, at a time, as a CountStatistic.
74      * @return an instance of {@link CountStatistic}
75      */
76     public CountStatistic JavaDoc getJmsMaxMessagesLoad();
77 }
78
Popular Tags