KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > sun > appserv > management > monitor > statistics > 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  * $Id: EJBMethodStats.java,v 1.3 2005/12/25 03:51:13 tcfujii Exp $
26  * $Date: 2005/12/25 03:51:13 $
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.TimeStatistic JavaDoc;
34
35 /** A Stats interface to represent the statistical data exposed by an EJB Business Method.
36  * These are based on the statistics exposed in S1AS7.0.
37  * All the EJB Methods should expose statistical data by implementing this interface.
38  */
39
40 public interface EJBMethodStats extends Stats JavaDoc
41 {
42     
43     /** Returns the statistics of the method invocation as an instance of TimeStatistic.
44      * Note that it returns the number of times the operation called, the total time
45      * that was spent during the invocation and so on. All the calculations of the
46      * statistic are being done over time.
47      * @return in instance of {@link TimeStatistic}
48      */
49     public TimeStatistic JavaDoc getMethodStatistic();
50     
51     /** Returns the total number of errors as a CountStatistic. It is upto the method
52      * implementor to characterize what an error is. Generally if an operation results in
53      * an exception, this count will increment by one.
54      * @return an instance of {@link CountStatistic}
55      */
56     public CountStatistic JavaDoc getTotalNumErrors();
57     
58     /** Returns the total number of successful runs, as a CountStatistic. It is upto the method
59      * implementor to characterize what a successful run is. Generally if an operation returns
60      * normally, this count will increment by one.
61      * @return an instance of {@link CountStatistic}
62      */
63     public CountStatistic JavaDoc getTotalNumSuccess();
64     
65     /** Returns the time spent during the last successful/unsuccessful attempt to execute the operation, as a CountStatistic.
66      * The time spent is generally an indication of the system load/processing time.
67      * @return an instance of {@link CountStatistic}
68      */
69     public CountStatistic JavaDoc getExecutionTime();
70 }
71
Popular Tags