Package 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(classes=io.micronaut.http.annotation.Controller.class) @Requires(beans=LogoutHandler.class) @Controller("${micronaut.security.endpoints.logout.path:/logout}") @Secured("isAnonymous()") public class LogoutController extends Object
Since:
1.0
Author:
Sergio del Amo

  • Constructor Summary

    Constructors
    Constructor
    Description
    LogoutController(LogoutHandler<io.micronaut.http.HttpRequest<?>,io.micronaut.http.MutableHttpResponse<?>> logoutHandler, io.micronaut.context.event.ApplicationEventPublisher<LogoutEvent> logoutEventPublisher, LogoutControllerConfiguration logoutControllerConfiguration)
     

  • Method Summary

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

    • LogoutController

      public LogoutController(LogoutHandler<io.micronaut.http.HttpRequest<?>,io.micronaut.http.MutableHttpResponse<?>> logoutHandler, io.micronaut.context.event.ApplicationEventPublisher<LogoutEvent> logoutEventPublisher, LogoutControllerConfiguration logoutControllerConfiguration)
      Parameters:
      logoutHandler - A collaborator which helps to build HTTP response if user logout.
      logoutEventPublisher - The application event publisher
      logoutControllerConfiguration - Configuration for the Logout controller

  • Method Details

    • index

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