WebServiceEndpointAggregateStats


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  package com.sun.appserv.management.monitor.statistics;
25  
26  import javax.management.j2ee.statistics.Stats  ;
27  import javax.management.j2ee.statistics.CountStatistic  ;
28  import com.sun.appserv.management.j2ee.statistics.StringStatistic;
29  import com.sun.appserv.management.j2ee.statistics.NumberStatistic;
30  
31  /**
32   * Web Service Endpoint's stats interface. It provides faults, response time,
33   * throughput and authentication failure/success information.
34   *
35   * @since AppServer 9.0
36   */
37  public interface WebServiceEndpointAggregateStats extends Stats  
38  {
39      /**
40       * Returns the total number of fault as a CountStatistic.
41       * Generally if an Endpoint results in a fault, this count will
42       * increment by one.
43       *
44       * @return an instance of {@link CountStatistic}
45       */
46      public CountStatistic   getTotalFaults();
47  
48      /**
49       * Returns the total number of successful runs, as a CountStatistic.
50       * Generally if an operation returns with out a fault it is consider a
51       * success. normally, this count will increment by one.
52       *
53       * @return an instance of {@link CountStatistic}
54       */
55      public CountStatistic   getTotalNumSuccess();
56  
57      /**
58       * Returns the average time in milli seconds spent during the last 
59       * successful/unsuccessful attempt to execute the operation, as a
60       * CountStatistic. The time spent is generally an indication of 
61       * the system load/processing time.
62       *
63       * @return an instance of {@link CountStatistic}
64       */
65      public CountStatistic   getAverageResponseTime();
66  
67      /**
68       * Returns the time in milli seconds spent during the last 
69       * successful/unsuccessful attempt to execute the operation, as a
70       * CountStatistic.  
71       *
72       * @return an instance of {@link CountStatistic}
73       */
74      public CountStatistic   getResponseTime();
75  
76      /**
77       * Returns the minimum time spent in milli seconds for any successful/
78       * unsuccessful attempt to execute the operation, as a CountStatistic.
79       *
80       * @return an instance of {@link CountStatistic}
81       */
82      public CountStatistic   getMinResponseTime();
83  
84      /**
85       * Returns the maximum time spent in milli seconds for any successful/
86       * unsuccessful attempt to execute the operation, as a CountStatistic.
87       *
88       * @return an instance of {@link CountStatistic}
89       */
90      public CountStatistic   getMaxResponseTime();
91  
92      /**
93       * Returns the number successful messages/minute since the server is
94       * started as a NumberStatistic.
95       *
96       * @return an instance of {@link NumberStatistic}
97       */
98      public NumberStatistic getThroughput();
99  
100     /**
101      * Returns the total number of authentication failures as a
102      * CountStatistic.
103      *
104      * @return an instance of {@link CountStatistic}
105      */
106     public CountStatistic   getTotalAuthFailures();
107 
108     /**
109      * Returns the total number of authentication successes
110      * CountStatistic.
111      *
112      * @return an instance of {@link CountStatistic}
113      */
114     public CountStatistic   getTotalAuthSuccesses();
115 }
116
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags