io.micronaut.configuration.jdbc.dbcp

Class DatasourceConfiguration

java.lang.Object

org.apache.commons.dbcp2.BasicDataSource

io.micronaut.configuration.jdbc.dbcp.DatasourceConfiguration

All Implemented Interfaces:

BasicJdbcConfiguration, java.lang.AutoCloseable, java.sql.Wrapper, javax.management.MBeanRegistration, javax.sql.CommonDataSource, javax.sql.DataSource, org.apache.commons.dbcp2.BasicDataSourceMXBean

@Context
 @EachProperty(value="datasources",
              primary="default")
public class DatasourceConfiguration
extends org.apache.commons.dbcp2.BasicDataSource
implements BasicJdbcConfiguration

Allows the configuration of Apache DBCP JDBC data sources. All properties on BasicDataSource are available to be configured. If the url, driver class, username, or password are missing, sensible defaults will be provided when possible. If no configuration beyond the datasource name is provided, an in memory datastore will be configured based on the available drivers on the classpath.

Since:

1.0

Author:

James Kleeh

Field Summary

Fields inherited from interface io.micronaut.jdbc.BasicJdbcConfiguration

PREFIX

Constructor Summary

Constructors

Constructor and Description
DatasourceConfiguration(java.lang.String name) Constructor.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getConfiguredDriverClassName()
java.lang.String	getConfiguredPassword()
java.lang.String	getConfiguredUrl()
java.lang.String	getConfiguredUsername()
java.lang.String	getConfiguredValidationQuery()
java.lang.String	getDriverClassName()
java.lang.String	getName() Get the name of the bean.
java.lang.String	getPassword()
java.lang.String	getUrl()
java.lang.String	getUsername()
java.lang.String	getValidationQuery()
void	setDataSourceProperties(java.util.Map<java.lang.String,?> dsProperties) Sets the datasource properties.

Methods inherited from class org.apache.commons.dbcp2.BasicDataSource

addConnectionProperty, close, createConnectionFactory, createConnectionPool, createDataSource, createDataSourceInstance, createObjectPool, createPoolableConnectionFactory, evict, getAbandonedLogWriter, getAbandonedUsageTracking, getAutoCommitOnReturn, getCacheState, getConnection, getConnection, getConnectionFactoryClassName, getConnectionInitSqls, getConnectionInitSqlsAsArray, getConnectionPool, getDefaultAutoCommit, getDefaultCatalog, getDefaultQueryTimeout, getDefaultReadOnly, getDefaultSchema, getDefaultTransactionIsolation, getDisconnectionSqlCodes, getDisconnectionSqlCodesAsArray, getDriver, getDriverClassLoader, getEnableAutoCommitOnReturn, getEvictionPolicyClassName, getFastFailValidation, getInitialSize, getJmxName, getLifo, getLogAbandoned, getLogExpiredConnections, getLoginTimeout, getLogWriter, getMaxConnLifetimeMillis, getMaxIdle, getMaxOpenPreparedStatements, getMaxTotal, getMaxWaitMillis, getMinEvictableIdleTimeMillis, getMinIdle, getNumActive, getNumIdle, getNumTestsPerEvictionRun, getParentLogger, getRegisteredJmxName, getRemoveAbandonedOnBorrow, getRemoveAbandonedOnMaintenance, getRemoveAbandonedTimeout, getRollbackOnReturn, getSoftMinEvictableIdleTimeMillis, getTestOnBorrow, getTestOnCreate, getTestOnReturn, getTestWhileIdle, getTimeBetweenEvictionRunsMillis, getValidationQueryTimeout, invalidateConnection, isAccessToUnderlyingConnectionAllowed, isClosed, isPoolPreparedStatements, isWrapperFor, log, log, postDeregister, postRegister, preDeregister, preRegister, removeConnectionProperty, setAbandonedLogWriter, setAbandonedUsageTracking, setAccessToUnderlyingConnectionAllowed, setAutoCommitOnReturn, setCacheState, setConnectionFactoryClassName, setConnectionInitSqls, setConnectionProperties, setDefaultAutoCommit, setDefaultCatalog, setDefaultQueryTimeout, setDefaultReadOnly, setDefaultSchema, setDefaultTransactionIsolation, setDisconnectionSqlCodes, setDriver, setDriverClassLoader, setDriverClassName, setEnableAutoCommitOnReturn, setEvictionPolicyClassName, setFastFailValidation, setInitialSize, setJmxName, setLifo, setLogAbandoned, setLogExpiredConnections, setLoginTimeout, setLogWriter, setMaxConnLifetimeMillis, setMaxIdle, setMaxOpenPreparedStatements, setMaxTotal, setMaxWaitMillis, setMinEvictableIdleTimeMillis, setMinIdle, setNumTestsPerEvictionRun, setPassword, setPoolPreparedStatements, setRemoveAbandonedOnBorrow, setRemoveAbandonedOnMaintenance, setRemoveAbandonedTimeout, setRollbackOnReturn, setSoftMinEvictableIdleTimeMillis, setTestOnBorrow, setTestOnCreate, setTestOnReturn, setTestWhileIdle, setTimeBetweenEvictionRunsMillis, setUrl, setUsername, setValidationQuery, setValidationQueryTimeout, startPoolMaintenance, unwrap, validateConnectionFactory

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.micronaut.jdbc.BasicJdbcConfiguration

setDriverClassName, setPassword, setUrl, setUsername

Constructor Detail

DatasourceConfiguration

public DatasourceConfiguration(@Parameter
                               java.lang.String name)

Constructor.

Parameters:

name - name configured from properties

Method Detail

getName

public java.lang.String getName()

Get the name of the bean.

Specified by:

getName in interface BasicJdbcConfiguration

Returns:

name

getDriverClassName

public java.lang.String getDriverClassName()

Specified by:

getDriverClassName in interface BasicJdbcConfiguration

Specified by:

getDriverClassName in interface org.apache.commons.dbcp2.BasicDataSourceMXBean

Overrides:

getDriverClassName in class org.apache.commons.dbcp2.BasicDataSource

Returns:

The driver class name to be used by the data source

getConfiguredDriverClassName

public java.lang.String getConfiguredDriverClassName()

Specified by:

getConfiguredDriverClassName in interface BasicJdbcConfiguration

Returns:

The driver class name supplied via configuration

getUrl

public java.lang.String getUrl()

Specified by:

getUrl in interface BasicJdbcConfiguration

Specified by:

getUrl in interface org.apache.commons.dbcp2.BasicDataSourceMXBean

Overrides:

getUrl in class org.apache.commons.dbcp2.BasicDataSource

Returns:

The URL to be used by the data source

getConfiguredUrl

public java.lang.String getConfiguredUrl()

Specified by:

getConfiguredUrl in interface BasicJdbcConfiguration

Returns:

The URL supplied via configuration

getUsername

public java.lang.String getUsername()

Specified by:

getUsername in interface BasicJdbcConfiguration

Specified by:

getUsername in interface org.apache.commons.dbcp2.BasicDataSourceMXBean

Overrides:

getUsername in class org.apache.commons.dbcp2.BasicDataSource

Returns:

The username to be used by the data source

getConfiguredUsername

public java.lang.String getConfiguredUsername()

Specified by:

getConfiguredUsername in interface BasicJdbcConfiguration

Returns:

The username supplied via configuration

getPassword

public java.lang.String getPassword()

Specified by:

getPassword in interface BasicJdbcConfiguration

Specified by:

getPassword in interface org.apache.commons.dbcp2.BasicDataSourceMXBean

Overrides:

getPassword in class org.apache.commons.dbcp2.BasicDataSource

Returns:

The password to be used by the data source

getConfiguredPassword

public java.lang.String getConfiguredPassword()

Specified by:

getConfiguredPassword in interface BasicJdbcConfiguration

Returns:

The password supplied via configuration

getValidationQuery

public java.lang.String getValidationQuery()

Specified by:

getValidationQuery in interface BasicJdbcConfiguration

Specified by:

getValidationQuery in interface org.apache.commons.dbcp2.BasicDataSourceMXBean

Overrides:

getValidationQuery in class org.apache.commons.dbcp2.BasicDataSource

Returns:

The validation query to be used by the data source

setDataSourceProperties

public void setDataSourceProperties(@MapFormat(transformation=FLAT,keyFormat=RAW)
                                    java.util.Map<java.lang.String,?> dsProperties)

Description copied from interface: BasicJdbcConfiguration

Sets the datasource properties.

Specified by:

setDataSourceProperties in interface BasicJdbcConfiguration

Parameters:

dsProperties - The properties

getConfiguredValidationQuery

public java.lang.String getConfiguredValidationQuery()

Specified by:

getConfiguredValidationQuery in interface BasicJdbcConfiguration

Returns:

The validation query supplied via configuration