org.springframework.jdbc.datasource: public class: UserCredentialsDataSourceAdapter

org.springframework.jdbc.datasource
public class: UserCredentialsDataSourceAdapter [javadoc | source]

java.lang.Object
   org.springframework.jdbc.datasource.DelegatingDataSource
      org.springframework.jdbc.datasource.UserCredentialsDataSourceAdapter

All Implemented Interfaces:
DataSource, InitializingBean

Direct Known Subclasses:
IsolationLevelDataSourceAdapter, WebSphereDataSourceAdapter

An adapter for a target JDBC javax.sql.DataSource , applying the specified user credentials to every standard getConnection() call, implicitly invoking getConnection(username, password) on the target. All other methods simply delegate to the corresponding methods of the target DataSource.

Can be used to proxy a target JNDI DataSource that does not have user credentials configured. Client code can work with this DataSource as usual, using the standard getConnection() call.

In the following example, client code can simply transparently work with the preconfigured "myDataSource", implicitly accessing "myTargetDataSource" with the specified user credentials.

<bean id="myTargetDataSource" class="org.springframework.jndi.JndiObjectFactoryBean">
<property name="jndiName" value="java:comp/env/jdbc/myds"/>
</bean>

<bean id="myDataSource" class="org.springframework.jdbc.datasource.UserCredentialsDataSourceAdapter">
<property name="targetDataSource" ref="myTargetDataSource"/>
<property name="username" value="myusername"/>
<property name="password" value="mypassword"/>
</bean>

If the "username" is empty, this proxy will simply delegate to the standard getConnection() method of the target DataSource. This can be used to keep a UserCredentialsDataSourceAdapter bean definition just for the option of implicitly passing in user credentials if the particular target DataSource requires it.

Also see:

getConnection

author: Juergen - Hoeller

since: 1.0.2 -

Method from org.springframework.jdbc.datasource.UserCredentialsDataSourceAdapter Summary:
doGetConnection, getConnection, getConnection, removeCredentialsFromCurrentThread, setCredentialsForCurrentThread, setPassword, setUsername

Methods from org.springframework.jdbc.datasource.DelegatingDataSource:
afterPropertiesSet, getConnection, getConnection, getLogWriter, getLoginTimeout, getTargetDataSource, isWrapperFor, setLogWriter, setLoginTimeout, setTargetDataSource, unwrap

Methods from java.lang.Object:
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method from org.springframework.jdbc.datasource.UserCredentialsDataSourceAdapter Detail:
protected Connection doGetConnection(String username, String password) throws SQLException { Assert.state(getTargetDataSource() != null, "'targetDataSource' is required"); if (StringUtils.hasLength(username)) { return getTargetDataSource().getConnection(username, password); } else { return getTargetDataSource().getConnection(); } } This implementation delegates to the `getConnection(username, password)` method of the target DataSource, passing in the specified user credentials. If the specified username is empty, it will simply delegate to the standard `getConnection()` method of the target DataSource.
public Connection getConnection() throws SQLException { JdbcUserCredentials threadCredentials = (JdbcUserCredentials) this.threadBoundCredentials.get(); if (threadCredentials != null) { return doGetConnection(threadCredentials.username, threadCredentials.password); } else { return doGetConnection(this.username, this.password); } } Determine whether there are currently thread-bound credentials, using them if available, falling back to the statically specified username and password (i.e. values of the bean properties) else. Delegates to #doGetConnection(String, String) with the determined credentials as parameters.
public Connection getConnection(String username, String password) throws SQLException { return doGetConnection(username, password); } Simply delegates to #doGetConnection(String, String) , keeping the given user credentials as-is.
public void removeCredentialsFromCurrentThread() { this.threadBoundCredentials.set(null); } Remove any user credentials for this proxy from the current thread. Statically specified user credentials apply again afterwards.
public void setCredentialsForCurrentThread(String username, String password) { this.threadBoundCredentials.set(new JdbcUserCredentials(username, password)); } Set user credententials for this proxy and the current thread. The given username and password will be applied to all subsequent `getConnection()` calls on this DataSource proxy. This will override any statically specified user credentials, that is, values of the "username" and "password" bean properties.
public void setPassword(String password) { this.password = password; } Set the default user's password that this adapter should use for retrieving Connections. Default is no specific password. Note that an explicitly specified username will always override any username/password specified at the DataSource level.
public void setUsername(String username) { this.username = username; } Set the default username that this adapter should use for retrieving Connections. Default is no specific user. Note that an explicitly specified username will always override any username/password specified at the DataSource level.

Method from org.springframework.jdbc.datasource.UserCredentialsDataSourceAdapter Detail:

 protected Connection doGetConnection(String username,
    String password) throws SQLException {
		Assert.state(getTargetDataSource() != null, "'targetDataSource' is required");
		if (StringUtils.hasLength(username)) {
			return getTargetDataSource().getConnection(username, password);
		}
		else {
			return getTargetDataSource().getConnection();
		}
}

getConnection(username, password)

getConnection()

 public Connection getConnection() throws SQLException {
		JdbcUserCredentials threadCredentials = (JdbcUserCredentials) this.threadBoundCredentials.get();
		if (threadCredentials != null) {
			return doGetConnection(threadCredentials.username, threadCredentials.password);
		}
		else {
			return doGetConnection(this.username, this.password);
		}
}

Delegates to #doGetConnection(String, String) with the determined credentials as parameters.

 public Connection getConnection(String username,
    String password) throws SQLException {
		return doGetConnection(username, password);
}

#doGetConnection(String, String)

 public  void removeCredentialsFromCurrentThread() {
		this.threadBoundCredentials.set(null);
}

Remove any user credentials for this proxy from the current thread. Statically specified user credentials apply again afterwards.

 public  void setCredentialsForCurrentThread(String username,
    String password) {
		this.threadBoundCredentials.set(new JdbcUserCredentials(username, password));
}

getConnection()

This will override any statically specified user credentials, that is, values of the "username" and "password" bean properties.

 public  void setPassword(String password) {
		this.password = password;
}

Default is no specific password. Note that an explicitly specified username will always override any username/password specified at the DataSource level.

 public  void setUsername(String username) {
	                                         	 
		this.username = username;
}

Default is no specific user. Note that an explicitly specified username will always override any username/password specified at the DataSource level.