KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > sun > appserv > management > monitor > statistics > ConnectionQueueStats


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.appserv.management.monitor.statistics;
24
25 import javax.management.j2ee.statistics.Stats JavaDoc;
26 import javax.management.j2ee.statistics.CountStatistic JavaDoc;
27 import javax.management.j2ee.statistics.BoundedRangeStatistic JavaDoc;
28 import javax.management.j2ee.statistics.RangeStatistic JavaDoc;
29
30 import com.sun.appserv.management.j2ee.statistics.StringStatistic;
31
32 /**
33     @see com.sun.appserv.management.monitor.ConnectionQueueMonitor
34  */
35 public interface ConnectionQueueStats extends Stats JavaDoc
36 {
37     /**
38         Gets the total number of connections that have been queued.
39         <p>
40         A given connection may be queued multiple times, so
41         <code>CountTotalQueued</code> may be greater than or equal to
42         <code>CountTotalConnections</code>.
43      
44         @return number of connections queued
45      */
46     public CountStatistic JavaDoc getCountTotalQueued();
47     
48     /**
49         Gets the number of times the queue has been too full to accommodate
50         a connection
51      * @return number of overflows
52      */
53     public CountStatistic JavaDoc getCountOverflows();
54      
55     /**
56         @return total number of connections that have been accepted.
57      */
58     public CountStatistic JavaDoc getCountTotalConnections();
59     
60     /**
61         Gets the average number of connections queued in the last 5 minutes
62      
63      @return average
64      */
65     public CountStatistic JavaDoc getCountQueued5MinuteAverage();
66     
67     /**
68         Gets the total number of ticks that connections have spent in the
69         queue. A tick is a system-dependent unit of time.
70      @return number of ticks
71      */
72     public CountStatistic JavaDoc getTicksTotalQueued();
73     
74     /**
75         Gets the average number of connections queued in the last 1 minute
76      
77         @return average number
78      */
79     public CountStatistic JavaDoc getCountQueued1MinuteAverage();
80     
81     /**
82         Gets the average number of connections queued in the last 15 minutes
83         @return average number
84      */
85     public CountStatistic JavaDoc getCountQueued15MinuteAverage();
86     
87     /**
88         Gets the maximum size of the connection queue
89         @return the maximum size
90      */
91     public CountStatistic JavaDoc getMaxQueued();
92     
93     /**
94         Gets the largest number of connections that were in the queue
95         simultaneously.
96      
97         @return the count
98      */
99     public CountStatistic JavaDoc getPeakQueued();
100     
101     /**
102         @return The ID of the connection queue
103      */
104     public StringStatistic getID();
105     
106     /**
107      * @return number of connections currently in the queue
108      */
109     public CountStatistic JavaDoc getCountQueued();
110 }
111
Popular Tags