Package io.micronaut.configuration.jdbc.dbcp.metadata

Class DbcpDataSourcePoolMetadata

java.lang.Object

io.micronaut.jdbc.metadata.AbstractDataSourcePoolMetadata<org.apache.commons.dbcp2.BasicDataSource>

io.micronaut.configuration.jdbc.dbcp.metadata.DbcpDataSourcePoolMetadata

All Implemented Interfaces:

DataSourcePoolMetadata<org.apache.commons.dbcp2.BasicDataSource>

public class DbcpDataSourcePoolMetadata
extends AbstractDataSourcePoolMetadata<org.apache.commons.dbcp2.BasicDataSource>

DataSourcePoolMetadata for a DBCP BasicDataSource. NOTICE: Forked from Spring Boot.

Since:

1.0.0

Author:

Stephane Nicoll, Christian Oestreich

Constructor Summary

Constructors

Constructor	Description
DbcpDataSourcePoolMetadata(org.apache.commons.dbcp2.BasicDataSource dataSource)	DBCP typed DataSourcePoolMetadata object.

Method Summary

Modifier and Type	Method	Description
Integer	getActive()	Return the current number of active connections that have been allocated from the data source or null if that information is not available.
Boolean	getDefaultAutoCommit()	The default auto-commit state of connections created by this pool.
Integer	getIdle()	Return the number of idle connections in the pool.
Integer	getMax()	Return the maximum number of active connections that can be allocated at the same time or -1 if there is no limit.
Integer	getMin()	Return the minimum number of idle connections in the pool or null if that information is not available.
String	getValidationQuery()	Return the query to use to validate that a connection is valid or null if that information is not available.

Methods inherited from class io.micronaut.jdbc.metadata.AbstractDataSourcePoolMetadata

getDataSource, getUsage

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DbcpDataSourcePoolMetadata

public DbcpDataSourcePoolMetadata(org.apache.commons.dbcp2.BasicDataSource dataSource)

DBCP typed DataSourcePoolMetadata object.

Parameters:

dataSource - The datasource

Method Detail

getIdle

public Integer getIdle()

Description copied from interface: DataSourcePoolMetadata

Return the number of idle connections in the pool.

Returns:

the idle value

getActive

public Integer getActive()

Description copied from interface: DataSourcePoolMetadata

Return the current number of active connections that have been allocated from the data source or null if that information is not available.

Returns:

the number of active connections or null

getMax

public Integer getMax()

Description copied from interface: DataSourcePoolMetadata

Return the maximum number of active connections that can be allocated at the same time or -1 if there is no limit. Can also return null if that information is not available.

Returns:

the maximum number of active connections or null

getMin

public Integer getMin()

Description copied from interface: DataSourcePoolMetadata

Return the minimum number of idle connections in the pool or null if that information is not available.

Returns:

the minimum number of active connections or null

getValidationQuery

public String getValidationQuery()

Description copied from interface: DataSourcePoolMetadata

Return the query to use to validate that a connection is valid or null if that information is not available.

Returns:

the validation query or null

getDefaultAutoCommit

public Boolean getDefaultAutoCommit()

Description copied from interface: DataSourcePoolMetadata

The default auto-commit state of connections created by this pool. If not set (null), default is JDBC driver default (If set to null then the java.sql.Connection.setAutoCommit(boolean) method will not be called.)

Returns:

the default auto-commit state or null