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

Constructor Summary

Constructors

Constructor and Description
LogoutController(LogoutHandler logoutHandler, ApplicationEventPublisher eventPublisher) Deprecated.
LogoutController(LogoutHandler logoutHandler, ApplicationEventPublisher eventPublisher, LogoutControllerConfiguration logoutControllerConfiguration)

Method Summary

Modifier and Type	Method and Description
protected HttpResponse	handleLogout(HttpRequest<?> request, Authentication authentication)
HttpResponse	index(HttpRequest<?> request, Authentication authentication) POST endpoint for Logout Controller.
HttpResponse	indexGet(HttpRequest<?> request, Authentication authentication) GET endpoint for Logout Controller.

Methods inherited from class java.lang.Object

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

Constructor Detail

LogoutController

@Inject
public LogoutController(@Nullable
                                LogoutHandler logoutHandler,
                                ApplicationEventPublisher eventPublisher,
                                LogoutControllerConfiguration logoutControllerConfiguration)

Parameters:

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

eventPublisher - The application event publisher

logoutControllerConfiguration - Configuration for the Logout controller

LogoutController

@Deprecated
public LogoutController(@Nullable
                                    LogoutHandler logoutHandler,
                                    ApplicationEventPublisher eventPublisher)

Deprecated.

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)

POST endpoint for Logout Controller.

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

indexGet

@Get
public HttpResponse indexGet(HttpRequest<?> request,
                                  Authentication authentication)

GET endpoint for Logout Controller.

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

handleLogout

protected HttpResponse handleLogout(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