org.logicalcobwebs.proxool.admin.SnapshotIF Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of proxool Show documentation
Show all versions of proxool Show documentation
Cloudhopper distribution of Proxool database connection pooling library
The newest version!
/*
* This software is released under a licence similar to the Apache Software Licence.
* See org.logicalcobwebs.proxool.package.html for details.
* The latest version is available at http://proxool.sourceforge.net
*/
package org.logicalcobwebs.proxool.admin;
import org.logicalcobwebs.proxool.ConnectionInfoIF;
import java.util.Date;
/**
* Provides a snapshot of a pool
*
* @version $Revision: 1.3 $, $Date: 2005/10/02 12:32:01 $
* @author bill
* @author $Author: billhorsman $ (current maintainer)
* @since Proxool 0.7
*/
public interface SnapshotIF {
/**
* When the pool was started
* @return dateStarted
*/
Date getDateStarted();
/**
* How many connections have been served since the pool started
* @return servedCount
*/
long getServedCount();
/**
* How many connections have been refused since the pool started
* @return refusedCount
*/
long getRefusedCount();
/**
* The number of active (busy) connections
* @return activeConnectionCount
*/
int getActiveConnectionCount();
/**
* The number of available (free) connections
* @return availableConnectionCount
*/
int getAvailableConnectionCount();
/**
* The number of offline connections. A connection is offline
* if it is being tested by the house keeper.
* @return offlineConnectionCount
*/
int getOfflineConnectionCount();
/**
* Get the maximum possible connections (as defined in the
* {@link org.logicalcobwebs.proxool.ConnectionPoolDefinitionIF definition}.
* @return maximumConnectionCount
*/
int getMaximumConnectionCount();
/**
* The date that this snapshot applies
* @return snapshotDate
*/
Date getSnapshotDate();
/**
* The details of each connection. Will be null if this is not a
* detailed snapshot.
* @return connectionInfos
* @see #isDetail
*/
ConnectionInfoIF[] getConnectionInfos();
/**
* The details of one connection. Will be null if this is not a
* detailed snapshot or if this ID is not found.
* @param id the connection {@link ConnectionInfoIF#getId ID}
* @return connectionInfo
* @see #isDetail
*/
ConnectionInfoIF getConnectionInfo(long id);
/**
* Whether we have requested detailed information about each
* connection
* @return detail
* @see #getConnectionInfos
*/
boolean isDetail();
long getConnectionCount();
}
/*
Revision history:
$Log: SnapshotIF.java,v $
Revision 1.3 2005/10/02 12:32:01 billhorsman
Make connectionCount available to statistics
Revision 1.2 2003/03/03 11:11:59 billhorsman
fixed licence
Revision 1.1 2003/02/19 23:36:51 billhorsman
renamed monitor package to admin
Revision 1.2 2003/02/12 12:28:28 billhorsman
added url, proxyHashcode and delegateHashcode to
ConnectionInfoIF
Revision 1.1 2003/01/31 11:35:57 billhorsman
improvements to servlet (including connection details)
Revision 1.1 2003/01/30 17:20:15 billhorsman
fixes, improvements and doc
*/