LogoutDsl

A Kotlin DSL to configure HttpSecurity logout support using idiomatic Kotlin code.

Eleftheria Stein

5.3

Constructors

constructor()

whether the SecurityContextLogoutHandler should clear the Authentication at the time of logout.

whether to invalidate the HttpSession at the time of logout.

var logoutRequestMatcher: RequestMatcher?

the RequestMatcher that triggers log out to occur.

var logoutSuccessHandler: LogoutSuccessHandler?

the LogoutSuccessHandler to use after logout has occurred. If this is specified, logoutSuccessUrl is ignored.

the URL to redirect to after logout has occurred.

the URL that triggers log out to occur.

fun addLogoutHandler(logoutHandler: LogoutHandler)

Adds a LogoutHandler. The SecurityContextLogoutHandler is added as the last LogoutHandler by default.

fun defaultLogoutSuccessHandlerFor(logoutHandler: LogoutSuccessHandler, preferredMatcher: RequestMatcher)

Sets a default LogoutSuccessHandler to be used which prefers being invoked for the provided RequestMatcher.

fun deleteCookies(vararg cookieNamesToClear: String)

Allows specifying the names of cookies to be removed on logout success.

Disables logout

Grants access to the logoutSuccessUrl and the logoutUrl for every user.