Update configuration properties to use Duration

Update appropriate configuration properties to use the `Duration`
type, rather than an ad-hoc mix of milliseconds or seconds.

Configuration properties can now be defined in a consistent and readable
way. For example `server.session.timeout=5m`.

Properties that were previously declared using seconds are annotated
with `@DurationUnit` to ensure a smooth upgrade experience. For example
`server.session.timeout=20` continues to mean 20 seconds.

Fixes gh-11080

Author: philwebb

spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/elasticsearch/ElasticsearchHealthIndicatorAutoConfiguration.java

@@ -16,6 +16,7 @@
 
 package org.springframework.boot.actuate.autoconfigure.elasticsearch;
 
+import java.time.Duration;
 import java.util.Map;
 
 import io.searchbox.client.JestClient;
@@ -77,8 +78,10 @@ public HealthIndicator elasticsearchHealthIndicator() {
 
 		@Override
 		protected ElasticsearchHealthIndicator createHealthIndicator(Client client) {
+			Duration responseTimeout = this.properties.getResponseTimeout();
 			return new ElasticsearchHealthIndicator(client,
-					this.properties.getResponseTimeout(), this.properties.getIndices());
+					responseTimeout == null ? 100 : responseTimeout.toMillis(),
+					this.properties.getIndices());
 		}
 
 	}

spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/elasticsearch/ElasticsearchHealthIndicatorProperties.java

@@ -16,6 +16,7 @@
 
 package org.springframework.boot.actuate.autoconfigure.elasticsearch;
 
+import java.time.Duration;
 import java.util.ArrayList;
 import java.util.List;
 
@@ -38,9 +39,9 @@ public class ElasticsearchHealthIndicatorProperties {
 	private List<String> indices = new ArrayList<>();
 
 	/**
-	 * Time, in milliseconds, to wait for a response from the cluster.
+	 * Time to wait for a response from the cluster.
 	 */
-	private long responseTimeout = 100L;
+	private Duration responseTimeout = Duration.ofMillis(100);
 
 	public List<String> getIndices() {
 		return this.indices;
@@ -50,11 +51,11 @@ public void setIndices(List<String> indices) {
 		this.indices = indices;
 	}
 
-	public long getResponseTimeout() {
+	public Duration getResponseTimeout() {
 		return this.responseTimeout;
 	}
 
-	public void setResponseTimeout(long responseTimeout) {
+	public void setResponseTimeout(Duration responseTimeout) {
 		this.responseTimeout = responseTimeout;
 	}
 

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

@@ -16,9 +16,14 @@
 
 package org.springframework.boot.actuate.autoconfigure.endpoint;
 
+import java.time.Duration;
 import java.util.function.Function;
 
 import org.springframework.boot.actuate.endpoint.cache.CachingOperationInvokerAdvisor;
+import org.springframework.boot.context.properties.bind.BindResult;
+import org.springframework.boot.context.properties.bind.Bindable;
+import org.springframework.boot.context.properties.bind.Binder;
+import org.springframework.core.env.Environment;
 import org.springframework.core.env.PropertyResolver;
 
 /**
@@ -30,20 +35,24 @@
  */
 class EndpointIdTimeToLivePropertyFunction implements Function<String, Long> {
 
-	private final PropertyResolver propertyResolver;
+	private static final Bindable<Duration> DURATION = Bindable.of(Duration.class);
+
+	private final Environment environment;
 
 	/**
 	 * Create a new instance with the {@link PropertyResolver} to use.
-	 * @param propertyResolver the environment
+	 * @param environment the environment
 	 */
-	EndpointIdTimeToLivePropertyFunction(PropertyResolver propertyResolver) {
-		this.propertyResolver = propertyResolver;
+	EndpointIdTimeToLivePropertyFunction(Environment environment) {
+		this.environment = environment;
 	}
 
 	@Override
 	public Long apply(String endpointId) {
-		String key = String.format("management.endpoint.%s.cache.time-to-live",
+		String name = String.format("management.endpoint.%s.cache.time-to-live",
 				endpointId);
-		return this.propertyResolver.getProperty(key, Long.class);
+		BindResult<Duration> duration = Binder.get(this.environment).bind(name, DURATION);
+		return duration.map(Duration::toMillis).orElse(null);
 	}
+
 }

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

@@ -16,10 +16,13 @@
 
 package org.springframework.boot.actuate.autoconfigure.endpoint.web.servlet;
 
+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.context.properties.bind.convert.DurationUnit;
 
 /**
  * Configuration properties for MVC endpoints' CORS support.
@@ -58,10 +61,11 @@ public class CorsEndpointProperties {
 	private Boolean allowCredentials;
 
 	/**
-	 * How long, in seconds, the response from a pre-flight request can be cached by
-	 * clients.
+	 * How long the response from a pre-flight request can be cached by clients. If a
+	 * duration suffix is not specified, seconds will be used.
 	 */
-	private Long maxAge = 1800L;
+	@DurationUnit(ChronoUnit.SECONDS)
+	private Duration maxAge = Duration.ofSeconds(1800);
 
 	public List<String> getAllowedOrigins() {
 		return this.allowedOrigins;
@@ -103,11 +107,11 @@ public void setAllowCredentials(Boolean allowCredentials) {
 		this.allowCredentials = allowCredentials;
 	}
 
-	public Long getMaxAge() {
+	public Duration getMaxAge() {
 		return this.maxAge;
 	}
 
-	public void setMaxAge(Long maxAge) {
+	public void setMaxAge(Duration maxAge) {
 		this.maxAge = maxAge;
 	}
 

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

@@ -78,7 +78,7 @@ private CorsConfiguration getCorsConfiguration(CorsEndpointProperties properties
 			configuration.setExposedHeaders(properties.getExposedHeaders());
 		}
 		if (properties.getMaxAge() != null) {
-			configuration.setMaxAge(properties.getMaxAge());
+			configuration.setMaxAge(properties.getMaxAge().getSeconds());
 		}
 		if (properties.getAllowCredentials() != null) {
 			configuration.setAllowCredentials(properties.getAllowCredentials());

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

@@ -100,7 +100,7 @@ protected void configure(T factory, ConnectionFactory connectionFactory,
 			factory.setDefaultRequeueRejected(configuration.getDefaultRequeueRejected());
 		}
 		if (configuration.getIdleEventInterval() != null) {
-			factory.setIdleEventInterval(configuration.getIdleEventInterval());
+			factory.setIdleEventInterval(configuration.getIdleEventInterval().toMillis());
 		}
 		ListenerRetry retryConfig = configuration.getRetry();
 		if (retryConfig.isEnabled()) {

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

@@ -105,7 +105,8 @@ public CachingConnectionFactory rabbitConnectionFactory(RabbitProperties config)
 				factory.setVirtualHost(config.determineVirtualHost());
 			}
 			if (config.getRequestedHeartbeat() != null) {
-				factory.setRequestedHeartbeat(config.getRequestedHeartbeat());
+				factory.setRequestedHeartbeat(
+						(int) config.getRequestedHeartbeat().getSeconds());
 			}
 			RabbitProperties.Ssl ssl = config.getSsl();
 			if (ssl.isEnabled()) {
@@ -121,7 +122,8 @@ public CachingConnectionFactory rabbitConnectionFactory(RabbitProperties config)
 				factory.setTrustStorePassphrase(ssl.getTrustStorePassword());
 			}
 			if (config.getConnectionTimeout() != null) {
-				factory.setConnectionTimeout(config.getConnectionTimeout());
+				factory.setConnectionTimeout(
+						(int) config.getConnectionTimeout().toMillis());
 			}
 			factory.afterPropertiesSet();
 			CachingConnectionFactory connectionFactory = new CachingConnectionFactory(

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

@@ -16,12 +16,15 @@
 
 package org.springframework.boot.autoconfigure.amqp;
 
+import java.time.Duration;
+import java.time.temporal.ChronoUnit;
 import java.util.ArrayList;
 import java.util.List;
 
 import org.springframework.amqp.core.AcknowledgeMode;
 import org.springframework.amqp.rabbit.connection.CachingConnectionFactory.CacheMode;
 import org.springframework.boot.context.properties.ConfigurationProperties;
+import org.springframework.boot.context.properties.bind.convert.DurationUnit;
 import org.springframework.util.CollectionUtils;
 import org.springframework.util.StringUtils;
 
@@ -74,9 +77,11 @@ public class RabbitProperties {
 	private String addresses;
 
 	/**
-	 * Requested heartbeat timeout, in seconds; zero for none.
+	 * Requested heartbeat timeout; zero for none. If a duration suffix is not specified,
+	 * seconds will be used.
 	 */
-	private Integer requestedHeartbeat;
+	@DurationUnit(ChronoUnit.SECONDS)
+	private Duration requestedHeartbeat;
 
 	/**
 	 * Enable publisher confirms.
@@ -89,9 +94,9 @@ public class RabbitProperties {
 	private boolean publisherReturns;
 
 	/**
-	 * Connection timeout, in milliseconds; zero for infinite.
+	 * Connection timeout; zero for infinite.
 	 */
-	private Integer connectionTimeout;
+	private Duration connectionTimeout;
 
 	/**
 	 * Cache configuration.
@@ -258,11 +263,11 @@ public void setVirtualHost(String virtualHost) {
 		this.virtualHost = ("".equals(virtualHost) ? "/" : virtualHost);
 	}
 
-	public Integer getRequestedHeartbeat() {
+	public Duration getRequestedHeartbeat() {
 		return this.requestedHeartbeat;
 	}
 
-	public void setRequestedHeartbeat(Integer requestedHeartbeat) {
+	public void setRequestedHeartbeat(Duration requestedHeartbeat) {
 		this.requestedHeartbeat = requestedHeartbeat;
 	}
 
@@ -282,11 +287,11 @@ public void setPublisherReturns(boolean publisherReturns) {
 		this.publisherReturns = publisherReturns;
 	}
 
-	public Integer getConnectionTimeout() {
+	public Duration getConnectionTimeout() {
 		return this.connectionTimeout;
 	}
 
-	public void setConnectionTimeout(Integer connectionTimeout) {
+	public void setConnectionTimeout(Duration connectionTimeout) {
 		this.connectionTimeout = connectionTimeout;
 	}
 
@@ -557,9 +562,9 @@ public static abstract class AmqpContainer {
 		private Boolean defaultRequeueRejected;
 
 		/**
-		 * How often idle container events should be published in milliseconds.
+		 * How often idle container events should be published.
 		 */
-		private Long idleEventInterval;
+		private Duration idleEventInterval;
 
 		/**
 		 * Optional properties for a retry interceptor.
@@ -598,11 +603,11 @@ public void setDefaultRequeueRejected(Boolean defaultRequeueRejected) {
 			this.defaultRequeueRejected = defaultRequeueRejected;
 		}
 
-		public Long getIdleEventInterval() {
+		public Duration getIdleEventInterval() {
 			return this.idleEventInterval;
 		}
 
-		public void setIdleEventInterval(Long idleEventInterval) {
+		public void setIdleEventInterval(Duration idleEventInterval) {
 			this.idleEventInterval = idleEventInterval;
 		}
 

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

@@ -16,9 +16,9 @@
 
 package org.springframework.boot.autoconfigure.cache;
 
+import java.time.Duration;
 import java.util.ArrayList;
 import java.util.List;
-import java.util.concurrent.TimeUnit;
 
 import org.springframework.boot.context.properties.ConfigurationProperties;
 import org.springframework.core.io.Resource;
@@ -141,24 +141,16 @@ public void setSpec(String spec) {
 	public static class Couchbase {
 
 		/**
-		 * Entry expiration in milliseconds. By default the entries never expire. Note
-		 * that this value is ultimately converted to seconds.
+		 * Entry expiration. By default the entries never expire. Note that this value is
+		 * ultimately converted to seconds.
 		 */
-		private int expiration;
+		private Duration expiration;
 
-		public int getExpiration() {
+		public Duration getExpiration() {
 			return this.expiration;
 		}
 
-		/**
-		 * Return the expiration in seconds.
-		 * @return the expiration in seconds
-		 */
-		public int getExpirationSeconds() {
-			return (int) TimeUnit.MILLISECONDS.toSeconds(this.expiration);
-		}
-
-		public void setExpiration(int expiration) {
+		public void setExpiration(Duration expiration) {
 			this.expiration = expiration;
 		}
 
@@ -246,9 +238,9 @@ public void setConfig(Resource config) {
 	public static class Redis {
 
 		/**
-		 * Entry expiration in milliseconds. By default the entries never expire.
+		 * Entry expiration. By default the entries never expire.
 		 */
-		private long timeToLive = 0;
+		private Duration timeToLive;
 
 		/**
 		 * Allow caching null values.
@@ -265,11 +257,11 @@ public static class Redis {
 		 */
 		private boolean useKeyPrefix = true;
 
-		public long getTimeToLive() {
+		public Duration getTimeToLive() {
 			return this.timeToLive;
 		}
 
-		public void setTimeToLive(long timeToLive) {
+		public void setTimeToLive(Duration timeToLive) {
 			this.timeToLive = timeToLive;
 		}
 

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

@@ -16,6 +16,7 @@
 
 package org.springframework.boot.autoconfigure.cache;
 
+import java.time.Duration;
 import java.util.List;
 
 import com.couchbase.client.java.Bucket;
@@ -59,11 +60,13 @@ public CouchbaseCacheConfiguration(CacheProperties cacheProperties,
 	@Bean
 	public CouchbaseCacheManager cacheManager() {
 		List<String> cacheNames = this.cacheProperties.getCacheNames();
-		CouchbaseCacheManager cacheManager = new CouchbaseCacheManager(
-				CacheBuilder.newInstance(this.bucket)
-						.withExpiration(this.cacheProperties.getCouchbase()
-								.getExpirationSeconds()),
-				cacheNames.toArray(new String[cacheNames.size()]));
+		CacheBuilder builder = CacheBuilder.newInstance(this.bucket);
+		Duration expiration = this.cacheProperties.getCouchbase().getExpiration();
+		if (expiration != null) {
+			builder = builder.withExpiration((int) expiration.getSeconds());
+		}
+		String[] names = cacheNames.toArray(new String[cacheNames.size()]);
+		CouchbaseCacheManager cacheManager = new CouchbaseCacheManager(builder, names);
 		return this.customizers.customize(cacheManager);
 	}