Skip navigation links

Oracle Fusion Middleware
Java API Reference for Oracle WebLogic Server
12c (12.2.1)

Part Number E55141-01
P4 Change 1723563 on 2015/10/09


weblogic.management.runtime
Interface UserLockoutManagerRuntimeMBean

All Superinterfaces:
DynamicMBean, MBeanRegistration, NotificationBroadcaster, RuntimeMBean, WebLogicMBean

public interface UserLockoutManagerRuntimeMBean
extends RuntimeMBean

This class is used to monitor and manage per security realm user lockout information.

Since:
9.0.0.0

Method Summary
abstract  void clearLockout(String userName)
          Unlocks a user account.
abstract  void clearLockout(String userName, String identityDomain)
          Unlocks a user account.
abstract  long getInvalidLoginAttemptsTotalCount()
          Returns the number of invalid logins attempted since this server has been started and lockouts have been enabled.
abstract  long getInvalidLoginUsersHighCount()
          Returns the highest number of users with concurrent unexpired or uncleared invalid login attempts.
abstract  long getLastLoginFailure(String userName)
          Returns a string that indicates the time of the last invalid login for this user.
abstract  long getLastLoginFailure(String userName, String identityDomain)
          Returns a string that indicates the time of the last invalid login for this user.
abstract  long getLockedUsersCurrentCount()
          Returns the number of users that are currently locked out of this server.
abstract  long getLoginAttemptsWhileLockedTotalCount()
          Returns the number of invalid logins attempted since this server has been started and lockouts have been enabled.
abstract  long getLoginFailureCount(String userName)
          Returns the current count of login failures for a specific user.
abstract  long getLoginFailureCount(String userName, String identityDomain)
          Returns the current count of login failures for a specific user.
abstract  long getUnlockedUsersTotalCount()
          Returns the number times users have been unlocked since this server has been started.
abstract  long getUserLockoutTotalCount()
          Returns the number of user lockouts that have occured since this server has been started.
abstract  boolean isLockedOut(String userName)
          Indicates whether a user is locked out.
abstract  boolean isLockedOut(String userName, String identityDomain)
          Indicates whether a user is locked out.

 

Methods inherited from interface weblogic.management.runtime.RuntimeMBean
addPropertyChangeListener, removePropertyChangeListener

 

Methods inherited from interface weblogic.management.WebLogicMBean
getMBeanInfo, getName, getObjectName, getParent, getType, isCachingDisabled, isRegistered, setName, setParent

 

Methods inherited from interface javax.management.DynamicMBean
getAttribute, getAttributes, invoke, setAttribute, setAttributes

 

Methods inherited from interface javax.management.MBeanRegistration
postDeregister, postRegister, preDeregister, preRegister

 

Methods inherited from interface javax.management.NotificationBroadcaster
addNotificationListener, getNotificationInfo, removeNotificationListener

 

Method Detail

getUserLockoutTotalCount

long getUserLockoutTotalCount()
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.

getInvalidLoginAttemptsTotalCount

long getInvalidLoginAttemptsTotalCount()
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.

getLoginAttemptsWhileLockedTotalCount

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

getInvalidLoginUsersHighCount

long getInvalidLoginUsersHighCount()
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.

getUnlockedUsersTotalCount

long getUnlockedUsersTotalCount()
Returns the number times users have been unlocked since this server has been started.

getLockedUsersCurrentCount

long getLockedUsersCurrentCount()
Returns the number of users that are currently locked out of this server.

isLockedOut

boolean isLockedOut(String userName)
Indicates whether a user is locked out.
Parameters:
userName - - A user name. If the user does not exist, this method returns false.

clearLockout

void clearLockout(String userName)
Unlocks a user account.
Parameters:
userName - - A user name. If the user does not exist, this method returns false.

getLastLoginFailure

long getLastLoginFailure(String userName)
Returns a string that indicates the time of the last invalid login for this user.
Parameters:
userName - - A user name. If the user does not exist, this method returns false.

getLoginFailureCount

long getLoginFailureCount(String userName)
Returns the current count of login failures for a specific user. This value returns to
Parameters:
userName - - A user name. If the user does not exist, this method returns false.

isLockedOut

boolean isLockedOut(String userName,
                    String identityDomain)
Indicates whether a user is locked out.
Parameters:
userName - - A user name. If the user does not exist, this method returns false.
identityDomain - - The identity domain of the user. May be null.

clearLockout

void clearLockout(String userName,
                  String identityDomain)
Unlocks a user account.
Parameters:
userName - - A user name. If the user does not exist, this method returns false.
identityDomain - - The identity domain of the user. May be null.

getLastLoginFailure

long getLastLoginFailure(String userName,
                         String identityDomain)
Returns a string that indicates the time of the last invalid login for this user.
Parameters:
userName - - A user name. If the user does not exist, this method returns false.
identityDomain - - The identity domain of the user. May be null.

getLoginFailureCount

long getLoginFailureCount(String userName,
                          String identityDomain)
Returns the current count of login failures for a specific user. This value returns to
Parameters:
userName - - A user name. If the user does not exist, this method returns false.
identityDomain - - The identity domain of the user. May be null.

Skip navigation links

Copyright 1996, 2015, Oracle and/or its affiliates. All rights reserved. Oracle is a registered trademark of Oracle Corporation and/or its affiliates. Other names may be trademarks of their respective owners.

Oracle Fusion Middleware
Java API Reference for Oracle WebLogic Server
12c (12.2.1)

Part Number E55141-01
P4 Change 1723563 on 2015/10/09