UserLockoutManagerMBean

Overview  |   Related MBeans  |   Attributes  |   Operations

Overview

Lists and manages lockouts on user accounts.

   
Fully Qualified Interface NameIf 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.

Related MBeans

This section describes attributes that provide access to other MBeans.

    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
    TypeRealmMBean
    Relationship type: Reference.

    Attributes

    This section describes the following attributes:

    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 UserLockoutManagerRuntimeMBean#getInvalidLoginAttemptsTotalCount()

           
    Privileges Read only
    Typelong
    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 UserLockoutManagerRuntimeMBean#getInvalidLoginUsersHighCount()

           
    Privileges Read only
    Typelong
    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 UserLockoutManagerRuntimeMBean#getLockedUsersCurrentCount()

           
    Privileges Read only
    Typelong
    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
    Typelong
    Default Value5
    Minimum value0

    LockoutDuration

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

           
    Privileges Read/Write
    Typelong
    Default Value30
    Minimum value0

    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
    Typeboolean
    Default Valuetrue

    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
    Typelong
    Default Value400
    Minimum value0

    LockoutResetDuration

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

           
    Privileges Read/Write
    Typelong
    Default Value5
    Minimum value1

    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 LockoutThresholdvalue, 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
    Typelong
    Default Value5
    Minimum value1

    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 UserLockoutManagerRuntimeMBean#getLoginAttemptsWhileLockedTotalCount()

           
    Privileges Read only
    Typelong
    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
    Typejava.lang.String
    Default ValueUserLockoutManager
    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 UserLockoutManagerRuntimeMBean#getUnlockedUsersTotalCount()

           
    Privileges Read only
    Typelong
    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 UserLockoutManagerRuntimeMBean#getUserLockoutTotalCount()

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

    Operations

    This section describes the following operations:

    clearLockout

    Unlocks a user account.

    Deprecated. 9.0.0.0 Replaced by UserLockoutManagerRuntimeMBean#clearLockout(String)

       
    Operation Name"clearLockout"
    ParametersObject [] {  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.
    SignatureString [] { "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 UserLockoutManagerRuntimeMBean#getLastLoginFailure(String)

       
    Operation Name"getLastLoginFailure"
    ParametersObject [] {  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.
    SignatureString [] { "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 UserLockoutManagerRuntimeMBean#getLoginFailureCount(String)

       
    Operation Name"getLoginFailureCount"
    ParametersObject [] {  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.
    SignatureString [] { "java.lang.String" }
    Returns long

    isLockedOut

    Indicates whether a user is locked out.

    Deprecated. 9.0.0.0 Replaced by UserLockoutManagerRuntimeMBean#isLockedOut(String)

       
    Operation Name"isLockedOut"
    ParametersObject [] {  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.
    SignatureString [] { "java.lang.String" }
    Returns boolean

    isSet

    Returns true if the specified attribute has been set explicitly in this MBean instance.

       
    Operation Name"isSet"
    ParametersObject [] {  propertyName }

    where:

    • propertyName is an object of type java.lang.String that specifies:

      property to check
    SignatureString [] { "java.lang.String" }
    Returns boolean
    Exceptions
    • java.lang.IllegalArgumentException

    unSet

    Restore the given property to its default value.

       
    Operation Name"unSet"
    ParametersObject [] {  propertyName }

    where:

    • propertyName is an object of type java.lang.String that specifies:

      property to restore
    SignatureString [] { "java.lang.String" }
    Returns void
    Exceptions
    • java.lang.IllegalArgumentException
      UnsupportedOperationException if called on a runtime implementation.

    wls_getDisplayName

    Returns the display name of an MBean.

    Deprecated 9.0.0.0

       
    Operation Name"wls_getDisplayName"
    Parametersnull
    Signaturenull
    ReturnsString