AbstractDataSourcePoolMetadata (spring-boot 2.7.8)

java.lang.Object
- org.springframework.boot.jdbc.metadata.AbstractDataSourcePoolMetadata<T>

Type Parameters:

T - the data source type

All Implemented Interfaces:

DataSourcePoolMetadata

Direct Known Subclasses:

CommonsDbcp2DataSourcePoolMetadata, HikariDataSourcePoolMetadata, OracleUcpDataSourcePoolMetadata, TomcatDataSourcePoolMetadata
```
public abstract class AbstractDataSourcePoolMetadata<T extends javax.sql.DataSource>
extends java.lang.Object
implements DataSourcePoolMetadata
```
A base DataSourcePoolMetadata implementation.

Since:

2.0.0

Constructor Summary

Constructors
Modifier Constructor and Description

protected AbstractDataSourcePoolMetadata(T dataSource)
Create an instance with the data source to use.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected T`	`getDataSource()`
`java.lang.Float`	`getUsage()` Return the usage of the pool as value between 0 and 1 (or -1 if the pool is not limited).

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

Methods inherited from interface org.springframework.boot.jdbc.metadata.DataSourcePoolMetadata
getActive, getDefaultAutoCommit, getIdle, getMax, getMin, getValidationQuery

- Constructor Detail
  - AbstractDataSourcePoolMetadata
```
protected AbstractDataSourcePoolMetadata(T dataSource)
```
    Create an instance with the data source to use.
    
    Parameters:
    
    dataSource - the data source
- Method Detail
  - getUsage
```
public java.lang.Float getUsage()
```
    Description copied from interface: DataSourcePoolMetadata
    Return the usage of the pool as value between 0 and 1 (or -1 if the pool is not limited).
    - 1 means that the maximum number of connections have been allocated
    - 0 means that no connection is currently active
    - -1 means there is not limit to the number of connections that can be allocated
    This may also return null if the data source does not provide the necessary information to compute the poll usage.
    Specified by:
    
    getUsage in interface DataSourcePoolMetadata
    
    Returns:
    
    the usage value or null
  - getDataSource
```
protected final T getDataSource()
```