# UserLockoutManagerMBean

Overview | Related MBeans | Attributes | Operations

## Overview

Lists and manages lockouts on user accounts.

The methods to manage currently locked out users and to get lockout statistics have been deprecated in 9.0.0.0 and moved to ServerRuntime.getServerSecurityRuntime().getDefaultRealmRuntime().getUserLocoutManagerRuntime().

Fully Qualified Interface Name | If you use the `getMBeanInfo` operation in MBeanTypeServiceMBean, supply the following value as this MBean's fully qualified interface name: `weblogic.management.security.authentication.UserLockoutManagerMBean`
Factory Methods | No factory methods. Instances of this MBean are created automatically.
Access Points | You can access this MBean from the following MBean attributes:
RealmMBean.UserLockoutManager |

## Related MBeans

This section describes attributes that provide access to other MBeans. For more information about the MBean hierarchy, refer to WebLogic Server MBean Data Model.

Realm |

### Realm

Returns the realm that contains this user lockout manager. Returns null if this security provider is not contained by a realm.

Privileges | Read only
Type | RealmMBean
Relationship type: | Reference.

## Attributes

This section describes the following attributes:

InvalidLoginAttemptsTotalCount InvalidLoginUsersHighCount LockedUsersCurrentCount LockoutCacheSize LockoutDuration LockoutEnabled LockoutGCThreshold | LockoutResetDuration LockoutThreshold LoginAttemptsWhileLockedTotalCount Name UnlockedUsersTotalCount UserLockoutTotalCount

### InvalidLoginAttemptsTotalCount

Returns the number of invalid logins attempted since this server has been started and lockouts have been enabled. In a cluster, this method returns the number of invalid logins attempted that have occured since the cluster has been started because all servers share login failure information.

Deprecated. 9.0.0.0 Replaced by ServerSecurityRuntimeMBean#getInvalidLoginAttemptsTotalCount()

Privileges | Read only
Type | long
Redeploy or Restart required | Changes take effect after you redeploy the module or restart the server.

### InvalidLoginUsersHighCount

Returns the highest number of users with concurrent unexpired or uncleared invalid login attempts. Invalid login attempts expire as specified by `LockoutResetDuration`. This count is useful in determining whether the `LockoutCacheSize` needs to be modified.

Deprecated. 9.0.0.0 Replaced by ServerSecurityRuntimeMBean#getInvalidLoginUsersHighCount()

Privileges | Read only
Type | long
Redeploy or Restart required | Changes take effect after you redeploy the module or restart the server.

### LockedUsersCurrentCount

Returns the number of users that are currently locked out of this server.

Deprecated. 9.0.0.0 Replaced by ServerSecurityRuntimeMBean#getLockedUsersCurrentCount()

Privileges | Read only
Type | long
Redeploy or Restart required | Changes take effect after you redeploy the module or restart the server.

### LockoutCacheSize

Returns the number of invalid login records that the server places in a cache. The server creates one record for each invalid login.

Privileges | Read/Write
Type | long
Default Value | 5
Minimum value | 0

### LockoutDuration

Returns the number of minutes that a user account is locked out.

Privileges | Read/Write
Type | long
Default Value | 30
Minimum value | 0

### LockoutEnabled

Returns whether the server locks out users when there are invalid login attempts. A `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."

Privileges | Read/Write
Type | boolean
Default Value | true

### LockoutGCThreshold

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.

Privileges | Read/Write
Type | long
Default Value | 400
Minimum value | 0

### LockoutResetDuration

The number of minutes within which consecutive invalid login attempts cause the user account to be locked out.

Privileges | Read/Write
Type | long
Default Value | 5
Minimum value | 1

### LockoutThreshold

Returns the maximum number of consecutive invalid login attempts before account is locked out. When the number of invalid logins within a specified period of time is greater than `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.

Privileges | Read/Write
Type | long
Default Value | 5
Minimum value | 1

### LoginAttemptsWhileLockedTotalCount

Returns the number of invalid logins attempted since this server has been started and lockouts have been enabled.

Deprecated. 9.0.0.0 Replaced by ServerSecurityRuntimeMBean#getLoginAttemptsWhileLockedTotalCount()

Privileges | Read only
Type | long
Redeploy or Restart required | Changes take effect after you redeploy the module or restart the server.

### Name

The name of this configuration. WebLogic Server uses an MBean to implement and persist the configuration.

Privileges | Read only
Type | java.lang.String
Default Value | UserLockoutManager
Redeploy or Restart required | Changes take effect after you redeploy the module or restart the server.

### UnlockedUsersTotalCount

Returns the number times users have been unlocked since this server has been started.

Deprecated. 9.0.0.0 Replaced by ServerSecurityRuntimeMBean#getUnlockedUsersTotalCount()

Privileges | Read only
Type | long
Redeploy or Restart required | Changes take effect after you redeploy the module or restart the server.

### UserLockoutTotalCount

Returns the number of user lockouts that have occured since this server has been started. In a cluster, this method returns the number of user lockouts that have occured since the cluster has been started because all servers share login failure information.

Deprecated. 9.0.0.0 Replaced by ServerSecurityRuntimeMBean#getUserLockoutTotalCount()

Privileges | Read only
Type | long
Redeploy or Restart required | Changes take effect after you redeploy the module or restart the server.

## Operations

This section describes the following operations:

clearLockout getLastLoginFailure getLoginFailureCount | isLockedOut wls_getDisplayName

### clearLockout

Unlocks a user account.

Deprecated. 9.0.0.0 Replaced by ServerSecurityRuntimeMBean#clearLockout(String)

Operation Name | `"clearLockout"`
Parameters | `Object [] { userName }` where: `userName` is an object of type `java.lang.String` that specifies: - A user name. If the user does not exist, this method returns `false`.
Signature | `String [] { "java.lang.String" }`
Returns | `void`

### getLastLoginFailure

Returns a string that indicates the time of the last invalid login for this user.

Deprecated. 9.0.0.0 Replaced by ServerSecurityRuntimeMBean#getLastLoginFailure(String)

Operation Name | `"getLastLoginFailure"`
Parameters | `Object [] { userName }` where: `userName` is an object of type `java.lang.String` that specifies: - A user name. If the user does not exist, this method returns `false`.
Signature | `String [] { "java.lang.String" }`
Returns | `long`

### getLoginFailureCount

Returns the current count of login failures for a specific user. This value returns to

Deprecated. 9.0.0.0 Replaced by ServerSecurityRuntimeMBean#getLoginFailureCount(String)

Operation Name | `"getLoginFailureCount"`
Parameters | `Object [] { userName }` where: `userName` is an object of type `java.lang.String` that specifies: - A user name. If the user does not exist, this method returns `false`.
Signature | `String [] { "java.lang.String" }`
Returns | `long`

### isLockedOut

Indicates whether a user is locked out.

Deprecated. 9.0.0.0 Replaced by ServerSecurityRuntimeMBean#isLockedOut(String)

Operation Name | `"isLockedOut"`
Parameters | `Object [] { userName }` where: `userName` is an object of type `java.lang.String` that specifies: - A user name. If the user does not exist, this method returns `false`.
Signature | `String [] { "java.lang.String" }`
Returns | `boolean`

### wls_getDisplayName

Operation Name | `"wls_getDisplayName"`
Parameters | `null`
Signature | `null`
Returns | `String`