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

Add Kotlin logout samples to docs 

Issue gh-8172
This commit is contained in:
Eleftheria Stein 2020-07-06 12:45:41 +02:00
parent 4fb5ff35db
commit 0bdf6859be
1 changed files with 23 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
docs/manual/src/docs/asciidoc/_includes/servlet/authentication/logout.adoc
View File

@ -2,7 +2,7 @@
== Handling Logouts == Handling Logouts
[[logout-java-configuration]] [[logout-java-configuration]]
=== Logout Java Configuration === Logout Java/Kotlin Configuration
When using the `{security-api-url}org/springframework/security/config/annotation/web/configuration/WebSecurityConfigurerAdapter.html[WebSecurityConfigurerAdapter]`, logout capabilities are automatically applied. When using the `{security-api-url}org/springframework/security/config/annotation/web/configuration/WebSecurityConfigurerAdapter.html[WebSecurityConfigurerAdapter]`, logout capabilities are automatically applied.
The default is that accessing the URL `/logout` will log the user out by: The default is that accessing the URL `/logout` will log the user out by:
@ -14,7 +14,10 @@ The default is that accessing the URL `/logout` will log the user out by:
Similar to configuring login capabilities, however, you also have various options to further customize your logout requirements: Similar to configuring login capabilities, however, you also have various options to further customize your logout requirements:
[source,java] .Logout Configuration
====
.Java
[source,java,role="primary"]
---- ----
protected void configure(HttpSecurity http) throws Exception { protected void configure(HttpSecurity http) throws Exception {
http http
@ -30,6 +33,24 @@ protected void configure(HttpSecurity http) throws Exception {
} }
---- ----
.Kotlin
[source,kotlin,role="secondary"]
-----
override fun configure(http: HttpSecurity) {
http {
logout {
logoutUrl = "/my/logout" // <1>
logoutSuccessUrl = "/my/index" // <2>
logoutSuccessHandler = customLogoutSuccessHandler // <3>
invalidateHttpSession = true // <4>
addLogoutHandler(logoutHandler) // <5>
deleteCookies(cookieNamesToClear) // <6>
}
}
}
-----
====
<1> Provides logout support. <1> Provides logout support.
This is automatically applied when using `WebSecurityConfigurerAdapter`. This is automatically applied when using `WebSecurityConfigurerAdapter`.
<2> The URL that triggers log out to occur (default is `/logout`). <2> The URL that triggers log out to occur (default is `/logout`).