public interface UserLockoutManagerRuntimeMBean extends RuntimeMBean
This class is used to monitor and manage per security realm user lockout information.
Modifier and Type | Method and Description |
---|---|
void |
clearLockout(String userName)
Unlocks a user account.
|
void |
clearLockout(String userName,
String identityDomain)
Unlocks a user account.
|
long |
getInvalidLoginAttemptsTotalCount()
Returns the number of invalid logins attempted since this server
has been started and lockouts have been enabled.
|
long |
getInvalidLoginUsersHighCount()
Returns the highest number of users with concurrent
unexpired or uncleared invalid login attempts.
|
long |
getLastLoginFailure(String userName)
Returns a string that indicates the time of the last invalid login for this user.
|
long |
getLastLoginFailure(String userName,
String identityDomain)
Returns a string that indicates the time of the last invalid login for this user.
|
long |
getLockedUsersCurrentCount()
Returns the number of users that are currently locked out of this server.
|
long |
getLoginAttemptsWhileLockedTotalCount()
Returns the number of invalid logins attempted since this server
has been started and lockouts have been enabled.
|
long |
getLoginFailureCount(String userName)
Returns the current count of login failures for a specific user.
|
long |
getLoginFailureCount(String userName,
String identityDomain)
Returns the current count of login failures for a specific user.
|
long |
getUnlockedUsersTotalCount()
Returns the number times users have been unlocked
since this server has been started.
|
long |
getUserLockoutTotalCount()
Returns the number of user lockouts that have occured since
this server has been started.
|
boolean |
isLockedOut(String userName)
Indicates whether a user is locked out.
|
boolean |
isLockedOut(String userName,
String identityDomain)
Indicates whether a user is locked out.
|
addPropertyChangeListener, removePropertyChangeListener
getMBeanInfo, getName, getObjectName, getParent, getType, isCachingDisabled, isRegistered, setName, setParent
getAttribute, getAttributes, invoke, setAttribute, setAttributes
postDeregister, postRegister, preDeregister, preRegister
addNotificationListener, getNotificationInfo, removeNotificationListener
long getUserLockoutTotalCount()
long getInvalidLoginAttemptsTotalCount()
long getLoginAttemptsWhileLockedTotalCount()
long getInvalidLoginUsersHighCount()
LockoutResetDuration
.
This count is useful in determining whether the LockoutCacheSize
needs to be modified.long getUnlockedUsersTotalCount()
long getLockedUsersCurrentCount()
boolean isLockedOut(String userName)
userName
- - A user name. If the user does not exist, this method returns false
.void clearLockout(String userName)
userName
- - A user name. If the user does not exist, this method returns false
.long getLastLoginFailure(String userName)
userName
- - A user name. If the user does not exist, this method returns false
.long getLoginFailureCount(String userName)
userName
- - A user name. If the user does not exist, this method returns false
.boolean isLockedOut(String userName, String identityDomain)
userName
- - A user name. If the user does not exist, this method returns false
.identityDomain
- - The identity domain of the user. May be null.void clearLockout(String userName, String identityDomain)
userName
- - A user name. If the user does not exist, this method returns false
.identityDomain
- - The identity domain of the user. May be null.long getLastLoginFailure(String userName, String identityDomain)
userName
- - A user name. If the user does not exist, this method returns false
.identityDomain
- - The identity domain of the user. May be null.long getLoginFailureCount(String userName, String identityDomain)
userName
- - A user name. If the user does not exist, this method returns false
.identityDomain
- - The identity domain of the user. May be null.