Spring Framework 6.1.4 · org.springframework.jdbc.datasource.AbstractDriverBasedDataSource

Modifier and Type	Field and Description
private String	catalog
private Properties	connectionProperties
private String	password
private String	schema
private String	url
private String	username

Access	Constructor and Description
public	AbstractDriverBasedDataSource()

Method Summary

Modifier and Type	Method and Description
public String	getCatalog() Return the database catalog to be applied to each Connection, if any.
public Connection	getConnection() Implements javax.sql.DataSource.getConnection. This implementation delegates to `getConnectionFromDriver`, using the default username and password of this DataSource.
public Connection	getConnection(String the database user on whose behalf the connection is being made username, String the user's password password) Implements javax.sql.DataSource.getConnection. This implementation delegates to `getConnectionFromDriver`, using the given username and password.
protected Connection	Returns: the obtained Connection getConnectionFromDriver(String the name of the user username, String the password to use password) Build properties for the Driver, including the given username and password (if any), and obtain a corresponding Connection.
protected abstract Connection	Returns: the obtained Connection getConnectionFromDriver(Properties the merged connection properties props) Obtain a Connection using the given properties.
public Properties	getConnectionProperties() Return the connection properties to be passed to the Driver, if any.
public String	getPassword() Return the JDBC password to use for connecting through the Driver.
public String	getSchema() Return the database schema to be applied to each Connection, if any.
public String	getUrl() Return the JDBC URL to use for connecting through the Driver.
public String	getUsername() Return the JDBC username to use for connecting through the Driver.
public void	setCatalog(String catalog) Specify a database catalog to be applied to each Connection.
public void	setConnectionProperties(Properties connectionProperties) Specify arbitrary connection properties as key/value pairs, to be passed to the Driver.
public void	setPassword(String password) Set the JDBC password to use for connecting through the Driver.
public void	setSchema(String schema) Specify a database schema to be applied to each Connection.
public void	setUrl(String url) Set the JDBC URL to use for connecting through the Driver.
public void	setUsername(String username) Set the JDBC username to use for connecting through the Driver.

Inherited from org.springframework.jdbc.datasource.AbstractDataSource:: getLoginTimeout getLogWriter getParentLogger isWrapperFor setLoginTimeout setLogWriter unwrap

catalog	back to summary
private String catalog Annotations @Nullable

connectionProperties	back to summary
private Properties connectionProperties Annotations @Nullable

password	back to summary
private String password Annotations @Nullable

schema	back to summary
private String schema Annotations @Nullable

url	back to summary
private String url Annotations @Nullable

username	back to summary
private String username Annotations @Nullable

AbstractDriverBasedDataSource	back to summary
public AbstractDriverBasedDataSource()

Method Detail

getCatalog	back to summary
public String getCatalog() Return the database catalog to be applied to each Connection, if any. Annotations @Nullable Since 4.3.2

getCatalog

back to summary

public String getCatalog()

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

Annotations

@Nullable

Since

4.3.2

getConnection back to summary

getConnection	back to summary
public Connection getConnection() throws SQLException Implements javax.sql.DataSource.getConnection. This implementation delegates to `getConnectionFromDriver`, using the default username and password of this DataSource. Returns:Connection Doc from javax.sql.DataSource.getConnection. a connection to the data source Annotations @Override Exceptions SQLException: Doc from javax.sql.DataSource.getConnection. if a database access error occurs See Also `getConnectionFromDriver(String, String)`, `setUsername`, `setPassword`

public Connection getConnection() throws SQLException

Implements javax.sql.DataSource.getConnection.

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

Returns:Connection

Doc from javax.sql.DataSource.getConnection.

a connection to the data source

Annotations

@Override

Exceptions

SQLException:

Doc from javax.sql.DataSource.getConnection.

if a database access error occurs

getConnection back to summary

getConnection	back to summary
public Connection getConnection(String username, String password) throws SQLException Implements javax.sql.DataSource.getConnection. This implementation delegates to `getConnectionFromDriver`, using the given username and password. Parameters username:String Doc from javax.sql.DataSource.getConnection. the database user on whose behalf the connection is being made password:String Doc from javax.sql.DataSource.getConnection. the user's password Returns:Connection Doc from javax.sql.DataSource.getConnection. a connection to the data source Annotations @Override Exceptions SQLException: Doc from javax.sql.DataSource.getConnection. if a database access error occurs See Also `getConnectionFromDriver(String, String)`

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

Implements javax.sql.DataSource.getConnection.

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

Parameters

username:String

Doc from javax.sql.DataSource.getConnection.

the database user on whose behalf the connection is being made

password:String

Doc from javax.sql.DataSource.getConnection.

the user's password

Returns:Connection

Doc from javax.sql.DataSource.getConnection.

a connection to the data source

Annotations

@Override

Exceptions

SQLException:

Doc from javax.sql.DataSource.getConnection.

if a database access error occurs

getConnectionFromDriver back to summary

getConnectionFromDriver	back to summary
protected Connection getConnectionFromDriver(String username, String password) throws SQLException Build properties for the Driver, including the given username and password (if any), and obtain a corresponding Connection. Parameters username:String the name of the user password:String the password to use Returns:Connection the obtained Connection Exceptions SQLException: in case of failure See Also `java.sql.Driver#connect(String, java.util.Properties)`

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

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

Parameters

username:String: the name of the user
password:String: the password to use

Returns:Connection

the obtained Connection

Exceptions

SQLException:: in case of failure

getConnectionFromDriver	back to summary
protected abstract Connection getConnectionFromDriver(Properties props) throws SQLException Obtain a Connection using the given properties. Template method to be implemented by subclasses. Parameters props:Properties the merged connection properties Returns:Connection the obtained Connection Exceptions SQLException: in case of failure

getConnectionFromDriver

back to summary

protected abstract Connection getConnectionFromDriver(Properties props) throws SQLException

Obtain a Connection using the given properties.

Template method to be implemented by subclasses.

Parameters

props:Properties: the merged connection properties

Returns:Connection

the obtained Connection

Exceptions

SQLException:: in case of failure

getConnectionProperties	back to summary
public Properties getConnectionProperties() Return the connection properties to be passed to the Driver, if any. Annotations @Nullable

getConnectionProperties

back to summary

public Properties getConnectionProperties()

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

Annotations

@Nullable

getPassword	back to summary
public String getPassword() Return the JDBC password to use for connecting through the Driver. Annotations @Nullable

getPassword

back to summary

public String getPassword()

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

Annotations

@Nullable

getSchema	back to summary
public String getSchema() Return the database schema to be applied to each Connection, if any. Annotations @Nullable Since 4.3.2

getSchema

back to summary

public String getSchema()

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

Annotations

@Nullable

Since

4.3.2

getUrl	back to summary
public String getUrl() Return the JDBC URL to use for connecting through the Driver. Annotations @Nullable

getUrl

back to summary

public String getUrl()

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

Annotations

@Nullable

getUsername	back to summary
public String getUsername() Return the JDBC username to use for connecting through the Driver. Annotations @Nullable

getUsername

back to summary

public String getUsername()

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

Annotations

@Nullable

setCatalog back to summary

setCatalog	back to summary
public void setCatalog(String catalog) Specify a database catalog to be applied to each Connection. Since 4.3.2 See Also `Connection#setCatalog`

public void setCatalog(String catalog)

Specify a database catalog to be applied to each Connection.

Since: 4.3.2
See Also: Connection#setCatalog

setConnectionProperties back to summary

setConnectionProperties	back to summary
public void setConnectionProperties(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 `java.sql.Driver#connect(String, java.util.Properties)`

public void setConnectionProperties(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: java.sql.Driver#connect(String, java.util.Properties)

setPassword back to summary

setPassword	back to summary
public void setPassword(String password) Set the JDBC password to use for connecting through the Driver. See Also `java.sql.Driver#connect(String, java.util.Properties)`

public void setPassword(String password)

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

See Also: java.sql.Driver#connect(String, java.util.Properties)

setSchema back to summary

setSchema	back to summary
public void setSchema(String schema) Specify a database schema to be applied to each Connection. Since 4.3.2 See Also `Connection#setSchema`

public void setSchema(String schema)

Specify a database schema to be applied to each Connection.

Since: 4.3.2
See Also: Connection#setSchema

setUrl back to summary

setUrl	back to summary
public void setUrl(String url) Set the JDBC URL to use for connecting through the Driver. See Also `java.sql.Driver#connect(String, java.util.Properties)`

public void setUrl(String url)

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

See Also: java.sql.Driver#connect(String, java.util.Properties)

setUsername back to summary

setUsername	back to summary
public void setUsername(String username) Set the JDBC username to use for connecting through the Driver. See Also `java.sql.Driver#connect(String, java.util.Properties)`

public void setUsername(String username)

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

See Also: java.sql.Driver#connect(String, java.util.Properties)

public abstract Class AbstractDriverBasedDataSource

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail