Add support for Oracle UCP

See gh-23403

Author: fabio-grassi-gbs

spring-boot-project/spring-boot-autoconfigure/build.gradle

@@ -64,6 +64,7 @@ dependencies {
 	optional("org.codehaus.groovy:groovy-templates")
 	optional("com.github.ben-manes.caffeine:caffeine")
 	optional("com.github.mxab.thymeleaf.extras:thymeleaf-extras-data-attribute")
+	optional("com.oracle.database.jdbc:ucp")
 	optional("com.sendgrid:sendgrid-java")
 	optional("com.unboundid:unboundid-ldapsdk")
 	optional("com.zaxxer:HikariCP")

spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/jdbc/DataSourceAutoConfiguration.java

@@ -48,6 +48,7 @@
  * @author Phillip Webb
  * @author Stephane Nicoll
  * @author Kazuki Shimizu
+ * @author Fabio Grassi
  * @since 1.0.0
  */
 @Configuration(proxyBeanMethods = false)
@@ -69,8 +70,8 @@ protected static class EmbeddedDatabaseConfiguration {
 	@Conditional(PooledDataSourceCondition.class)
 	@ConditionalOnMissingBean({ DataSource.class, XADataSource.class })
 	@Import({ DataSourceConfiguration.Hikari.class, DataSourceConfiguration.Tomcat.class,
-			DataSourceConfiguration.Dbcp2.class, DataSourceConfiguration.Generic.class,
-			DataSourceJmxConfiguration.class })
+			DataSourceConfiguration.Dbcp2.class, DataSourceConfiguration.Ucp.class,
+			DataSourceConfiguration.Generic.class, DataSourceJmxConfiguration.class })
 	protected static class PooledDataSourceConfiguration {
 
 	}

spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/jdbc/DataSourceConfiguration.java

@@ -16,9 +16,13 @@
 
 package org.springframework.boot.autoconfigure.jdbc;
 
+import java.sql.SQLException;
+
 import javax.sql.DataSource;
 
 import com.zaxxer.hikari.HikariDataSource;
+import oracle.ucp.jdbc.PoolDataSource;
+import oracle.ucp.jdbc.PoolDataSourceImpl;
 
 import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
@@ -27,6 +31,7 @@
 import org.springframework.boot.jdbc.DatabaseDriver;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
+import org.springframework.dao.InvalidDataAccessApiUsageException;
 import org.springframework.util.StringUtils;
 
 /**
@@ -35,6 +40,7 @@
  * @author Dave Syer
  * @author Phillip Webb
  * @author Stephane Nicoll
+ * @author Fabio Grassi
  */
 abstract class DataSourceConfiguration {
 
@@ -109,6 +115,33 @@ org.apache.commons.dbcp2.BasicDataSource dataSource(DataSourceProperties propert
 
 	}
 
+	/**
+	 * UCP DataSource configuration.
+	 */
+	@Configuration(proxyBeanMethods = false)
+	@ConditionalOnClass(PoolDataSource.class)
+	@ConditionalOnMissingBean(DataSource.class)
+	@ConditionalOnProperty(name = "spring.datasource.type", havingValue = "oracle.ucp.jdbc.PoolDataSource",
+			matchIfMissing = true)
+	static class Ucp {
+
+		@Bean
+		@ConfigurationProperties(prefix = "spring.datasource.ucp")
+		PoolDataSource dataSource(DataSourceProperties properties) {
+			PoolDataSource dataSource = createDataSource(properties, PoolDataSourceImpl.class);
+			if (StringUtils.hasText(properties.getName())) {
+				try {
+					dataSource.setConnectionPoolName(properties.getName());
+				}
+				catch (SQLException se) {
+					throw new InvalidDataAccessApiUsageException("Error setting property connectionPoolName", se);
+				}
+			}
+			return dataSource;
+		}
+
+	}
+
 	/**
 	 * Generic DataSource configuration.
 	 */

spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/jdbc/metadata/DataSourcePoolMetadataProvidersConfiguration.java

@@ -17,6 +17,7 @@
 package org.springframework.boot.autoconfigure.jdbc.metadata;
 
 import com.zaxxer.hikari.HikariDataSource;
+import oracle.ucp.jdbc.PoolDataSource;
 import org.apache.commons.dbcp2.BasicDataSource;
 
 import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
@@ -25,6 +26,7 @@
 import org.springframework.boot.jdbc.metadata.DataSourcePoolMetadataProvider;
 import org.springframework.boot.jdbc.metadata.HikariDataSourcePoolMetadata;
 import org.springframework.boot.jdbc.metadata.TomcatDataSourcePoolMetadata;
+import org.springframework.boot.jdbc.metadata.UcpDataSourcePoolMetadata;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
 
@@ -33,6 +35,7 @@
  * sources.
  *
  * @author Stephane Nicoll
+ * @author Fabio Grassi
  * @since 1.2.0
  */
 @Configuration(proxyBeanMethods = false)
@@ -90,4 +93,21 @@ DataSourcePoolMetadataProvider commonsDbcp2PoolDataSourceMetadataProvider() {
 
 	}
 
+	@Configuration(proxyBeanMethods = false)
+	@ConditionalOnClass(PoolDataSource.class)
+	static class UcpPoolDataSourceMetadataProviderConfiguration {
+
+		@Bean
+		DataSourcePoolMetadataProvider UcpPoolDataSourceMetadataProvider() {
+			return (dataSource) -> {
+				PoolDataSource ucpDataSource = DataSourceUnwrapper.unwrap(dataSource, PoolDataSource.class);
+				if (ucpDataSource != null) {
+					return new UcpDataSourcePoolMetadata(ucpDataSource);
+				}
+				return null;
+			};
+		}
+
+	}
+
 }

spring-boot-project/spring-boot-autoconfigure/src/test/java/org/springframework/boot/autoconfigure/jdbc/UcpDataSourceConfigurationTests.java

@@ -0,0 +1,105 @@
+/*
+ * Copyright 2012-2020 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.boot.autoconfigure.jdbc;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+import javax.sql.DataSource;
+
+import org.junit.jupiter.api.Test;
+import org.springframework.boot.autoconfigure.AutoConfigurations;
+import org.springframework.boot.test.context.runner.ApplicationContextRunner;
+
+import oracle.ucp.jdbc.PoolDataSource;
+import oracle.ucp.jdbc.PoolDataSourceImpl;
+
+/**
+ * Tests for {@link DataSourceAutoConfiguration} with Oracle UCP.
+ *
+ * @author Fabio Grassi
+ */
+class UcpDataSourceConfigurationTests {
+
+	private static final String PREFIX = "spring.datasource.ucp.";
+
+	private final ApplicationContextRunner contextRunner = new ApplicationContextRunner()
+			.withConfiguration(AutoConfigurations.of(DataSourceAutoConfiguration.class))
+			.withPropertyValues("spring.datasource.initialization-mode=never",
+					"spring.datasource.type=" + PoolDataSource.class.getName());
+
+	@Test
+	void testDataSourceExists() {
+		this.contextRunner.run((context) -> {
+			assertThat(context.getBeansOfType(DataSource.class)).hasSize(1);
+			assertThat(context.getBeansOfType(PoolDataSourceImpl.class)).hasSize(1);
+		});
+	}
+
+	@Test
+	void testDataSourcePropertiesOverridden() {
+		this.contextRunner.withPropertyValues(PREFIX + "URL=jdbc:foo//bar/spam", PREFIX + "maxIdleTime=1234")
+				.run((context) -> {
+					PoolDataSourceImpl ds = context.getBean(PoolDataSourceImpl.class);
+					assertThat(ds.getURL()).isEqualTo("jdbc:foo//bar/spam");
+					assertThat(ds.getMaxIdleTime()).isEqualTo(1234);
+				});
+	}
+
+	@Test
+	void testDataSourceConnectionPropertiesOverridden() {
+		this.contextRunner.withPropertyValues(PREFIX + "connectionProperties.autoCommit=false").run((context) -> {
+			PoolDataSourceImpl ds = context.getBean(PoolDataSourceImpl.class);
+			assertThat(ds.getConnectionProperty("autoCommit")).isEqualTo("false");
+
+		});
+	}
+
+	@Test
+	void testDataSourceDefaultsPreserved() {
+		this.contextRunner.run((context) -> {
+			PoolDataSourceImpl ds = context.getBean(PoolDataSourceImpl.class);
+			assertThat(ds.getInitialPoolSize()).isEqualTo(0);
+			assertThat(ds.getMinPoolSize()).isEqualTo(0);
+			assertThat(ds.getMaxPoolSize()).isEqualTo(Integer.MAX_VALUE);
+			assertThat(ds.getInactiveConnectionTimeout()).isEqualTo(0);
+			assertThat(ds.getConnectionWaitTimeout()).isEqualTo(3);
+			assertThat(ds.getTimeToLiveConnectionTimeout()).isEqualTo(0);
+			assertThat(ds.getAbandonedConnectionTimeout()).isEqualTo(0);
+			assertThat(ds.getTimeoutCheckInterval()).isEqualTo(30);
+			assertThat(ds.getFastConnectionFailoverEnabled()).isFalse();
+		});
+	}
+
+	@Test
+	void nameIsAliasedToPoolName() {
+		this.contextRunner.withPropertyValues("spring.datasource.name=myDS").run((context) -> {
+			PoolDataSourceImpl ds = context.getBean(PoolDataSourceImpl.class);
+			assertThat(ds.getConnectionPoolName()).isEqualTo("myDS");
+
+		});
+	}
+
+	@Test
+	void connectionPoolNameTakesPrecedenceOverName() {
+		this.contextRunner.withPropertyValues("spring.datasource.name=myDS", PREFIX + "connectionPoolName=myUcpDS")
+				.run((context) -> {
+					PoolDataSourceImpl ds = context.getBean(PoolDataSourceImpl.class);
+					assertThat(ds.getConnectionPoolName()).isEqualTo("myUcpDS");
+				});
+	}
+
+}

spring-boot-project/spring-boot/build.gradle

@@ -21,6 +21,7 @@ dependencies {
 	optional("com.atomikos:transactions-jta")
 	optional("com.fasterxml.jackson.core:jackson-databind")
 	optional("com.google.code.gson:gson")
+	optional("com.oracle.database.jdbc:ucp")
 	optional("com.samskivert:jmustache")
 	optional("com.zaxxer:HikariCP")
 	optional("io.netty:netty-tcnative-boringssl-static")
@@ -77,7 +78,7 @@ dependencies {
 	testImplementation("com.ibm.db2:jcc")
 	testImplementation("com.jayway.jsonpath:json-path")
 	testImplementation("com.microsoft.sqlserver:mssql-jdbc")
-	testImplementation("com.oracle.ojdbc:ojdbc8")
+	testImplementation("com.oracle.database.jdbc:ojdbc8")
 	testImplementation("com.squareup.okhttp3:okhttp")
 	testImplementation("com.sun.xml.messaging.saaj:saaj-impl")
 	testImplementation("io.projectreactor:reactor-test")

spring-boot-project/spring-boot/src/main/java/org/springframework/boot/jdbc/DataSourceBuilder.java

@@ -37,16 +37,17 @@
 
 /**
  * Convenience class for building a {@link DataSource} with common implementations and
- * properties. If HikariCP, Tomcat or Commons DBCP are on the classpath one of them will
- * be selected (in that order with Hikari first). In the interest of a uniform interface,
- * and so that there can be a fallback to an embedded database if one can be detected on
- * the classpath, only a small set of common configuration properties are supported. To
- * inject additional properties into the result you can downcast it, or use
+ * properties. If HikariCP, Tomcat, Commons DBCP or Oracle UCP are on the classpath one of
+ * them will be selected (in that order with Hikari first). In the interest of a uniform
+ * interface, and so that there can be a fallback to an embedded database if one can be
+ * detected on the classpath, only a small set of common configuration properties are
+ * supported. To inject additional properties into the result you can downcast it, or use
  * {@code @ConfigurationProperties}.
  *
  * @param <T> type of DataSource produced by the builder
  * @author Dave Syer
  * @author Madhura Bhave
+ * @author Fabio Grassi
  * @since 2.0.0
  */
 public final class DataSourceBuilder<T extends DataSource> {
@@ -166,9 +167,9 @@ void registerAliases(DataSource candidate, ConfigurationPropertyNameAliases alia
 
 	}
 
-	private static class OracleDataSourceSettings extends DataSourceSettings {
+	private static class OracleCommonDataSourceSettings extends DataSourceSettings {
 
-		OracleDataSourceSettings(Class<? extends DataSource> type) {
+		OracleCommonDataSourceSettings(Class<? extends DataSource> type) {
 			super(type, (aliases) -> aliases.addAliases("username", "user"));
 		}
 
@@ -194,7 +195,7 @@ private static class DataSourceSettingsResolver {
 							(type) -> new DataSourceSettings(type,
 									(aliases) -> aliases.addAliases("driver-class-name", "driver-class"))));
 			addIfAvailable(this.allDataSourceSettings, create(classLoader,
-					"oracle.jdbc.datasource.OracleCommonDataSource", OracleDataSourceSettings::new));
+					"oracle.jdbc.datasource.OracleCommonDataSource", OracleCommonDataSourceSettings::new));
 		}
 
 		private static List<DataSourceSettings> resolveAvailableDataSourceSettings(ClassLoader classLoader) {
@@ -205,6 +206,8 @@ private static List<DataSourceSettings> resolveAvailableDataSourceSettings(Class
 					create(classLoader, "org.apache.tomcat.jdbc.pool.DataSource", DataSourceSettings::new));
 			addIfAvailable(providers,
 					create(classLoader, "org.apache.commons.dbcp2.BasicDataSource", DataSourceSettings::new));
+			addIfAvailable(providers,
+					create(classLoader, "oracle.ucp.jdbc.PoolDataSourceImpl", DataSourceSettings::new));
 			return providers;
 		}
 

spring-boot-project/spring-boot/src/main/java/org/springframework/boot/jdbc/metadata/UcpDataSourcePoolMetadata.java

@@ -0,0 +1,81 @@
+/*
+ * Copyright 2012-2019 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.boot.jdbc.metadata;
+
+import java.sql.SQLException;
+
+import javax.sql.DataSource;
+
+import org.springframework.dao.InvalidDataAccessApiUsageException;
+import org.springframework.util.StringUtils;
+
+import oracle.ucp.jdbc.PoolDataSource;
+
+/**
+ * {@link DataSourcePoolMetadata} for a Oracle UCP {@link DataSource}.
+ *
+ * @author Fabio Grassi
+ * @since 2.3.4
+ */
+public class UcpDataSourcePoolMetadata extends AbstractDataSourcePoolMetadata<PoolDataSource> {
+
+	public UcpDataSourcePoolMetadata(PoolDataSource dataSource) {
+		super(dataSource);
+	}
+
+	@Override
+	public Integer getActive() {
+		try {
+			return getDataSource().getBorrowedConnectionsCount();
+		}
+		catch (SQLException se) {
+			throw new InvalidDataAccessApiUsageException("Error while reading property borrowedConnectionsCount", se);
+		}
+	}
+
+	@Override
+	public Integer getIdle() {
+		try {
+			return getDataSource().getAvailableConnectionsCount();
+		}
+		catch (SQLException se) {
+			throw new InvalidDataAccessApiUsageException("Error while reading property availableConnectionsCount", se);
+		}
+	}
+
+	@Override
+	public Integer getMax() {
+		return getDataSource().getMaxPoolSize();
+	}
+
+	@Override
+	public Integer getMin() {
+		return getDataSource().getMinPoolSize();
+	}
+
+	@Override
+	public String getValidationQuery() {
+		return getDataSource().getSQLForValidateConnection();
+	}
+
+	@Override
+	public Boolean getDefaultAutoCommit() {
+		String ac = getDataSource().getConnectionProperty("autoCommit");
+		return StringUtils.hasText(ac) ? Boolean.valueOf(ac) : null;
+	}
+
+}