Interface UserLockoutService
- All Known Implementing Classes:
DefaultUserLockoutService
public interface UserLockoutService
Service responsible for handling login attempts. This service handles the creation, locking,
unlocking, etc. of user accounts.
-
Method Summary
Modifier and TypeMethodDescriptionboolean
canResetPassword
(User user) Return true if this user can reset their password.void
createLoginAttempt
(User user, String loginAttemptResult) Create a user login attempt.void
createLoginAttempt
(String username, String loginAttemptResult, String clientId) Create a user login attemptManually lock a userunlockUser
(User user) Manually unlock a userunlockUserIfEligible
(String username, String clientId) If a user is eligbile for unlocking, unlock them.After a password reset, unlock the user if they're eligible.
-
Method Details
-
createLoginAttempt
Create a user login attempt.- Parameters:
user
- The user to create a login attempt forloginAttemptResult
- The login attempt result.- Throws:
org.springframework.security.authentication.LockedException
- if the user is locked out
-
createLoginAttempt
Create a user login attempt- Parameters:
username
- The username to create an attempt forloginAttemptResult
- The login attempt resultclientId
- The client ID
-
unlockUser
Manually unlock a user- Parameters:
user
- The user to unlock
-
lockUser
Manually lock a user- Parameters:
user
- The user to lock
-
unlockUserIfEligible
If a user is eligbile for unlocking, unlock them.- Parameters:
username
- The usernameclientId
- The client ID- Returns:
- The user, if they exist
-
canResetPassword
Return true if this user can reset their password.See
AuthorizationServer.getLockedUserCanResetPassword()
andUserLockoutProperties.isLockedUserCanResetPassword()
- Parameters:
user
- The user to check- Returns:
- true if the user can reset their password, otherwise false.
-
unlockUserOnPasswordResetIfEligible
After a password reset, unlock the user if they're eligible.See
AuthorizationServer.getResetPasswordUnlocksUser()
andUserLockoutProperties.isResetPasswordUnlocksUser()
- Parameters:
user
- The user to unlock, if eligible- Returns:
- true if the user has been unlocked, false if the user is still locked, or null if no action was taken
-