io.micronaut.security.endpoints

Class LogoutController

java.lang.Object

io.micronaut.security.endpoints.LogoutController

@Requires(property="micronaut.security.endpoints.logout.enabled",
          value="true")
 @Controller(value="${micronaut.security.endpoints.logout.path:/logout}")
 @Secured(value="isAnonymous()")
public class LogoutController
extends Object

Since:

1.0

Author:

Sergio del Amo

Field Summary

Fields

Modifier and Type	Field and Description
protected ApplicationEventPublisher	eventPublisher
protected LogoutHandler	logoutHandler

Constructor Summary

Constructors

Constructor and Description
LogoutController(LogoutHandler logoutHandler, ApplicationEventPublisher eventPublisher)

Method Summary

Modifier and Type	Method and Description
HttpResponse	index(HttpRequest<?> request, Authentication authentication)

Methods inherited from class java.lang.Object

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

Field Detail

logoutHandler

protected final LogoutHandler logoutHandler

eventPublisher

protected final ApplicationEventPublisher eventPublisher

Constructor Detail

LogoutController

public LogoutController(@Nullable
                        LogoutHandler logoutHandler,
                        ApplicationEventPublisher eventPublisher)

Parameters:

logoutHandler - A collaborator which helps to build HTTP response if user logout.

eventPublisher - The application event publisher

Method Detail

index

@Consumes(value={"application/x-www-form-urlencoded","application/json"})
 @Post
public HttpResponse index(HttpRequest<?> request,
                                                                                                           Authentication authentication)

Parameters:

request - The HttpRequest being executed

authentication - Authentication instance for current user

Returns:

An AccessRefreshToken encapsulated in the HttpResponse or a failure indicated by the HTTP status