io.micronaut.security.endpoints

Class LogoutController

java.lang.Object

io.micronaut.security.endpoints.LogoutController

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

Since:

1.0

Author:

Sergio del Amo

Constructor Summary

Constructors

Constructor and Description
LogoutController(LogoutHandler logoutHandler, io.micronaut.context.event.ApplicationEventPublisher eventPublisher, LogoutControllerConfiguration logoutControllerConfiguration)

Method Summary

Modifier and Type	Method and Description
protected io.micronaut.http.MutableHttpResponse<?>	handleLogout(io.micronaut.http.HttpRequest<?> request, Authentication authentication)
io.micronaut.http.MutableHttpResponse<?>	index(io.micronaut.http.HttpRequest<?> request, Authentication authentication) POST endpoint for Logout Controller.
io.micronaut.http.MutableHttpResponse<?>	indexGet(io.micronaut.http.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(LogoutHandler logoutHandler,
                                io.micronaut.context.event.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

Method Detail

index

@Consumes(value={"application/x-www-form-urlencoded","application/json"})
 @Post
public io.micronaut.http.MutableHttpResponse<?> index(io.micronaut.http.HttpRequest<?> request,
                                                                                                                                       @Nullable
                                                                                                                                       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 io.micronaut.http.MutableHttpResponse<?> indexGet(io.micronaut.http.HttpRequest<?> request,
                                                              @Nullable
                                                              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 io.micronaut.http.MutableHttpResponse<?> handleLogout(io.micronaut.http.HttpRequest<?> request,
                                                                @Nullable
                                                                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