Cwikius-Spring
/
spring-security
mirror of https://github.com/spring-projects/spring-security.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Polish javadoc in Kotlin DSL 

Issue gh-11646
This commit is contained in:
Steve Riesenberg 2022-08-30 12:53:37 -05:00
parent 2e26e875c8
commit 5bdbc3f78d
No known key found for this signature in database
GPG Key ID: 5F311AB48A55D521
5 changed files with 334 additions and 334 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

506
config/src/main/kotlin/org/springframework/security/config/web/servlet/HttpSecurityDsl.kt
View File

@ -35,19 +35,19 @@ import javax.servlet.http.HttpServletRequest
* @EnableWebSecurity
* class SecurityConfig {
*
* @Bean
* fun securityFilterChain(http: HttpSecurity): SecurityFilterChain {
* http {
* authorizeRequests {
* authorize("/public", permitAll)
* authorize(anyRequest, authenticated)
* }
* formLogin {
* loginPage = "/log-in"
* }
* }
* return http.build()
* }
* @Bean
* fun securityFilterChain(http: HttpSecurity): SecurityFilterChain {
* http {
* authorizeRequests {
* authorize("/public", permitAll)
* authorize(anyRequest, authenticated)
* }
* formLogin {
* loginPage = "/log-in"
* }
* }
* return http.build()
* }
* }
* ```
*
@ -87,16 +87,16 @@ class HttpSecurityDsl(private val http: HttpSecurity, private val init: HttpSecu
* @EnableWebSecurity
* class SecurityConfig {
*
* @Bean
* fun securityFilterChain(http: HttpSecurity): SecurityFilterChain {
* http {
* securityMatcher("/private/**")
* formLogin {
* loginPage = "/log-in"
* }
* }
* return http.build()
* }
* @Bean
* fun securityFilterChain(http: HttpSecurity): SecurityFilterChain {
* http {
* securityMatcher("/private/**")
* formLogin {
* loginPage = "/log-in"
* }
* }
* return http.build()
* }
* }
* ```
*
@ -129,16 +129,16 @@ class HttpSecurityDsl(private val http: HttpSecurity, private val init: HttpSecu
* @EnableWebSecurity
* class SecurityConfig {
*
* @Bean
* fun securityFilterChain(http: HttpSecurity): SecurityFilterChain {
* http {
* securityMatcher(AntPathRequestMatcher("/private/**"))
* formLogin {
* loginPage = "/log-in"
* }
* }
* return http.build()
* }
* @Bean
* fun securityFilterChain(http: HttpSecurity): SecurityFilterChain {
* http {
* securityMatcher(AntPathRequestMatcher("/private/**"))
* formLogin {
* loginPage = "/log-in"
* }
* }
* return http.build()
* }
* }
* ```
*
@ -160,15 +160,15 @@ class HttpSecurityDsl(private val http: HttpSecurity, private val init: HttpSecu
* @EnableWebSecurity
* class SecurityConfig {
*
* @Bean
* fun securityFilterChain(http: HttpSecurity): SecurityFilterChain {
* http {
* formLogin {
* loginPage = "/log-in"
* }
* }
* return http.build()
* }
* @Bean
* fun securityFilterChain(http: HttpSecurity): SecurityFilterChain {
* http {
* formLogin {
* loginPage = "/log-in"
* }
* }
* return http.build()
* }
* }
* ```
*
@ -190,16 +190,16 @@ class HttpSecurityDsl(private val http: HttpSecurity, private val init: HttpSecu
* @EnableWebSecurity
* class SecurityConfig {
*
* @Bean
* fun securityFilterChain(http: HttpSecurity): SecurityFilterChain {
* http {
* authorizeRequests {
* authorize("/public", permitAll)
* authorize(anyRequest, authenticated)
* }
* }
* return http.build()
* }
* @Bean
* fun securityFilterChain(http: HttpSecurity): SecurityFilterChain {
* http {
* authorizeRequests {
* authorize("/public", permitAll)
* authorize(anyRequest, authenticated)
* }
* }
* return http.build()
* }
* }
* ```
*
@ -221,16 +221,16 @@ class HttpSecurityDsl(private val http: HttpSecurity, private val init: HttpSecu
* @EnableWebSecurity
* class SecurityConfig {
*
* @Bean
* fun securityFilterChain(http: HttpSecurity): SecurityFilterChain {
* http {
* authorizeHttpRequests {
* authorize("/public", permitAll)
* authorize(anyRequest, authenticated)
* }
* }
* return http.build()
* }
* @Bean
* fun securityFilterChain(http: HttpSecurity): SecurityFilterChain {
* http {
* authorizeHttpRequests {
* authorize("/public", permitAll)
* authorize(anyRequest, authenticated)
* }
* }
* return http.build()
* }
* }
* ```
*
@ -253,15 +253,15 @@ class HttpSecurityDsl(private val http: HttpSecurity, private val init: HttpSecu
* @EnableWebSecurity
* class SecurityConfig {
*
* @Bean
* fun securityFilterChain(http: HttpSecurity): SecurityFilterChain {
* http {
* httpBasic {
* realmName = "Custom Realm"
* }
* }
* return http.build()
* }
* @Bean
* fun securityFilterChain(http: HttpSecurity): SecurityFilterChain {
* http {
* httpBasic {
* realmName = "Custom Realm"
* }
* }
* return http.build()
* }
* }
* ```
*
@ -283,15 +283,15 @@ class HttpSecurityDsl(private val http: HttpSecurity, private val init: HttpSecu
* @EnableWebSecurity
* class SecurityConfig {
*
* @Bean
* fun securityFilterChain(http: HttpSecurity): SecurityFilterChain {
* http {
* passwordManagement {
* changePasswordPage = "/custom-change-password-page"
* }
* }
* return http.build()
* }
* @Bean
* fun securityFilterChain(http: HttpSecurity): SecurityFilterChain {
* http {
* passwordManagement {
* changePasswordPage = "/custom-change-password-page"
* }
* }
* return http.build()
* }
* }
* ```
*
@ -314,17 +314,17 @@ class HttpSecurityDsl(private val http: HttpSecurity, private val init: HttpSecu
* @EnableWebSecurity
* class SecurityConfig {
*
* @Bean
* fun securityFilterChain(http: HttpSecurity): SecurityFilterChain {
* http {
* headers {
* referrerPolicy {
* policy = ReferrerPolicy.SAME_ORIGIN
* }
* }
* }
* return http.build()
* }
* @Bean
* fun securityFilterChain(http: HttpSecurity): SecurityFilterChain {
* http {
* headers {
* referrerPolicy {
* policy = ReferrerPolicy.SAME_ORIGIN
* }
* }
* }
* return http.build()
* }
* }
* ```
*
@ -346,15 +346,15 @@ class HttpSecurityDsl(private val http: HttpSecurity, private val init: HttpSecu
* @EnableWebSecurity
* class SecurityConfig {
*
* @Bean
* fun securityFilterChain(http: HttpSecurity): SecurityFilterChain {
* http {
* cors {
* disable()
* }
* }
* return http.build()
* }
* @Bean
* fun securityFilterChain(http: HttpSecurity): SecurityFilterChain {
* http {
* cors {
* disable()
* }
* }
* return http.build()
* }
* }
* ```
*
@ -376,18 +376,18 @@ class HttpSecurityDsl(private val http: HttpSecurity, private val init: HttpSecu
* @EnableWebSecurity
* class SecurityConfig {
*
* @Bean
* fun securityFilterChain(http: HttpSecurity): SecurityFilterChain {
* http {
* sessionManagement {
* invalidSessionUrl = "/invalid-session"
* sessionConcurrency {
* maximumSessions = 1
* }
* }
* }
* return http.build()
* }
* @Bean
* fun securityFilterChain(http: HttpSecurity): SecurityFilterChain {
* http {
* sessionManagement {
* invalidSessionUrl = "/invalid-session"
* sessionConcurrency {
* maximumSessions = 1
* }
* }
* }
* return http.build()
* }
* }
* ```
*
@ -409,15 +409,15 @@ class HttpSecurityDsl(private val http: HttpSecurity, private val init: HttpSecu
* @EnableWebSecurity
* class SecurityConfig {
*
* @Bean
* fun securityFilterChain(http: HttpSecurity): SecurityFilterChain {
* http {
* portMapper {
* map(80, 443)
* }
* }
* return http.build()
* }
* @Bean
* fun securityFilterChain(http: HttpSecurity): SecurityFilterChain {
* http {
* portMapper {
* map(80, 443)
* }
* }
* return http.build()
* }
* }
* ```
*
@ -439,16 +439,16 @@ class HttpSecurityDsl(private val http: HttpSecurity, private val init: HttpSecu
* @EnableWebSecurity
* class SecurityConfig {
*
* @Bean
* fun securityFilterChain(http: HttpSecurity): SecurityFilterChain {
* http {
* requiresChannel {
* secure("/public", requiresInsecure)
* secure(anyRequest, requiresSecure)
* }
* }
* return http.build()
* }
* @Bean
* fun securityFilterChain(http: HttpSecurity): SecurityFilterChain {
* http {
* requiresChannel {
* secure("/public", requiresInsecure)
* secure(anyRequest, requiresSecure)
* }
* }
* return http.build()
* }
* }
* ```
*
@ -470,13 +470,13 @@ class HttpSecurityDsl(private val http: HttpSecurity, private val init: HttpSecu
* @EnableWebSecurity
* class SecurityConfig {
*
* @Bean
* fun securityFilterChain(http: HttpSecurity): SecurityFilterChain {
* http {
* x509 { }
* }
* return http.build()
* }
* @Bean
* fun securityFilterChain(http: HttpSecurity): SecurityFilterChain {
* http {
* x509 { }
* }
* return http.build()
* }
* }
* ```
*
@ -499,13 +499,13 @@ class HttpSecurityDsl(private val http: HttpSecurity, private val init: HttpSecu
* @EnableWebSecurity
* class SecurityConfig {
*
* @Bean
* fun securityFilterChain(http: HttpSecurity): SecurityFilterChain {
* http {
* requestCache { }
* }
* return http.build()
* }
* @Bean
* fun securityFilterChain(http: HttpSecurity): SecurityFilterChain {
* http {
* requestCache { }
* }
* return http.build()
* }
* }
* ```
*
@ -527,15 +527,15 @@ class HttpSecurityDsl(private val http: HttpSecurity, private val init: HttpSecu
* @EnableWebSecurity
* class SecurityConfig {
*
* @Bean
* fun securityFilterChain(http: HttpSecurity): SecurityFilterChain {
* http {
* exceptionHandling {
* accessDeniedPage = "/access-denied"
* }
* }
* return http.build()
* }
* @Bean
* fun securityFilterChain(http: HttpSecurity): SecurityFilterChain {
* http {
* exceptionHandling {
* accessDeniedPage = "/access-denied"
* }
* }
* return http.build()
* }
* }
* ```
*
@ -557,13 +557,13 @@ class HttpSecurityDsl(private val http: HttpSecurity, private val init: HttpSecu
* @EnableWebSecurity
* class SecurityConfig {
*
* @Bean
* fun securityFilterChain(http: HttpSecurity): SecurityFilterChain {
* http {
* csrf { }
* }
* return http.build()
* }
* @Bean
* fun securityFilterChain(http: HttpSecurity): SecurityFilterChain {
* http {
* csrf { }
* }
* return http.build()
* }
* }
* ```
*
@ -584,15 +584,15 @@ class HttpSecurityDsl(private val http: HttpSecurity, private val init: HttpSecu
* @EnableWebSecurity
* class SecurityConfig {
*
* @Bean
* fun securityFilterChain(http: HttpSecurity): SecurityFilterChain {
* http {
* logout {
* logoutUrl = "/log-out"
* }
* }
* return http.build()
* }
* @Bean
* fun securityFilterChain(http: HttpSecurity): SecurityFilterChain {
* http {
* logout {
* logoutUrl = "/log-out"
* }
* }
* return http.build()
* }
* }
* ```
*
@ -616,15 +616,15 @@ class HttpSecurityDsl(private val http: HttpSecurity, private val init: HttpSecu
* @EnableWebSecurity
* class SecurityConfig {
*
* @Bean
* fun securityFilterChain(http: HttpSecurity): SecurityFilterChain {
* http {
* saml2Login {
* relyingPartyRegistration = getSaml2RelyingPartyRegistration()
* }
* }
* return http.build()
* }
* @Bean
* fun securityFilterChain(http: HttpSecurity): SecurityFilterChain {
* http {
* saml2Login {
* relyingPartyRegistration = getSaml2RelyingPartyRegistration()
* }
* }
* return http.build()
* }
* }
* ```
*
@ -646,15 +646,15 @@ class HttpSecurityDsl(private val http: HttpSecurity, private val init: HttpSecu
* @EnableWebSecurity
* class SecurityConfig {
*
* @Bean
* fun securityFilterChain(http: HttpSecurity): SecurityFilterChain {
* http {
* anonymous {
* authorities = listOf(SimpleGrantedAuthority("ROLE_ANON"))
* }
* }
* return http.build()
* }
* @Bean
* fun securityFilterChain(http: HttpSecurity): SecurityFilterChain {
* http {
* anonymous {
* authorities = listOf(SimpleGrantedAuthority("ROLE_ANON"))
* }
* }
* return http.build()
* }
* }
* ```
*
@ -678,15 +678,15 @@ class HttpSecurityDsl(private val http: HttpSecurity, private val init: HttpSecu
* @EnableWebSecurity
* class SecurityConfig {
*
* @Bean
* fun securityFilterChain(http: HttpSecurity): SecurityFilterChain {
* http {
* oauth2Login {
* clientRegistrationRepository = getClientRegistrationRepository()
* }
* }
* return http.build()
* }
* @Bean
* fun securityFilterChain(http: HttpSecurity): SecurityFilterChain {
* http {
* oauth2Login {
* clientRegistrationRepository = getClientRegistrationRepository()
* }
* }
* return http.build()
* }
* }
* ```
*
@ -708,13 +708,13 @@ class HttpSecurityDsl(private val http: HttpSecurity, private val init: HttpSecu
* @EnableWebSecurity
* class SecurityConfig {
*
* @Bean
* fun securityFilterChain(http: HttpSecurity): SecurityFilterChain {
* http {
* oauth2Client { }
* }
* return http.build()
* }
* @Bean
* fun securityFilterChain(http: HttpSecurity): SecurityFilterChain {
* http {
* oauth2Client { }
* }
* return http.build()
* }
* }
* ```
*
@ -736,15 +736,15 @@ class HttpSecurityDsl(private val http: HttpSecurity, private val init: HttpSecu
* @EnableWebSecurity
* class SecurityConfig {
*
* @Bean
* fun securityFilterChain(http: HttpSecurity): SecurityFilterChain {
* http {
* oauth2ResourceServer {
* jwt { }
* }
* }
* return http.build()
* }
* @Bean
* fun securityFilterChain(http: HttpSecurity): SecurityFilterChain {
* http {
* oauth2ResourceServer {
* jwt { }
* }
* }
* return http.build()
* }
* }
* ```
*
@ -766,15 +766,15 @@ class HttpSecurityDsl(private val http: HttpSecurity, private val init: HttpSecu
* @EnableWebSecurity
* class SecurityConfig {
*
* @Bean
* fun securityFilterChain(http: HttpSecurity): SecurityFilterChain {
* http {
* rememberMe {
* tokenValiditySeconds = 604800
* }
* }
* return http.build()
* }
* @Bean
* fun securityFilterChain(http: HttpSecurity): SecurityFilterChain {
* http {
* rememberMe {
* tokenValiditySeconds = 604800
* }
* }
* return http.build()
* }
* }
* ```
*
@ -795,13 +795,13 @@ class HttpSecurityDsl(private val http: HttpSecurity, private val init: HttpSecu
* @EnableWebSecurity
* class SecurityConfig {
*
* @Bean
* fun securityFilterChain(http: HttpSecurity): SecurityFilterChain {
* http {
* addFilterAt(CustomFilter(), UsernamePasswordAuthenticationFilter::class.java)
* }
* return http.build()
* }
* @Bean
* fun securityFilterChain(http: HttpSecurity): SecurityFilterChain {
* http {
* addFilterAt(CustomFilter(), UsernamePasswordAuthenticationFilter::class.java)
* }
* return http.build()
* }
* }
* ```
*
@ -852,13 +852,13 @@ class HttpSecurityDsl(private val http: HttpSecurity, private val init: HttpSecu
* @EnableWebSecurity
* class SecurityConfig {
*
* @Bean
* fun securityFilterChain(http: HttpSecurity): SecurityFilterChain {
* http {
* addFilterAfter(CustomFilter(), UsernamePasswordAuthenticationFilter::class.java)
* }
* return http.build()
* }
* @Bean
* fun securityFilterChain(http: HttpSecurity): SecurityFilterChain {
* http {
* addFilterAfter(CustomFilter(), UsernamePasswordAuthenticationFilter::class.java)
* }
* return http.build()
* }
* }
* ```
*
@ -909,13 +909,13 @@ class HttpSecurityDsl(private val http: HttpSecurity, private val init: HttpSecu
* @EnableWebSecurity
* class SecurityConfig {
*
* @Bean
* fun securityFilterChain(http: HttpSecurity): SecurityFilterChain {
* http {
* addFilterBefore(CustomFilter(), UsernamePasswordAuthenticationFilter::class.java)
* }
* return http.build()
* }
* @Bean
* fun securityFilterChain(http: HttpSecurity): SecurityFilterChain {
* http {
* addFilterBefore(CustomFilter(), UsernamePasswordAuthenticationFilter::class.java)
* }
* return http.build()
* }
* }
* ```
*
@ -938,13 +938,13 @@ class HttpSecurityDsl(private val http: HttpSecurity, private val init: HttpSecu
* @EnableWebSecurity
* class SecurityConfig {
*
* @Bean
* fun securityFilterChain(http: HttpSecurity): SecurityFilterChain {
* http {
* addFilterBefore<UsernamePasswordAuthenticationFilter>(CustomFilter())
* }
* return http.build()
* }
* @Bean
* fun securityFilterChain(http: HttpSecurity): SecurityFilterChain {
* http {
* addFilterBefore<UsernamePasswordAuthenticationFilter>(CustomFilter())
* }
* return http.build()
* }
* }
* ```
*
@ -974,15 +974,15 @@ class HttpSecurityDsl(private val http: HttpSecurity, private val init: HttpSecu
* @EnableWebSecurity
* class SecurityConfig {
*
* @Bean
* fun securityFilterChain(http: HttpSecurity): SecurityFilterChain {
* @Bean
* fun securityFilterChain(http: HttpSecurity): SecurityFilterChain {
* http {
* securityContext {
* securityContextRepository = SECURITY_CONTEXT_REPOSITORY
* }
* }
* return http.build()
* }
* }
* }
* ```
* @author Norbert Nowak

22
config/src/main/kotlin/org/springframework/security/config/web/servlet/OAuth2ClientDsl.kt
View File

@ -67,17 +67,17 @@ class OAuth2ClientDsl {
* @EnableWebSecurity
* class SecurityConfig {
*
* @Bean
* fun securityFilterChain(http: HttpSecurity): SecurityFilterChain {
* http {
* oauth2Client {
* authorizationCodeGrant {
* authorizationRequestResolver = getAuthorizationRequestResolver()
* }
* }
* }
* return http.build()
* }
* @Bean
* fun securityFilterChain(http: HttpSecurity): SecurityFilterChain {
* http {
* oauth2Client {
* authorizationCodeGrant {
* authorizationRequestResolver = getAuthorizationRequestResolver()
* }
* }
* }
* return http.build()
* }
* }
* ```
*

70
config/src/main/kotlin/org/springframework/security/config/web/servlet/OAuth2LoginDsl.kt
View File

@ -99,17 +99,17 @@ class OAuth2LoginDsl {
* @EnableWebSecurity
* class SecurityConfig {
*
* @Bean
* fun securityFilterChain(http: HttpSecurity): SecurityFilterChain {
* http {
* oauth2Login {
* authorizationEndpoint {
* baseUri = "/auth"
* }
* }
* }
* return http.build()
* }
* @Bean
* fun securityFilterChain(http: HttpSecurity): SecurityFilterChain {
* http {
* oauth2Login {
* authorizationEndpoint {
* baseUri = "/auth"
* }
* }
* }
* return http.build()
* }
* }
* ```
*
@ -132,14 +132,14 @@ class OAuth2LoginDsl {
*
* @Bean
* fun securityFilterChain(http: HttpSecurity): SecurityFilterChain {
* http {
* oauth2Login {
* tokenEndpoint {
* accessTokenResponseClient = getAccessTokenResponseClient()
* }
* }
* }
* return http.build()
* http {
* oauth2Login {
* tokenEndpoint {
* accessTokenResponseClient = getAccessTokenResponseClient()
* }
* }
* }
* return http.build()
* }
* }
* ```
@ -163,14 +163,14 @@ class OAuth2LoginDsl {
*
* @Bean
* fun securityFilterChain(http: HttpSecurity): SecurityFilterChain {
* http {
* oauth2Login {
* redirectionEndpoint {
* baseUri = "/home"
* }
* }
* }
* return http.build()
* http {
* oauth2Login {
* redirectionEndpoint {
* baseUri = "/home"
* }
* }
* }
* return http.build()
* }
* }
* ```
@ -194,14 +194,14 @@ class OAuth2LoginDsl {
*
* @Bean
* fun securityFilterChain(http: HttpSecurity): SecurityFilterChain {
* http {
* oauth2Login {
* userInfoEndpoint {
* userService = getUserService()
* }
* }
* }
* return http.build()
* http {
* oauth2Login {
* userInfoEndpoint {
* userService = getUserService()
* }
* }
* }
* return http.build()
* }
* }
* ```

40
config/src/main/kotlin/org/springframework/security/config/web/servlet/OAuth2ResourceServerDsl.kt
View File

@ -58,17 +58,17 @@ class OAuth2ResourceServerDsl {
* @EnableWebSecurity
* class SecurityConfig {
*
* @Bean
* fun securityFilterChain(http: HttpSecurity): SecurityFilterChain {
* http {
* oauth2ResourceServer {
* jwt {
* jwkSetUri = "https://example.com/oauth2/jwk"
* }
* }
* }
* return http.build()
* }
* @Bean
* fun securityFilterChain(http: HttpSecurity): SecurityFilterChain {
* http {
* oauth2ResourceServer {
* jwt {
* jwkSetUri = "https://example.com/oauth2/jwk"
* }
* }
* }
* return http.build()
* }
* }
* ```
*
@ -88,15 +88,15 @@ class OAuth2ResourceServerDsl {
* @EnableWebSecurity
* class SecurityConfig {
*
* @Bean
* fun securityFilterChain(http: HttpSecurity): SecurityFilterChain {
* http {
* oauth2ResourceServer {
* opaqueToken { }
* }
* }
* return http.build()
* }
* @Bean
* fun securityFilterChain(http: HttpSecurity): SecurityFilterChain {
* http {
* oauth2ResourceServer {
* opaqueToken { }
* }
* }
* return http.build()
* }
* }
* ```
*

30
config/src/main/kotlin/org/springframework/security/config/web/servlet/SessionManagementDsl.kt
View File

@ -55,12 +55,12 @@ class SessionManagementDsl {
*
* @Bean
* fun securityFilterChain(http: HttpSecurity): SecurityFilterChain {
* http {
* sessionManagement {
* sessionFixation { }
* }
* }
* return http.build()
* http {
* sessionManagement {
* sessionFixation { }
* }
* }
* return http.build()
* }
* }
* ```
@ -84,15 +84,15 @@ class SessionManagementDsl {
*
* @Bean
* fun securityFilterChain(http: HttpSecurity): SecurityFilterChain {
* http {
* sessionManagement {
* sessionConcurrency {
* maximumSessions = 1
* maxSessionsPreventsLogin = true
* }
* }
* }
* return http.build()
* http {
* sessionManagement {
* sessionConcurrency {
* maximumSessions = 1
* maxSessionsPreventsLogin = true
* }
* }
* }
* return http.build()
* }
* }
* ```