org.logicalcobwebs.proxool.admin
Interface SnapshotIF

public interface SnapshotIF

Provides a snapshot of a pool

Since:

Proxool 0.7

Version:

$Revision: 1.2 $, $Date: 2003/03/03 11:11:59 $

Author:

bill, $Author: billhorsman $ (current maintainer)

Method Summary

int	getActiveConnectionCount() The number of active (busy) connections
int	getAvailableConnectionCount() The number of available (free) connections
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

public java.util.Date getDateStarted()

When the pool was started

Returns:

dateStarted

getServedCount

public long getServedCount()

How many connections have been served since the pool started

Returns:

servedCount

getRefusedCount

public long getRefusedCount()

How many connections have been refused since the pool started

Returns:

refusedCount

getActiveConnectionCount

public int getActiveConnectionCount()

The number of active (busy) connections

Returns:

activeConnectionCount

getAvailableConnectionCount

public int getAvailableConnectionCount()

The number of available (free) connections

Returns:

availableConnectionCount

getOfflineConnectionCount

public int getOfflineConnectionCount()

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

Returns:

offlineConnectionCount

getMaximumConnectionCount

public int getMaximumConnectionCount()

Get the maximum possible connections (as defined in the definition.

Returns:

maximumConnectionCount

getSnapshotDate

public java.util.Date getSnapshotDate()

The date that this snapshot applies

Returns:

snapshotDate

getConnectionInfos

public ConnectionInfoIF[] getConnectionInfos()

The details of each connection. Will be null if this is not a detailed snapshot.

Returns:

connectionInfos

See Also:

isDetail()

getConnectionInfo

public 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

public boolean isDetail()

Whether we have requested detailed information about each connection

Returns:

detail

See Also:

getConnectionInfos()