KickJava   Java API By Example, From Geeks To Geeks.

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


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: EJBMethodStats.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.TimeStatistic JavaDoc;
39
40 /** A Stats interface to represent the statistical data exposed by an EJB Business Method.
41  * These are based on the statistics exposed in S1AS7.0.
42  * All the EJB Methods 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 EJBMethodStats extends Stats JavaDoc {
50     
51     /** Returns the statistics of the method invocation as an instance of TimeStatistic.
52      * Note that it returns the number of times the operation called, the total time
53      * that was spent during the invocation and so on. All the calculations of the
54      * statistic are being done over time.
55      * @return in instance of {@link TimeStatistic}
56      */
57     public TimeStatistic JavaDoc getMethodStatistic();
58     
59     /** Returns the total number of errors as a CountStatistic. It is upto the method
60      * implementor to characterize what an error is. Generally if an operation results in
61      * an exception, this count will increment by one.
62      * @return an instance of {@link CountStatistic}
63      */
64     public CountStatistic JavaDoc getTotalNumErrors();
65     
66     /** Returns the total number of successful runs, as a CountStatistic. It is upto the method
67      * implementor to characterize what a successful run is. Generally if an operation returns
68      * normally, this count will increment by one.
69      * @return an instance of {@link CountStatistic}
70      */
71     public CountStatistic JavaDoc getTotalNumSuccess();
72     
73     /** Returns the time spent during the last successful/unsuccessful attempt to execute the operation, as a CountStatistic.
74      * The time spent is generally an indication of the system load/processing time.
75      * @return an instance of {@link CountStatistic}
76      */
77     public CountStatistic JavaDoc getExecutionTime();
78 }
79
Popular Tags