Skip to content

Commit cc44a93

Browse files
committed
Polish WebSecurityConfigurerAdapter JavaDoc
Issue gh-8784
1 parent 956a6ee commit cc44a93

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
@@ -331,12 +331,10 @@ public void init(final WebSecurity web) throws Exception {
331331
* Override this method to configure {@link WebSecurity}. For example, if you wish to
332332
* ignore certain requests.
333333
*
334-
* Endpoint used in this method ignores the
335-
* spring security filters, headers, csrf etc. see
336-
* {@link org.springframework.security.config.annotation.web.configurers.HeadersConfigurer} and
337-
* {@link org.springframework.security.config.annotation.web.configurers.CsrfConfigurer }
334+
* Endpoints specified in this method will be ignored by Spring Security, meaning it
335+
* will not protect them from CSRF, XSS, Clickjacking, and so on.
338336
*
339-
* Instead, if you want to protect public endpoints against common vulnerabilities, then see
337+
* Instead, if you want to protect endpoints against common vulnerabilities, then see
340338
* {@link #configure(HttpSecurity)} and the {@link HttpSecurity#authorizeRequests}
341339
* configuration method.
342340
*/
@@ -352,9 +350,9 @@ public void configure(WebSecurity web) throws Exception {
352350
* http.authorizeRequests().anyRequest().authenticated().and().formLogin().and().httpBasic();
353351
* </pre>
354352
*
355-
* Public endpoints that require defense against common vulnerabilities can be specified here.
353+
* Any endpoint that requires defense against common vulnerabilities can be specified here, including public ones.
356354
* See {@link HttpSecurity#authorizeRequests} and the `permitAll()` authorization rule
357-
* for more details.
355+
* for more details on public endpoints.
358356
*
359357
* @param http the {@link HttpSecurity} to modify
360358
* @throws Exception if an error occurs

0 commit comments

Comments
 (0)