root
/
spring-framework
mirror of https://github.com/spring-projects/spring-framework.git
1
0
Fork 0
Code Issues Actions 6 Packages Projects Releases Wiki Activity

Remove outdated notes on forwarded headers.
Backport Bot / build (push) Waiting to run Details
Build and Deploy Snapshot / Build and Deploy Snapshot (push) Waiting to run Details
Build and Deploy Snapshot / Verify (push) Blocked by required conditions Details
CI / ${{ matrix.os.name}} | Java ${{ matrix.java.version}} (map[toolchain:false version:17], map[id:ubuntu-latest name:Linux]) (push) Waiting to run Details
CI / ${{ matrix.os.name}} | Java ${{ matrix.java.version}} (map[toolchain:true version:21], map[id:ubuntu-latest name:Linux]) (push) Waiting to run Details
CI / ${{ matrix.os.name}} | Java ${{ matrix.java.version}} (map[toolchain:true version:23], map[id:ubuntu-latest name:Linux]) (push) Waiting to run Details
Deploy Docs / Dispatch docs deployment (push) Waiting to run Details 

Closes gh-34625
This commit is contained in:
rstoyanchev 2025-03-25 17:03:13 +01:00
parent 044258f085
commit f68fb97e7e
1 changed files with 0 additions and 35 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -151,8 +151,6 @@ public class MvcUriComponentsBuilder {
* Create a {@link UriComponentsBuilder} from the mapping of a controller class * Create a {@link UriComponentsBuilder} from the mapping of a controller class
* and current request information including Servlet mapping. If the controller * and current request information including Servlet mapping. If the controller
* contains multiple mappings, only the first one is used. * contains multiple mappings, only the first one is used.
* <p><strong>Note:</strong> This method extracts values from "Forwarded"
* and "X-Forwarded-*" headers if found. See class-level docs.
* @param controllerType the controller to build a URI for * @param controllerType the controller to build a URI for
* @return a UriComponentsBuilder instance (never {@code null}) * @return a UriComponentsBuilder instance (never {@code null})
*/ */
@ -165,8 +163,6 @@ public class MvcUriComponentsBuilder {
* {@code UriComponentsBuilder} representing the base URL. This is useful * {@code UriComponentsBuilder} representing the base URL. This is useful
* when using MvcUriComponentsBuilder outside the context of processing a * when using MvcUriComponentsBuilder outside the context of processing a
* request or to apply a custom baseUrl not matching the current request. * request or to apply a custom baseUrl not matching the current request.
* <p><strong>Note:</strong> This method extracts values from "Forwarded"
* and "X-Forwarded-*" headers if found. See class-level docs.
* @param builder the builder for the base URL; the builder will be cloned * @param builder the builder for the base URL; the builder will be cloned
* and therefore not modified and may be re-used for further calls. * and therefore not modified and may be re-used for further calls.
* @param controllerType the controller to build a URI for * @param controllerType the controller to build a URI for
@ -192,8 +188,6 @@ public class MvcUriComponentsBuilder {
* Create a {@link UriComponentsBuilder} from the mapping of a controller * Create a {@link UriComponentsBuilder} from the mapping of a controller
* method and an array of method argument values. This method delegates * method and an array of method argument values. This method delegates
* to {@link #fromMethod(Class, Method, Object...)}. * to {@link #fromMethod(Class, Method, Object...)}.
* <p><strong>Note:</strong> This method extracts values from "Forwarded"
* and "X-Forwarded-*" headers if found. See class-level docs.
* @param controllerType the controller * @param controllerType the controller
* @param methodName the method name * @param methodName the method name
* @param args the argument values * @param args the argument values
@ -213,8 +207,6 @@ public class MvcUriComponentsBuilder {
* accepts a {@code UriComponentsBuilder} representing the base URL. This is * accepts a {@code UriComponentsBuilder} representing the base URL. This is
* useful when using MvcUriComponentsBuilder outside the context of processing * useful when using MvcUriComponentsBuilder outside the context of processing
* a request or to apply a custom baseUrl not matching the current request. * a request or to apply a custom baseUrl not matching the current request.
* <p><strong>Note:</strong> This method extracts values from "Forwarded"
* and "X-Forwarded-*" headers if found. See class-level docs.
* @param builder the builder for the base URL; the builder will be cloned * @param builder the builder for the base URL; the builder will be cloned
* and therefore not modified and may be re-used for further calls. * and therefore not modified and may be re-used for further calls.
* @param controllerType the controller * @param controllerType the controller
@ -239,8 +231,6 @@ public class MvcUriComponentsBuilder {
* {@link org.springframework.web.method.support.UriComponentsContributor * {@link org.springframework.web.method.support.UriComponentsContributor
* UriComponentsContributor}) while remaining argument values are ignored and * UriComponentsContributor}) while remaining argument values are ignored and
* can be {@code null}. * can be {@code null}.
* <p><strong>Note:</strong> This method extracts values from "Forwarded"
* and "X-Forwarded-*" headers if found. See class-level docs.
* @param controllerType the controller type * @param controllerType the controller type
* @param method the controller method * @param method the controller method
* @param args argument values for the controller method * @param args argument values for the controller method
@ -257,8 +247,6 @@ public class MvcUriComponentsBuilder {
* This is useful when using MvcUriComponentsBuilder outside the context of * This is useful when using MvcUriComponentsBuilder outside the context of
* processing a request or to apply a custom baseUrl not matching the * processing a request or to apply a custom baseUrl not matching the
* current request. * current request.
* <p><strong>Note:</strong> This method extracts values from "Forwarded"
* and "X-Forwarded-*" headers if found. See class-level docs.
* @param baseUrl the builder for the base URL; the builder will be cloned * @param baseUrl the builder for the base URL; the builder will be cloned
* and therefore not modified and may be re-used for further calls. * and therefore not modified and may be re-used for further calls.
* @param controllerType the controller type * @param controllerType the controller type
@ -305,8 +293,6 @@ public class MvcUriComponentsBuilder {
* controller.getAddressesForCountry("US") * controller.getAddressesForCountry("US")
* builder = MvcUriComponentsBuilder.fromMethodCall(controller); * builder = MvcUriComponentsBuilder.fromMethodCall(controller);
* </pre> * </pre>
* <p><strong>Note:</strong> This method extracts values from "Forwarded"
* and "X-Forwarded-*" headers if found. See class-level docs.
* @param info either the value returned from a "mock" controller * @param info either the value returned from a "mock" controller
* invocation or the "mock" controller itself after an invocation * invocation or the "mock" controller itself after an invocation
* @return a UriComponents instance * @return a UriComponents instance
@ -327,8 +313,6 @@ public class MvcUriComponentsBuilder {
* {@code UriComponentsBuilder} representing the base URL. This is useful * {@code UriComponentsBuilder} representing the base URL. This is useful
* when using MvcUriComponentsBuilder outside the context of processing a * when using MvcUriComponentsBuilder outside the context of processing a
* request or to apply a custom baseUrl not matching the current request. * request or to apply a custom baseUrl not matching the current request.
* <p><strong>Note:</strong> This method extracts values from "Forwarded"
* and "X-Forwarded-*" headers if found. See class-level docs.
* @param builder the builder for the base URL; the builder will be cloned * @param builder the builder for the base URL; the builder will be cloned
* and therefore not modified and may be re-used for further calls. * and therefore not modified and may be re-used for further calls.
* @param info either the value returned from a "mock" controller * @param info either the value returned from a "mock" controller
@ -354,8 +338,6 @@ public class MvcUriComponentsBuilder {
* <pre class="code"> * <pre class="code">
* MvcUriComponentsBuilder.fromMethodCall(on(FooController.class).getFoo(1)).build(); * MvcUriComponentsBuilder.fromMethodCall(on(FooController.class).getFoo(1)).build();
* </pre> * </pre>
* <p><strong>Note:</strong> This method extracts values from "Forwarded"
* and "X-Forwarded-*" headers if found. See class-level docs.
* @param controllerType the target controller * @param controllerType the target controller
*/ */
public static <T> T on(Class<T> controllerType) { public static <T> T on(Class<T> controllerType) {
@ -378,8 +360,6 @@ public class MvcUriComponentsBuilder {
* fooController.saveFoo(2, null); * fooController.saveFoo(2, null);
* builder = MvcUriComponentsBuilder.fromMethodCall(fooController); * builder = MvcUriComponentsBuilder.fromMethodCall(fooController);
* </pre> * </pre>
* <p><strong>Note:</strong> This method extracts values from "Forwarded"
* and "X-Forwarded-*" headers if found. See class-level docs.
* @param controllerType the target controller * @param controllerType the target controller
*/ */
public static <T> T controller(Class<T> controllerType) { public static <T> T controller(Class<T> controllerType) {
@ -422,9 +402,6 @@ public class MvcUriComponentsBuilder {
* </pre> * </pre>
* <p>Note that it's not necessary to specify all arguments. Only the ones * <p>Note that it's not necessary to specify all arguments. Only the ones
* required to prepare the URL, mainly {@code @RequestParam} and {@code @PathVariable}). * required to prepare the URL, mainly {@code @RequestParam} and {@code @PathVariable}).
*
* <p><strong>Note:</strong> This method extracts values from "Forwarded"
* and "X-Forwarded-*" headers if found. See class-level docs.
* @param mappingName the mapping name * @param mappingName the mapping name
* @return a builder to prepare the URI String * @return a builder to prepare the URI String
* @throws IllegalArgumentException if the mapping name is not found or * @throws IllegalArgumentException if the mapping name is not found or
@ -440,8 +417,6 @@ public class MvcUriComponentsBuilder {
* {@code UriComponentsBuilder} representing the base URL. This is useful * {@code UriComponentsBuilder} representing the base URL. This is useful
* when using MvcUriComponentsBuilder outside the context of processing a * when using MvcUriComponentsBuilder outside the context of processing a
* request or to apply a custom baseUrl not matching the current request. * request or to apply a custom baseUrl not matching the current request.
* <p><strong>Note:</strong> This method extracts values from "Forwarded"
* and "X-Forwarded-*" headers if found. See class-level docs.
* @param builder the builder for the base URL; the builder will be cloned * @param builder the builder for the base URL; the builder will be cloned
* and therefore not modified and may be re-used for further calls. * and therefore not modified and may be re-used for further calls.
* @param name the mapping name * @param name the mapping name
@ -481,8 +456,6 @@ public class MvcUriComponentsBuilder {
/** /**
* An alternative to {@link #fromController(Class)} for use with an instance * An alternative to {@link #fromController(Class)} for use with an instance
* of this class created via a call to {@link #relativeTo}. * of this class created via a call to {@link #relativeTo}.
* <p><strong>Note:</strong> This method extracts values from "Forwarded"
* and "X-Forwarded-*" headers if found. See class-level docs.
* @since 4.2 * @since 4.2
*/ */
public UriComponentsBuilder withController(Class<?> controllerType) { public UriComponentsBuilder withController(Class<?> controllerType) {
@ -492,8 +465,6 @@ public class MvcUriComponentsBuilder {
/** /**
* An alternative to {@link #fromMethodName(Class, String, Object...)} for * An alternative to {@link #fromMethodName(Class, String, Object...)} for
* use with an instance of this class created via {@link #relativeTo}. * use with an instance of this class created via {@link #relativeTo}.
* <p><strong>Note:</strong> This method extracts values from "Forwarded"
* and "X-Forwarded-*" headers if found. See class-level docs.
* @since 4.2 * @since 4.2
*/ */
public UriComponentsBuilder withMethodName(Class<?> controllerType, String methodName, Object... args) { public UriComponentsBuilder withMethodName(Class<?> controllerType, String methodName, Object... args) {
@ -503,8 +474,6 @@ public class MvcUriComponentsBuilder {
/** /**
* An alternative to {@link #fromMethodCall(Object)} for use with an instance * An alternative to {@link #fromMethodCall(Object)} for use with an instance
* of this class created via {@link #relativeTo}. * of this class created via {@link #relativeTo}.
* <p><strong>Note:</strong> This method extracts values from "Forwarded"
* and "X-Forwarded-*" headers if found. See class-level docs.
* @since 4.2 * @since 4.2
*/ */
public UriComponentsBuilder withMethodCall(Object invocationInfo) { public UriComponentsBuilder withMethodCall(Object invocationInfo) {
@ -514,8 +483,6 @@ public class MvcUriComponentsBuilder {
/** /**
* An alternative to {@link #fromMappingName(String)} for use with an instance * An alternative to {@link #fromMappingName(String)} for use with an instance
* of this class created via {@link #relativeTo}. * of this class created via {@link #relativeTo}.
* <p><strong>Note:</strong> This method extracts values from "Forwarded"
* and "X-Forwarded-*" headers if found. See class-level docs.
* @since 4.2 * @since 4.2
*/ */
public MethodArgumentBuilder withMappingName(String mappingName) { public MethodArgumentBuilder withMappingName(String mappingName) {
@ -525,8 +492,6 @@ public class MvcUriComponentsBuilder {
/** /**
* An alternative to {@link #fromMethod(Class, Method, Object...)} * An alternative to {@link #fromMethod(Class, Method, Object...)}
* for use with an instance of this class created via {@link #relativeTo}. * for use with an instance of this class created via {@link #relativeTo}.
* <p><strong>Note:</strong> This method extracts values from "Forwarded"
* and "X-Forwarded-*" headers if found. See class-level docs.
* @since 4.2 * @since 4.2
*/ */
public UriComponentsBuilder withMethod(Class<?> controllerType, Method method, Object... args) { public UriComponentsBuilder withMethod(Class<?> controllerType, Method method, Object... args) {