KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > logicalcobwebs > proxool > ConnectionPoolStatisticsIF


1 /*
2  * This software is released under a licence similar to the Apache Software Licence.
3  * See org.logicalcobwebs.proxool.package.html for details.
4  * The latest version is available at http://proxool.sourceforge.net
5  */
6 package org.logicalcobwebs.proxool;
7
8 import java.util.Date JavaDoc;
9
10 /**
11  * This provides real time information about the pool. You can get this from
12  * {@link ProxoolFacade#getConnectionPoolStatistics ProxoolFacade}.
13  *
14  * <pre>
15  * String alias = "myPool";
16  * ConnectionPoolStatisticsIF cps = ProxoolFacade.getConnectionPoolStatistics(alias);
17  * </pre>
18  *
19  * @version $Revision: 1.6 $, $Date: 2005/10/02 12:32:02 $
20  * @author billhorsman
21  * @author $Author: billhorsman $ (current maintainer)
22  */
23 public interface ConnectionPoolStatisticsIF {
24
25     /**
26      * The number of connections provided.
27      * @return connectionsServedCount
28      */
29     long getConnectionsServedCount();
30
31     /**
32      * The number of connections refused. Either because there was a problem
33     * connecting to the database, or perhaps because the maximumConnectionCount
34     * was reached.
35      * @return connectionsRefusedCount
36      */
37     long getConnectionsRefusedCount();
38
39     /**
40      * The number of connections currently in use.
41      * @return activeConnectionCount
42      */
43     int getActiveConnectionCount();
44
45     /**
46      * The number of connections that are available for use (doesn't include
47     * active connections).
48      * @return availableConnectionCount
49      */
50     int getAvailableConnectionCount();
51
52     /**
53      * The number of connections that are neither active or available. Probably
54      * because the house keeping thread is checking them.
55      * @return offlineConnectionCount
56      */
57     int getOfflineConnectionCount();
58
59     /**
60      * When this pool was started
61      * @return dateStarted
62      */
63     Date JavaDoc getDateStarted();
64
65     long getConnectionCount();
66 }
67
68 /*
69  Revision history:
70  $Log: ConnectionPoolStatisticsIF.java,v $
71  Revision 1.6 2005/10/02 12:32:02 billhorsman
72  Make connectionCount available to statistics
73
74  Revision 1.5 2003/03/03 11:11:57 billhorsman
75  fixed licence
76
77  Revision 1.4 2003/01/15 12:01:21 billhorsman
78  added getDateStarted() plus better doc
79
80  Revision 1.3 2002/12/15 19:21:42 chr32
81  Changed @linkplain to @link (to preserve JavaDoc for 1.2/1.3 users).
82
83  Revision 1.2 2002/10/25 16:00:26 billhorsman
84  added better class javadoc
85
86  Revision 1.1.1.1 2002/09/13 08:13:04 billhorsman
87  new
88
89  Revision 1.6 2002/07/10 16:14:47 billhorsman
90  widespread layout changes and move constants into ProxoolConstants
91
92  Revision 1.5 2002/07/02 11:19:08 billhorsman
93  layout code and imports
94
95  Revision 1.4 2002/06/28 11:19:47 billhorsman
96  improved doc
97
98 */
99
Popular Tags