Package com.broadleafcommerce.auth.authorization.security.rememberme.autoconfigure

Class RememberMeLoginProperties

java.lang.Object
com.broadleafcommerce.auth.authorization.security.rememberme.autoconfigure.RememberMeLoginProperties
@ConfigurationProperties(prefix="broadleaf.auth.login.remember-me") public class RememberMeLoginProperties extends Object
Properties configuring 'Remember Me' functionality for login.

  • Constructor Details

    • RememberMeLoginProperties

      public RememberMeLoginProperties()

  • Method Details

    • isEnabled

      public boolean isEnabled()
      Whether to enable features supporting 'remember me' login functionality. This is disabled by default.

    • getLoginFormParameterName

      public String getLoginFormParameterName()
      The name of the parameter submitted during login indicating the user's preference on whether this session should be remembered.

    • isGloballyRevokeAllUserTokensOnLogout

      public boolean isGloballyRevokeAllUserTokensOnLogout()
      Whether to globally invalidate/revoke all of a user's 'remember-me' tokens (regardless of client, device, etc) when they log out. Setting this to false is usually preferable to preserve distinct 'remember-me' states in each client/device they are logged into. For example, logging out on a computer shouldn't cause the user to be forgotten on their mobile phone. However, in some scenarios it may be desirable to set this to true, in which case logging out anywhere will revoke 'remember me' everywhere.

    • getContinuationEndpoint

      public RememberMeLoginProperties.RememberMeContinuationEndpointProperties getContinuationEndpoint()
      Properties configuring the Remember Me continuation endpoint behavior.

    • getAutoLoginCookie

      public RememberMeLoginProperties.AutoLoginCookieProperties getAutoLoginCookie()
      Properties for the 'remember-me' auto-login cookie.

    • getAvailabilityIndicator

      public RememberMeLoginProperties.AvailabilityIndicatorProperties getAvailabilityIndicator()
      Properties configuring components that return indicators on whether 'remember me' is available.

    • setEnabled

      public void setEnabled(boolean enabled)
      Whether to enable features supporting 'remember me' login functionality. This is disabled by default.

    • setLoginFormParameterName

      public void setLoginFormParameterName(String loginFormParameterName)
      The name of the parameter submitted during login indicating the user's preference on whether this session should be remembered.

    • setGloballyRevokeAllUserTokensOnLogout

      public void setGloballyRevokeAllUserTokensOnLogout(boolean globallyRevokeAllUserTokensOnLogout)
      Whether to globally invalidate/revoke all of a user's 'remember-me' tokens (regardless of client, device, etc) when they log out. Setting this to false is usually preferable to preserve distinct 'remember-me' states in each client/device they are logged into. For example, logging out on a computer shouldn't cause the user to be forgotten on their mobile phone. However, in some scenarios it may be desirable to set this to true, in which case logging out anywhere will revoke 'remember me' everywhere.

    • setContinuationEndpoint

      public void setContinuationEndpoint(RememberMeLoginProperties.RememberMeContinuationEndpointProperties continuationEndpoint)
      Properties configuring the Remember Me continuation endpoint behavior.

    • setAutoLoginCookie

      public void setAutoLoginCookie(RememberMeLoginProperties.AutoLoginCookieProperties autoLoginCookie)
      Properties for the 'remember-me' auto-login cookie.

    • setAvailabilityIndicator

      public void setAvailabilityIndicator(RememberMeLoginProperties.AvailabilityIndicatorProperties availabilityIndicator)
      Properties configuring components that return indicators on whether 'remember me' is available.