PWCConnectionQueueStats


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   * PWCConnectionQueueStats.java
31   *
32   * Created on April 2, 2004, 10:05 AM
33   */
34  
35  package com.sun.enterprise.admin.monitor.stats;
36  
37  /**
38   *
39   * @author  nsegura
40   */
41  import com.sun.enterprise.admin.monitor.stats.StringStatistic;
42  import javax.management.j2ee.statistics.CountStatistic  ;
43  import javax.management.j2ee.statistics.Stats  ;
44  
45  /** 
46   * ConnectionQueue information shows the number of sessions in the queue
47   * and the average delay before the connection is accepted
48   */
49  public interface PWCConnectionQueueStats extends Stats   {
50  
51      /** 
52       * Gets the ID of the connection queue
53       *
54       * @return The ID of the connection queue
55       */
56      public StringStatistic getId();
57  
58      /**
59       * Gets the total number of connections that have been accepted.
60       *
61       * @return Total number of connections that have been accepted.
62       */    
63      public CountStatistic   getCountTotalConnections();
64  
65      /**
66       * Gets the number of connections currently in the queue
67       *
68       * @return Number of connections currently in the queue
69       */    
70      public CountStatistic   getCountQueued();
71  
72      /**
73       * Gets the largest number of connections that were in the queue
74       * simultaneously.
75       *
76       * @return Largest number of connections that were in the queue
77       * simultaneously
78       */    
79      public CountStatistic   getPeakQueued();
80  
81      /**
82       * Gets the maximum size of the connection queue
83       *
84       * @return Maximum size of the connection queue
85       */    
86      public CountStatistic   getMaxQueued();
87  
88      /** 
89       * Gets the number of times the queue has been too full to accommodate
90       * a connection
91       *
92       * @return Number of times the queue has been too full to accommodate
93       * a connection
94       */    
95      public CountStatistic   getCountOverflows();
96  
97      /** 
98       * Gets the total number of connections that have been queued.
99       *
100      * A given connection may be queued multiple times, so
101      * <code>counttotalqueued</code> may be greater than or equal to
102      * <code>counttotalconnections</code>.
103      *
104      * @return Total number of connections that have been queued
105      */        
106     public CountStatistic   getCountTotalQueued();
107 
108     /**
109      * Gets the total number of ticks that connections have spent in the
110      * queue.
111      * 
112      * A tick is a system-dependent unit of time.
113      *
114      * @return Total number of ticks that connections have spent in the
115      * queue
116      */    
117     public CountStatistic   getTicksTotalQueued();
118 
119     /** 
120      * Gets the average number of connections queued in the last 1 minute
121      *
122      * @return Average number of connections queued in the last 1 minute
123      */    
124     public CountStatistic   getCountQueued1MinuteAverage();
125 
126     /** 
127      * Gets the average number of connections queued in the last 5 minutes
128      *
129      * @return Average number of connections queued in the last 5 minutes
130      */    
131     public CountStatistic   getCountQueued5MinuteAverage();
132 
133     /** 
134      * Gets the average number of connections queued in the last 15 minutes
135      *
136      * @return Average number of connections queued in the last 15 minutes
137      */    
138     public CountStatistic   getCountQueued15MinuteAverage();
139     
140 }
141
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags