spring-framework / org.springframework.jdbc.datasource / DriverManagerDataSource

DriverManagerDataSource

open class DriverManagerDataSource : AbstractDriverBasedDataSource

Simple implementation of the standard JDBC javax.sql.DataSource interface, configuring the plain old JDBC java.sql.DriverManager via bean properties, and returning a new java.sql.Connection from every getConnection call.

NOTE: This class is not an actual connection pool; it does not actually pool Connections. It just serves as simple replacement for a full-blown connection pool, implementing the same standard interface, but creating new Connections on every call.

Useful for test or standalone environments outside of a Java EE container, either as a DataSource bean in a corresponding ApplicationContext or in conjunction with a simple JNDI environment. Pool-assuming Connection.close() calls will simply close the Connection, so any DataSource-aware persistence code should work.

NOTE: Within special class loading environments such as OSGi, this class is effectively superseded by SimpleDriverDataSource due to general class loading issues with the JDBC DriverManager that be resolved through direct Driver usage (which is exactly what SimpleDriverDataSource does).

In a Java EE container, it is recommended to use a JNDI DataSource provided by the container. Such a DataSource can be exposed as a DataSource bean in a Spring ApplicationContext via org.springframework.jndi.JndiObjectFactoryBean, for seamless switching to and from a local DataSource bean like this class. For tests, you can then either set up a mock JNDI environment through Spring's org.springframework.mock.jndi.SimpleNamingContextBuilder, or switch the bean definition to a local DataSource (which is simpler and thus recommended).

If you need a "real" connection pool outside of a Java EE container, consider Apache Commons DBCP or C3P0. Commons DBCP's BasicDataSource and C3P0's ComboPooledDataSource are full connection pool beans, supporting the same basic properties as this class plus specific settings (such as minimal/maximal pool size etc).

Author
Juergen Hoeller

Since
14.03.2003

See Also
SimpleDriverDataSource

Constructors

<init>

DriverManagerDataSource()

Constructor for bean-style configuration.

DriverManagerDataSource(url: String)
DriverManagerDataSource(url: String, conProps: Properties)

Create a new DriverManagerDataSource with the given JDBC URL, not specifying a username or password for JDBC access.

DriverManagerDataSource(url: String, username: String, password: String)

Create a new DriverManagerDataSource with the given standard DriverManager parameters.

Functions

setDriverClassName

open fun setDriverClassName(driverClassName: String): Unit

Set the JDBC driver class name. This driver will get initialized on startup, registering itself with the JDK's DriverManager.

NOTE: DriverManagerDataSource is primarily intended for accessing pre-registered JDBC drivers. If you need to register a new driver, consider using SimpleDriverDataSource instead. Alternatively, consider initializing the JDBC driver yourself before instantiating this DataSource. The "driverClassName" property is mainly preserved for backwards compatibility, as well as for migrating between Commons DBCP and this DataSource.

Inherited Functions

getCatalog	`open fun getCatalog(): String` Return the database catalog to be applied to each Connection, if any.
getConnection	`open fun getConnection(): Connection` This implementation delegates to `getConnectionFromDriver`, using the default username and password of this DataSource. `open fun getConnection(username: String, password: String): Connection` This implementation delegates to `getConnectionFromDriver`, using the given username and password.
getConnectionProperties	`open fun getConnectionProperties(): Properties` Return the connection properties to be passed to the Driver, if any.
getPassword	`open fun getPassword(): String` Return the JDBC password to use for connecting through the Driver.
getSchema	`open fun getSchema(): String` Return the database schema to be applied to each Connection, if any.
getUrl	`open fun getUrl(): String` Return the JDBC URL to use for connecting through the Driver.
getUsername	`open fun getUsername(): String` Return the JDBC username to use for connecting through the Driver.
setCatalog	`open fun setCatalog(catalog: String): Unit` Specify a database catalog to be applied to each Connection.
setConnectionProperties	`open fun setConnectionProperties(connectionProperties: Properties): Unit` Specify arbitrary connection properties as key/value pairs, to be passed to the Driver. Can also contain "user" and "password" properties. However, any "username" and "password" bean properties specified on this DataSource will override the corresponding connection properties.
setPassword	`open fun setPassword(password: String): Unit` Set the JDBC password to use for connecting through the Driver.
setSchema	`open fun setSchema(schema: String): Unit` Specify a database schema to be applied to each Connection.
setUrl	`open fun setUrl(url: String): Unit` Set the JDBC URL to use for connecting through the Driver.
setUsername	`open fun setUsername(username: String): Unit` Set the JDBC username to use for connecting through the Driver.

Inheritors

SingleConnectionDataSource

open class SingleConnectionDataSource : DriverManagerDataSource, SmartDataSource, DisposableBean

Implementation of SmartDataSource that wraps a single JDBC Connection which is not closed after use. Obviously, this is not multi-threading capable.

Note that at shutdown, someone should close the underlying Connection via the close() method. Client code will never call close on the Connection handle if it is SmartDataSource-aware (e.g. uses DataSourceUtils.releaseConnection).

If client code will call close() in the assumption of a pooled Connection, like when using persistence tools, set "suppressClose" to "true". This will return a close-suppressing proxy instead of the physical Connection.

This is primarily intended for testing. For example, it enables easy testing outside an application server, for code that expects to work on a DataSource. In contrast to DriverManagerDataSource, it reuses the same Connection all the time, avoiding excessive creation of physical Connections.