org.springframework.security.web.server.authentication.logout

Class HeaderWriterServerLogoutHandler

java.lang.Object

org.springframework.security.web.server.authentication.logout.HeaderWriterServerLogoutHandler

All Implemented Interfaces:

ServerLogoutHandler

public final class HeaderWriterServerLogoutHandler
extends java.lang.Object
implements ServerLogoutHandler

A ServerLogoutHandler implementation which writes HTTP headers during logout.

Since:

5.2

Constructor Summary

Constructors

Constructor and Description
HeaderWriterServerLogoutHandler(ServerHttpHeadersWriter headersWriter) Constructs a new instance using the ServerHttpHeadersWriter implementation.

Method Summary

Modifier and Type	Method and Description
reactor.core.publisher.Mono<java.lang.Void>	logout(WebFilterExchange exchange, Authentication authentication) Invoked when log out is requested

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

HeaderWriterServerLogoutHandler

public HeaderWriterServerLogoutHandler(ServerHttpHeadersWriter headersWriter)

Constructs a new instance using the ServerHttpHeadersWriter implementation.

Parameters:

headersWriter - a ServerHttpHeadersWriter implementation

Throws:

java.lang.IllegalArgumentException - if the argument is null

Method Detail

logout

public reactor.core.publisher.Mono<java.lang.Void> logout(WebFilterExchange exchange,
                                                          Authentication authentication)

Description copied from interface: ServerLogoutHandler

Invoked when log out is requested

Specified by:

logout in interface ServerLogoutHandler

Parameters:

exchange - the exchange

authentication - the Authentication

Returns:

a completion notification (success or error)