Browse Source

Fix dated Javadoc in MvcUriComponentsBuilder

related to forwarded headers

Closes gh-34615
pull/34656/head
rstoyanchev 9 months ago
parent
commit
18c3b637e4
  1. 15
      spring-web/src/main/java/org/springframework/web/cors/CorsConfiguration.java
  2. 15
      spring-webmvc/src/main/java/org/springframework/web/servlet/mvc/method/annotation/MvcUriComponentsBuilder.java

15
spring-web/src/main/java/org/springframework/web/cors/CorsConfiguration.java

@ -1,5 +1,5 @@
/* /*
* Copyright 2002-2024 the original author or authors. * Copyright 2002-2025 the original author or authors.
* *
* Licensed under the Apache License, Version 2.0 (the "License"); * Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License. * you may not use this file except in compliance with the License.
@ -297,14 +297,7 @@ public class CorsConfiguration {
* allowCredentials} is set to {@code true}, that combination is handled * allowCredentials} is set to {@code true}, that combination is handled
* by copying the method specified in the CORS preflight request. * by copying the method specified in the CORS preflight request.
* <p>If not set, only {@code "GET"} and {@code "HEAD"} are allowed. * <p>If not set, only {@code "GET"} and {@code "HEAD"} are allowed.
* <p>By default this is not set. * <p>By default, this is not set.
* <p><strong>Note:</strong> CORS checks use values from "Forwarded"
* (<a href="https://tools.ietf.org/html/rfc7239">RFC 7239</a>),
* "X-Forwarded-Host", "X-Forwarded-Port", and "X-Forwarded-Proto" headers,
* if present, in order to reflect the client-originated address.
* Consider using the {@code ForwardedHeaderFilter} in order to choose from a
* central place whether to extract and use, or to discard such headers.
* See the Spring Framework reference for more on this filter.
*/ */
public void setAllowedMethods(@Nullable List<String> allowedMethods) { public void setAllowedMethods(@Nullable List<String> allowedMethods) {
this.allowedMethods = (allowedMethods != null ? new ArrayList<>(allowedMethods) : null); this.allowedMethods = (allowedMethods != null ? new ArrayList<>(allowedMethods) : null);
@ -456,7 +449,7 @@ public class CorsConfiguration {
* level of trust with the configured domains and also increases the surface * level of trust with the configured domains and also increases the surface
* attack of the web application by exposing sensitive user-specific * attack of the web application by exposing sensitive user-specific
* information such as cookies and CSRF tokens. * information such as cookies and CSRF tokens.
* <p>By default this is not set (i.e. user credentials are not supported). * <p>By default, this is not set (i.e. user credentials are not supported).
*/ */
public void setAllowCredentials(@Nullable Boolean allowCredentials) { public void setAllowCredentials(@Nullable Boolean allowCredentials) {
this.allowCredentials = allowCredentials; this.allowCredentials = allowCredentials;
@ -480,7 +473,7 @@ public class CorsConfiguration {
* <p>Setting this property has an impact on how {@link #setAllowedOrigins(List) * <p>Setting this property has an impact on how {@link #setAllowedOrigins(List)
* origins} and {@link #setAllowedOriginPatterns(List) originPatterns} are processed, * origins} and {@link #setAllowedOriginPatterns(List) originPatterns} are processed,
* see related API documentation for more details. * see related API documentation for more details.
* <p>By default this is not set (i.e. private network access is not supported). * <p>By default, this is not set (i.e. private network access is not supported).
* @since 5.3.32 * @since 5.3.32
* @see <a href="https://wicg.github.io/private-network-access/">Private network access specifications</a> * @see <a href="https://wicg.github.io/private-network-access/">Private network access specifications</a>
*/ */

15
spring-webmvc/src/main/java/org/springframework/web/servlet/mvc/method/annotation/MvcUriComponentsBuilder.java

@ -1,5 +1,5 @@
/* /*
* Copyright 2002-2024 the original author or authors. * Copyright 2002-2025 the original author or authors.
* *
* Licensed under the Apache License, Version 2.0 (the "License"); * Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License. * you may not use this file except in compliance with the License.
@ -84,13 +84,12 @@ import org.springframework.web.util.pattern.PathPatternParser;
* {@link #relativeTo(org.springframework.web.util.UriComponentsBuilder)}. * {@link #relativeTo(org.springframework.web.util.UriComponentsBuilder)}.
* </ul> * </ul>
* *
* <p><strong>Note:</strong> This class uses values from "Forwarded" * <p><strong>Note:</strong> As of 5.1, methods in this class do not extract
* (<a href="https://tools.ietf.org/html/rfc7239">RFC 7239</a>), * {@code "Forwarded"} and {@code "X-Forwarded-*"} headers that specify the
* "X-Forwarded-Host", "X-Forwarded-Port", and "X-Forwarded-Proto" headers, * client-originated address. Please, use
* if present, in order to reflect the client-originated protocol and address. * {@link org.springframework.web.filter.ForwardedHeaderFilter
* Consider using the {@code ForwardedHeaderFilter} in order to choose from a * ForwardedHeaderFilter}, or similar from the underlying server, to extract
* central place whether to extract and use, or to discard such headers. * and use such headers, or to discard them.
* See the Spring Framework reference for more on this filter.
* *
* @author Oliver Gierke * @author Oliver Gierke
* @author Rossen Stoyanchev * @author Rossen Stoyanchev

Loading…
Cancel
Save