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 JwtCookieConfiguration	jwtCookieConfiguration Deprecated.
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)
CookieLoginHandler(JwtCookieConfiguration jwtCookieConfiguration, RedirectConfiguration redirectConfiguration, PriorToLoginPersistence priorToLoginPersistence) Deprecated. Use CookieLoginHandler(AccessTokenCookieConfiguration, RedirectConfiguration, PriorToLoginPersistence) instead.
CookieLoginHandler(JwtCookieConfiguration jwtCookieConfiguration, java.lang.String loginSuccess, java.lang.String loginFailure) Deprecated. Use CookieLoginHandler(AccessTokenCookieConfiguration, RedirectConfiguration, PriorToLoginPersistence) instead.

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)
protected abstract java.util.List<io.micronaut.http.cookie.Cookie>	getCookies(UserDetails userDetails, io.micronaut.http.HttpRequest<?> request)
protected abstract java.util.List<io.micronaut.http.cookie.Cookie>	getCookies(UserDetails userDetails, java.lang.String refreshToken, io.micronaut.http.HttpRequest<?> request)
io.micronaut.http.MutableHttpResponse<?>	loginFailed(AuthenticationResponse authenticationFailed, io.micronaut.http.HttpRequest<?> request)
io.micronaut.http.MutableHttpResponse<?>	loginRefresh(UserDetails userDetails, java.lang.String refreshToken, io.micronaut.http.HttpRequest<?> request)
io.micronaut.http.MutableHttpResponse<?>	loginSuccess(UserDetails userDetails, 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

jwtCookieConfiguration

@Deprecated
protected final JwtCookieConfiguration jwtCookieConfiguration

Deprecated.

accessTokenCookieConfiguration

protected final AccessTokenCookieConfiguration accessTokenCookieConfiguration

priorToLoginPersistence

protected final PriorToLoginPersistence priorToLoginPersistence

loginFailure

protected final java.lang.String loginFailure

loginSuccess

protected final java.lang.String loginSuccess

refresh

protected final java.lang.String refresh

Constructor Detail

CookieLoginHandler

@Inject
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

CookieLoginHandler

@Deprecated
public CookieLoginHandler(JwtCookieConfiguration jwtCookieConfiguration,
                                      RedirectConfiguration redirectConfiguration,
                                      @Nullable
                                      PriorToLoginPersistence priorToLoginPersistence)

Deprecated. Use CookieLoginHandler(AccessTokenCookieConfiguration, RedirectConfiguration, PriorToLoginPersistence) instead.

Parameters:

redirectConfiguration - Redirect configuration

jwtCookieConfiguration - JWT Cookie Configuration

priorToLoginPersistence - The prior to login persistence strategy

CookieLoginHandler

@Deprecated
public CookieLoginHandler(JwtCookieConfiguration jwtCookieConfiguration,
                                      java.lang.String loginSuccess,
                                      java.lang.String loginFailure)

Deprecated. Use CookieLoginHandler(AccessTokenCookieConfiguration, RedirectConfiguration, PriorToLoginPersistence) instead.

Parameters:

jwtCookieConfiguration - JWT Cookie Configuration

loginSuccess - Url to redirect to after a successful Login

loginFailure - Url to redirect to after an unsuccessful login

Method Detail

getCookies

protected abstract java.util.List<io.micronaut.http.cookie.Cookie> getCookies(UserDetails userDetails,
                                                                              io.micronaut.http.HttpRequest<?> request)

getCookies

protected abstract java.util.List<io.micronaut.http.cookie.Cookie> getCookies(UserDetails userDetails,
                                                                              java.lang.String refreshToken,
                                                                              io.micronaut.http.HttpRequest<?> request)

loginSuccess

public io.micronaut.http.MutableHttpResponse<?> loginSuccess(UserDetails userDetails,
                                                             io.micronaut.http.HttpRequest<?> request)

Specified by:

loginSuccess in interface LoginHandler

Parameters:

userDetails - 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:

An HTTP Response. Eg. a redirect or 401 response

loginRefresh

public io.micronaut.http.MutableHttpResponse<?> loginRefresh(UserDetails userDetails,
                                                             java.lang.String refreshToken,
                                                             io.micronaut.http.HttpRequest<?> request)

Specified by:

loginRefresh in interface LoginHandler

Parameters:

userDetails - 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

createRefreshResponse

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

Parameters:

request - The request

Returns:

A 303 HTTP Response

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