PoolTracer (DBPool 5.0 API)

Constructor Summary
`PoolTracer(ObjectPool pool, File file)` Creates a new `PoolTracer` which logs to the specified file.
`PoolTracer(ObjectPool pool, PrintWriter logWriter, boolean closeOnExit)` Creates a new `PoolTracer` which logs to the specified `PrintWriter`.
`PoolTracer(ObjectPool pool, String filename)` Creates a new ObjectPoolAudit which logs to the specified File.
`PoolTracer(Properties props)` Creates a new `PoolTracer` which logs to the specified file.

Method Summary
`MessageFormat`	`getMessageFormatInstance()` Returns the current `MessageFormat` instance used for formatting log messages.
`protected void`	`logPoolStats(ObjectPoolEvent evt)` Writes an entry containing the pool statistics to the log file.
`void`	`maxPoolLimitExceeded(ObjectPoolEvent evt)` Called when a check-out request causes the poolSize limit to be exceeded.
`void`	`maxPoolLimitReached(ObjectPoolEvent evt)` Called when a check-out request causes the poolSize limit to be reached.
`void`	`maxSizeLimitError(ObjectPoolEvent evt)` Called when a check-out request attempts to exceed the maxSize limit.
`void`	`maxSizeLimitReached(ObjectPoolEvent evt)` Called when a check-out request causes the maxSize limit to be reached.
`void`	`poolCheckIn(ObjectPoolEvent evt)` Called when an item is checked back in to the pool.
`void`	`poolCheckOut(ObjectPoolEvent evt)` Called when an item is checked out of the pool.
`void`	`poolFlushed(ObjectPoolEvent evt)` Called when the pool is flushed of all free/unused items.
`void`	`poolInitCompleted(ObjectPoolEvent evt)` Called when the pool's `ObjectPool.init(int)` method has completed.
`void`	`poolParametersChanged(ObjectPoolEvent evt)` Called when the pool's parameters are changed.
`void`	`poolReleased(ObjectPoolEvent evt)` Called when the pool is released (no more events are fired by the pool after this event).
`void`	`setDateFormat(DateFormat df)` Sets the date formatter for the logging.
`void`	`setMessageFormat(MessageFormat mf)` Sets the `MessageFormat` instance used for formatting log messages.
`void`	`validationError(ObjectPoolEvent evt)` Called when an item is found to be invalid.

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail

PoolTracer

public PoolTracer(ObjectPool pool,
                  PrintWriter logWriter,
                  boolean closeOnExit)

Creates a new PoolTracer which logs to the specified PrintWriter.

Parameters:: pool - ObjectPool for which to trace activity; logWriter - PrintWriter to use for writing trace activity; closeOnExit - whether to close the PrintWriter on release

PoolTracer

public PoolTracer(ObjectPool pool,
                  File file)
           throws FileNotFoundException

Creates a new PoolTracer which logs to the specified file. Note: if the file already exists it is truncated to zero-length, then used for writing the log.

Parameters:: pool - ObjectPool for which to trace activity; file - File to which to log trace activity
Throws:: FileNotFoundException

PoolTracer

public PoolTracer(ObjectPool pool,
                  String filename)
           throws FileNotFoundException

Creates a new ObjectPoolAudit which logs to the specified File.

Parameters:: pool - ObjectPool for which to trace activity; filename - name of file to which to log trace activity
Throws:: FileNotFoundException

PoolTracer

public PoolTracer(Properties props)
           throws FileNotFoundException

Creates a new PoolTracer which logs to the specified file. Note: if the file already exists it is truncated to zero-length, then used for writing the log.

Parameters:: props - Properties defining trace activity
Throws:: FileNotFoundException

Method Detail

setDateFormat

public void setDateFormat(DateFormat df)

Sets the date formatter for the logging. The default is the same as used by the LogUtil class.

Parameters:: df - DateFormat instance to use for formatting log messages

setMessageFormat

public void setMessageFormat(MessageFormat mf)

Sets the MessageFormat instance used for formatting log messages. To use the default instance, just call this method with a null argument.

Format strings are specified using the following variables:

{0} - pool name (string)
{1} - minpool (integer)
{2} - maxpool (integer)
{3} - maxsize (integer)
{4} - expiry time (long)
{5} - items checked out (integer)
{6} - free item count (integer)
{7} - current pool size (i.e. {5}+{6}, integer)
{8} - hit rate (float)
{9} - event type (string)

The default format is as follows:

 {0}: minpool={1,number,#}, maxpool={2,number,#}, maxsize={3,number,#}, expiry={4,number,#}, out={5,number,#}, free={6,number,#}, hitRate={8,number,0.0##%}

Parameters:: mf - MessageFormat instance to use for formatting log messages

getMessageFormatInstance

public MessageFormat getMessageFormatInstance()

Returns the current MessageFormat instance used for formatting log messages.

logPoolStats

protected void logPoolStats(ObjectPoolEvent evt)

Writes an entry containing the pool statistics to the log file.