KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > sun > enterprise > admin > monitor > stats > WebModuleStats


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 package com.sun.enterprise.admin.monitor.stats;
24
25 import javax.management.j2ee.statistics.Stats JavaDoc;
26 import javax.management.j2ee.statistics.CountStatistic JavaDoc;
27
28 /**
29  * Interface for querying web module statistics.
30  */

31 public interface WebModuleStats extends Stats JavaDoc {
32
33     /**
34      * Gets the number of JSPs that have been loaded in the web module
35      * associated with this WebModuleStats.
36      *.
37      * @return Number of JSPs that have been loaded
38      */

39     public CountStatistic JavaDoc getJspCount();
40
41     /**
42      * Gets the number of JSPs that have been reloaded in the web module
43      * associated with this WebModuleStats
44      *.
45      * @return Number of JSPs that have been reloaded
46      */

47     public CountStatistic JavaDoc getJspReloadCount();
48
49     /**
50      * Gets the number of errors that were triggered by JSP invocations.
51      *.
52      * @return Number of errors triggered by JSP invocations
53      */

54     public CountStatistic JavaDoc getJspErrorCount();
55
56     /**
57      * Gets the total number of sessions that have been created for the web
58      * module associated with this WebModuleStats.
59      *.
60      * @return Total number of sessions created
61      */

62     public CountStatistic JavaDoc getSessionsTotal();
63
64     /**
65      * Gets the number of currently active sessions for the web
66      * module associated with this WebModuleStats.
67      *.
68      * @return Number of currently active sessions
69      */

70     public CountStatistic JavaDoc getActiveSessionsCurrent();
71
72     /**
73      * Gets the maximum number of concurrently active sessions for the web
74      * module associated with this WebModuleStats.
75      *
76      * @return Maximum number of concurrently active sessions
77      */

78     public CountStatistic JavaDoc getActiveSessionsHigh();
79
80     /**
81      * Gets the total number of rejected sessions for the web
82      * module associated with this WebModuleStats.
83      *
84      * <p>This is the number of sessions that were not created because the
85      * maximum allowed number of sessions were active.
86      *.
87      * @return Total number of rejected sessions
88      */

89     public CountStatistic JavaDoc getRejectedSessionsTotal();
90
91     /**
92      * Gets the total number of expired sessions for the web
93      * module associated with this WebModuleStats.
94      *.
95      * @return Total number of expired sessions
96      */

97     public CountStatistic JavaDoc getExpiredSessionsTotal();
98
99     /**
100      * Gets the cumulative processing times of all servlets in the web module
101      * associated with this WebModuleStats.
102      *
103      * @return Cumulative processing times of all servlets in the web module
104      * associated with this WebModuleStats
105      */

106     public CountStatistic JavaDoc getServletProcessingTimes();
107
108     /**
109      * Returns comma-separated list of all sessions currently active in the web
110      * module associated with this WebModuleStats.
111      *
112      * @return Comma-separated list of all sessions currently active in the
113      * web module associated with this WebModuleStats
114      */

115     public StringStatistic getSessions();
116
117     /**
118      * Resets this WebModuleStats.
119      */

120     public void reset();
121         
122 }
123
Popular Tags