Class UserLockoutProperties
java.lang.Object
com.broadleafcommerce.auth.user.autoconfigure.UserLockoutProperties
@ConfigurationProperties(prefix="broadleaf.auth.user-lockout")
public class UserLockoutProperties
extends Object
Optional properties when handling user lockout due to failed login attempts. These will be used
if no lockout settings are present on an authorization server. If no default lockout behavior is
desired, these properties should not be set.
See also
AuthorizationServer
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionprotected boolean
boolean
How many failed login attempts are allowed before a user is locked out.The time, in minutes, a user is locked out if they exceed the allowed number of failed login attempts.How long, in minutes, it takes for failed login attempts to "decay".int
hashCode()
boolean
If true, a locked user can trigger a password reset.boolean
If true, a password reset action will unlock a user on a successful password reset action.void
setFailedLoginAttemptsAllowed
(Integer failedLoginAttemptsAllowed) How many failed login attempts are allowed before a user is locked out.void
setLockedUserCanResetPassword
(boolean lockedUserCanResetPassword) If true, a locked user can trigger a password reset.void
setLockoutDurationMinutes
(Long lockoutDurationMinutes) The time, in minutes, a user is locked out if they exceed the allowed number of failed login attempts.void
setLoginFailDecayMinutes
(Long loginFailDecayMinutes) How long, in minutes, it takes for failed login attempts to "decay".void
setResetPasswordUnlocksUser
(boolean resetPasswordUnlocksUser) If true, a password reset action will unlock a user on a successful password reset action.toString()
-
Constructor Details
-
UserLockoutProperties
public UserLockoutProperties()
-
-
Method Details
-
getFailedLoginAttemptsAllowed
How many failed login attempts are allowed before a user is locked out. Zero or null indicates unlimited login attempts. -
getLockoutDurationMinutes
The time, in minutes, a user is locked out if they exceed the allowed number of failed login attempts. Null indicates unlimited lockout duration. -
getLoginFailDecayMinutes
How long, in minutes, it takes for failed login attempts to "decay". Failed login attempts that have decayed will not be taken into account when determining if a use should be locked out. Null indicates attempts never decay. -
isResetPasswordUnlocksUser
public boolean isResetPasswordUnlocksUser()If true, a password reset action will unlock a user on a successful password reset action. Default value is false. -
isLockedUserCanResetPassword
public boolean isLockedUserCanResetPassword()If true, a locked user can trigger a password reset. Default value is false. -
setFailedLoginAttemptsAllowed
How many failed login attempts are allowed before a user is locked out. Zero or null indicates unlimited login attempts. -
setLockoutDurationMinutes
The time, in minutes, a user is locked out if they exceed the allowed number of failed login attempts. Null indicates unlimited lockout duration. -
setLoginFailDecayMinutes
How long, in minutes, it takes for failed login attempts to "decay". Failed login attempts that have decayed will not be taken into account when determining if a use should be locked out. Null indicates attempts never decay. -
setResetPasswordUnlocksUser
public void setResetPasswordUnlocksUser(boolean resetPasswordUnlocksUser) If true, a password reset action will unlock a user on a successful password reset action. Default value is false. -
setLockedUserCanResetPassword
public void setLockedUserCanResetPassword(boolean lockedUserCanResetPassword) If true, a locked user can trigger a password reset. Default value is false. -
equals
-
canEqual
-
hashCode
public int hashCode() -
toString
-