Harmonize configuration properties that accept a list of values

Closes gh-42478

Author: wilkinsona

spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/endpoint/web/CorsEndpointProperties.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2021 the original author or authors.
+ * Copyright 2012-2024 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.
@@ -37,34 +37,32 @@
 public class CorsEndpointProperties {
 
 	/**
-	 * Comma-separated list of origins to allow. '*' allows all origins. When credentials
-	 * are allowed, '*' cannot be used and origin patterns should be configured instead.
-	 * When no allowed origins or allowed origin patterns are set, CORS support is
-	 * disabled.
+	 * List of origins to allow. '*' allows all origins. When credentials are allowed, '*'
+	 * cannot be used and origin patterns should be configured instead. When no allowed
+	 * origins or allowed origin patterns are set, CORS support is disabled.
 	 */
 	private List<String> allowedOrigins = new ArrayList<>();
 
 	/**
-	 * Comma-separated list of origin patterns to allow. Unlike allowed origins which only
-	 * supports '*', origin patterns are more flexible (for example
-	 * 'https://*.example.com') and can be used when credentials are allowed. When no
-	 * allowed origin patterns or allowed origins are set, CORS support is disabled.
+	 * List of origin patterns to allow. Unlike allowed origins which only supports '*',
+	 * origin patterns are more flexible (for example 'https://*.example.com') and can be
+	 * used when credentials are allowed. When no allowed origin patterns or allowed
+	 * origins are set, CORS support is disabled.
 	 */
 	private List<String> allowedOriginPatterns = new ArrayList<>();
 
 	/**
-	 * Comma-separated list of methods to allow. '*' allows all methods. When not set,
-	 * defaults to GET.
+	 * List of methods to allow. '*' allows all methods. When not set, defaults to GET.
 	 */
 	private List<String> allowedMethods = new ArrayList<>();
 
 	/**
-	 * Comma-separated list of headers to allow in a request. '*' allows all headers.
+	 * List of headers to allow in a request. '*' allows all headers.
 	 */
 	private List<String> allowedHeaders = new ArrayList<>();
 
 	/**
-	 * Comma-separated list of headers to include in a response.
+	 * List of headers to include in a response.
 	 */
 	private List<String> exposedHeaders = new ArrayList<>();
 

spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/health/HealthProperties.java

@@ -78,7 +78,7 @@ public void setRoles(Set<String> roles) {
 	public static class Status {
 
 		/**
-		 * Comma-separated list of health statuses in order of severity.
+		 * List of health statuses in order of severity.
 		 */
 		private List<String> order = new ArrayList<>();
 

spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/metrics/MetricsProperties.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2023 the original author or authors.
+ * Copyright 2012-2024 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.
@@ -200,7 +200,7 @@ public Diskspace getDiskspace() {
 		public static class Diskspace {
 
 			/**
-			 * Comma-separated list of paths to report disk metrics for.
+			 * List of paths to report disk metrics for.
 			 */
 			private List<File> paths = new ArrayList<>(Collections.singletonList(new File(".")));
 

spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/amqp/PropertiesRabbitConnectionDetails.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2023 the original author or authors.
+ * Copyright 2012-2024 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.
@@ -52,7 +52,7 @@ public String getVirtualHost() {
 	@Override
 	public List<Address> getAddresses() {
 		List<Address> addresses = new ArrayList<>();
-		for (String address : this.properties.determineAddresses().split(",")) {
+		for (String address : this.properties.determineAddresses()) {
 			int portSeparatorIndex = address.lastIndexOf(':');
 			String host = address.substring(0, portSeparatorIndex);
 			String port = address.substring(portSeparatorIndex + 1);

spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/amqp/RabbitProperties.java

@@ -92,10 +92,10 @@ public class RabbitProperties {
 	private String virtualHost;
 
 	/**
-	 * Comma-separated list of addresses to which the client should connect. When set, the
-	 * host and port are ignored.
+	 * List of addresses to which the client should connect. When set, the host and port
+	 * are ignored.
 	 */
-	private String addresses;
+	private List<String> addresses;
 
 	/**
 	 * Mode used to shuffle configured addresses.
@@ -163,7 +163,7 @@ public String getHost() {
 	 * Returns the host from the first address, or the configured host if no addresses
 	 * have been set.
 	 * @return the host
-	 * @see #setAddresses(String)
+	 * @see #setAddresses(List)
 	 * @see #getHost()
 	 */
 	public String determineHost() {
@@ -185,7 +185,7 @@ public Integer getPort() {
 	 * Returns the port from the first address, or the configured port if no addresses
 	 * have been set.
 	 * @return the port
-	 * @see #setAddresses(String)
+	 * @see #setAddresses(List)
 	 * @see #getPort()
 	 */
 	public int determinePort() {
@@ -203,38 +203,38 @@ public void setPort(Integer port) {
 		this.port = port;
 	}
 
-	public String getAddresses() {
+	public List<String> getAddresses() {
 		return this.addresses;
 	}
 
 	/**
-	 * Returns the comma-separated addresses or a single address ({@code host:port})
-	 * created from the configured host and port if no addresses have been set.
+	 * Returns the configured addresses or a single address ({@code host:port}) created
+	 * from the configured host and port if no addresses have been set.
 	 * @return the addresses
 	 */
-	public String determineAddresses() {
+	public List<String> determineAddresses() {
 		if (CollectionUtils.isEmpty(this.parsedAddresses)) {
 			if (this.host.contains(",")) {
 				throw new InvalidConfigurationPropertyValueException("spring.rabbitmq.host", this.host,
 						"Invalid character ','. Value must be a single host. For multiple hosts, use property 'spring.rabbitmq.addresses' instead.");
 			}
-			return this.host + ":" + determinePort();
+			return List.of(this.host + ":" + determinePort());
 		}
 		List<String> addressStrings = new ArrayList<>();
 		for (Address parsedAddress : this.parsedAddresses) {
 			addressStrings.add(parsedAddress.host + ":" + parsedAddress.port);
 		}
-		return StringUtils.collectionToCommaDelimitedString(addressStrings);
+		return addressStrings;
 	}
 
-	public void setAddresses(String addresses) {
+	public void setAddresses(List<String> addresses) {
 		this.addresses = addresses;
 		this.parsedAddresses = parseAddresses(addresses);
 	}
 
-	private List<Address> parseAddresses(String addresses) {
+	private List<Address> parseAddresses(List<String> addresses) {
 		List<Address> parsedAddresses = new ArrayList<>();
-		for (String address : StringUtils.commaDelimitedListToStringArray(addresses)) {
+		for (String address : addresses) {
 			parsedAddresses.add(new Address(address, Optional.ofNullable(getSsl().getEnabled()).orElse(false)));
 		}
 		return parsedAddresses;
@@ -248,7 +248,7 @@ public String getUsername() {
 	 * If addresses have been set and the first address has a username it is returned.
 	 * Otherwise returns the result of calling {@code getUsername()}.
 	 * @return the username
-	 * @see #setAddresses(String)
+	 * @see #setAddresses(List)
 	 * @see #getUsername()
 	 */
 	public String determineUsername() {
@@ -271,7 +271,7 @@ public String getPassword() {
 	 * If addresses have been set and the first address has a password it is returned.
 	 * Otherwise returns the result of calling {@code getPassword()}.
 	 * @return the password or {@code null}
-	 * @see #setAddresses(String)
+	 * @see #setAddresses(List)
 	 * @see #getPassword()
 	 */
 	public String determinePassword() {
@@ -298,7 +298,7 @@ public String getVirtualHost() {
 	 * If addresses have been set and the first address has a virtual host it is returned.
 	 * Otherwise returns the result of calling {@code getVirtualHost()}.
 	 * @return the virtual host or {@code null}
-	 * @see #setAddresses(String)
+	 * @see #setAddresses(List)
 	 * @see #getVirtualHost()
 	 */
 	public String determineVirtualHost() {
@@ -471,7 +471,7 @@ public Boolean getEnabled() {
 		 * Returns whether SSL is enabled from the first address, or the configured ssl
 		 * enabled flag if no addresses have been set.
 		 * @return whether ssl is enabled
-		 * @see #setAddresses(String)
+		 * @see #setAddresses(List)
 		 * @see #getEnabled() ()
 		 */
 		public boolean determineEnabled() {

spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/cache/CacheProperties.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2022 the original author or authors.
+ * Copyright 2012-2024 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.
@@ -41,8 +41,8 @@ public class CacheProperties {
 	private CacheType type;
 
 	/**
-	 * Comma-separated list of cache names to create if supported by the underlying cache
-	 * manager. Usually, this disables the ability to create additional caches on-the-fly.
+	 * List of cache names to create if supported by the underlying cache manager.
+	 * Usually, this disables the ability to create additional caches on-the-fly.
 	 */
 	private List<String> cacheNames = new ArrayList<>();
 

spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/context/MessageSourceAutoConfiguration.java

@@ -42,6 +42,7 @@
 import org.springframework.core.io.Resource;
 import org.springframework.core.io.support.PathMatchingResourcePatternResolver;
 import org.springframework.core.type.AnnotatedTypeMetadata;
+import org.springframework.util.CollectionUtils;
 import org.springframework.util.ConcurrentReferenceHashMap;
 import org.springframework.util.StringUtils;
 
@@ -67,9 +68,8 @@ public class MessageSourceAutoConfiguration {
 	@Bean
 	public MessageSource messageSource(MessageSourceProperties properties) {
 		ResourceBundleMessageSource messageSource = new ResourceBundleMessageSource();
-		if (StringUtils.hasText(properties.getBasename())) {
-			messageSource.setBasenames(StringUtils
-				.commaDelimitedListToStringArray(StringUtils.trimAllWhitespace(properties.getBasename())));
+		if (!CollectionUtils.isEmpty(properties.getBasename())) {
+			messageSource.setBasenames(properties.getBasename().toArray(new String[0]));
 		}
 		if (properties.getEncoding() != null) {
 			messageSource.setDefaultEncoding(properties.getEncoding().name());

spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/context/MessageSourceProperties.java

@@ -20,6 +20,8 @@
 import java.nio.charset.StandardCharsets;
 import java.time.Duration;
 import java.time.temporal.ChronoUnit;
+import java.util.ArrayList;
+import java.util.List;
 
 import org.springframework.boot.context.properties.ConfigurationProperties;
 import org.springframework.boot.convert.DurationUnit;
@@ -35,12 +37,12 @@
 public class MessageSourceProperties {
 
 	/**
-	 * Comma-separated list of basenames (essentially a fully-qualified classpath
-	 * location), each following the ResourceBundle convention with relaxed support for
-	 * slash based locations. If it doesn't contain a package qualifier (such as
-	 * "org.mypackage"), it will be resolved from the classpath root.
+	 * List of basenames (essentially a fully-qualified classpath location), each
+	 * following the ResourceBundle convention with relaxed support for slash based
+	 * locations. If it doesn't contain a package qualifier (such as "org.mypackage"), it
+	 * will be resolved from the classpath root.
 	 */
-	private String basename = "messages";
+	private List<String> basename = new ArrayList<>(List.of("messages"));
 
 	/**
 	 * Message bundles encoding.
@@ -73,11 +75,11 @@ public class MessageSourceProperties {
 	 */
 	private boolean useCodeAsDefaultMessage = false;
 
-	public String getBasename() {
+	public List<String> getBasename() {
 		return this.basename;
 	}
 
-	public void setBasename(String basename) {
+	public void setBasename(List<String> basename) {
 		this.basename = basename;
 	}
 

spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/data/redis/RedisProperties.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2023 the original author or authors.
+ * Copyright 2012-2024 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.
@@ -322,8 +322,8 @@ public void setTimeBetweenEvictionRuns(Duration timeBetweenEvictionRuns) {
 	public static class Cluster {
 
 		/**
-		 * Comma-separated list of "host:port" pairs to bootstrap from. This represents an
-		 * "initial" list of cluster nodes and is required to have at least one entry.
+		 * List of "host:port" pairs to bootstrap from. This represents an "initial" list
+		 * of cluster nodes and is required to have at least one entry.
 		 */
 		private List<String> nodes;
 
@@ -362,7 +362,7 @@ public static class Sentinel {
 		private String master;
 
 		/**
-		 * Comma-separated list of "host:port" pairs.
+		 * List of "host:port" pairs.
 		 */
 		private List<String> nodes;
 

spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/elasticsearch/ElasticsearchProperties.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2023 the original author or authors.
+ * Copyright 2012-2024 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.
@@ -33,7 +33,7 @@
 public class ElasticsearchProperties {
 
 	/**
-	 * Comma-separated list of the Elasticsearch instances to use.
+	 * List of the Elasticsearch instances to use.
 	 */
 	private List<String> uris = new ArrayList<>(Collections.singletonList("http://localhost:9200"));
 

spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/flyway/FlywayProperties.java

@@ -319,8 +319,8 @@ public class FlywayProperties {
 	private Boolean skipExecutingMigrations;
 
 	/**
-	 * Ignore migrations that match this comma-separated list of patterns when validating
-	 * migrations. Requires Flyway Teams.
+	 * List of patterns that identify migrations to ignore when performing validation.
+	 * Requires Flyway Teams.
 	 */
 	private List<String> ignoreMigrationPatterns;
 

spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/freemarker/FreeMarkerProperties.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2020 the original author or authors.
+ * Copyright 2012-2024 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.
@@ -44,7 +44,7 @@ public class FreeMarkerProperties extends AbstractTemplateViewResolverProperties
 	private Map<String, String> settings = new HashMap<>();
 
 	/**
-	 * Comma-separated list of template paths.
+	 * List of template paths.
 	 */
 	private String[] templateLoaderPath = new String[] { DEFAULT_TEMPLATE_LOADER_PATH };
 
@@ -72,6 +72,10 @@ public String[] getTemplateLoaderPath() {
 		return this.templateLoaderPath;
 	}
 
+	public void setTemplateLoaderPath(String... templateLoaderPaths) {
+		this.templateLoaderPath = templateLoaderPaths;
+	}
+
 	public boolean isPreferFileSystemAccess() {
 		return this.preferFileSystemAccess;
 	}
@@ -80,8 +84,4 @@ public void setPreferFileSystemAccess(boolean preferFileSystemAccess) {
 		this.preferFileSystemAccess = preferFileSystemAccess;
 	}
 
-	public void setTemplateLoaderPath(String... templateLoaderPaths) {
-		this.templateLoaderPath = templateLoaderPaths;
-	}
-
 }