public interface UserLockoutManagerMBean extends StandardInterface, DescriptorBean
Modifier and Type | Method and Description |
---|---|
void |
clearLockout(String userName)
Deprecated.
9.0.0.0 Replaced by
UserLockoutManagerRuntimeMBean.clearLockout(String) |
long |
getInvalidLoginAttemptsTotalCount()
Deprecated.
9.0.0.0 Replaced by
UserLockoutManagerRuntimeMBean.getInvalidLoginAttemptsTotalCount() |
long |
getInvalidLoginUsersHighCount()
Deprecated.
9.0.0.0 Replaced by
UserLockoutManagerRuntimeMBean.getInvalidLoginUsersHighCount() |
long |
getLastLoginFailure(String userName)
Deprecated.
9.0.0.0 Replaced by
UserLockoutManagerRuntimeMBean.getLastLoginFailure(String) |
long |
getLockedUsersCurrentCount()
Deprecated.
9.0.0.0 Replaced by
UserLockoutManagerRuntimeMBean.getLockedUsersCurrentCount() |
long |
getLockoutCacheSize()
Returns the number of invalid login records that the server places in a cache.
|
long |
getLockoutDuration()
Returns the number of minutes that a user account is locked out.
|
long |
getLockoutGCThreshold()
Returns the maximum number of invalid login records that the server keeps in memory.
|
long |
getLockoutResetDuration()
The number of minutes within which consecutive invalid login attempts cause the user account to be locked out.
|
long |
getLockoutThreshold()
Returns the maximum number of consecutive invalid login attempts before account is locked out.
|
long |
getLoginAttemptsWhileLockedTotalCount()
Deprecated.
9.0.0.0 Replaced by
UserLockoutManagerRuntimeMBean.getLoginAttemptsWhileLockedTotalCount() |
long |
getLoginFailureCount(String userName)
Deprecated.
9.0.0.0 Replaced by
UserLockoutManagerRuntimeMBean.getLoginFailureCount(String) |
String |
getName()
The name of this configuration.
|
RealmMBean |
getRealm()
Returns the realm that contains this user lockout manager.
|
long |
getUnlockedUsersTotalCount()
Deprecated.
9.0.0.0 Replaced by
UserLockoutManagerRuntimeMBean.getUnlockedUsersTotalCount() |
long |
getUserLockoutTotalCount()
Deprecated.
9.0.0.0 Replaced by
UserLockoutManagerRuntimeMBean.getUserLockoutTotalCount() |
boolean |
isLockedOut(String userName)
Deprecated.
9.0.0.0 Replaced by
UserLockoutManagerRuntimeMBean.isLockedOut(String) |
boolean |
isLockoutEnabled()
Returns whether the server locks out users when there are invalid login attempts.
|
void |
setLockoutCacheSize(long lockoutCacheSize)
Sets the number of invalid login records that the server places in a cache.
|
void |
setLockoutDuration(long lockoutDuration)
Sets the number of minutes that a user account is locked out.
|
void |
setLockoutEnabled(boolean lockoutEnabled)
Sets whether the server locks out users when there are invalid login attempts.
|
void |
setLockoutGCThreshold(long lockoutGCThreshold)
Sets the maximum number of invalid login records that the server keeps in memory.
|
void |
setLockoutResetDuration(long newValue)
The number of minutes within which consecutive invalid login attempts cause the user account to be locked out.
|
void |
setLockoutThreshold(long lockoutThreshold)
Sets the maximum number of consecutive invalid login attempts before account is locked out.
|
addPropertyChangeListener, createChildCopyIncludingObsolete, getParentBean, isEditable, removePropertyChangeListener
long getUserLockoutTotalCount()
UserLockoutManagerRuntimeMBean.getUserLockoutTotalCount()
long getInvalidLoginAttemptsTotalCount()
UserLockoutManagerRuntimeMBean.getInvalidLoginAttemptsTotalCount()
long getLoginAttemptsWhileLockedTotalCount()
UserLockoutManagerRuntimeMBean.getLoginAttemptsWhileLockedTotalCount()
long getInvalidLoginUsersHighCount()
UserLockoutManagerRuntimeMBean.getInvalidLoginUsersHighCount()
LockoutResetDuration
.
This count is useful in determining whether the LockoutCacheSize
needs to be modified.long getUnlockedUsersTotalCount()
UserLockoutManagerRuntimeMBean.getUnlockedUsersTotalCount()
long getLockedUsersCurrentCount()
UserLockoutManagerRuntimeMBean.getLockedUsersCurrentCount()
RealmMBean getRealm()
boolean isLockoutEnabled()
true
value for this attribute causes the server to consider
the other attributes of this MBean. A false
value causes the server
to ignore the other attributes of this MBean."void setLockoutEnabled(boolean lockoutEnabled) throws InvalidAttributeValueException
lockoutEnabled
- - the new lockout enabled valueInvalidAttributeValueException
UserLockoutManagerMBean.isLockoutEnabled()
long getLockoutThreshold()
LockoutThreshold
value, the user is locked out. For example,
with the default setting of 1
, the user is locked out on the
second consecutive invalid login. With a setting of 2
, the user
is locked out on the third consecutive invalid login.void setLockoutThreshold(long lockoutThreshold) throws InvalidAttributeValueException
lockoutThreshold
- - the new lockout thresholdInvalidAttributeValueException
UserLockoutManagerMBean.getLockoutThreshold()
long getLockoutDuration()
void setLockoutDuration(long lockoutDuration) throws InvalidAttributeValueException
lockoutDuration
- - the new lockout duration in minutesInvalidAttributeValueException
UserLockoutManagerMBean.getLockoutDuration()
long getLockoutResetDuration()
void setLockoutResetDuration(long newValue) throws InvalidAttributeValueException
newValue
- - new value for attribute LockoutResetDurationInvalidAttributeValueException
UserLockoutManagerMBean.getLockoutResetDuration()
long getLockoutCacheSize()
void setLockoutCacheSize(long lockoutCacheSize) throws InvalidAttributeValueException
lockoutCacheSize
- - the new lockout cache sizeInvalidAttributeValueException
UserLockoutManagerMBean.getLockoutCacheSize()
long getLockoutGCThreshold()
Returns the maximum number of invalid login records that the server keeps in memory.
If the number of invalid login records is equal to or greater than this value, the server's garbage collection purges the records that have expired. A record expires when the user associated with the record has been locked out.
The lower the threshold, the more often the server uses its resources to collect garbage.
void setLockoutGCThreshold(long lockoutGCThreshold) throws InvalidAttributeValueException
lockoutGCThreshold
- - the new lockout garbage collection thresholdInvalidAttributeValueException
UserLockoutManagerMBean.getLockoutGCThreshold()
boolean isLockedOut(String userName)
UserLockoutManagerRuntimeMBean.isLockedOut(String)
userName
- - A user name. If the user does not exist, this method returns false
.void clearLockout(String userName)
UserLockoutManagerRuntimeMBean.clearLockout(String)
userName
- - A user name. If the user does not exist, this method returns false
.long getLastLoginFailure(String userName)
UserLockoutManagerRuntimeMBean.getLastLoginFailure(String)
userName
- - A user name. If the user does not exist, this method returns false
.long getLoginFailureCount(String userName)
UserLockoutManagerRuntimeMBean.getLoginFailureCount(String)
userName
- - A user name. If the user does not exist, this method returns false
.String getName()
getName
in interface StandardInterface