org.logicalcobwebs.proxool.admin
Interface SnapshotIF

All Known Implementing Classes:
Snapshot

public interface SnapshotIF

Provides a snapshot of a pool

Since:
Proxool 0.7
Version:
$Revision: 1.3 $, $Date: 2005/10/02 12:32:01 $
Author:
bill, $Author: billhorsman $ (current maintainer)

Method Summary
 int getActiveConnectionCount()
          The number of active (busy) connections
 int getAvailableConnectionCount()
          The number of available (free) connections
 long getConnectionCount()
           
 ConnectionInfoIF getConnectionInfo(long id)
          The details of one connection.
 ConnectionInfoIF[] getConnectionInfos()
          The details of each connection.
 java.util.Date getDateStarted()
          When the pool was started
 int getMaximumConnectionCount()
          Get the maximum possible connections (as defined in the definition.
 int getOfflineConnectionCount()
          The number of offline connections.
 long getRefusedCount()
          How many connections have been refused since the pool started
 long getServedCount()
          How many connections have been served since the pool started
 java.util.Date getSnapshotDate()
          The date that this snapshot applies
 boolean isDetail()
          Whether we have requested detailed information about each connection
 

Method Detail

getDateStarted

java.util.Date getDateStarted()
When the pool was started

Returns:
dateStarted

getServedCount

long getServedCount()
How many connections have been served since the pool started

Returns:
servedCount

getRefusedCount

long getRefusedCount()
How many connections have been refused since the pool started

Returns:
refusedCount

getActiveConnectionCount

int getActiveConnectionCount()
The number of active (busy) connections

Returns:
activeConnectionCount

getAvailableConnectionCount

int getAvailableConnectionCount()
The number of available (free) connections

Returns:
availableConnectionCount

getOfflineConnectionCount

int getOfflineConnectionCount()
The number of offline connections. A connection is offline if it is being tested by the house keeper.

Returns:
offlineConnectionCount

getMaximumConnectionCount

int getMaximumConnectionCount()
Get the maximum possible connections (as defined in the definition.

Returns:
maximumConnectionCount

getSnapshotDate

java.util.Date getSnapshotDate()
The date that this snapshot applies

Returns:
snapshotDate

getConnectionInfos

ConnectionInfoIF[] getConnectionInfos()
The details of each connection. Will be null if this is not a detailed snapshot.

Returns:
connectionInfos
See Also:
isDetail()

getConnectionInfo

ConnectionInfoIF getConnectionInfo(long id)
The details of one connection. Will be null if this is not a detailed snapshot or if this ID is not found.

Parameters:
id - the connection ID
Returns:
connectionInfo
See Also:
isDetail()

isDetail

boolean isDetail()
Whether we have requested detailed information about each connection

Returns:
detail
See Also:
getConnectionInfos()

getConnectionCount

long getConnectionCount()