Class AbstractDriverBasedDataSource

java.lang.Object

org.springframework.jdbc.datasource.AbstractDataSource

org.springframework.jdbc.datasource.AbstractDriverBasedDataSource

All Implemented Interfaces:

Wrapper, CommonDataSource, DataSource

Direct Known Subclasses:

DriverManagerDataSource, SimpleDriverDataSource

public abstract class AbstractDriverBasedDataSource
extends AbstractDataSource

Abstract base class for JDBC DataSource implementations that operate on a JDBC Driver.

Since:

2.5.5

Author:

Juergen Hoeller

See Also:

• SimpleDriverDataSource
• DriverManagerDataSource

Field Summary

Fields inherited from class AbstractDataSource

logger

Constructor Summary

Constructors

Constructor	Description
AbstractDriverBasedDataSource()

Method Summary

Modifier and Type	Method	Description
@Nullable String	getCatalog()	Return the database catalog to be applied to each Connection, if any.
Connection	getConnection()	This implementation delegates to getConnectionFromDriver, using the default username and password of this DataSource.
Connection	getConnection(String username, String password)	This implementation delegates to getConnectionFromDriver, using the given username and password.
protected Connection	getConnectionFromDriver(@Nullable String username, @Nullable String password)	Build properties for the Driver, including the given username and password (if any), and obtain a corresponding Connection.
protected abstract Connection	getConnectionFromDriver(Properties props)	Obtain a Connection using the given properties.
@Nullable Properties	getConnectionProperties()	Return the connection properties to be passed to the Driver, if any.
@Nullable String	getPassword()	Return the JDBC password to use for connecting through the Driver.
@Nullable String	getSchema()	Return the database schema to be applied to each Connection, if any.
@Nullable String	getUrl()	Return the JDBC URL to use for connecting through the Driver.
@Nullable String	getUsername()	Return the JDBC username to use for connecting through the Driver.
void	setCatalog(@Nullable String catalog)	Specify a database catalog to be applied to each Connection.
void	setConnectionProperties(@Nullable Properties connectionProperties)	Specify arbitrary connection properties as key/value pairs, to be passed to the Driver.
void	setPassword(@Nullable String password)	Set the JDBC password to use for connecting through the Driver.
void	setSchema(@Nullable String schema)	Specify a database schema to be applied to each Connection.
void	setUrl(@Nullable String url)	Set the JDBC URL to use for connecting through the Driver.
void	setUsername(@Nullable String username)	Set the JDBC username to use for connecting through the Driver.

Methods inherited from class AbstractDataSource

getLoginTimeout, getLogWriter, getParentLogger, isWrapperFor, setLoginTimeout, setLogWriter, unwrap

Methods inherited from class Object

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

Methods inherited from interface CommonDataSource

createShardingKeyBuilder

Methods inherited from interface DataSource

createConnectionBuilder

Constructor Details

AbstractDriverBasedDataSource

public AbstractDriverBasedDataSource()

Method Details

setUrl

public void setUrl(@Nullable String url)

Set the JDBC URL to use for connecting through the Driver.

See Also:

• Driver.connect(String, java.util.Properties)

getUrl

public @Nullable String getUrl()

Return the JDBC URL to use for connecting through the Driver.

setUsername

public void setUsername(@Nullable String username)

Set the JDBC username to use for connecting through the Driver.

See Also:

• Driver.connect(String, java.util.Properties)

getUsername

public @Nullable String getUsername()

Return the JDBC username to use for connecting through the Driver.

setPassword

public void setPassword(@Nullable String password)

Set the JDBC password to use for connecting through the Driver.

See Also:

• Driver.connect(String, java.util.Properties)

getPassword

public @Nullable String getPassword()

Return the JDBC password to use for connecting through the Driver.

setCatalog

public void setCatalog(@Nullable String catalog)

Specify a database catalog to be applied to each Connection.

Since:

4.3.2

See Also:

• Connection.setCatalog(String)

getCatalog

public @Nullable String getCatalog()

Return the database catalog to be applied to each Connection, if any.

Since:

4.3.2

setSchema

public void setSchema(@Nullable String schema)

Specify a database schema to be applied to each Connection.

Since:

4.3.2

See Also:

• Connection.setSchema(String)

getSchema

public @Nullable String getSchema()

Return the database schema to be applied to each Connection, if any.

Since:

4.3.2

setConnectionProperties

public void setConnectionProperties(@Nullable Properties connectionProperties)

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.

See Also:

• Driver.connect(String, java.util.Properties)

getConnectionProperties

public @Nullable Properties getConnectionProperties()

Return the connection properties to be passed to the Driver, if any.

getConnection

public Connection getConnection()
                         throws SQLException

This implementation delegates to getConnectionFromDriver, using the default username and password of this DataSource.

Throws:

SQLException

See Also:

• getConnectionFromDriver(String, String)
• setUsername(String)
• setPassword(String)

getConnection

public Connection getConnection(String username,
 String password)
                         throws SQLException

This implementation delegates to getConnectionFromDriver, using the given username and password.

Throws:

SQLException

See Also:

• getConnectionFromDriver(String, String)

getConnectionFromDriver

protected Connection getConnectionFromDriver(@Nullable String username,
 @Nullable String password)
                                      throws SQLException

Build properties for the Driver, including the given username and password (if any), and obtain a corresponding Connection.

Parameters:

username - the name of the user

password - the password to use

Returns:

the obtained Connection

Throws:

SQLException - in case of failure

See Also:

• Driver.connect(String, java.util.Properties)

getConnectionFromDriver

protected abstract Connection getConnectionFromDriver(Properties props)
                                               throws SQLException

Obtain a Connection using the given properties.

Template method to be implemented by subclasses.

Parameters:

props - the merged connection properties

Returns:

the obtained Connection

Throws:

SQLException - in case of failure