Misleading JavaDoc in ServletUriComponentsBuilder [SPR-17317]

[spring-projects-issues]

johann-sonntagbauer opened SPR-17317 and commented

After the upgrade to Spring 5.1.0 the implementation of ServlerUriComponentsBuilder changed that X-Forwarded-* Headers are not respected any longer. 

But some JavaDoc comments on the methods suggest otherwise.

This leads to misleading assumptions because JavaDoc and implementation are different.

 

Example:

#fromCurrentServletMapping

JavaDoc: This method extracts values from "Forwarded" and "X-Forwarded-*" headers if found

This method delegates to 

 

#fromServletMapping which notes in the JavaDoc that 

As of 5.1, this method ignores "Forwarded" and "X-Forwarded-*" headers ...

---

Affects: 5.1 GA

Issue Links:

• Centralize handling of "Forwarded" headers to ForwardedHeaderFilter [SPR-16668] #21209 Centralize handling of "Forwarded" headers to ForwardedHeaderFilter

Referenced from: commits bb5c8ed

[spring-projects-issues]

Rossen Stoyanchev commented

I've removed all method-level comments and added a single note on the class level to state that forwarded headers are no longer used as of 5.1.

[spring-projects-issues]

johann-sonntagbauer commented

Thank you very much!