Spring/spring-boot
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Add 'required' parameter to ConnectionDetailsFactories

Browse Source 
Update `ConnectionDetailsFactories` so that callers can now declare if
a result is required or not and improve exception hierarchy.

See gh-35168
This commit is contained in:
Phillip Webb
2023-04-29 13:23:48 -07:00
parent 2b261e6ebd
commit 403481ff96
7 changed files with 89 additions and 36 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/service/connection/ConnectionDetailsFactories.java
View File

@@ -65,10 +65,16 @@ public class ConnectionDetailsFactories {
* given source.
* @param <S> the source type
* @param source the source
* @param required if a connection details result is required
* @return a map of {@link ConnectionDetails} instances
* @throws ConnectionDetailsFactoryNotFoundException if a result is required but no
* connection details factory is registered for the source
* @throws ConnectionDetailsNotFoundException if a result is required but no
* connection details instance was created from a registered factory
*/
public <S> Map<Class<?>, ConnectionDetails> getConnectionDetails(S source) {
List<Registration<S, ?>> registrations = getRegistrations(source);
public <S> Map<Class<?>, ConnectionDetails> getConnectionDetails(S source, boolean required)
throws ConnectionDetailsFactoryNotFoundException, ConnectionDetailsNotFoundException {
List<Registration<S, ?>> registrations = getRegistrations(source, required);
Map<Class<?>, ConnectionDetails> result = new LinkedHashMap<>();
for (Registration<S, ?> registration : registrations) {
ConnectionDetails connectionDetails = registration.factory().getConnectionDetails(source);
@@ -79,11 +85,14 @@ public class ConnectionDetailsFactories {
.formatted(connectionDetailsType.getName()));
}
}
if (required && result.isEmpty()) {
throw new ConnectionDetailsNotFoundException(source);
}
return Map.copyOf(result);
}
@SuppressWarnings("unchecked")
<S> List<Registration<S, ?>> getRegistrations(S source) {
<S> List<Registration<S, ?>> getRegistrations(S source, boolean required) {
Class<S> sourceType = (Class<S>) source.getClass();
List<Registration<S, ?>> result = new ArrayList<>();
for (Registration<?, ?> candidate : this.registrations) {
@@ -91,7 +100,7 @@ public class ConnectionDetailsFactories {
result.add((Registration<S, ?>) candidate);
}
}
if (result.isEmpty()) {
if (required && result.isEmpty()) {
throw new ConnectionDetailsFactoryNotFoundException(source);
}
result.sort(Comparator.comparing(Registration::factory, AnnotationAwareOrderComparator.INSTANCE));

2
spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/service/connection/ConnectionDetailsFactoryNotFoundException.java
View File

@@ -28,7 +28,7 @@ package org.springframework.boot.autoconfigure.service.connection;
public class ConnectionDetailsFactoryNotFoundException extends RuntimeException {
public <S> ConnectionDetailsFactoryNotFoundException(S source) {
super("No ConnectionDetailsFactory found for source '" + source + "'");
super("No ConnectionDetailsFactory found for source '%s'".formatted(source));
}
}

34
spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/service/connection/ConnectionDetailsNotFoundException.java Normal file
View File

@@ -0,0 +1,34 @@
/*
* Copyright 2012-2023 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.service.connection;
/**
* {@link RuntimeException} thrown when required {@link ConnectionDetails} could not be
* found.
*
* @author Moritz Halbritter
* @author Andy Wilkinson
* @author Phillip Webb
* @since 3.1.0
*/
public class ConnectionDetailsNotFoundException extends RuntimeException {
public <S> ConnectionDetailsNotFoundException(S source) {
super("No ConnectionDetails found for source '%s'".formatted(source));
}
}

44
spring-boot-project/spring-boot-autoconfigure/src/test/java/org/springframework/boot/autoconfigure/service/connection/ConnectionDetailsFactoriesTests.java
View File

@@ -42,27 +42,49 @@ class ConnectionDetailsFactoriesTests {
private final MockSpringFactoriesLoader loader = new MockSpringFactoriesLoader();
@Test
void getConnectionDetailsWhenNoFactoryForSourceThrowsException() {
void getRequiredConnectionDetailsWhenNoFactoryForSourceThrowsException() {
ConnectionDetailsFactories factories = new ConnectionDetailsFactories(this.loader);
assertThatExceptionOfType(ConnectionDetailsFactoryNotFoundException.class)
.isThrownBy(() -> factories.getConnectionDetails("source"));
.isThrownBy(() -> factories.getConnectionDetails("source", true));
}
@Test
void getOptionalConnectionDetailsWhenNoFactoryForSourceThrowsException() {
ConnectionDetailsFactories factories = new ConnectionDetailsFactories(this.loader);
assertThat(factories.getConnectionDetails("source", false)).isEmpty();
}
@Test
void getConnectionDetailsWhenSourceHasOneMatchReturnsSingleResult() {
this.loader.addInstance(ConnectionDetailsFactory.class, new TestConnectionDetailsFactory());
ConnectionDetailsFactories factories = new ConnectionDetailsFactories(this.loader);
Map<Class<?>, ConnectionDetails> connectionDetails = factories.getConnectionDetails("source");
Map<Class<?>, ConnectionDetails> connectionDetails = factories.getConnectionDetails("source", false);
assertThat(connectionDetails).hasSize(1);
assertThat(connectionDetails.get(TestConnectionDetails.class)).isInstanceOf(TestConnectionDetailsImpl.class);
}
@Test
void getRequiredConnectionDetailsWhenSourceHasNoMatchTheowsException() {
this.loader.addInstance(ConnectionDetailsFactory.class, new NullResultTestConnectionDetailsFactory());
ConnectionDetailsFactories factories = new ConnectionDetailsFactories(this.loader);
assertThatExceptionOfType(ConnectionDetailsNotFoundException.class)
.isThrownBy(() -> factories.getConnectionDetails("source", true));
}
@Test
void getOptionalConnectionDetailsWhenSourceHasNoMatchReturnsEmptyMap() {
this.loader.addInstance(ConnectionDetailsFactory.class, new NullResultTestConnectionDetailsFactory());
ConnectionDetailsFactories factories = new ConnectionDetailsFactories(this.loader);
Map<Class<?>, ConnectionDetails> connectionDetails = factories.getConnectionDetails("source", false);
assertThat(connectionDetails).isEmpty();
}
@Test
void getConnectionDetailsWhenSourceHasMultipleMatchesReturnsMultipleResults() {
this.loader.addInstance(ConnectionDetailsFactory.class, new TestConnectionDetailsFactory(),
new OtherConnectionDetailsFactory());
ConnectionDetailsFactories factories = new ConnectionDetailsFactories(this.loader);
Map<Class<?>, ConnectionDetails> connectionDetails = factories.getConnectionDetails("source");
Map<Class<?>, ConnectionDetails> connectionDetails = factories.getConnectionDetails("source", false);
assertThat(connectionDetails).hasSize(2);
}
@@ -71,7 +93,7 @@ class ConnectionDetailsFactoriesTests {
this.loader.addInstance(ConnectionDetailsFactory.class, new TestConnectionDetailsFactory(),
new TestConnectionDetailsFactory());
ConnectionDetailsFactories factories = new ConnectionDetailsFactories(this.loader);
assertThatIllegalStateException().isThrownBy(() -> factories.getConnectionDetails("source"))
assertThatIllegalStateException().isThrownBy(() -> factories.getConnectionDetails("source", false))
.withMessage("Duplicate connection details supplied for " + TestConnectionDetails.class.getName());
}
@@ -82,7 +104,7 @@ class ConnectionDetailsFactoriesTests {
TestConnectionDetailsFactory orderThree = new TestConnectionDetailsFactory(3);
this.loader.addInstance(ConnectionDetailsFactory.class, orderOne, orderThree, orderTwo);
ConnectionDetailsFactories factories = new ConnectionDetailsFactories(this.loader);
List<Registration<String, ?>> registrations = factories.getRegistrations("source");
List<Registration<String, ?>> registrations = factories.getRegistrations("source", false);
assertThat(registrations.get(0).factory()).isEqualTo(orderOne);
assertThat(registrations.get(1).factory()).isEqualTo(orderTwo);
assertThat(registrations.get(2).factory()).isEqualTo(orderThree);
@@ -119,6 +141,16 @@ class ConnectionDetailsFactoriesTests {
}
private static final class NullResultTestConnectionDetailsFactory
implements ConnectionDetailsFactory<String, TestConnectionDetails> {
@Override
public TestConnectionDetails getConnectionDetails(String source) {
return null;
}
}
private static final class OtherConnectionDetailsFactory
implements ConnectionDetailsFactory<String, OtherConnectionDetails> {