Consistent support for last-modified argument as Instant/ZonedDateTime

Issue: SPR-17571

Author: jhoeller

spring-web/src/main/java/org/springframework/http/HttpHeaders.java

@@ -1148,6 +1148,7 @@ public void setLastModified(long lastModified) {
 	/**
 	 * Set the time the resource was last changed, as specified by the
 	 * {@code Last-Modified} header.
+	 * @since 5.1.4
 	 */
 	public void setLastModified(Instant lastModified) {
 		setInstant(LAST_MODIFIED, lastModified);
@@ -1156,9 +1157,10 @@ public void setLastModified(Instant lastModified) {
 	/**
 	 * Set the time the resource was last changed, as specified by the
 	 * {@code Last-Modified} header.
+	 * @since 5.1.4
 	 */
 	public void setLastModified(ZonedDateTime lastModified) {
-		setZonedDateTime(LAST_MODIFIED, lastModified);
+		setZonedDateTime(LAST_MODIFIED, lastModified.withZoneSameInstant(ZoneId.of("GMT")));
 	}
 
 	/**
@@ -1276,19 +1278,20 @@ public List<String> getVary() {
 	 * Set the given date under the given header name after formatting it as a string
 	 * using the RFC-1123 date-time formatter. The equivalent of
 	 * {@link #set(String, String)} but for date headers.
-	 * @since 5.0
+	 * @since 5.1.4
 	 */
-	public void setZonedDateTime(String headerName, ZonedDateTime date) {
-		set(headerName, DATE_FORMATTERS[0].format(date));
+	public void setInstant(String headerName, Instant date) {
+		setZonedDateTime(headerName, ZonedDateTime.ofInstant(date, GMT));
 	}
 
 	/**
 	 * Set the given date under the given header name after formatting it as a string
 	 * using the RFC-1123 date-time formatter. The equivalent of
 	 * {@link #set(String, String)} but for date headers.
+	 * @since 5.0
 	 */
-	public void setInstant(String headerName, Instant date) {
-		setZonedDateTime(headerName, ZonedDateTime.ofInstant(date, GMT));
+	public void setZonedDateTime(String headerName, ZonedDateTime date) {
+		set(headerName, DATE_FORMATTERS[0].format(date));
 	}
 
 	/**
@@ -1299,14 +1302,7 @@ public void setInstant(String headerName, Instant date) {
 	 * @see #setZonedDateTime(String, ZonedDateTime)
 	 */
 	public void setDate(String headerName, long date) {
-		set(headerName, formatDate(date));
-	}
-
-	// Package private: also used in ResponseCookie..
-	static String formatDate(long date) {
-		Instant instant = Instant.ofEpochMilli(date);
-		ZonedDateTime time = ZonedDateTime.ofInstant(instant, GMT);
-		return DATE_FORMATTERS[0].format(time);
+		setInstant(headerName, Instant.ofEpochMilli(date));
 	}
 
 	/**
@@ -1656,4 +1652,11 @@ public static HttpHeaders writableHttpHeaders(HttpHeaders headers) {
 		}
 	}
 
+	// Package-private: used in ResponseCookie
+	static String formatDate(long date) {
+		Instant instant = Instant.ofEpochMilli(date);
+		ZonedDateTime time = ZonedDateTime.ofInstant(instant, GMT);
+		return DATE_FORMATTERS[0].format(time);
+	}
+
 }

spring-web/src/main/java/org/springframework/http/ResponseEntity.java

@@ -366,18 +366,20 @@ public interface HeadersBuilder<B extends HeadersBuilder<B>> {
 		 * {@code Last-Modified} header.
 		 * @param lastModified the last modified date
 		 * @return this builder
+		 * @since 5.1.4
 		 * @see HttpHeaders#setLastModified(long)
 		 */
-		B lastModified(ZonedDateTime lastModified);
+		B lastModified(Instant lastModified);
 
 		/**
 		 * Set the time the resource was last changed, as specified by the
 		 * {@code Last-Modified} header.
 		 * @param lastModified the last modified date
 		 * @return this builder
+		 * @since 5.1.4
 		 * @see HttpHeaders#setLastModified(long)
 		 */
-		B lastModified(Instant lastModified);
+		B lastModified(ZonedDateTime lastModified);
 
 		/**
 		 * Set the location of a resource, as specified by the {@code Location} header.
@@ -516,13 +518,13 @@ public BodyBuilder lastModified(long date) {
 		}
 
 		@Override
-		public BodyBuilder lastModified(ZonedDateTime date) {
+		public BodyBuilder lastModified(Instant date) {
 			this.headers.setLastModified(date);
 			return this;
 		}
 
 		@Override
-		public BodyBuilder lastModified(Instant date) {
+		public BodyBuilder lastModified(ZonedDateTime date) {
 			this.headers.setLastModified(date);
 			return this;
 		}

spring-webflux/src/main/java/org/springframework/web/reactive/function/server/DefaultEntityResponseBuilder.java

@@ -17,9 +17,8 @@
 package org.springframework.web.reactive.function.server;
 
 import java.net.URI;
-import java.time.ZoneId;
+import java.time.Instant;
 import java.time.ZonedDateTime;
-import java.time.format.DateTimeFormatter;
 import java.util.Arrays;
 import java.util.HashMap;
 import java.util.LinkedHashSet;
@@ -158,11 +157,15 @@ public EntityResponse.Builder<T> hint(String key, Object value) {
 		return this;
 	}
 
+	@Override
+	public EntityResponse.Builder<T> lastModified(Instant lastModified) {
+		this.headers.setLastModified(lastModified);
+		return this;
+	}
+
 	@Override
 	public EntityResponse.Builder<T> lastModified(ZonedDateTime lastModified) {
-		ZonedDateTime gmt = lastModified.withZoneSameInstant(ZoneId.of("GMT"));
-		String headerValue = DateTimeFormatter.RFC_1123_DATE_TIME.format(gmt);
-		this.headers.set(HttpHeaders.LAST_MODIFIED, headerValue);
+		this.headers.setLastModified(lastModified);
 		return this;
 	}
 
@@ -174,10 +177,7 @@ public EntityResponse.Builder<T> location(URI location) {
 
 	@Override
 	public EntityResponse.Builder<T> cacheControl(CacheControl cacheControl) {
-		String ccValue = cacheControl.getHeaderValue();
-		if (ccValue != null) {
-			this.headers.setCacheControl(cacheControl.getHeaderValue());
-		}
+		this.headers.setCacheControl(cacheControl);
 		return this;
 	}
 

spring-webflux/src/main/java/org/springframework/web/reactive/function/server/DefaultServerResponseBuilder.java

@@ -157,9 +157,15 @@ public ServerResponse.BodyBuilder hint(String key, Object value) {
 		return this;
 	}
 
+	@Override
+	public ServerResponse.BodyBuilder lastModified(Instant lastModified) {
+		this.headers.setLastModified(lastModified);
+		return this;
+	}
+
 	@Override
 	public ServerResponse.BodyBuilder lastModified(ZonedDateTime lastModified) {
-		this.headers.setZonedDateTime(HttpHeaders.LAST_MODIFIED, lastModified);
+		this.headers.setLastModified(lastModified);
 		return this;
 	}
 

spring-webflux/src/main/java/org/springframework/web/reactive/function/server/EntityResponse.java

@@ -17,6 +17,7 @@
 package org.springframework.web.reactive.function.server;
 
 import java.net.URI;
+import java.time.Instant;
 import java.time.ZonedDateTime;
 import java.util.Set;
 import java.util.function.Consumer;
@@ -176,11 +177,23 @@ interface Builder<T> {
 
 		/**
 		 * Set the entity tag of the body, as specified by the {@code ETag} header.
-		 * @param eTag the new entity tag
+		 * @param etag the new entity tag
 		 * @return this builder
 		 * @see HttpHeaders#setETag(String)
 		 */
-		Builder<T> eTag(String eTag);
+		Builder<T> eTag(String etag);
+
+		/**
+		 * Set the time the resource was last changed, as specified by the
+		 * {@code Last-Modified} header.
+		 * <p>The date should be specified as the number of milliseconds since
+		 * January 1, 1970 GMT.
+		 * @param lastModified the last modified date
+		 * @return this builder
+		 * @since 5.1.4
+		 * @see HttpHeaders#setLastModified(long)
+		 */
+		Builder<T> lastModified(Instant lastModified);
 
 		/**
 		 * Set the time the resource was last changed, as specified by the

spring-webflux/src/main/java/org/springframework/web/reactive/function/server/ServerResponse.java

@@ -17,6 +17,7 @@
 package org.springframework.web.reactive.function.server;
 
 import java.net.URI;
+import java.time.Instant;
 import java.time.ZonedDateTime;
 import java.util.Collection;
 import java.util.List;
@@ -275,6 +276,16 @@ interface HeadersBuilder<B extends HeadersBuilder<B>> {
 		 */
 		B eTag(String eTag);
 
+		/**
+		 * Set the time the resource was last changed, as specified by the
+		 * {@code Last-Modified} header.
+		 * @param lastModified the last modified date
+		 * @return this builder
+		 * @since 5.1.4
+		 * @see HttpHeaders#setLastModified(long)
+		 */
+		B lastModified(Instant lastModified);
+
 		/**
 		 * Set the time the resource was last changed, as specified by the
 		 * {@code Last-Modified} header.