io.micronaut.security.token.jwt.cookie

Class CookieLoginHandler

java.lang.Object

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

All Implemented Interfaces:

LoginHandler, RedirectingLoginHandler

Direct Known Subclasses:

IdTokenLoginHandler, JwtCookieLoginHandler

public abstract class CookieLoginHandler
extends java.lang.Object
implements 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

Author:

Sergio del Amo

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
CookieLoginHandler(AccessTokenCookieConfiguration accessTokenCookieConfiguration, RedirectConfiguration redirectConfiguration, PriorToLoginPersistence priorToLoginPersistence)

Method Summary

Modifier and Type	Method and 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(Authentication authentication, io.micronaut.http.HttpRequest<?> request) Return the cookies for the given parameters.
abstract java.util.List<io.micronaut.http.cookie.Cookie>	getCookies(Authentication authentication, java.lang.String refreshToken, io.micronaut.http.HttpRequest<?> request) Return the cookies for the given parameters.
io.micronaut.http.MutableHttpResponse<?>	loginFailed(AuthenticationResponse authenticationFailed, io.micronaut.http.HttpRequest<?> request)
io.micronaut.http.MutableHttpResponse<?>	loginRefresh(Authentication authentication, java.lang.String refreshToken, io.micronaut.http.HttpRequest<?> request)
io.micronaut.http.MutableHttpResponse<?>	loginSuccess(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 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

public CookieLoginHandler(AccessTokenCookieConfiguration accessTokenCookieConfiguration,
                          RedirectConfiguration redirectConfiguration,
                          @Nullable
                          PriorToLoginPersistence priorToLoginPersistence)

Parameters:

accessTokenCookieConfiguration - Access token cookie configuration

redirectConfiguration - Redirect configuration

priorToLoginPersistence - The prior to login persistence strategy

Method Detail

getCookies

public abstract java.util.List<io.micronaut.http.cookie.Cookie> getCookies(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(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(Authentication authentication,
                                                             io.micronaut.http.HttpRequest<?> request)

Specified by:

loginSuccess in interface LoginHandler

Parameters:

authentication - Authenticated user's representation.

request - The HttpRequest being executed

Returns:

An HTTP Response. Eg. a redirect or an JWT token rendered to the response

loginFailed

public io.micronaut.http.MutableHttpResponse<?> loginFailed(AuthenticationResponse authenticationFailed,
                                                            io.micronaut.http.HttpRequest<?> request)

Specified by:

loginFailed in interface 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(Authentication authentication,
                                                             java.lang.String refreshToken,
                                                             io.micronaut.http.HttpRequest<?> request)

Specified by:

loginRefresh in interface LoginHandler

Parameters:

authentication - Authenticated user's representation.

refreshToken - The refresh token

request - The HttpRequest being executed

Returns:

An HTTP Response. Eg. a redirect or an JWT token rendered to the response

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