Package io.micronaut.security.token.cookie

Class TokenCookieLoginHandler

java.lang.Object

io.micronaut.security.token.cookie.CookieLoginHandler

io.micronaut.security.token.cookie.TokenCookieLoginHandler

All Implemented Interfaces:

LoginHandler<io.micronaut.http.HttpRequest<?>,io.micronaut.http.MutableHttpResponse<?>>, RedirectingLoginHandler<io.micronaut.http.HttpRequest<?>,io.micronaut.http.MutableHttpResponse<?>>

@Requires(classes=io.micronaut.http.HttpRequest.class) @Requires(property="micronaut.security.authentication",value="cookie")
@Singleton
public class TokenCookieLoginHandler
extends CookieLoginHandler

Since:

1.0

Author:

Sergio del Amo

Field Summary

Fields

Modifier and Type	Field	Description
protected final AccessRefreshTokenGenerator	accessRefreshTokenGenerator
protected final AccessTokenConfiguration	accessTokenConfiguration
protected final List<LoginCookieProvider<io.micronaut.http.HttpRequest<?>>>	loginCookieProviders
protected final RefreshTokenCookieConfiguration	refreshTokenCookieConfiguration

Fields inherited from class io.micronaut.security.token.cookie.CookieLoginHandler

accessTokenCookieConfiguration, loginFailure, loginSuccess, priorToLoginPersistence, refresh

Constructor Summary

Constructors

Constructor	Description
TokenCookieLoginHandler(RedirectService redirectService, RedirectConfiguration redirectConfiguration, AccessTokenCookieConfiguration accessTokenCookieConfiguration, RefreshTokenCookieConfiguration refreshTokenCookieConfiguration, AccessTokenConfiguration accessTokenConfiguration, AccessRefreshTokenGenerator accessRefreshTokenGenerator, @Nullable PriorToLoginPersistence<io.micronaut.http.HttpRequest<?>,io.micronaut.http.MutableHttpResponse<?>> priorToLoginPersistence)	Deprecated, for removal: This API element is subject to removal in a future version. Use TokenCookieLoginHandler(RedirectService, RedirectConfiguration, AccessTokenCookieConfiguration, RefreshTokenCookieConfiguration, AccessTokenConfiguration, AccessRefreshTokenGenerator, PriorToLoginPersistence, List) instead.
TokenCookieLoginHandler(RedirectService redirectService, RedirectConfiguration redirectConfiguration, AccessTokenCookieConfiguration accessTokenCookieConfiguration, RefreshTokenCookieConfiguration refreshTokenCookieConfiguration, AccessTokenConfiguration accessTokenConfiguration, AccessRefreshTokenGenerator accessRefreshTokenGenerator, @Nullable PriorToLoginPersistence<io.micronaut.http.HttpRequest<?>,io.micronaut.http.MutableHttpResponse<?>> priorToLoginPersistence, List<LoginCookieProvider<io.micronaut.http.HttpRequest<?>>> loginCookieProviders)

Method Summary

Modifier and Type	Method	Description
protected @NonNull io.micronaut.http.cookie.Cookie	accessTokenCookie(@NonNull AccessRefreshToken accessRefreshToken, @NonNull io.micronaut.http.HttpRequest<?> request)	Instantiates an Access Token Cookie.
List<io.micronaut.http.cookie.Cookie>	getCookies(Authentication authentication, io.micronaut.http.HttpRequest<?> request)	Return the cookies for the given parameters.
List<io.micronaut.http.cookie.Cookie>	getCookies(Authentication authentication, String refreshToken, io.micronaut.http.HttpRequest<?> request)	Return the cookies for the given parameters.
protected List<io.micronaut.http.cookie.Cookie>	getCookies(AccessRefreshToken accessRefreshToken, io.micronaut.http.HttpRequest<?> request)	Return the cookies for the given parameters.
protected @NonNull Optional<io.micronaut.http.cookie.Cookie>	refreshTokenCookie(@NonNull AccessRefreshToken accessRefreshToken, @NonNull io.micronaut.http.HttpRequest<?> request)	Instantiates a Refresh Token Cookie.

Methods inherited from class io.micronaut.security.token.cookie.CookieLoginHandler

applyCookies, createRefreshResponse, createSuccessResponse, loginFailed, loginRefresh, loginSuccess

Methods inherited from class java.lang.Object

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

Field Details

accessRefreshTokenGenerator

protected final AccessRefreshTokenGenerator accessRefreshTokenGenerator

refreshTokenCookieConfiguration

protected final RefreshTokenCookieConfiguration refreshTokenCookieConfiguration

accessTokenConfiguration

protected final AccessTokenConfiguration accessTokenConfiguration

loginCookieProviders

protected final List<LoginCookieProvider<io.micronaut.http.HttpRequest<?>>> loginCookieProviders

Constructor Details

TokenCookieLoginHandler

@Inject
public TokenCookieLoginHandler(RedirectService redirectService,
 RedirectConfiguration redirectConfiguration,
 AccessTokenCookieConfiguration accessTokenCookieConfiguration,
 RefreshTokenCookieConfiguration refreshTokenCookieConfiguration,
 AccessTokenConfiguration accessTokenConfiguration,
 AccessRefreshTokenGenerator accessRefreshTokenGenerator,
 @Nullable
 @Nullable PriorToLoginPersistence<io.micronaut.http.HttpRequest<?>,io.micronaut.http.MutableHttpResponse<?>> priorToLoginPersistence,
 List<LoginCookieProvider<io.micronaut.http.HttpRequest<?>>> loginCookieProviders)

Parameters:

redirectService - Redirection Service

redirectConfiguration - Redirect configuration

accessTokenCookieConfiguration - JWT Access Token Cookie Configuration

refreshTokenCookieConfiguration - Refresh Token Cookie Configuration

accessTokenConfiguration - JWT Generator Configuration

accessRefreshTokenGenerator - Access Refresh Token Generator

priorToLoginPersistence - Prior To Login Persistence Mechanism

loginCookieProviders - Login Cookie Providers

TokenCookieLoginHandler

@Deprecated(forRemoval=true,
            since="4.11.0")
public TokenCookieLoginHandler(RedirectService redirectService,
 RedirectConfiguration redirectConfiguration,
 AccessTokenCookieConfiguration accessTokenCookieConfiguration,
 RefreshTokenCookieConfiguration refreshTokenCookieConfiguration,
 AccessTokenConfiguration accessTokenConfiguration,
 AccessRefreshTokenGenerator accessRefreshTokenGenerator,
 @Nullable
 @Nullable PriorToLoginPersistence<io.micronaut.http.HttpRequest<?>,io.micronaut.http.MutableHttpResponse<?>> priorToLoginPersistence)

Deprecated, for removal: This API element is subject to removal in a future version.

Use TokenCookieLoginHandler(RedirectService, RedirectConfiguration, AccessTokenCookieConfiguration, RefreshTokenCookieConfiguration, AccessTokenConfiguration, AccessRefreshTokenGenerator, PriorToLoginPersistence, List) instead.

Parameters:

redirectService - Redirection Service

redirectConfiguration - Redirect configuration

accessTokenCookieConfiguration - JWT Access Token Cookie Configuration

refreshTokenCookieConfiguration - Refresh Token Cookie Configuration

accessTokenConfiguration - JWT Generator Configuration

accessRefreshTokenGenerator - Access Refresh Token Generator

priorToLoginPersistence - Prior To Login Persistence Mechanism

Method Details

getCookies

public List<io.micronaut.http.cookie.Cookie> getCookies(Authentication authentication,
 io.micronaut.http.HttpRequest<?> request)

Description copied from class: CookieLoginHandler

Return the cookies for the given parameters. This method will generate new cookies based on the current configuration.

Specified by:

getCookies in class CookieLoginHandler

Parameters:

authentication - The Authenticated user's representation

request - The current request

Returns:

A list of cookies

getCookies

public List<io.micronaut.http.cookie.Cookie> getCookies(Authentication authentication,
 String refreshToken,
 io.micronaut.http.HttpRequest<?> request)

Description copied from class: CookieLoginHandler

Return the cookies for the given parameters. This method will generate new cookies based on the current configuration.

Specified by:

getCookies in class CookieLoginHandler

Parameters:

authentication - The Authenticated user's representation

refreshToken - The access refresh token

request - The current request

Returns:

A list of cookies

getCookies

protected List<io.micronaut.http.cookie.Cookie> getCookies(AccessRefreshToken accessRefreshToken,
 io.micronaut.http.HttpRequest<?> request)

Return the cookies for the given parameters.

Parameters:

accessRefreshToken - The access refresh token

request - The current request

Returns:

A list of cookies

accessTokenCookie

@NonNull
protected @NonNull io.micronaut.http.cookie.Cookie accessTokenCookie(@NonNull
 @NonNull AccessRefreshToken accessRefreshToken,
 @NonNull
 @NonNull io.micronaut.http.HttpRequest<?> request)

Instantiates an Access Token Cookie.

Parameters:

accessRefreshToken - The access refresh token

request - The current request

Returns:

Access Token Cookie

refreshTokenCookie

@NonNull
protected @NonNull Optional<io.micronaut.http.cookie.Cookie> refreshTokenCookie(@NonNull
 @NonNull AccessRefreshToken accessRefreshToken,
 @NonNull
 @NonNull io.micronaut.http.HttpRequest<?> request)

Instantiates a Refresh Token Cookie.

Parameters:

accessRefreshToken - The access refresh token

request - The current request

Returns:

Refresh Token Cookie