org.springframework.cloud.aws.jdbc.datasource

Class TomcatJdbcDataSourceFactory

java.lang.Object

org.apache.tomcat.jdbc.pool.PoolProperties

org.springframework.cloud.aws.jdbc.datasource.TomcatJdbcDataSourceFactory

All Implemented Interfaces:

Serializable, Cloneable, org.apache.tomcat.jdbc.pool.PoolConfiguration, DataSourceFactory

public class TomcatJdbcDataSourceFactory
extends org.apache.tomcat.jdbc.pool.PoolProperties
implements DataSourceFactory

A Tomcat JDBC Pool DataSourceFactory implementation that creates a JDBC pool backed datasource. Allows the configuration of all configuration properties except username, password, url and driver class name because they are passed in while actually creating the datasource. All other properties can be modified by calling the respective setter methods. This class uses a DatabasePlatformSupport implementation to actually retrieve the driver class name and url in order to create the datasource.

All properties are derived from PoolConfiguration of the Tomcat JDBC Pool class.

Since:

1.0

Author:

Agim Emruli

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.tomcat.jdbc.pool.PoolProperties

org.apache.tomcat.jdbc.pool.PoolProperties.InterceptorDefinition, org.apache.tomcat.jdbc.pool.PoolProperties.InterceptorProperty

Field Summary

Fields inherited from class org.apache.tomcat.jdbc.pool.PoolProperties

DEFAULT_MAX_ACTIVE, poolCounter

Fields inherited from interface org.apache.tomcat.jdbc.pool.PoolConfiguration

PKG_PREFIX

Constructor Summary

Constructors

Constructor and Description
TomcatJdbcDataSourceFactory()

Method Summary

Modifier and Type	Method and Description
void	closeDataSource(DataSource dataSource) Will be called if the datasource is not used anymore to allow the factory to release any resource that are used by the created object.
org.apache.tomcat.jdbc.pool.DataSource	createDataSource(DataSourceInformation dataSourceInformation) Creates a datasource with the passed in information.
void	setDatabasePlatformSupport(DatabasePlatformSupport databasePlatformSupport)
void	setDefaultTransactionIsolationName(String constantName)
void	setDriverClassName(String driverClassName)
void	setPassword(String password)
void	setUrl(String url)
void	setUsername(String username)

Methods inherited from class org.apache.tomcat.jdbc.pool.PoolProperties

clone, getAbandonWhenPercentageFull, getCommitOnReturn, getConnectionProperties, getDataSource, getDataSourceJNDI, getDbProperties, getDefaultAutoCommit, getDefaultCatalog, getDefaultReadOnly, getDefaultTransactionIsolation, getDriverClassName, getInitialSize, getInitSQL, getJdbcInterceptors, getJdbcInterceptorsAsArray, getLogValidationErrors, getMaxActive, getMaxAge, getMaxIdle, getMaxWait, getMinEvictableIdleTimeMillis, getMinIdle, getName, getNumTestsPerEvictionRun, getPassword, getPoolCounter, getPoolName, getPropagateInterruptState, getProperties, getRemoveAbandonedTimeout, getRollbackOnReturn, getSuspectTimeout, getTimeBetweenEvictionRunsMillis, getUrl, getUseDisposableConnectionFacade, getUseLock, getUsername, getUseStatementFacade, getValidationInterval, getValidationQuery, getValidationQueryTimeout, getValidator, getValidatorClassName, isAccessToUnderlyingConnectionAllowed, isAlternateUsernameAllowed, isDefaultAutoCommit, isDefaultReadOnly, isFairQueue, isIgnoreExceptionOnPreLoad, isJmxEnabled, isLogAbandoned, isPoolSweeperEnabled, isRemoveAbandoned, isTestOnBorrow, isTestOnConnect, isTestOnReturn, isTestWhileIdle, isUseEquals, setAbandonWhenPercentageFull, setAccessToUnderlyingConnectionAllowed, setAlternateUsernameAllowed, setCommitOnReturn, setConnectionProperties, setDataSource, setDataSourceJNDI, setDbProperties, setDefaultAutoCommit, setDefaultCatalog, setDefaultReadOnly, setDefaultTransactionIsolation, setFairQueue, setIgnoreExceptionOnPreLoad, setInitialSize, setInitSQL, setJdbcInterceptors, setJmxEnabled, setLogAbandoned, setLogValidationErrors, setMaxActive, setMaxAge, setMaxIdle, setMaxWait, setMinEvictableIdleTimeMillis, setMinIdle, setName, setNumTestsPerEvictionRun, setPropagateInterruptState, setRemoveAbandoned, setRemoveAbandonedTimeout, setRollbackOnReturn, setSuspectTimeout, setTestOnBorrow, setTestOnConnect, setTestOnReturn, setTestWhileIdle, setTimeBetweenEvictionRunsMillis, setUseDisposableConnectionFacade, setUseEquals, setUseLock, setUseStatementFacade, setValidationInterval, setValidationQuery, setValidationQueryTimeout, setValidator, setValidatorClassName, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

TomcatJdbcDataSourceFactory

public TomcatJdbcDataSourceFactory()

Method Detail

setUsername

public void setUsername(String username)

Specified by:

setUsername in interface org.apache.tomcat.jdbc.pool.PoolConfiguration

Overrides:

setUsername in class org.apache.tomcat.jdbc.pool.PoolProperties

setPassword

public void setPassword(String password)

Specified by:

setPassword in interface org.apache.tomcat.jdbc.pool.PoolConfiguration

Overrides:

setPassword in class org.apache.tomcat.jdbc.pool.PoolProperties

setDriverClassName

public void setDriverClassName(String driverClassName)

Specified by:

setDriverClassName in interface org.apache.tomcat.jdbc.pool.PoolConfiguration

Overrides:

setDriverClassName in class org.apache.tomcat.jdbc.pool.PoolProperties

setUrl

public void setUrl(String url)

Specified by:

setUrl in interface org.apache.tomcat.jdbc.pool.PoolConfiguration

Overrides:

setUrl in class org.apache.tomcat.jdbc.pool.PoolProperties

setDefaultTransactionIsolationName

public void setDefaultTransactionIsolationName(String constantName)

setDatabasePlatformSupport

public void setDatabasePlatformSupport(DatabasePlatformSupport databasePlatformSupport)

createDataSource

public org.apache.tomcat.jdbc.pool.DataSource createDataSource(DataSourceInformation dataSourceInformation)

Description copied from interface: DataSourceFactory

Creates a datasource with the passed in information. The datasource itself should be fully constructed and initialized to be used in a multi threaded environment.

Specified by:

createDataSource in interface DataSourceFactory

Parameters:

dataSourceInformation - - the DataSourceInformation parameter object which holds all dynamic information for the datasource creation.

Returns:

- a fully initialized datasource instance which can be used by the application to actually interact with a database platform

closeDataSource

public void closeDataSource(DataSource dataSource)

Description copied from interface: DataSourceFactory

Will be called if the datasource is not used anymore to allow the factory to release any resource that are used by the created object. Implementation should check if the passed in datasource is a "known" datasource and if so interact with the to shutdown the datasource. On well known datasource like Apache Commons DBCP and Apache Tomcat JDBC this method will call the close() method to release any connection which are held in the pool.

Specified by:

closeDataSource in interface DataSourceFactory

Parameters:

dataSource - - The datasource that is not used anymore and can be destroyed by the factory