RedirectConfiguration (security-parent 4.9.0 API)

All Superinterfaces:: io.micronaut.core.util.Toggleable

All Known Implementing Classes:: RedirectConfigurationProperties

public interface RedirectConfiguration extends io.micronaut.core.util.Toggleable

Since:: 2.0.0
Author:: Sergio del Amo

Method Summary

Modifier and Type

Method

Description

@NonNull ForbiddenRedirectConfiguration

getForbidden()

@NonNull String

getLoginFailure()

@NonNull String

getLoginSuccess()

@NonNull String

getLogout()

@NonNull RefreshRedirectConfiguration

getRefresh()

@NonNull UnauthorizedRedirectConfiguration

getUnauthorized()

boolean

isPriorToLogin()

Methods inherited from interface io.micronaut.core.util.Toggleable
isEnabled

Method Details
- getLoginSuccess
  
  @NonNull @NonNull String getLoginSuccess()
  
  Returns:
  
  String to be parsed into a URI which represents where the user is redirected to after a successful login.
- getLoginFailure
  
  @NonNull @NonNull String getLoginFailure()
  
  Returns:
  
  String to be parsed into a URI which represents where the user is redirected to after a failed login.
- getLogout
  
  @NonNull @NonNull String getLogout()
  
  Returns:
  
  String to be parsed into a URI which represents where the user is redirected to after logout.
- getUnauthorized
  
  @NonNull @NonNull UnauthorizedRedirectConfiguration getUnauthorized()
  
  Returns:
  
  configuration about where the user is redirected to after trying to access a secured route.
- getForbidden
  
  @NonNull @NonNull ForbiddenRedirectConfiguration getForbidden()
  
  Returns:
  
  configuration about where the user is redirected to after trying to access a secured route for which the does not have sufficient roles.
- getRefresh
  
  @NonNull @NonNull RefreshRedirectConfiguration getRefresh()
  
  Returns:
  
  configuration about where the user is redirected to after executing the refresh token endpoint.
- isPriorToLogin
  
  boolean isPriorToLogin()
  
  Returns:
  
  If the user attempted to access a URL while unauthenticated, and was subsequently redirected to login, redirect back to that URL post login (true). Use the static login success URL (false).