/*
 * Copyright 2002-2017 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.springframework.jdbc.datasource;

import java.sql.Connection;
import java.sql.SQLException;
import java.util.Properties;

import org.springframework.lang.Nullable;

Abstract base class for JDBC DataSource implementations that operate on a JDBC Driver. 
Author:
Juergen Hoeller
See Also:
SimpleDriverDataSource
DriverManagerDataSource
Since:
2.5.5/**
 * Abstract base class for JDBC {@link javax.sql.DataSource} implementations
 * that operate on a JDBC {@link java.sql.Driver}.
 *
 * @author Juergen Hoeller
 * @since 2.5.5
 * @see SimpleDriverDataSource
 * @see DriverManagerDataSource
 */
public abstract class AbstractDriverBasedDataSource extends AbstractDataSource {

	@Nullable
	private String url;

	@Nullable
	private String username;

	@Nullable
	private String password;

	@Nullable
	private String catalog;

	@Nullable
	private String schema;

	@Nullable
	private Properties connectionProperties;


	
Set the JDBC URL to use for connecting through the Driver.
See Also:
connect.connect(String, Properties)/**
	 * Set the JDBC URL to use for connecting through the Driver.
	 * @see java.sql.Driver#connect(String, java.util.Properties)
	 */
	public void setUrl(@Nullable String url) {
		this.url = (url != null ? url.trim() : null);
	}

	
Return the JDBC URL to use for connecting through the Driver.
/**
	 * Return the JDBC URL to use for connecting through the Driver.
	 */
	@Nullable
	public String getUrl() {
		return this.url;
	}

	
Set the JDBC username to use for connecting through the Driver.
See Also:
connect.connect(String, Properties)/**
	 * Set the JDBC username to use for connecting through the Driver.
	 * @see java.sql.Driver#connect(String, java.util.Properties)
	 */
	public void setUsername(@Nullable String username) {
		this.username = username;
	}

	
Return the JDBC username to use for connecting through the Driver.
/**
	 * Return the JDBC username to use for connecting through the Driver.
	 */
	@Nullable
	public String getUsername() {
		return this.username;
	}

	
Set the JDBC password to use for connecting through the Driver.
See Also:
connect.connect(String, Properties)/**
	 * Set the JDBC password to use for connecting through the Driver.
	 * @see java.sql.Driver#connect(String, java.util.Properties)
	 */
	public void setPassword(@Nullable String password) {
		this.password = password;
	}

	
Return the JDBC password to use for connecting through the Driver.
/**
	 * Return the JDBC password to use for connecting through the Driver.
	 */
	@Nullable
	public String getPassword() {
		return this.password;
	}

	
Specify a database catalog to be applied to each Connection.
See Also:
Connection.setCatalog
Since:
4.3.2/**
	 * Specify a database catalog to be applied to each Connection.
	 * @since 4.3.2
	 * @see Connection#setCatalog
	 */
	public void setCatalog(@Nullable String catalog) {
		this.catalog = catalog;
	}

	
Return the database catalog to be applied to each Connection, if any.
Since:
4.3.2/**
	 * Return the database catalog to be applied to each Connection, if any.
	 * @since 4.3.2
	 */
	@Nullable
	public String getCatalog() {
		return this.catalog;
	}

	
Specify a database schema to be applied to each Connection.
See Also:
Connection.setSchema
Since:
4.3.2/**
	 * Specify a database schema to be applied to each Connection.
	 * @since 4.3.2
	 * @see Connection#setSchema
	 */
	public void setSchema(@Nullable String schema) {
		this.schema = schema;
	}

	
Return the database schema to be applied to each Connection, if any.
Since:
4.3.2/**
	 * Return the database schema to be applied to each Connection, if any.
	 * @since 4.3.2
	 */
	@Nullable
	public String getSchema() {
		return this.schema;
	}

	
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:
connect.connect(String, Properties)/**
	 * Specify arbitrary connection properties as key/value pairs,
	 * to be passed to the Driver.
	 * <p>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 java.sql.Driver#connect(String, java.util.Properties)
	 */
	public void setConnectionProperties(@Nullable Properties connectionProperties) {
		this.connectionProperties = connectionProperties;
	}

	
Return the connection properties to be passed to the Driver, if any.
/**
	 * Return the connection properties to be passed to the Driver, if any.
	 */
	@Nullable
	public Properties getConnectionProperties() {
		return this.connectionProperties;
	}


	
This implementation delegates to getConnectionFromDriver, using the default username and password of this DataSource. 
See Also:
getConnectionFromDriver(String, String)
setUsername
setPassword/**
	 * This implementation delegates to {@code getConnectionFromDriver},
	 * using the default username and password of this DataSource.
	 * @see #getConnectionFromDriver(String, String)
	 * @see #setUsername
	 * @see #setPassword
	 */
	@Override
	public Connection getConnection() throws SQLException {
		return getConnectionFromDriver(getUsername(), getPassword());
	}

	
This implementation delegates to getConnectionFromDriver, using the given username and password. 
See Also:
getConnectionFromDriver(String, String)/**
	 * This implementation delegates to {@code getConnectionFromDriver},
	 * using the given username and password.
	 * @see #getConnectionFromDriver(String, String)
	 */
	@Override
	public Connection getConnection(String username, String password) throws SQLException {
		return getConnectionFromDriver(username, password);
	}


	
Build properties for the Driver, including the given username and password (if any),
and obtain a corresponding Connection.
Params:
username – the name of the user
password – the password to use
Throws:
SQLException – in case of failure
See Also:
Driver.connect(String, Properties)
Returns:
the obtained Connection/**
	 * Build properties for the Driver, including the given username and password (if any),
	 * and obtain a corresponding Connection.
	 * @param username the name of the user
	 * @param password the password to use
	 * @return the obtained Connection
	 * @throws SQLException in case of failure
	 * @see java.sql.Driver#connect(String, java.util.Properties)
	 */
	protected Connection getConnectionFromDriver(@Nullable String username, @Nullable String password) throws SQLException {
		Properties mergedProps = new Properties();
		Properties connProps = getConnectionProperties();
		if (connProps != null) {
			mergedProps.putAll(connProps);
		}
		if (username != null) {
			mergedProps.setProperty("user", username);
		}
		if (password != null) {
			mergedProps.setProperty("password", password);
		}

		Connection con = getConnectionFromDriver(mergedProps);
		if (this.catalog != null) {
			con.setCatalog(this.catalog);
		}
		if (this.schema != null) {
			con.setSchema(this.schema);
		}
		return con;
	}

	
Obtain a Connection using the given properties.
Template method to be implemented by subclasses.
Params:
props – the merged connection properties
Throws:
SQLException – in case of failure
Returns:
the obtained Connection/**
	 * Obtain a Connection using the given properties.
	 * <p>Template method to be implemented by subclasses.
	 * @param props the merged connection properties
	 * @return the obtained Connection
	 * @throws SQLException in case of failure
	 */
	protected abstract Connection getConnectionFromDriver(Properties props) throws SQLException;

}