Package org.craftercms.security.authentication

Interface RememberMeManager

All Known Implementing Classes:
RememberMeManagerImpl
public interface RememberMeManager
Manages remember me functionality.
Author:
avasquez

  • Method Summary

    Modifier and Type
    Method
    Description
    Authentication
    autoLogin(org.craftercms.commons.http.RequestContext context)
    Attempts auto login if a remember me cookie is present in the current request
    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.

  • Method Details

    • autoLogin

      Authentication autoLogin(org.craftercms.commons.http.RequestContext context) throws RememberMeException
      Attempts auto login if a remember me cookie is present in the current request
      Parameters:
      context - the request context
      Returns:
      the authentication if auto login was successful
      Throws:
      RememberMeException

    • enableRememberMe

      void enableRememberMe(Authentication authentication, org.craftercms.commons.http.RequestContext context) throws RememberMeException
      Enables remember me for the current authenticated profile, generally by adding a remember me cookie.
      Parameters:
      authentication - the authentication object
      context - the request context
      Throws:
      RememberMeException

    • disableRememberMe

      void disableRememberMe(org.craftercms.commons.http.RequestContext context) throws RememberMeException
      Disabled remember me for the current authenticated profile, generally by removing remember me cookie.
      Parameters:
      context - the request context
      Throws:
      RememberMeException