Package io.micronaut.security.session

Class SessionLoginHandler

java.lang.Object
io.micronaut.security.session.SessionLoginHandler
All Implemented Interfaces:
io.micronaut.security.handlers.LoginHandler<io.micronaut.http.HttpRequest<?>,io.micronaut.http.MutableHttpResponse<?>>, io.micronaut.security.handlers.RedirectingLoginHandler<io.micronaut.http.HttpRequest<?>,io.micronaut.http.MutableHttpResponse<?>>
@Requires(condition=SessionAuthenticationModeCondition.class) @Singleton public class SessionLoginHandler extends Object implements io.micronaut.security.handlers.RedirectingLoginHandler<io.micronaut.http.HttpRequest<?>,io.micronaut.http.MutableHttpResponse<?>>
A RedirectingLoginHandler implementation for session based authentication.
Since:
1.0

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected final @Nullable String
    loginFailure
     
    protected final @Nullable String
    loginSuccess
     
    protected final io.micronaut.security.config.RedirectConfiguration
    redirectConfiguration
     
    protected final io.micronaut.session.SessionStore<io.micronaut.session.Session>
    sessionStore
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    SessionLoginHandler(io.micronaut.security.config.RedirectConfiguration redirectConfiguration, io.micronaut.session.SessionStore<io.micronaut.session.Session> sessionStore, @Nullable io.micronaut.security.errors.PriorToLoginPersistence<io.micronaut.http.HttpRequest<?>,io.micronaut.http.MutableHttpResponse<?>> priorToLoginPersistence, io.micronaut.security.config.RedirectService redirectService)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Use SessionLoginHandler(RedirectConfiguration, SessionStore, PriorToLoginPersistence, RedirectService, List) instead.
    SessionLoginHandler(io.micronaut.security.config.RedirectConfiguration redirectConfiguration, io.micronaut.session.SessionStore<io.micronaut.session.Session> sessionStore, @Nullable io.micronaut.security.errors.PriorToLoginPersistence<io.micronaut.http.HttpRequest<?>,io.micronaut.http.MutableHttpResponse<?>> priorToLoginPersistence, io.micronaut.security.config.RedirectService redirectService, List<SessionPopulator<io.micronaut.http.HttpRequest<?>>> sessionPopulators)
    Constructor.

  • Method Summary

    Modifier and Type
    Method
    Description
    io.micronaut.http.MutableHttpResponse<?>
    loginFailed(io.micronaut.security.authentication.AuthenticationResponse authenticationFailed, io.micronaut.http.HttpRequest<?> request)
     
    io.micronaut.http.MutableHttpResponse<?>
    loginRefresh(io.micronaut.security.authentication.Authentication authentication, String refreshToken, io.micronaut.http.HttpRequest<?> request)
     
    io.micronaut.http.MutableHttpResponse<?>
    loginSuccess(io.micronaut.security.authentication.Authentication authentication, io.micronaut.http.HttpRequest<?> request)
     

    Methods inherited from class java.lang.Object

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

  • Field Details

    • loginSuccess

      @Nullable protected final @Nullable String loginSuccess

    • loginFailure

      @Nullable protected final @Nullable String loginFailure

    • redirectConfiguration

      protected final io.micronaut.security.config.RedirectConfiguration redirectConfiguration

    • sessionStore

      protected final io.micronaut.session.SessionStore<io.micronaut.session.Session> sessionStore

  • Constructor Details

    • SessionLoginHandler

      @Inject public SessionLoginHandler(io.micronaut.security.config.RedirectConfiguration redirectConfiguration, io.micronaut.session.SessionStore<io.micronaut.session.Session> sessionStore, @Nullable @Nullable io.micronaut.security.errors.PriorToLoginPersistence<io.micronaut.http.HttpRequest<?>,io.micronaut.http.MutableHttpResponse<?>> priorToLoginPersistence, io.micronaut.security.config.RedirectService redirectService, List<SessionPopulator<io.micronaut.http.HttpRequest<?>>> sessionPopulators)
      Constructor.
      Parameters:
      redirectConfiguration - Redirect configuration
      sessionStore - The session store
      priorToLoginPersistence - The persistence to store the original url
      redirectService - Redirection Service
      sessionPopulators - Session Populators

    • SessionLoginHandler

      @Deprecated(forRemoval=true, since="4.11.0") public SessionLoginHandler(io.micronaut.security.config.RedirectConfiguration redirectConfiguration, io.micronaut.session.SessionStore<io.micronaut.session.Session> sessionStore, @Nullable @Nullable io.micronaut.security.errors.PriorToLoginPersistence<io.micronaut.http.HttpRequest<?>,io.micronaut.http.MutableHttpResponse<?>> priorToLoginPersistence, io.micronaut.security.config.RedirectService redirectService)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Use SessionLoginHandler(RedirectConfiguration, SessionStore, PriorToLoginPersistence, RedirectService, List) instead.
      Constructor.
      Parameters:
      redirectConfiguration - Redirect configuration
      sessionStore - The session store
      priorToLoginPersistence - The persistence to store the original url
      redirectService - Redirection Service

  • Method Details

    • loginSuccess

      public io.micronaut.http.MutableHttpResponse<?> loginSuccess(io.micronaut.security.authentication.Authentication authentication, io.micronaut.http.HttpRequest<?> request)
      Specified by:
      loginSuccess in interface io.micronaut.security.handlers.LoginHandler<io.micronaut.http.HttpRequest<?>,io.micronaut.http.MutableHttpResponse<?>>

    • loginRefresh

      public io.micronaut.http.MutableHttpResponse<?> loginRefresh(io.micronaut.security.authentication.Authentication authentication, String refreshToken, io.micronaut.http.HttpRequest<?> request)
      Specified by:
      loginRefresh in interface io.micronaut.security.handlers.LoginHandler<io.micronaut.http.HttpRequest<?>,io.micronaut.http.MutableHttpResponse<?>>

    • loginFailed

      public io.micronaut.http.MutableHttpResponse<?> loginFailed(io.micronaut.security.authentication.AuthenticationResponse authenticationFailed, io.micronaut.http.HttpRequest<?> request)
      Specified by:
      loginFailed in interface io.micronaut.security.handlers.LoginHandler<io.micronaut.http.HttpRequest<?>,io.micronaut.http.MutableHttpResponse<?>>