Add Accept-Query handling and remove versions from since

Author: desiderantes

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

@@ -108,6 +108,12 @@ public class HttpHeaders implements MultiValueMap<String, String>, Serializable
 	 * @see <a href="https://tools.ietf.org/html/rfc7233#section-2.3">Section 5.3.5 of RFC 7233</a>
 	 */
 	public static final String ACCEPT_RANGES = "Accept-Ranges";
+
+	/**
+	 * The HTTP {@code Accept-Query} header field name.
+	 * @see <a href="https://datatracker.ietf.org/doc/draft-ietf-httpbis-safe-method-w-body/">IETF Draft</a>
+	 */
+	public static final String ACCEPT_QUERY = "Accept-Query";
 	/**
 	 * The CORS {@code Access-Control-Allow-Credentials} response header field name.
 	 * @see <a href="https://www.w3.org/TR/cors/">CORS W3C recommendation</a>
@@ -568,6 +574,27 @@ public List<MediaType> getAcceptPatch() {
 		return MediaType.parseMediaTypes(get(ACCEPT_PATCH));
 	}
 
+	/**
+	 * Set the list of acceptable {@linkplain MediaType media types} for
+	 * {@code QUERY} methods, as specified by the {@code Accept-QUERY} header.
+	 * @since x.x.x
+	 */
+	public void setAcceptQuery(List<MediaType> mediaTypes) {
+		set(ACCEPT_QUERY, MediaType.toString(mediaTypes));
+	}
+
+	/**
+	 * Return the list of acceptable {@linkplain MediaType media types} for
+	 * {@code QUERY} methods, as specified by the {@code Accept-Query} header.
+	 * <p>Returns an empty list when the acceptable media types are unspecified.
+	 * @since x.x.x
+	 */
+	public List<MediaType> getAcceptQuery() {
+		return MediaType.parseMediaTypes(get(ACCEPT_QUERY));
+	}
+
+
+
 	/**
 	 * Set the (new) value of the {@code Access-Control-Allow-Credentials} response header.
 	 */

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

@@ -84,7 +84,7 @@ public final class HttpMethod implements Comparable<HttpMethod>, Serializable {
 
 	/**
 	 * The HTTP method {@code QUERY}.
-	 * @see <a href="https://httpwg.org/http-extensions/draft-ietf-httpbis-safe-method-w-body.html">IETF Draft</a>
+	 * @see <a href="https://datatracker.ietf.org/doc/draft-ietf-httpbis-safe-method-w-body/">IETF Draft</a>
 	 */
 	public static final HttpMethod QUERY = new HttpMethod("QUERY");
 

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

@@ -349,7 +349,7 @@ public static BodyBuilder query(URI url) {
 	 * @param uriTemplate the uri template to use
 	 * @param uriVariables variables to expand the URI template with
 	 * @return the created builder
-	 * @since 6.2
+	 * @since x.x.x
 	 */
 	public static BodyBuilder query(String uriTemplate, Object... uriVariables) {
 		return method(HttpMethod.QUERY, uriTemplate, uriVariables);

spring-web/src/main/java/org/springframework/web/HttpMediaTypeNotSupportedException.java

@@ -134,6 +134,9 @@ public HttpHeaders getHeaders() {
 		if (HttpMethod.PATCH.equals(this.httpMethod)) {
 			headers.setAcceptPatch(getSupportedMediaTypes());
 		}
+		if (HttpMethod.QUERY.equals(this.httpMethod)) {
+			headers.setAcceptQuery(getSupportedMediaTypes());
+		}
 		return headers;
 	}
 

spring-web/src/main/java/org/springframework/web/bind/annotation/QueryMapping.java

@@ -39,7 +39,7 @@
  * such as {@code @GetMapping}, {@code @PutMapping}, etc.
  *
  * @author Mario Ruiz
- * @since 6.2
+ * @since x.x.x
  * @see GetMapping
  * @see PutMapping
  * @see PostMapping

spring-web/src/main/java/org/springframework/web/server/UnsupportedMediaTypeStatusException.java

@@ -165,6 +165,9 @@ public HttpHeaders getHeaders() {
 		if (this.method == HttpMethod.PATCH) {
 			headers.setAcceptPatch(this.supportedMediaTypes);
 		}
+		if (this.method == HttpMethod.QUERY) {
+			headers.setAcceptQuery(this.supportedMediaTypes);
+		}
 		return headers;
 	}
 

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

@@ -700,7 +700,7 @@ public interface Builder {
 		 * Adds a route to the given handler function that handles HTTP {@code QUERY} requests.
 		 * @param handlerFunction the handler function to handle all {@code QUERY} requests
 		 * @return this builder
-		 * @since 6.2
+		 * @since x.x.x
 		 */
 		Builder QUERY(HandlerFunction<ServerResponse> handlerFunction);
 
@@ -722,7 +722,7 @@ public interface Builder {
 		 * @param handlerFunction the handler function to handle all {@code QUERY} requests that
 		 * match {@code predicate}
 		 * @return this builder
-		 * @since 6.2
+		 * @since x.x.x
 		 * @see RequestPredicates
 		 */
 		Builder QUERY(RequestPredicate predicate, HandlerFunction<ServerResponse> handlerFunction);

spring-webflux/src/main/java/org/springframework/web/reactive/result/method/RequestMappingInfoHandlerMapping.java

@@ -192,8 +192,9 @@ protected HandlerMethod handleNoMatch(Set<RequestMappingInfo> infos,
 			HttpMethod httpMethod = request.getMethod();
 			Set<HttpMethod> methods = helper.getAllowedMethods();
 			if (HttpMethod.OPTIONS.equals(httpMethod)) {
-				Set<MediaType> mediaTypes = helper.getConsumablePatchMediaTypes();
-				HttpOptionsHandler handler = new HttpOptionsHandler(methods, mediaTypes);
+				Set<MediaType> patchMediaTypes = helper.getConsumablePatchMediaTypes();
+				Set<MediaType> queryMediaTypes = helper.getConsumableQueryMediaTypes();
+				HttpOptionsHandler handler = new HttpOptionsHandler(methods, patchMediaTypes, queryMediaTypes);
 				return new HandlerMethod(handler, HTTP_OPTIONS_HANDLE_METHOD);
 			}
 			throw new MethodNotAllowedException(httpMethod, methods);
@@ -326,14 +327,23 @@ public List<Set<NameValueExpression<String>>> getParamConditions() {
 		 * PATCH specified, or that have no methods at all.
 		 */
 		public Set<MediaType> getConsumablePatchMediaTypes() {
-			Set<MediaType> result = new LinkedHashSet<>();
-			for (PartialMatch match : this.partialMatches) {
-				Set<RequestMethod> methods = match.getInfo().getMethodsCondition().getMethods();
-				if (methods.isEmpty() || methods.contains(RequestMethod.PATCH)) {
-					result.addAll(match.getInfo().getConsumesCondition().getConsumableMediaTypes());
-				}
-			}
-			return result;
+			return getConsumableMediaTypesForMethod(RequestMethod.PATCH);
+		}
+
+		/**
+		 * Return declared "consumable" types but only among those that have
+		 * PATCH specified, or that have no methods at all.
+		 */
+		public Set<MediaType> getConsumableQueryMediaTypes() {
+			return getConsumableMediaTypesForMethod(RequestMethod.QUERY);
+		}
+
+		private Set<MediaType> getConsumableMediaTypesForMethod(RequestMethod method) {
+			return this.partialMatches.stream()
+					.map(PartialMatch::getInfo)
+					.filter(info -> info.getMethodsCondition().getMethods().isEmpty() || info.getMethodsCondition().getMethods().contains(method))
+					.flatMap(info -> info.getConsumesCondition().getConsumableMediaTypes().stream())
+					.collect(Collectors.toCollection(LinkedHashSet::new));
 		}
 
 
@@ -403,9 +413,10 @@ private static class HttpOptionsHandler {
 		private final HttpHeaders headers = new HttpHeaders();
 
 
-		public HttpOptionsHandler(Set<HttpMethod> declaredMethods, Set<MediaType> acceptPatch) {
+		public HttpOptionsHandler(Set<HttpMethod> declaredMethods, Set<MediaType> acceptPatch, Set<MediaType> acceptQuery) {
 			this.headers.setAllow(initAllowedHttpMethods(declaredMethods));
 			this.headers.setAcceptPatch(new ArrayList<>(acceptPatch));
+			this.headers.setAcceptQuery(new ArrayList<>(acceptQuery));
 		}
 
 		private static Set<HttpMethod> initAllowedHttpMethods(Set<HttpMethod> declaredMethods) {

spring-webflux/src/test/java/org/springframework/web/reactive/result/method/RequestMappingInfoHandlerMappingTests.java

@@ -377,7 +377,7 @@ private void testHttpMediaTypeNotSupportedException(String url) {
 				.isEqualTo(Collections.singletonList(new MediaType("application", "xml"))));
 	}
 
-	private void testHttpOptions(String requestURI, Set<HttpMethod> allowedMethods, @Nullable MediaType acceptPatch) {
+	private void testHttpOptions(String requestURI, Set<HttpMethod> allowedMethods, @Nullable MediaType acceptMediaType) {
 		ServerWebExchange exchange = MockServerWebExchange.from(MockServerHttpRequest.options(requestURI));
 		HandlerMethod handlerMethod = (HandlerMethod) this.handlerMapping.getHandler(exchange).block();
 
@@ -395,9 +395,15 @@ private void testHttpOptions(String requestURI, Set<HttpMethod> allowedMethods,
 		HttpHeaders headers = (HttpHeaders) value;
 		assertThat(headers.getAllow()).hasSameElementsAs(allowedMethods);
 
-		if (acceptPatch != null && headers.getAllow().contains(HttpMethod.PATCH) ) {
-			assertThat(headers.getAcceptPatch()).containsExactly(acceptPatch);
+		if (acceptMediaType != null) {
+			if (headers.getAllow().contains(HttpMethod.PATCH)) {
+				assertThat(headers.getAcceptPatch()).containsExactly(acceptMediaType);
+			}
+			if (headers.getAllow().contains(HttpMethod.QUERY)) {
+				assertThat(headers.getAcceptQuery()).containsExactly(acceptMediaType);
+			}
 		}
+
 	}
 
 	private void testMediaTypeNotAcceptable(String url) {

spring-webmvc/src/main/java/org/springframework/web/servlet/function/RouterFunctions.java

@@ -614,7 +614,7 @@ public interface Builder {
 		 * Adds a route to the given handler function that handles HTTP {@code QUERY} requests.
 		 * @param handlerFunction the handler function to handle all {@code QUERY} requests
 		 * @return this builder
-		 * @since 5.3
+		 * @since x.x.x
 		 */
 		Builder QUERY(HandlerFunction<ServerResponse> handlerFunction);
 
@@ -636,7 +636,7 @@ public interface Builder {
 		 * @param handlerFunction the handler function to handle all {@code QUERY} requests that
 		 * match {@code predicate}
 		 * @return this builder
-		 * @since 5.3
+		 * @since x.x.x
 		 * @see RequestPredicates
 		 */
 		Builder QUERY(RequestPredicate predicate, HandlerFunction<ServerResponse> handlerFunction);