io.awspring.cloud.jdbc.datasource

Interface DataSourceFactory

All Known Implementing Classes:

TomcatJdbcDataSourceFactory

public interface DataSourceFactory

Factory to create DataSource instances at runtime. In contrast to the regular datasource definitions, this interface allows the dynamic creation of datasource at runtime. This is especially useful and needed if the datasource information like the url, username and password are not available at configuration time. With this factory it is possible to create datasource with configuration information which is fetched while starting the application. Because of the dynamic creation of datasource at runtime, this interface also provides the lifecycle method closeDataSource(javax.sql.DataSource) to actually shutdown the created datasource. This method should be called while destroying the application itself.

Note: This interface does not assume what kind of datasource is returned. It is strongly recommended to use an already existing and pooled datasource like Tomcat JDBC datasource for real life production applications.

Since:

1.0

Author:

Agim Emruli

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.
DataSource	createDataSource(DataSourceInformation dataSourceInformation) Creates a datasource with the passed in information.

Method Detail

createDataSource

DataSource createDataSource(DataSourceInformation dataSourceInformation)

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.

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

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. 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.

Parameters:

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