Adjusts setRequestHandler javadoc in CsrfFilter

wldomiciano · Steve Riesenberg · commit 2c8854bb7fd9 · 2023-01-10T11:31:51.000-06:00
Adjusts setRequestHandler method javadoc in CsrfFilter class to reflect changes in 6.0. In 6.0, the default CsrfTokenRequestHandler changed to XorCsrfTokenRequestAttributeHandler, however, the javadoc for the setRequestHandler method still said it was CsrfTokenRequestAttributeHandler. This change adjusts the information to make it more accurate, because, although XorCsrfTokenRequestAttributeHandler is a subclass of CsrfTokenRequestAttributeHandler, the behavior is quite different. Closes gh-12464
diff --git a/web/src/main/java/org/springframework/security/web/csrf/CsrfFilter.java b/web/src/main/java/org/springframework/security/web/csrf/CsrfFilter.java
@@ -170,7 +170,7 @@ public void setAccessDeniedHandler(AccessDeniedHandler accessDeniedHandler) {
 	 * {@link CsrfToken} available as a request attribute.
 	 *
 	 * <p>
-	 * The default is {@link CsrfTokenRequestAttributeHandler}.
+	 * The default is {@link XorCsrfTokenRequestAttributeHandler}.
 	 * </p>
 	 * @param requestHandler the {@link CsrfTokenRequestHandler} to use
 	 * @since 5.8

Original file line number	Diff line number	Diff line change
`@@ -170,7 +170,7 @@ public void setAccessDeniedHandler(AccessDeniedHandler accessDeniedHandler) {`
`170`	`170`	`* {@link CsrfToken} available as a request attribute.`
`171`	`171`	`*`
`172`	`172`	`* <p>`
`173`		`- * The default is {@link CsrfTokenRequestAttributeHandler}.`
	`173`	`+ * The default is {@link XorCsrfTokenRequestAttributeHandler}.`
`174`	`174`	`* </p>`
`175`	`175`	`* @param requestHandler the {@link CsrfTokenRequestHandler} to use`
`176`	`176`	`* @since 5.8`