Skip to content

Commit 2303ac3

Browse files
committed
Polish WebSecurityConfigurerAdapter JavaDoc
Issue gh-8784
1 parent ef442de commit 2303ac3

File tree

1 file changed

+5
-7
lines changed

1 file changed

+5
-7
lines changed

config/src/main/java/org/springframework/security/config/annotation/web/configuration/WebSecurityConfigurerAdapter.java

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -333,12 +333,10 @@ public void run() {
333333
* Override this method to configure {@link WebSecurity}. For example, if you wish to
334334
* ignore certain requests.
335335
*
336-
* Endpoint used in this method ignores the
337-
* spring security filters, headers, csrf etc. see
338-
* {@link org.springframework.security.config.annotation.web.configurers.HeadersConfigurer} and
339-
* {@link org.springframework.security.config.annotation.web.configurers.CsrfConfigurer }
336+
* Endpoints specified in this method will be ignored by Spring Security, meaning it
337+
* will not protect them from CSRF, XSS, Clickjacking, and so on.
340338
*
341-
* Instead, if you want to protect public endpoints against common vulnerabilities, then see
339+
* Instead, if you want to protect endpoints against common vulnerabilities, then see
342340
* {@link #configure(HttpSecurity)} and the {@link HttpSecurity#authorizeRequests}
343341
* configuration method.
344342
*/
@@ -354,9 +352,9 @@ public void configure(WebSecurity web) throws Exception {
354352
* http.authorizeRequests().anyRequest().authenticated().and().formLogin().and().httpBasic();
355353
* </pre>
356354
*
357-
* Public endpoints that require defense against common vulnerabilities can be specified here.
355+
* Any endpoint that requires defense against common vulnerabilities can be specified here, including public ones.
358356
* See {@link HttpSecurity#authorizeRequests} and the `permitAll()` authorization rule
359-
* for more details.
357+
* for more details on public endpoints.
360358
*
361359
* @param http the {@link HttpSecurity} to modify
362360
* @throws Exception if an error occurs

0 commit comments

Comments
 (0)