Package org.craftercms.security.authentication.impl

Class RememberMeManagerImpl

java.lang.Object

org.craftercms.security.authentication.impl.RememberMeManagerImpl

All Implemented Interfaces:

RememberMeManager

public class RememberMeManagerImpl
extends Object
implements RememberMeManager

Default implementation of RememberMeManager.

Author:

avasquez

Field Summary

Fields

Modifier and Type	Field	Description
protected AuthenticationManager	authenticationManager
protected AuthenticationService	authenticationService
protected org.craftercms.commons.crypto.TextEncryptor	encryptor
protected ProfileService	profileService
static final String	REMEMBER_ME_COOKIE_NAME
protected org.craftercms.commons.http.CookieManager	rememberMeCookieManager
static final char	SERIALIZED_LOGIN_SEPARATOR

Constructor Summary

Constructors

Constructor	Description
RememberMeManagerImpl(AuthenticationService authenticationService, AuthenticationManager authenticationManager, ProfileService profileService, org.craftercms.commons.crypto.TextEncryptor encryptor, org.craftercms.commons.http.CookieManager rememberMeCookieManager)

Method Summary

Modifier and Type	Method	Description
protected void	addRememberMeCookie(String cookieValue, jakarta.servlet.http.HttpServletResponse response)
protected Authentication	authenticate(String profileId)
Authentication	autoLogin(org.craftercms.commons.http.RequestContext context)	Attempts auto login if a remember me cookie is present in the current request
protected void	deleteRememberMeCookie(jakarta.servlet.http.HttpServletResponse response)
protected PersistentLogin	deserializeLogin(String serializedLogin)
protected void	disableRememberMe(String loginId, org.craftercms.commons.http.RequestContext context)
void	disableRememberMe(org.craftercms.commons.http.RequestContext context)	Disabled remember me for the current authenticated profile, generally by removing remember me cookie.
void	enableRememberMe(Authentication authentication, org.craftercms.commons.http.RequestContext context)	Enables remember me for the current authenticated profile, generally by adding a remember me cookie.
protected PersistentLogin	getPersistentLoginFromCookie(jakarta.servlet.http.HttpServletRequest request)
protected String	getRememberMeCookie(jakarta.servlet.http.HttpServletRequest request)
protected String	serializeLogin(PersistentLogin login)
protected void	updateRememberMe(String loginId, org.craftercms.commons.http.RequestContext context)

Methods inherited from class java.lang.Object

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

Field Details

REMEMBER_ME_COOKIE_NAME

public static final String REMEMBER_ME_COOKIE_NAME

See Also:

• Constant Field Values

SERIALIZED_LOGIN_SEPARATOR

public static final char SERIALIZED_LOGIN_SEPARATOR

See Also:

• Constant Field Values

authenticationService

protected AuthenticationService authenticationService

authenticationManager

protected AuthenticationManager authenticationManager

profileService

protected ProfileService profileService

encryptor

protected org.craftercms.commons.crypto.TextEncryptor encryptor

rememberMeCookieManager

protected org.craftercms.commons.http.CookieManager rememberMeCookieManager

Constructor Details

RememberMeManagerImpl

public RememberMeManagerImpl(AuthenticationService authenticationService,
 AuthenticationManager authenticationManager,
 ProfileService profileService,
 org.craftercms.commons.crypto.TextEncryptor encryptor,
 org.craftercms.commons.http.CookieManager rememberMeCookieManager)

Method Details

autoLogin

public Authentication autoLogin(org.craftercms.commons.http.RequestContext context)
                         throws RememberMeException

Description copied from interface: RememberMeManager

Attempts auto login if a remember me cookie is present in the current request

Specified by:

autoLogin in interface RememberMeManager

Parameters:

context - the request context

Returns:

the authentication if auto login was successful

Throws:

RememberMeException

enableRememberMe

public void enableRememberMe(Authentication authentication,
 org.craftercms.commons.http.RequestContext context)
                      throws RememberMeException

Description copied from interface: RememberMeManager

Enables remember me for the current authenticated profile, generally by adding a remember me cookie.

Specified by:

enableRememberMe in interface RememberMeManager

Parameters:

authentication - the authentication object

context - the request context

Throws:

RememberMeException

disableRememberMe

public void disableRememberMe(org.craftercms.commons.http.RequestContext context)
                       throws RememberMeException

Description copied from interface: RememberMeManager

Disabled remember me for the current authenticated profile, generally by removing remember me cookie.

Specified by:

disableRememberMe in interface RememberMeManager

Parameters:

context - the request context

Throws:

RememberMeException

disableRememberMe

protected void disableRememberMe(String loginId,
 org.craftercms.commons.http.RequestContext context)
                          throws RememberMeException

Throws:

RememberMeException

updateRememberMe

protected void updateRememberMe(String loginId,
 org.craftercms.commons.http.RequestContext context)
                         throws RememberMeException

Throws:

RememberMeException

serializeLogin

protected String serializeLogin(PersistentLogin login)
                         throws RememberMeException

Throws:

RememberMeException

deserializeLogin

protected PersistentLogin deserializeLogin(String serializedLogin)
                                    throws RememberMeException

Throws:

RememberMeException

addRememberMeCookie

protected void addRememberMeCookie(String cookieValue,
 jakarta.servlet.http.HttpServletResponse response)

getRememberMeCookie

protected String getRememberMeCookie(jakarta.servlet.http.HttpServletRequest request)

deleteRememberMeCookie

protected void deleteRememberMeCookie(jakarta.servlet.http.HttpServletResponse response)

getPersistentLoginFromCookie

protected PersistentLogin getPersistentLoginFromCookie(jakarta.servlet.http.HttpServletRequest request)

authenticate

protected Authentication authenticate(String profileId)
                               throws AuthenticationException

Throws:

AuthenticationException