Package io.micronaut.security.token.jwt.cookie

Class CookieLoginHandler

java.lang.Object

io.micronaut.security.token.jwt.cookie.CookieLoginHandler

All Implemented Interfaces:

io.micronaut.security.handlers.LoginHandler, io.micronaut.security.handlers.RedirectingLoginHandler

Direct Known Subclasses:

JwtCookieLoginHandler

public abstract class CookieLoginHandler
extends java.lang.Object
implements io.micronaut.security.handlers.RedirectingLoginHandler

Abstract class which defines an implementation of RedirectingLoginHandler where a redirect response is issued. For a successful login a cookie is added to the response with a token.

Since:

2.0.0

Field Summary

Fields

Modifier and Type	Field	Description
protected AccessTokenCookieConfiguration	accessTokenCookieConfiguration
protected java.lang.String	loginFailure
protected java.lang.String	loginSuccess
protected io.micronaut.security.errors.PriorToLoginPersistence	priorToLoginPersistence
protected java.lang.String	refresh

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CookieLoginHandler(AccessTokenCookieConfiguration accessTokenCookieConfiguration, io.micronaut.security.config.RedirectConfiguration redirectConfiguration, io.micronaut.security.config.RedirectService redirectService, io.micronaut.security.errors.PriorToLoginPersistence priorToLoginPersistence)
	CookieLoginHandler(AccessTokenCookieConfiguration accessTokenCookieConfiguration, io.micronaut.security.config.RedirectConfiguration redirectConfiguration, io.micronaut.security.errors.PriorToLoginPersistence priorToLoginPersistence)	Deprecated. Use CookieLoginHandler(io.micronaut.security.token.jwt.cookie.AccessTokenCookieConfiguration,io.micronaut.security.config.RedirectConfiguration,io.micronaut.security.config.RedirectService,io.micronaut.security.errors.PriorToLoginPersistence) instead.

Method Summary

Modifier and Type	Method	Description
protected io.micronaut.http.MutableHttpResponse<?>	applyCookies(io.micronaut.http.MutableHttpResponse<?> response, java.util.List<io.micronaut.http.cookie.Cookie> cookies)
protected io.micronaut.http.MutableHttpResponse<?>	createRefreshResponse(io.micronaut.http.HttpRequest<?> request)
protected io.micronaut.http.MutableHttpResponse<?>	createSuccessResponse(io.micronaut.http.HttpRequest<?> request)
abstract java.util.List<io.micronaut.http.cookie.Cookie>	getCookies(io.micronaut.security.authentication.Authentication authentication, io.micronaut.http.HttpRequest<?> request)	Return the cookies for the given parameters.
abstract java.util.List<io.micronaut.http.cookie.Cookie>	getCookies(io.micronaut.security.authentication.Authentication authentication, java.lang.String refreshToken, io.micronaut.http.HttpRequest<?> request)	Return the cookies for the given parameters.
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, java.lang.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 Detail

accessTokenCookieConfiguration

protected final AccessTokenCookieConfiguration accessTokenCookieConfiguration

priorToLoginPersistence

protected final io.micronaut.security.errors.PriorToLoginPersistence priorToLoginPersistence

loginFailure

@Nullable
protected final java.lang.String loginFailure

loginSuccess

@Nullable
protected final java.lang.String loginSuccess

refresh

@Nullable
protected final java.lang.String refresh

Constructor Detail

CookieLoginHandler

@Deprecated
public CookieLoginHandler(AccessTokenCookieConfiguration accessTokenCookieConfiguration,
                          io.micronaut.security.config.RedirectConfiguration redirectConfiguration,
                          @Nullable
                          io.micronaut.security.errors.PriorToLoginPersistence priorToLoginPersistence)

Deprecated.

Use CookieLoginHandler(io.micronaut.security.token.jwt.cookie.AccessTokenCookieConfiguration,io.micronaut.security.config.RedirectConfiguration,io.micronaut.security.config.RedirectService,io.micronaut.security.errors.PriorToLoginPersistence) instead.

Parameters:

accessTokenCookieConfiguration - Access token cookie configuration

redirectConfiguration - Redirect configuration

priorToLoginPersistence - The prior to login persistence strategy

CookieLoginHandler

protected CookieLoginHandler(AccessTokenCookieConfiguration accessTokenCookieConfiguration,
                             io.micronaut.security.config.RedirectConfiguration redirectConfiguration,
                             io.micronaut.security.config.RedirectService redirectService,
                             @Nullable
                             io.micronaut.security.errors.PriorToLoginPersistence priorToLoginPersistence)

Parameters:

accessTokenCookieConfiguration - Access token cookie configuration

redirectConfiguration - Redirect configuration

redirectService - Redirect service

priorToLoginPersistence - The prior to login persistence strategy

Method Detail

getCookies

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

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

Parameters:

authentication - The Authenticated user's representation

request - The current request

Returns:

A list of cookies

getCookies

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

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

Parameters:

authentication - The Authenticated user's representation

refreshToken - The access refresh token

request - The current request

Returns:

A list of cookies

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

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

Parameters:

authenticationFailed - Object encapsulates the Login failure

request - The HttpRequest being executed

Returns:

A 303 HTTP Response or 200 HTTP Response if loginFailure is null, for example if RedirectConfiguration is disabled.

loginRefresh

public io.micronaut.http.MutableHttpResponse<?> loginRefresh(io.micronaut.security.authentication.Authentication authentication,
                                                             java.lang.String refreshToken,
                                                             io.micronaut.http.HttpRequest<?> request)

Specified by:

loginRefresh in interface io.micronaut.security.handlers.LoginHandler

createSuccessResponse

protected io.micronaut.http.MutableHttpResponse<?> createSuccessResponse(io.micronaut.http.HttpRequest<?> request)

Parameters:

request - The request

Returns:

A 303 HTTP Response or 200 HTTP Response if loginSuccess is null, for example if RedirectConfiguration is disabled.

createRefreshResponse

protected io.micronaut.http.MutableHttpResponse<?> createRefreshResponse(io.micronaut.http.HttpRequest<?> request)

Parameters:

request - The request

Returns:

A 303 HTTP Response or 200 HTTP Response if refresh is null.

applyCookies

protected io.micronaut.http.MutableHttpResponse<?> applyCookies(io.micronaut.http.MutableHttpResponse<?> response,
                                                                java.util.List<io.micronaut.http.cookie.Cookie> cookies)

Parameters:

response - The response

cookies - Cookies to be added to the response

Returns:

A 303 HTTP Response with cookies