GH-23 - Support +s and +ssc schemes.

This adds support for `bolt+s`, `bolt+ssc`, `neo4j+s` and `neo4j+ssc` by ignoring any properties for encryption and trust settings.

Author: michael-simons

neo4j-java-driver-spring-boot-autoconfigure/src/main/java/org/neo4j/driver/springframework/boot/autoconfigure/Neo4jDriverProperties.java

@@ -21,13 +21,14 @@
 import java.io.File;
 import java.net.URI;
 import java.time.Duration;
+import java.util.Locale;
 import java.util.concurrent.TimeUnit;
 
 import org.neo4j.driver.AuthToken;
 import org.neo4j.driver.AuthTokens;
 import org.neo4j.driver.Config;
+import org.neo4j.driver.internal.Scheme;
 import org.neo4j.driver.net.ServerAddressResolver;
-
 import org.springframework.beans.BeanUtils;
 import org.springframework.boot.context.properties.ConfigurationProperties;
 import org.springframework.boot.context.properties.source.InvalidConfigurationPropertyValueException;
@@ -102,27 +103,44 @@ public Config asDriverConfig() {
 
 		Config.ConfigBuilder builder = Config.builder();
 		this.pool.applyTo(builder);
-		this.config.applyTo(builder);
+		String scheme = uri == null ? "bolt" : uri.getScheme();
+		this.config.applyTo(builder, isSimpleScheme(scheme));
 
 		return builder.withLogging(new Neo4jSpringJclLogging()).build();
 	}
 
+	static boolean isSimpleScheme(String scheme) {
+
+		String lowerCaseScheme = scheme.toLowerCase(Locale.ENGLISH);
+		try {
+			Scheme.validateScheme(lowerCaseScheme);
+		} catch (IllegalArgumentException ex) {
+			throw new IllegalArgumentException(String.format("'%s' is not a supported scheme.", scheme));
+		}
+
+		return lowerCaseScheme.equals("bolt") || lowerCaseScheme.equals("neo4j");
+	}
+
 	public static class Authentication {
 
 		/**
 		 * The login of the user connecting to the database.
 		 */
 		private String username;
 
-		/** The password of the user connecting to the database. */
+		/**
+		 * The password of the user connecting to the database.
+		 */
 		private String password;
 
 		/**
 		 * The realm to connect to.
 		 */
 		private String realm;
 
-		/** A kerberos ticket for connecting to the database. Mutual exclusive with a given username. */
+		/**
+		 * A kerberos ticket for connecting to the database. Mutual exclusive with a given username.
+		 */
 		private String kerberosTicket;
 
 		public String getUsername() {
@@ -353,21 +371,28 @@ public void setServerAddressResolverClass(
 			this.serverAddressResolverClass = serverAddressResolverClass;
 		}
 
-		private void applyTo(Config.ConfigBuilder builder) {
+		private void applyTo(Config.ConfigBuilder builder, boolean withEncryptionAndTrustSettings) {
 
-			if (this.encrypted) {
-				builder.withEncryption();
-			} else {
-				builder.withoutEncryption();
+			if (withEncryptionAndTrustSettings) {
+				applyEncryptionAndTrustSettings(builder);
 			}
-			builder.withTrustStrategy(this.trustSettings.toInternalRepresentation());
+
 			builder.withConnectionTimeout(this.connectionTimeout.toMillis(), TimeUnit.MILLISECONDS);
 			builder.withMaxTransactionRetryTime(this.maxTransactionRetryTime.toMillis(), TimeUnit.MILLISECONDS);
 
 			if (this.serverAddressResolverClass != null) {
 				builder.withResolver(BeanUtils.instantiateClass(this.serverAddressResolverClass));
 			}
 		}
+
+		private void applyEncryptionAndTrustSettings(Config.ConfigBuilder builder) {
+			if (this.encrypted) {
+				builder.withEncryption();
+			} else {
+				builder.withoutEncryption();
+			}
+			builder.withTrustStrategy(this.trustSettings.toInternalRepresentation());
+		}
 	}
 
 	public static class TrustSettings {

neo4j-java-driver-spring-boot-autoconfigure/src/test/java/org/neo4j/driver/springframework/boot/autoconfigure/Neo4jDriverAutoConfigurationTest.java

@@ -18,9 +18,13 @@
  */
 package org.neo4j.driver.springframework.boot.autoconfigure;
 
+import static org.assertj.core.api.Assertions.*;
+import static org.neo4j.driver.springframework.boot.test.Neo4jDriverMocks.*;
+
 import org.junit.jupiter.api.Test;
+import org.junit.jupiter.params.ParameterizedTest;
+import org.junit.jupiter.params.provider.ValueSource;
 import org.neo4j.driver.Driver;
-
 import org.neo4j.driver.springframework.boot.autoconfigure.domain.EmptyPackage;
 import org.neo4j.ogm.drivers.bolt.driver.BoltDriver;
 import org.neo4j.ogm.session.SessionFactory;
@@ -33,9 +37,6 @@
 import org.springframework.context.annotation.Configuration;
 import org.springframework.data.neo4j.transaction.Neo4jTransactionManager;
 
-import static org.assertj.core.api.Assertions.assertThat;
-import static org.neo4j.driver.springframework.boot.test.Neo4jDriverMocks.*;
-
 /**
  * @author Michael J. Simons
  */
@@ -83,10 +84,32 @@ void shouldAlsoCreateOGMBeans() {
 				.hasSingleBean(Driver.class)
 				.hasSingleBean(BoltDriver.class)
 				.hasSingleBean(SessionFactory.class)
-				.hasSingleBean(Neo4jTransactionManager.class) // See https://github.com/spring-projects/spring-boot/pull/17662
+				.hasSingleBean(Neo4jTransactionManager.class)
 			);
 	}
 
+	/**
+	 * These tests assert correct configuration behaviour for cases in which one of the "advanced" schemes is used to
+	 * configure the driver. If any of the schemes is used, than a contradicting explicit configuration will throw an
+	 * error.
+	 *
+	 * @param scheme The schme to test.
+	 */
+	@ParameterizedTest
+	@ValueSource(strings = { "bolt+s", "bolt+ssc", "neo4j+s", "neo4j+ssc" })
+	void schemesShouldBeApplied(String scheme) {
+
+		this.contextRunner
+			.withPropertyValues("org.neo4j.driver.uri=" + scheme + "://localhost:4711")
+			.withClassLoader(new FilteredClassLoader(SessionFactory.class))
+			.run((ctx) -> {
+				assertThat(ctx).hasSingleBean(Driver.class);
+
+				Driver driver = ctx.getBean(Driver.class);
+				assertThat(driver.isEncrypted()).isTrue();
+			});
+	}
+
 	// Needed to not make OGM go mad on package root
 	@Configuration(proxyBeanMethods = false)
 	@EntityScan(basePackageClasses = EmptyPackage.class)

neo4j-java-driver-spring-boot-autoconfigure/src/test/java/org/neo4j/driver/springframework/boot/autoconfigure/Neo4jDriverPropertiesTest.java

@@ -18,6 +18,8 @@
  */
 package org.neo4j.driver.springframework.boot.autoconfigure;
 
+import static org.assertj.core.api.Assertions.*;
+
 import java.io.File;
 import java.io.IOException;
 import java.time.Duration;
@@ -27,10 +29,11 @@
 import org.junit.jupiter.api.DisplayName;
 import org.junit.jupiter.api.Nested;
 import org.junit.jupiter.api.Test;
-import org.neo4j.driver.internal.retry.RetrySettings;
+import org.junit.jupiter.params.ParameterizedTest;
+import org.junit.jupiter.params.provider.ValueSource;
 import org.neo4j.driver.AuthTokens;
 import org.neo4j.driver.Config;
-
+import org.neo4j.driver.internal.retry.RetrySettings;
 import org.neo4j.driver.springframework.boot.autoconfigure.Neo4jDriverProperties.Authentication;
 import org.neo4j.driver.springframework.boot.autoconfigure.Neo4jDriverProperties.DriverSettings;
 import org.neo4j.driver.springframework.boot.autoconfigure.Neo4jDriverProperties.PoolSettings;
@@ -42,9 +45,6 @@
 import org.springframework.context.annotation.AnnotationConfigApplicationContext;
 import org.springframework.context.annotation.Configuration;
 
-import static org.assertj.core.api.Assertions.assertThat;
-import static org.assertj.core.api.Assertions.assertThatExceptionOfType;
-
 /**
  * @author Michael J. Simons
  */
@@ -376,6 +376,33 @@ void shouldNotAssumeDefaultValuesForUrl() {
 		assertThat(driverProperties.getUri()).isNull();
 	}
 
+	@Nested
+	class SchemeDetection {
+
+		@ParameterizedTest
+		@ValueSource(strings = { "bolt", "Bolt", "neo4j", "Neo4J" })
+		void shouldDetectSimpleSchemes(String aSimpleScheme) {
+
+			assertThat(Neo4jDriverProperties.isSimpleScheme(aSimpleScheme)).isTrue();
+		}
+
+		@ParameterizedTest
+		@ValueSource(strings = { "bolt+s", "Bolt+ssc", "neo4j+s", "Neo4J+ssc" })
+		void shouldDetectAdvancedSchemes(String anAdvancedScheme) {
+
+			assertThat(Neo4jDriverProperties.isSimpleScheme(anAdvancedScheme)).isFalse();
+		}
+
+		@ParameterizedTest
+		@ValueSource(strings = { "bolt+routing", "bolt+x", "neo4j+wth" })
+		void shouldFailEarlyOnInvalidSchemes(String invalidScheme) {
+
+			assertThatIllegalArgumentException()
+				.isThrownBy(() -> Neo4jDriverProperties.isSimpleScheme(invalidScheme))
+				.withMessage("'%s' is not a supported scheme.", invalidScheme);
+		}
+	}
+
 	@Configuration(proxyBeanMethods = false)
 	@EnableConfigurationProperties(Neo4jDriverProperties.class)
 	static class TestConfiguration {