GH-21 - Clarify defaults and requirements of org.neo4j.driver.uri property.

Author: michael-simons

docs/appendix/configuration-options.adoc

@@ -70,7 +70,7 @@
 
 |`{config_prefix}.uri`
 |
-|+++The uri this driver should connect to. The driver supports bolt, bolt+routing or neo4j as schemes. The default URI is 'bolt://localhost:7687'.+++
+|+++The uri this driver should connect to. The driver supports bolt or neo4j as schemes. The starter does not provide a default URI so that clashes with the SDN/OGM Spring Boot starter are avoided.+++
 
 |`{config_prefix}.pool.metrics-enabled`
 |`false`

docs/manual/getting-started.adoc

@@ -121,6 +121,12 @@ org.neo4j.driver.authentication.username=neo4j
 org.neo4j.driver.authentication.password=secret
 ----
 
+IMPORTANT: The URI is required. Autoconfiguration will not be triggered without it.
+           This is to avoid clashes with the Spring Boot SDN/OGM starter.
+           The SDN/OGM starter defaults to localhost, but backs off when it detects a driver bean.
+           If this starter here would default to localhost as well, a driver bean would always be
+           provided and SDN/OGM would back off even when a user configured a different URI.
+
 This is the bare minimum of what you need to connect to a Neo4j instance.
 
 Refer to <<Configuration options,the list of configuration properties>> for all options this driver supports.

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

@@ -44,7 +44,7 @@ public class Neo4jDriverProperties {
 	/**
 	 * The uri this driver should connect to. The driver supports bolt or neo4j as schemes.
 	 */
-	private URI uri = URI.create("bolt://localhost:7687");
+	private URI uri;
 
 	/**
 	 * The authentication the driver is supposed to use. Maybe null.

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

@@ -356,7 +356,7 @@ void trustCustomCertificatesShouldWork1() throws IOException {
 
 		@Test
 		@DisplayName("…should fail on custom certificates without cert file")
-		void trustCustomCertificatesShouldWork2() throws IOException {
+		void trustCustomCertificatesShouldWork2() {
 
 			TrustSettings settings = new TrustSettings();
 			settings.setStrategy(Strategy.TRUST_CUSTOM_CA_SIGNED_CERTIFICATES);
@@ -368,6 +368,14 @@ void trustCustomCertificatesShouldWork2() throws IOException {
 		}
 	}
 
+	@Test
+	@DisplayName("Should not assume default value for the URL")
+	void shouldNotAssumeDefaultValuesForUrl() {
+
+		Neo4jDriverProperties driverProperties = new Neo4jDriverProperties();
+		assertThat(driverProperties.getUri()).isNull();
+	}
+
 	@Configuration(proxyBeanMethods = false)
 	@EnableConfigurationProperties(Neo4jDriverProperties.class)
 	static class TestConfiguration {